A powerful CLI for running Dungeons & Dragons encounters. Track initiative, health, effects, and turns with an intuitive terminal interface.
initiative is built with Cobra and the Charm ecosystem: Bubble Tea, Bubbles, Lipgloss, Huh?, and more.
- Install the application using one of the below methods
- Run
initiativein your terminal!
Review our wiki for additional documentation, and submit any questions to our Q&A discussion category.
The installation script will use the built artifacts from the releases based on your detected operating system and architecture.
curl -sSL https://raw.githubusercontent.com/joelzwarrington/initiative/main/scripts/install.sh | bashDownload the artifact from releases for your specific operating system and architecture.
The binaries can be built from source using the go install utility.
go install github.com/joelzwarrington/initiative@latest
Setup encounters with characters and monsters by providing initiative, quantities.
Organize your party members and NPCs, which can be added to encounters quickly.
Manage turn order and initiative tracking during combat encounters.
Track monster hit points throughout the encounter.
Your party data saves automatically and persists across sessions. Manage multiple campaigns with custom file paths using the --game flag.
The System Reference Document comes built-in with all core monsters. Expand your creature library with custom sources using the --source flag.
Roll dice directly from the command line using standard dice notation like 8d6 or 1d20+4.
See CONTRIBUTING.md to get started.
We'd love to hear from you!
- Bugs: Submit a bug report for bugs or problems
- Ideas: Share your ideas for new features or improvements
- Questions: Ask questions about usage or functionality
- [Cobra] library for creating powerful modern CLI applications
- [Bubble Tea] powerful terminal user interface framework
- [Skeleton] tab framework for Bubble Tea applications
- [Bubbles] components for Bubble Tea applications
- [Lipgloss] beautiful terminal styling
- [Huh?] interactive prompts and forms
In addition, this work also includes material from the System Reference Document 5.2.1 ("SRD 5.2.1") by Wizards of the Coast LLC, available at https://www.dndbeyond.com/srd. The SRD 5.2.1 is licensed under the Creative Commons Attribution 4.0 International License, available at https://creativecommons.org/licenses/by/4.0/legalcode.
Built with ♥ by @joelzwarrington