Metadata-Version: 2.1
Name: dungeonsheets
Version: 0.4.2
Summary: Dungeons and Dragons 5e Character Tools
Home-page: https://github.com/canismarko/dungeon-sheets
Author: Mark Wolfman
Author-email: canismarko@gmail.com
License: GPLv3
Download-URL: https://github.com/canismarko/dungeon-sheets/archive/master.zip
Keywords: D&D character sheets
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Games/Entertainment :: Role-Playing
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Requires-Dist: fdfgen
Requires-Dist: npyscreen
Requires-Dist: jinja2

================
 Dungeon Sheets
================

A tool to create character sheets for Dungeons and Dragons.

.. image:: https://travis-ci.com/canismarko/dungeon-sheets.svg?branch=master
    :target: https://travis-ci.com/canismarko/dungeon-sheets

Installation
============

.. code:: bash

    $ pip install dungeonsheets

.. note::

   Dungeon sheets requires **at least python 3.6**. This is mostly due
   to the liberal use of f-strings_. If you want to use it with
   previous versions of python 3, you'll probably have to replace all
   the f-strings with the older ``.format()`` method or string
   interpolation.

.. _f-strings: https://www.python.org/dev/peps/pep-0498/

External dependencies
=====================

* You will need **pdftk** installed to generate the sheets in PDF format.
* You will need **pdflatex** installed to generate the PDF spell pages (optional).

.. note::

   Different linux distributions have different names for packages. While
   pdftk is available in Debian and derivatives as **pdftk**, the package
   is not available in some RPM distributions, such as Fedora and CentOS.
   One alternative would be to build your PC sheets using docker.

.. note::

   If the ``pdflatex`` command is available on your system,
   spellcasters will include a spellbook with descriptions of each
   spell known. If not, then this feature will be skipped.

Usage
=====

Each character is described by a python file, which gives many
attributes associated with the character. See examples_ for more
information about the character descriptions.

.. _examples: https://github.com/canismarko/dungeon-sheets/tree/master/examples

The PDF's can then be generated using the ``makesheets`` command.

.. code:: bash

    $ cd examples
    $ makesheets wizard.py

dungeon-sheets contains definitions for standard weapons and spells,
so attack bonuses and damage can be calculated automatically.

If you'd like a **step-by-step walkthrough** for creating a new
character, just run ``create-character`` from a command line and a
helpful menu system will take care of the basics for you.


