diff --git a/README.md b/README.md index 767579f..10818a0 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,94 @@ -# NiimBlue +
-NIIMBOT printers webui. Design and print labels right from your browser. +[![logo](about/logo.svg)](https://niim.blue) -Uses [NiimBlueLib](https://github.com/MultiMote/niimbluelib) for communication. +# NIIMBOT printers webui -Project is deployed here: [niim.blue](https://niim.blue) +Design and print labels right from your browser -> [!NOTE] -> If you have printing problems, try different print task versions in print preview dialog. Make if default by pressing "Lock" button. -> -> If you found version suitable for your model, please write [here](https://github.com/MultiMote/niimbluelib/issues/1). -> -> Also read [Frequently asked questions](https://github.com/MultiMote/niimblue/wiki/Frequently-asked-questions). +[FAQ](https://github.com/MultiMote/niimblue/wiki/Frequently-asked-questions) | [Discord](https://discord.gg/jXPAfZVd8a) | [Telegram](https://t.me/niimblue) | [Boosty](https://boosty.to/multimote) | [NIIMBOT Community Wiki](https://printers.niim.blue) +[NiimBlueLib](https://github.com/MultiMote/niimbluelib) is used for communication + +
## Features -Key features: - -* Privacy first! This application works completely offline and does not send any data (except for downloading application files and importing ZPL labels). Label data is stored in your browser. +* Privacy first! This application works completely offline (at browser side) and does not send any data (except for downloading application files and importing ZPL labels). Label data is stored in your browser. * Support for both Bluetooth and USB connections. * Rich label editor. Label saving, import/export. * Print preview. You can see how your label will look like after post-processing. Several post-processing algorithms are available. * Android App (Capacitor based). -* Most complete implementation of [NIIMBOT protocol](https://niim-docs.pages.dev/documents/NIIMBOT_printers_protocol.html). +* Most complete implementation of [NIIMBOT protocol](https://printers.niim.blue/interfacing/proto/). -You can see the full list of implemented and planned features [on the Wiki](https://github.com/MultiMote/niimblue/wiki#features). - -List of tested models you can find in [niimbluelib](https://github.com/MultiMote/niimbluelib/issues/1) repository. +You can see more complete list of implemented and planned features [on the Wiki](https://github.com/MultiMote/niimblue/wiki#features). Demonstration video: [![demo video](https://img.youtube.com/vi/u8QX-5e3W_A/mqdefault.jpg)](https://www.youtube.com/watch?v=u8QX-5e3W_A) -## Browser support +## Supported printers + +There is no exact list of supported models in this project. This project aims to support the maximum number of models. + +You can check [a list of tested models here](https://github.com/MultiMote/niimbluelib/issues/1). If you own other model, please write a comment. + +If your (new) printer model does not print, please make a [packet dump](https://github.com/MultiMote/niimblue/wiki/Making-packet-capture) of print with official application. + +> [!NOTE] +> If you have printing problems, try different print task versions in print preview dialog. Make if default by pressing "Lock" button. + + +## Supported browsers Your browser must support Web Bluetooth API: [supported browsers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Bluetooth_API#browser_compatibility). For serial communication: [supported browsers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Serial_API#browser_compatibility). -In some systems you need to enable Chrome `Experimental Web Platform Features` (navigate to `chrome://flags`). +Modern Chrome-based browsers should usually work. -## Feedback needed! - -I only have D110 and B1 printers. If you own other models, please write a comment [here](https://github.com/MultiMote/niimbluelib/issues/1) describing your model working or not. - -Bluetooth dumps are MUCH appreciated. [How to make it](https://github.com/MultiMote/niimblue/wiki/Making-packet-capture). +In some systems you need to enable Chrome `Web Bluetooth` or `Experimental Web Platform Features` (navigate to `chrome://flags`). ## Images -Images may be outdated, interface is changing constantly. +Images may be outdated. ![ui](about/ui.png) +
+⬇ More images ⬇ + +Label properties: + ![labels](about/labels.png) +Save/load menu: + +![save_load](about/save_load.png) + +Print preview dialog: + ![print_preview](about/print_preview.png) +Post-processing: + ![dither](about/dither.png) +Templating: + ![templating](about/templating.png) +Dynamic data: + ![batch](about/batch.png) +In real life: + ![printed_b1](about/printed_b1.jpg) ![printed_d110](about/printed_d110.jpg) +
+ ## Launching development server @@ -89,7 +112,7 @@ Skip steps you have done. 5. Run dev server - Check code and open browser: + Check code and run: ```bash npm run dev-check @@ -101,15 +124,9 @@ Skip steps you have done. npm run dev ``` -## Translation status +To run own instance, build static files (`npm run build`) and host on yor web server, +or use [Docker Image](https://github.com/MultiMote/niimblue/wiki/Running-own-instance-with-Docker). + +## Translations (click to contribute) [![translation](https://weblate.mmote.ru/widget/niimblue/web/multi-auto.svg)](https://weblate.mmote.ru/engage/niimblue/) - -## Other - -| Links | | -|--------| -- | -| [](https://boosty.to/multimote) | Boosty (support project) | -| [](https://discord.gg/jXPAfZVd8a) | Discord (dev news, troubleshooting and other, en) | -| [](https://t.me/niimblue) | Telegram (ru/en discussion) | - diff --git a/about/batch.png b/about/batch.png index 71a66f9..cfe5a9a 100644 Binary files a/about/batch.png and b/about/batch.png differ diff --git a/about/dither.png b/about/dither.png index 527a32b..720e6e7 100644 Binary files a/about/dither.png and b/about/dither.png differ diff --git a/about/labels.png b/about/labels.png index 94bd170..008473a 100644 Binary files a/about/labels.png and b/about/labels.png differ diff --git a/about/logo.svg b/about/logo.svg new file mode 100644 index 0000000..076fe33 --- /dev/null +++ b/about/logo.svg @@ -0,0 +1,7 @@ + + + + + + + diff --git a/about/print_preview.png b/about/print_preview.png index f5cd5f1..41c62d7 100644 Binary files a/about/print_preview.png and b/about/print_preview.png differ diff --git a/about/save_load.png b/about/save_load.png new file mode 100644 index 0000000..ad1cc7f Binary files /dev/null and b/about/save_load.png differ diff --git a/about/templating.png b/about/templating.png index 4d1abf6..37f2de0 100644 Binary files a/about/templating.png and b/about/templating.png differ diff --git a/about/ui.png b/about/ui.png index fda752e..f091e03 100644 Binary files a/about/ui.png and b/about/ui.png differ