snd

README

---

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 • Tested Printer • Wiki

Important: If you have trouble getting this to work it's best to drop by our Discord.

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
• 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 like Open5e (instant access to SRD monsters, spells and more)
• Import data from other sources:
  • CSV
  • FoundryVTT 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) or any custom endpoints that are compatible with OpenAI API
• Cloud sync for templates, generators and data sources

📁 Download

You can find the latest version on the release page:

• https://github.com/BigJk/snd/releases

🍎 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

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/"

🐳 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)
2. docker run --expose 7123:7123 --device=/dev/bus/usb -v /some/place/to/persist:/app/userdata ghcr.io/bigjk/snd:master (change /some/place/to/persist to a folder where the user data should be persisted to)
3. 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"
    volumes:
      - "/some/place/to/persist:/app/userdata"

Printer Requirements

At the moment Sales & Dungeons only supports the ESC/POS (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

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 a 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!

🎉 🎉 🎉

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.

Thanks to all contributors ❤

Thanks to JetBrains

This Project is supported with a JetBrains License through the Open Source Support Program.

Credits

Icons used in the Sales & Dungeons Logo were made by Smashicons, Good Ware from www.flaticon.com

Documentation

Index

• Variables
• func IsDataSourceID(id string) bool
• func IsGeneratorID(id string) bool
• func IsTemplateID(id string) bool
• type DataSource
  • func (ds DataSource) ID() string
• type Entry
• type Generator
  • func (t Generator) ID() string
• type GeneratorConfig
• type Settings
• type Template
  • func (t Template) ID() string
• type TemplateConfig

Variables

var BuildTime string

var GitBranch string

var GitCommitHash string

Functions

func IsDataSourceID

func IsDataSourceID(id string) bool

func IsGeneratorID

func IsGeneratorID(id string) bool

func IsTemplateID

func IsTemplateID(id string) bool

Types

type DataSource

type DataSource struct {
	Name        string `json:"name"`
	Slug        string `json:"slug"`
	Author      string `json:"author"`
	Description string `json:"description"`
	Version     string `json:"version"`
}

DataSource represents a data source in S&D.

func (DataSource) ID

func (ds DataSource) ID() string

type Entry

type Entry struct {
	ID   string                 `json:"id"`
	Name string                 `json:"name"`
	Data map[string]interface{} `json:"data"`
}

Entry represents one data entry in a template or data source.

type Generator

type Generator struct {
	Name            string            `json:"name"`
	Slug            string            `json:"slug"`
	Author          string            `json:"author"`
	Description     string            `json:"description"`
	PrintTemplate   string            `json:"printTemplate"`
	PassEntriesToJS bool              `json:"passEntriesToJS"`
	Config          []GeneratorConfig `json:"config"`
	Images          map[string]string `json:"images"`
	DataSources     []string          `json:"dataSources"`
	Version         string            `json:"version"`
}

Generator represents one S&D generator. Instead of working with fixed data entries like the template a generator procedurally generates new entries to print on the spot.

func (Generator) ID

func (t Generator) ID() string

type GeneratorConfig

type GeneratorConfig struct {
	Key         string      `json:"key"`
	Name        string      `json:"name"`
	Description string      `json:"description"`
	Type        string      `json:"type"`
	Default     interface{} `json:"default"`
}

type Settings

type Settings struct {
	PrinterType     string `json:"printerType"`
	PrinterEndpoint string `json:"printerEndpoint"`
	PrinterWidth    int    `json:"printerWidth"`
	Commands        struct {
		ExplicitInit      bool `json:"explicitInit"`
		Cut               bool `json:"cut"`
		ForceStandardMode bool `json:"forceStandardMode"`
		LinesBefore       int  `json:"linesBefore"`
		LinesAfter        int  `json:"linesAfter"`
		SplitPrinting     bool `json:"splitPrinting"`
		SplitHeight       int  `json:"splitHeight"`
		SplitDelay        int  `json:"splitDelay"`
	} `json:"commands"`
	Stylesheets           []string `json:"stylesheets"`
	SpellcheckerLanguages []string `json:"spellcheckerLanguages"`
	PackageRepos          []string `json:"packageRepos"`
	SyncKey               string   `json:"syncKey"`
	SyncEnabled           bool     `json:"syncEnabled"`
	AIEnabled             bool     `json:"aiEnabled"`
	AIApiKey              string   `json:"aiApiKey"`
	AIModel               string   `json:"aiModel"`
	AIProvider            string   `json:"aiProvider"`
	AIContextWindow       int      `json:"aiContextWindow"`
	AIMaxTokens           int      `json:"aiMaxTokens"`
	AIURL                 string   `json:"aiUrl"`
}

Settings represents the basic settings for S&D.

type Template

type Template struct {
	Name          string                 `json:"name"`
	Slug          string                 `json:"slug"`
	Author        string                 `json:"author"`
	Description   string                 `json:"description"`
	PrintTemplate string                 `json:"printTemplate"`
	ListTemplate  string                 `json:"listTemplate"`
	SkeletonData  map[string]interface{} `json:"skeletonData"`
	Images        map[string]string      `json:"images"`
	Config        []TemplateConfig       `json:"config"`
	DataSources   []string               `json:"dataSources"`
	Version       string                 `json:"version"`
}

Template represents one S&D template.

func (Template) ID

func (t Template) ID() string

type TemplateConfig

type TemplateConfig struct {
	Key         string      `json:"key"`
	Name        string      `json:"name"`
	Description string      `json:"description"`
	Type        string      `json:"type"`
	Default     interface{} `json:"default"`
}