https://github.com/norm/your5e

A set of tools to help with running fifth edition D&D.
https://github.com/norm/your5e

Last synced: 9 months ago
JSON representation

A set of tools to help with running fifth edition D&D.

• Host: GitHub
• URL: https://github.com/norm/your5e
• Owner: norm
• Created: 2025-07-16T17:34:09.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2025-08-17T06:21:20.000Z (11 months ago)
• Last Synced: 2025-08-17T08:28:56.719Z (11 months ago)
• Language: Python
• Size: 104 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
your5e

======

A set of tools to help with running fifth edition D&D.

## Rules parsing and directives

Rules are expected to be [written up](docs/rules/README.md) including special

directives to explain to both the players and the tools.

Rules files can be checked for invalid directives:

```bash

# find errors

your5e check-rules docs/rules/directives/hit_die.md

# successful directives also...

your5e check-rules --verbose docs/rules/directives/hit_die.md

```

## Developing `your5e`

Requires:

- Python 3.10+

    - `pip install -e .[dev]`

- [bats](https://github.com/bats-core/bats-core) for CLI testing

    - `brew install bats-core` (on macOS)

Run black reformatting, flake8 linting, python, and CLI tests:

```bash

make test           # everything

make format         # black

make lint           # flake8

make tests          # both of:

make tests-python   #   pytest

make tests-bats     #   bats

```