Skip to content

bacook17/dungeon-sheets

 
 

Repository files navigation

Dungeon Sheets

A tool to create character sheets for Dungeons and Dragons.

image

Documentation Status

Installation

$ 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.

Optional External dependencies

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

If pdftk is available, it will be used for pdf generation. If not, a fallback python library (pdfrw) will be used. This has some limitations:

  • Produces v1.3 PDF files
  • Not able to flatten PDF forms
  • Will produce separate character-sheets, spell-lists and spell-books.

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.

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.

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

$ 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.

About

A tool to create character sheets for Dungeons and Dragons

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.3%
  • Other 0.7%