https://github.com/bigjk/snd
Sales & Dungeons — Thermal Printer as D&D / TTRPG Utility
https://github.com/bigjk/snd
dnd-tools dnd5e dungeon-master dungeons-and-dragons epson llm osr tabletop-gaming thermal-printer ttrpg
Last synced: 15 days ago
JSON representation
Sales & Dungeons — Thermal Printer as D&D / TTRPG Utility
- Host: GitHub
- URL: https://github.com/bigjk/snd
- Owner: BigJk
- License: mit
- Created: 2020-02-16T18:55:21.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-26T06:10:23.000Z (28 days ago)
- Last Synced: 2025-03-31T21:49:08.672Z (22 days ago)
- Topics: dnd-tools, dnd5e, dungeon-master, dungeons-and-dragons, epson, llm, osr, tabletop-gaming, thermal-printer, ttrpg
- Language: TypeScript
- Homepage: https://sales-and-dungeons.app/
- Size: 7.52 MB
- Stars: 533
- Watchers: 13
- Forks: 18
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
----
[](https://discord.gg/5MUZEjc) [](https://github.com/BigJk/snd/discussions) [](https://github.com/BigJk/snd/releases)
**Sales & Dungeons** — Thermal Printer as D&D Utility.
With Sales & Dungeons you can create highly customizable handouts, quick reference and much more for your Dungeons and Dragons (or other PnP) Sessions.
Most Thermal Printer are small in size and can be taken with you and kept right at the gaming table. Use-cases range from printing out magic items, spells
or a letter that the group found to little character sheets of your players to use as DM note. The possibilities are nearly endless!
[Printer Setup](https://sales-and-dungeons.app/docs/printer/setup/) • [Tested Printer](https://sales-and-dungeons.app/docs/printer/models/) • [Wiki](https://sales-and-dungeons.app/docs/intro/)
**Important:** If you have trouble getting this to work it's best to drop by our [Discord](https://discord.gg/5MUZEjc).
## Features
- Works on
- Windows
- Mac (Intel, M1)
- Linux (x64, ARM64)
- Raspberry Pi (ARMv6, ARMv7)
- Anything else go can be compiled on
- Extensive templating system through [Nunjucks](https://mozilla.github.io/nunjucks/)
- Extensive random generator system
- Various connection methods
- Windows Direct Printing
- Raw USB Printing
- CUPS (Linux, Mac)
- Serial
- Import & Export templates and data sources
- Fast access to external [data sources](https://sales-and-dungeons.app/docs/data-source/) like Open5e (instant access to SRD monsters, spells and more)
- Import data from other sources:
- CSV
- [FoundryVTT](https://foundryvtt.com/) Modules
- Fight Club 5e XML Format
- 5eTools
- Access Community Templates, Generators & Data Sources from within the App
- AI LLM Support (OpenAI, OpenRouter, Custom Local)
- Generate entries by prompt using the power of AI
- Translate entries by prompt
- Execute AI prompts in your templates and generators
- Support for using Local LLMs (for example via [LM Studio](https://lmstudio.ai/)) or any custom endpoints that are compatible with OpenAI API
- Cloud sync for templates, generators and data sources
## 🖨️ Examples
Some example prints
## 📁 Download
You can find the latest version on the release page:
- https://github.com/BigJk/snd/releases
### :apple: Mac
The mac bundles are not signed at the moment so you might face the following problems when opening the application:
#### It's not opening because it's from a unverified developer
If your mac is telling you that this app is from a unverified developer you can allow it via the "Privacy & Security" settings. More info: [Open a Mac app from an unidentified developer](https://support.apple.com/lv-lv/guide/mac-help/mh40616/mac)
#### It's not opening because the app "is damaged"
On M1, M2, etc. it can happen that the app is reported as damaged. Just copy Sales & Dungeons into your Applications folder and execute the following command to allow it to run:
```
xattr -d com.apple.quarantine "/Applications/Sales & Dungeons.app/"
```
### :whale: Docker
The headless version of Sales & Dungeons (using LibUSB) is also available via a docker container:
1. ``docker pull ghcr.io/bigjk/snd:master`` ([container](https://github.com/BigJk/snd/pkgs/container/snd))
2. ``docker run -p 7123:7123 --device=/dev/bus/usb --group-add uucp -v /some/place/to/persist:/app/userdata ghcr.io/bigjk/snd:master``
1. change ``/some/place/to/persist`` to a folder where the user data should be persisted to
2. replace `/dev/bus/usb` with the device of your usb/serial printer
3. replace `uucp` with a group (or gid) allowed to read the device file (use `$(stat -c "%g" /dev/bus/usb)` to get the right group)
4. Open ``http://127.0.0.1:7123`` in your favorite browser
Docker Compose Example
```
version: "3"
services:
snd:
image: ghcr.io/bigjk/snd:master
ports:
- "7123:7123"
devices:
- "/dev/bus/usb"
group_add:
- uucp
volumes:
- "/some/place/to/persist:/app/userdata"
```
## Printer Requirements
At the moment Sales & Dungeons only supports the [ESC/POS](https://en.wikipedia.org/wiki/ESC/P) (Epson Standard Code) control codes, which is still one of the most used control code set. Check if a thermal printer you are interested in mentions ESC/POS or Epson in the description or manual.
In general the rule of thumb is:
- Most cheap chinese thermal printer found on Amazon or AliExpress support it
- Most epson thermal printer obviously support it
- A lot of older Serial printer (like Metapace T-1) also support it
More specific information about tested printers can be found in the wiki: [Printer-Settings](https://sales-and-dungeons.app/docs/printer/models/)
## How It Works
**Templates:** Templates are created in HTML (and CSS) in combination with the Nunjucks templating language. You can imagine
the templates as little websites. That makes it possible to use all the nice and convenient layout options that HTML and CSS
has to offer and even include any common framework you might need (e.g. Fontawesome for Icons).
**Rendered HTML:** After creating a template you can create entries with the data you want and print them.
Nunjucks will create the rendered HTML from the data you want to print.
**Rendered Image:** Then this HTML get's converted to an image. Currently this conversion is done by Chrome via the
Chrome Debug Protocol. Although Chrome seems like a huge overkill for just HTML-To-Image conversion it's the standard solution at the
moment because it supports most of the modern HTML and CSS features.
**ESC / POS Commands:** The last step before our awesome template hits the Printer is the conversion from the rendered image
to the "draw image" command of the printer.
**Printer:** The generated command will then be sent to the printer and printed. Now your template is ready to be used!
:tada: :tada: :tada:
## Printers, Templating & Building
If you want to see what printers were already tested, which settings they need, how the templates work or how you can build Sales & Dungeons yourself please visit the [**wiki**](https://sales-and-dungeons.app/docs/intro/).
## Thanks to all contributors ❤
## Thanks to JetBrains
This Project is supported with a JetBrains License through the [Open Source Support Program](https://www.jetbrains.com/community/opensource).
## Found the project useful? :smiling_face_with_three_hearts:
[](https://ko-fi.com/A0A763FPT)
## Credits
Icons used in the Sales & Dungeons Logo were made by [Smashicons](https://www.flaticon.com/authors/smashicons), [Good Ware](https://www.flaticon.com/authors/good-ware) from [www.flaticon.com](http://www.flaticon.com)