DonJuan

A translation/rebuild of the original donjon dungeon generator. This package aims to deconstruct the original script into extendable parts, and provide all pieces for customization for different purposes and not just the map image. For example, when complete this package will automatically generate walls, doors, and light sources for use in Foundry Virtual Tabletop.

You can find the documentation here.

Installation

Install donjuan with pip:

pip install donjuan

You can find the package details here on PyPI.

You can also install donjuan using the setup.py file. To do so, you must first clone or download this repository and install the requirements.

Assuming you have git, you can do:

git clone https://github.com/tmcclintock/donjuan
cd donjuan
pip install -r requirements.txt

Then you can install with:

python setup.py install

If you have conda you can install the requirements using the environment.yml file before installing:

conda env create -f environment.yml
conda activate donjuan
python setup.py install

To run the test suite, you must have pytest installed. You can run the tests with:

pytest

which can be done from the root of the repository. To run all tests, including those with graphical outputs, run with the runslow flag:

pytest --runslow

Please report any issues you encounter on our issue page. Doing so will help make donjuan even better!

Contributing

To contribute to donjuan please see the developing page.