donjuan 0.0.2

Package for generating dungeons.

DonJuan

HACKATHON - a list of todo items for the 12/20/20 Hackathon can be found on the issues page!

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

Installing donjuan is possible using the setup.py file. When the package is more mature, we will cut a release on PyPI. For now, the steps to install are to clone or download this repository and install into your Python environment.

Assuming you have git, you can do:

git clone https://github.com/tmcclintock/donjuan
cd donjuan
pip install -r requirements.txt
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.

Note that the only requirement at the moment is pillow.

Contributing

To contribute to donjuan please see the developing page.