Wrath & Glory Space Hulk Generator

The Wrath & Glory Space Hulk Generator contains a random map generator for Cubicle7's Warhammer 40k role-playing game Wrath & Glory.

State

Active Development

Description

The code contains the generator as well as a streamlit app for a simple website hosting the generator that can be found here.

A description of the app is given in APP_ABOUT.md.

Use Cases

An initial analysis of the use cases for the generator is given in USE_CASES.md.

Installation

Currently, there is no stand-alone installation. To locally use the project, e.g. for making code changes,

1. Install the external dependencies from packages.txt (e.g. the graphviz backend)
2. Install the Python dependencies via poetry from pyproject.toml
3. Run the app via poetry run streamlit run streamlit_app.py from the repository root

Contributing

If you have any improvement suggestions or feature requests or if you found bugs, simply open an issue.

Or event better create a pull request (PR) with the recommended code change. If you create a PR, Please make sure to add/update the unittests accordingly.

Unittests

Run the unittests via pytest + coverage with:

poetry run pytest --cov

Linting

Linting is done with ruff because it's so fast and convenient. To check the code run:

poetry run ruff .

If you want to auto-fix fixable issues is the --fix flag in addition.

Formatting

The code is black as my soul, so format it accordingly with:

poetry run black .

License

See LICENSE