Glossary¶
Technical terms, acronyms, and concepts used throughout Studiorum documentation.
A¶
- ADR (Architectural Decision Record)
- A document that records an important architectural decision and its context and consequences. Used to track design decisions and their rationale.
- Adventure
- A 5e published module containing narrative content, encounters, maps, and NPCs. Examples: Curse of Strahd (CoS), Lost Mine of Phandelver (LMoP).
- API (Application Programming Interface)
- A set of protocols, routines, and tools for building software applications. Studiorum provides APIs for content processing and rendering.
- Appendix
- A section at the end of a generated document containing reference material (creatures, spells, items) mentioned in the main content.
B¶
- Bestiary
- A collection of creature statblocks, typically organized by source book or challenge rating.
- Book
- A complete 5e sourcebook containing rules, lore, and game content. Examples: Player's Handbook (PHB), Monster Manual (MM).
C¶
- Catalogue
- The index that loads and provides access to all 5e content data.
- CDN (Content Delivery Network)
- A distributed network of servers that deliver web content. Used for serving images and fonts in documentation.
- CLI (Command-Line Interface)
- A text-based interface for interacting with Studiorum. Commands like
studiorum convert adventure cos. - Content Type
- Categories of 5e game content (creatures, spells, items, adventures, etc.) that Studiorum can process.
- CR (Challenge Rating)
- A numerical rating in 5e that indicates how difficult a creature is to defeat.
- Cross-Reference
- Links between different pieces of content (e.g., a spell mentioned in a creature's abilities automatically linking to the spell's description).
D¶
- DI (Dependency Injection)
- A design pattern where dependencies are provided to an object rather than created by the object itself. Used in Studiorum's service container.
- Document Class
- The LaTeX template type that defines the overall structure and styling of generated documents (e.g.,
dndbook,article).
E¶
- Entry
- A single piece of content data (one creature, one spell, etc.) in the 5etools data format.
- Environment Variable
- System-level configuration settings that can override application defaults. Prefix:
STUDIORUM_.
F¶
- 5etools
- A popular online 5e reference tool and the data format used by Studiorum for content storage.
- Factory Pattern
- A design pattern that provides an interface for creating objects without specifying their exact class.
- Fluff
- Descriptive text and lore content that accompanies game mechanics (creature descriptions, item histories, etc.).
G¶
- Gallery
- A 5etools entry holding several images, rendered as a grid with a caption under each.
H¶
- HTTP API
- Web service that provides data access via HTTP requests. One of the supported data source types.
I¶
- Image Directory
- The 5etools-img checkout that 5etools image paths are relative to (
image.image_directory).
J¶
- Jinja2
- A templating engine used by Studiorum for generating LaTeX output from content data.
- JSON (JavaScript Object Notation)
- A lightweight data format used by 5etools and Studiorum for storing content data.
L¶
- LaTeX
- A document preparation system used by Studiorum to generate high-quality PDFs.
- Logfire
- An observability platform used by Studiorum for performance monitoring and error tracking.
M¶
- MCP (Model Context Protocol)
- A protocol that enables AI assistants to interact with external tools and services. Studiorum provides an MCP server.
- Metadata
- Additional information about content (source book, page numbers, etc.) used for attribution and organization.
O¶
- Observability
- The practice of monitoring system performance, errors, and behavior through logging, metrics, and tracing.
P¶
- PDF (Portable Document Format)
- The final output format generated by Studiorum's LaTeX rendering pipeline.
- Pydantic
- A Python library used by Studiorum for data validation and serialization using Python type annotations.
- Protocol
- In Python typing, an interface definition that specifies methods an object must implement.
R¶
- Registry
- A central location for managing and organizing related services or data sources.
- Rendering Context
- Information passed to templates during document generation (metadata, services, configuration).
- Result Type
- A programming pattern that represents either success (
Success[T]) or failure (Error[E]) to handle errors gracefully.
S¶
- Service Container
- A system for managing dependencies between different parts of the application using dependency injection.
- SRD (System Reference Document)
- The basic 5e content released under the Open Gaming License, always available in Studiorum.
- Statblock
- A formatted block containing a creature's game statistics (AC, HP, abilities, etc.).
T¶
- Tag
- Special markup in 5etools content that creates formatted text, links, and references in output documents.
- Template
- A file that defines how content should be formatted in the output document (LaTeX templates for PDF generation).
- TTL (Time To Live)
- How long cached data remains valid before being refreshed from the source.
U¶
- Unicode
- A standard for representing text in multiple languages and special characters.
- uv
- A fast Python package manager used by Studiorum for dependency management and virtual environments.
V¶
- Validation
- The process of checking that data conforms to expected formats and constraints.
W¶
- WebP
- A modern image format used by 5etools-img that Studiorum automatically converts to PNG for LaTeX compatibility.
Y¶
- YAML (YAML Ain't Markup Language)
- A human-readable data serialization standard used for Studiorum configuration files.
Common Abbreviations¶
| Abbreviation | Full Name | Usage |
|---|---|---|
| AI | Artificial Intelligence | Claude, GPT models |
| API | Application Programming Interface | Service interfaces |
| CLI | Command-Line Interface | Terminal commands |
| CoS | Curse of Strahd | Adventure module |
| CR | Challenge Rating | Creature difficulty |
| CSS | Cascading Style Sheets | Web styling |
| DI | Dependency Injection | Architecture pattern |
| DM | Dungeon Master | Game master |
| DMG | Dungeon Master's Guide | Core rulebook |
| HTML | HyperText Markup Language | Web content |
| HTTP | HyperText Transfer Protocol | Web communication |
| JSON | JavaScript Object Notation | Data format |
| LMoP | Lost Mine of Phandelver | Adventure module |
| MCP | Model Context Protocol | AI integration |
| MM | Monster Manual | Creature sourcebook |
| NPC | Non-Player Character | Game character |
| Portable Document Format | Document output | |
| PHB | Player's Handbook | Core rulebook |
| SRD | System Reference Document | Open content |
| TTL | Time To Live | Cache duration |
| UI | User Interface | Interface design |
| URL | Uniform Resource Locator | Web address |
| UUID | Universally Unique Identifier | Unique ID |
| YAML | YAML Ain't Markup Language | Config format |
Source Abbreviations¶
Common 5e source book abbreviations used in Studiorum:
Core Books¶
- PHB - Player's Handbook
- MM - Monster Manual
- DMG - Dungeon Master's Guide
Supplements¶
- SCAG - Sword Coast Adventurer's Guide
- VGM - Volo's Guide to Monsters
- XGE - Xanathar's Guide to Everything
- MTF - Mordenkainen's Tome of Foes
- GGR - Guildmaster's Guide to Ravnica
- AI - Acquisitions Incorporated
- ERLW - Eberron: Rising from the Last War
- EGW - Explorer's Guide to Wildemount
- MOT - Mythic Odysseys of Theros
- TCE - Tasha's Cauldron of Everything
- VGR - Van Richten's Guide to Ravenloft
- WBW - The Wild Beyond the Witchlight
- FTD - Fizban's Treasury of Dragons
- SCC - Strixhaven: A Curriculum of Chaos
- MPMM - Mordenkainen Presents: Monsters of the Multiverse
Adventures¶
- LMoP - Lost Mine of Phandelver
- HotDQ - Hoard of the Dragon Queen
- RoT - The Rise of Tiamat
- PotA - Princes of the Apocalypse
- OotA - Out of the Abyss
- CoS - Curse of Strahd
- SKT - Storm King's Thunder
- TftYP - Tales from the Yawning Portal
- ToA - Tomb of Annihilation
- WDH - Waterdeep: Dragon Heist
- WDMM - Waterdeep: Dungeon of the Mad Mage
- GoS - Ghosts of Saltmarsh
- BGDIA - Baldur's Gate: Descent into Avernus
- IMR - Icewind Dale: Rime of the Frostmaiden
- CM - Candlekeep Mysteries
- CRCotN - Critical Role: Call of the Netherdeep
Third Party¶
- HOMEBREW - User-created content
- UA - Unearthed Arcana (playtest content)
Need a term added to this glossary? Open an issue or contribute via pull request.