Skip to content

Quick Start

Get up and running with Studiorum to convert 5e content into professional PDFs.

Installation

Install Studiorum by cloning the Github repository. In the future it will be available on PyPi so you can use pip or uv.

git clone https://github.com/sargeant/studiorum.git
cd studiorum
uv sync
. .venv/bin/activate

# Studiorum is not available on PyPi yet. Future feature.
uv add studiorum

# Studiorum is not available on PyPi yet. Future feature.
pip install studiorum

LaTeX

You'll need a LaTeX installation to build the PDFs.

# Install MacTeX (full distribution)
brew install --cask mactex

# Or BasicTeX (minimal)
brew install --cask basictex

# Full installation
sudo apt-get install texlive-full

# Minimal installation
sudo apt-get install texlive-latex-base texlive-latex-extra

Download and install MiKTeX or TeX Live.

LaTeX template

We build on the great work of others by using an open source template for the LaTeX document processing language. In the future we plan to automatically handle the install, but for now please install the template manually.

Basic Usage

Convert a Creature

Convert a single creature to PDF:

studiorum convert creatures --type dragon --output dragons.tex
xelatex dragon.tex

List Available Content

See what content is available:

# List creatures
studiorum list content --type creature

# List spells
studiorum list content --type spell

# List items
studiorum list content --type item

# List adventures
studiorum list adventures

# List books
studiorum list books

Add More Content

If you have a directory of 5etools compatible JSON, you can configure Studiorum to load that data as it's primary data-source.

studiorum data set-primary <path to 5etools data>

Configuration

The user configuration is stored in ~/.studiorum/config.yml. You can see your entire configuration setup (defaults + user settings) by running:

studiorum config show

Next Steps

Getting Help