D&D 5e LaTeX Template
This is a LaTeX template for typesetting documents in the style of the Dungeons & Dragons 5th Edition (D&D 5e) books.
Features
- Color schemes and fonts are close to the core books.
- TeX Live includes the default fonts.
- Compiles with
pdflatex.
Installation
User install using TEXMFHOME (recommended)
This will install the template for your current user in one of the following locations:
- Linux:
~/.texmf/tex/latex - OS X / macOS:
~/Library/texmf/tex/latex - Windows:
C:\Users\{username}\texmf\tex\latex
LaTeX will find the package automatically.
-
Prepare your
TEXMFHOMEdirectory.mkdir "$(kpsewhich -var-value TEXMFHOME)/tex/latex/" -
Download the latest release and extract it in
$TEXMFHOME/tex/latex/.wget https://github.com/evanbergeron/DND-5e-LaTeX-Template/archive/v0.6.0.zip unzip -d "$(kpsewhich -var-value TEXMFHOME)/tex/latex/" v0.6.0.zip cd "$(kpsewhich -var-value TEXMFHOME)/tex/latex/" mv DND-5e-LaTeX-Template-0.6.0 dnd
Alternatively, clone the repo to the same location:
git clone https://github.com/evanbergeron/DND-5e-LaTeX-Template.git "$(kpsewhich -var-value TEXMFHOME)/tex/latex/dnd"
Project install using TEXINPUTS
You can also clone a copy of the repository to each LaTeX project. For example, to clone the repository to a lib/ directory in your project:
mkdir lib/
git clone https://github.com/evanbergeron/DND-5e-LaTeX-Template.git lib/dndLaTeX will not find the template automatically. Set TEXINPUTS when compiling your project to locate the package:
TEXINPUTS=./lib//: pdflatex project.texUsage
Load the template in your preamble:
\documentclass[10pt,twoside,twocolumn,openany]{book}
\usepackage[english]{babel}
\usepackage[utf8]{inputenc}
\usepackage{dnd}
\begin{document}
% ...Package options
bg
Declare how to load background and footer images. This is a key-value option with the following possible values:
full: Load both background and footer images. (default)none: Removes both background and footer images.print: Loads only the footer images.
justified
Justify column copy.
nomultitoc
Disable multi-column table of contents.
Dependencies
If you don't have LaTeX installed, we recommend installing a complete TeX Live distribution. https://www.tug.org/texlive/
Ubuntu
sudo apt-get install texlive-fullArch
sudo pacman -S texlive-bin texlive-core texlive-latexextraKnown issues and solutions
Stat block text color does not survive page breaks
This is a known issue in tcolorbox. According to the tcolorbox 4.12 manual (p. 363):
If your text content contains some text color changing commands, your color will not survive the break to the next box.
You can use LuaTeX to compile the document.
lualatex main.texWrapping monsterbox in float disrupts spacing inside stat block
Wrapping a monsterbox (or monsterboxnobg) in a floating figure adds extra space between stat block elements:
\begin{figure}[b]
\begin{monsterbox}{Orc Warden}
% ...
\end{monsterbox}
\end{figure}Instead, use the tcolorbox float parameter:
\begin{monsterbox}[float=b]{Orc Warden}
% ...
\end{monsterbox}Refer to the tcolorbox documentation (section 4.13) for more float parameters.
Contributing
Preparing a new release
-
Run
./bin/bump-versionto tag the new version../bin/bumpversion <version>
-
Compile the example PDF.
-
Save the first page of the PDF as scrot.jpg.
-
Update the change log for the new release; commit your changes.
-
Push changes.
git push && git push --tags -
Create a new release and attach the PDF and scrot.
Credits
- Background image from Lost and Taken
License
MIT
