magic-epaper-app

<img height="200px" src="./assets/icons/app_icon_desktop.png" align="right" />

# Magic ePaper

[![Build](https://img.shields.io/github/actions/workflow/status/fossasia/magic-epaper-app/push.yml?branch=main&label=build&logo=github)](https://github.com/fossasia/magic-epaper-app/actions/workflows/push.yml)
[![License](https://img.shields.io/github/license/fossasia/magic-epaper-app)](LICENSE.md)
[![Issues](https://img.shields.io/github/issues/fossasia/magic-epaper-app)](https://github.com/fossasia/magic-epaper-app/issues)
[![Last commit](https://img.shields.io/github/last-commit/fossasia/magic-epaper-app)](https://github.com/fossasia/magic-epaper-app/commits/main)
[![Contributors](https://img.shields.io/github/contributors/fossasia/magic-epaper-app)](https://github.com/fossasia/magic-epaper-app/graphs/contributors)
[![Translation status](https://hosted.weblate.org/widget/fossasia/magic-epaper-app/svg-badge.svg)](https://hosted.weblate.org/projects/fossasia/magic-epaper-app/)

Magic ePaper is an open-source Flutter app that lets you design content on your phone and transfer it to a battery-free NFC ePaper badge wirelessly. No cables or power needed on the badge. Import and dither photos for ePaper, draw and add text, generate QR codes and barcodes, or start from a ready-made card template, then tap your phone to the badge to write the image.

## Table of Contents

- [Download](#download)
- [Get a badge](#get-a-badge)
- [Features](#features)
- [Supported Displays](#supported-displays)
- [Roadmap](#roadmap)
- [Usage](#usage)
- [Permissions](#permissions)
- [Screenshots](#screenshots)
- [Development](#development)
- [Contributing](#contributing)
- [Branch Policy](#branch-policy)
- [Translations](#translations)
- [License](#license)

## Download

The app is currently in **beta testing** and runs on **Android**. Desktop support (Windows, macOS and Linux) is under active development.

* Download the latest build from the [app branch](https://github.com/fossasia/magic-epaper-app/tree/app), or build it yourself (see [Development](#development)).
* You need an **Android device with NFC** and a supported **NFC ePaper badge** (see [Supported Displays](#supported-displays)). Most design tools work without a badge; a badge is only needed to transfer an image.
* Found a bug? Please open an issue on the [issue tracker](https://github.com/fossasia/magic-epaper-app/issues) and include your phone model and badge.

## Get a badge

The Magic ePaper badge is still a **prototype** and is not on general sale yet. Ordering is planned to open on [fossasia.com](https://fossasia.com) in the future, and the hardware designs and prototypes are shared in the FOSSASIA repositories in the meantime. Any of the [supported NFC ePaper badges](#supported-displays) below already works with the app today.

## Features

* **Image editor**: import a photo, rotate/flip, adjust brightness and contrast, dither for ePaper (Floyd-Steinberg, Atkinson, Stucki, Sierra, Burkes, Halftone, Threshold),