Metadata-Version: 1.2
Name: donjon-painter
Version: 0.9.1
Summary: Graphical map translator for donjon's Random Dungeon Generator TSV files.
Home-page: https://github.com/Blackflighter/donjon-painter
Author: Korvin Roganov
Author-email: qualimerjudith@gmail.com
License: GPLv3
Description: donjon-painter - Dungeon Map Maker
        ==================================
        
        donjon-painter is a companion script to `donjon's Random Dungeon Generator`_. By selecting a TSV file along with a set of tile assets, you can easily create large, beautiful dungeon maps. Learn how to create new tilesets for donjon-painter `here`_.
        
        .. _donjon's Random Dungeon Generator: https://donjon.bin.sh/fantasy/dungeon/
        .. _here: https://github.com/Blackflighter/donjon-painter/blob/master/CONTRIBUTING.rst
        
        -------------
        Prerequisites
        -------------
        - Python:
            - >= 3.5
            - Pillow
        
        Installation
        ============
        
        -----------
        Windows EXE
        -----------
        Windows users have the option of downloading an EXE version of the script, which can be found `over here`_. You'll need to run the EXE from the terminal - this can be done more easily by editing your `PATH`_ environment variable.
        
        .. _over here: https://github.com/Blackflighter/donjon-painter/releases/
        .. _PATH: https://www.howtogeek.com/118594/how-to-edit-your-system-path-for-easy-command-line-access/
        
        ---------
        Using pip
        ---------
        donjon-painter is `available on PyPI`_. Until I get to creating packages for different Linux distributions, this is the ideal way of using it on them. Get it using this command:
        
        ::
        
            pip install --user --upgrade donjon-painter
        
        .. _available on PyPI: https://pypi.org/project/donjon-painter/
        
        --------
        setup.py
        --------
        All that needs to be done here is to `clone this repository`_. Having done so, extract the files, and navigate to the location of said folder. Once you're done with that, run this command:
        
        ::
        
            python3 setup.py install
        
        .. _clone this repository: https://help.github.com/articles/cloning-a-repository/
        
        Usage
        =====
        -------------------------
        1. Download your TSV file
        -------------------------
        First of all, begin by heading to `donjon's Random Dungeon Generator`_ to generate the dungeon of your liking. Having done that, you should select the option to download a TSV map of the generated file, as depicted below:
        
        .. image:: /res/donjon.png
        .. _donjon's Random Dungeon Generator: https://donjon.bin.sh/fantasy/dungeon/
        
        ------------------
        2. Run the command
        ------------------
        Having done this, run donjon-painter. By default, if you don't specify anything, it will default to interactive mode. This brings up a menu of options in the terminal, which you can then input.
        
        ::
        
            donjon-painter
        
        If you're using the EXE file, all you need to do is open it up, and this will bring you to interactive mode.
        
        A more advanced usage entails specifying both the command and the map file of your choice:
        
        ::
        
            donjon-painter [OPTIONS] MAPFILE
        
        Options
        =======
        There's a number of things you can do to change the behaviour of this script, as detailed below.
        
        ::
        
            -h, --help          Display the commands below
            -t, --tileset       Specify a theme folder outside of the inbuilt ones (consult CONTRIBUTING.rst for further information)
            -m, --measure       Measure the time it takes to create your map
            -o, --output        Choose a different location/name to save your map to
            -p, --pixels        Choose a different size to make your map tiles in pixels (default 70)
            -r, --randomise     Shuffle the map floor patterns for some variation if required
            -s, --savetiles     Used in conjunction with the --tileset option, create a complete tileset theme (consult CONTRIBUTING.rst)
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
