roschart/dmtoolbox

DMToolbox

Description

DMToolbox is a tool designed to assist Dungeon Masters (DMs) in managing role-playing games (RPGs). It aims to simplify and automate various tasks associated with running games, such as combat management, encounter planning, and tracking characters and monsters. Developed with Python and utilizing YAML for data persistence, DMToolbox seeks to be an indispensable companion for DMs, enhancing the gaming experience for both narrators and players.

Features

• Combat Management: Facilitates the execution of combat encounters, allowing DMs to focus on narrative and game dynamics.
• Encounter Planning: Assists in preparing encounters, adjusting difficulty and participants according to the campaign context.
• Character and Monster Tracking: Allows easy tracking of stats and conditions for characters and monsters during gameplay.

Getting Started

To start using DMToolbox, you will need to have Python installed on your system, as well as Poetry for dependency management. Follow these steps to set up your environment:

1. Install Python: Make sure you have Python 3.8 or higher installed on your system.
2. Install Poetry: Use Poetry to manage the project's dependencies. Installation instructions can be found on the official Poetry website.
3. Clone the Repository: Clone this repository to your local machine to get the source code.
4. Install Dependencies: Run poetry install in the root of the project to install all required dependencies.

Usage

(TBD - Details on how to use the tool, available commands, and usage examples will be added as the project evolves.)

Roadmap

Alpha Version

• Implementation of basic combat management functionality.
• Support for loading and managing character and monster data via YAML files.

Upcoming Features

• Expansion of encounter management to include planning tools and difficulty adjustment.
• Development of an intuitive user interface to facilitate game session management.
• Integration of a campaign tracking system to maintain records of progression and significant events.

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Note: This document is an initial draft and is subject to changes as the project evolves.