Unbound Tome

A free and open-source TTRPG platform for creating and viewing game content.

Initial milestone is aimed at supporting creation of DnD 5e campaigns and character sheets.

Stack

• Axum
• Axum-login
• SeaORM w/ Postgres
• Tailwind + DaisyUI
• HTMX
• Maud
• Oso

Planned Features

• Oauth2 support via Axum-login
• Support for 5e.tools json import and updates
• Import/export of character sheets
• Import/export of campaign data
• Import/export of different systems
• Export charsheets as PDF
• In-campaign chat
• Admin dashboard
• Event log
• Tracing and monitoring
• PWA support for android and ios

Extra Planned Features

• Implement CI/CD via Github Actions
• Support Docker and Docker Compose
• Support Helm Charts for Kubernetes deployments
• Add health check endpoints and a status page
• Consider supporting Valkey(Redis fork) and OpenTelemetry
• Support i10n via Project Fluent and fluent-template

Installation

Built using rust stable branch.

NB! Requires Bun (NPM alternative) to be installed.

1. Install Bun dependencies.

   bun install

2. Install sea-orm-cli.

   cargo install sea-orm-cli

3. Modify the configuration toml's in the config directory.

4. Initialize the postgres container.

   docker compose -f dockercompose.yml up -d

5. Run migrations.

   sea-orm-cli migrate fresh

Development

6. Start The development server.

   cargo watch -x run

Production

6. Build the production binary.

   cargo build --release

FAQ

1. Why is the password verification so slow? (eg. 400ms on my PC)

   Password-auth crate's password verification is considerably slower if built in debug mode. Building using --release flag will reduce the verification considerably. (20ms on my PC)