https://github.com/tmcclintock/donjuan

A modern tool for generating dungeons for tabletop games.
https://github.com/tmcclintock/donjuan

dnd dnd-tools foundry-vtt pathfinder-rpg procedural-generation python roll20

Last synced: 12 days ago
JSON representation

A modern tool for generating dungeons for tabletop games.

• Host: GitHub
• URL: https://github.com/tmcclintock/donjuan
• Owner: tmcclintock
• License: cc0-1.0
• Created: 2020-12-10T21:48:30.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-01-13T03:04:56.000Z (almost 4 years ago)
• Last Synced: 2024-10-22T22:26:09.284Z (16 days ago)
• Topics: dnd, dnd-tools, foundry-vtt, pathfinder-rpg, procedural-generation, python, roll20
• Language: Python
• Homepage:
• Size: 289 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
.. |BUILD STATUS| image:: https://github.com/tmcclintock/donjuan/workflows/Build%20Status/badge.svg?branch=main

	    :target: https://github.com/tmcclintock/donjuan/actions

.. |COVERALLS| image:: https://coveralls.io/repos/github/tmcclintock/donjuan/badge.svg?branch=main

	       :target: https://coveralls.io/github/tmcclintock/donjuan?branch=main

.. |LICENSE| image:: https://img.shields.io/badge/License-CC0%201.0-lightgrey.svg

	     :target: http://creativecommons.org/publicdomain/zero/1.0/

|BUILD STATUS| |COVERALLS| |LICENSE|

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``:

.. code-block:: bash

   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:

.. code-block:: bash

   git clone https://github.com/tmcclintock/donjuan

   cd donjuan

   pip install -r requirements.txt

Then you can install with:

.. code-block:: bash

   python setup.py install

If you have `conda

`_ you can install the requirements using the `environment.yml` file

before installing:

.. code-block:: bash

   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:

.. code-block:: bash

   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:

.. code-block:: bash

   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

`_.