Skip to content

meneldal/Warp-Lords-LaTeX-Template

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

D&D 5e LaTeX Template

Latest release

This is a LaTeX template for typesetting documents in the style of the Warp Lords books.

Features

  • Compiles with Xelatex (for extended font support)

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.

  1. Prepare your TEXMFHOME directory.

    mkdir "$(kpsewhich -var-value TEXMFHOME)/tex/latex/"
  2. Download the latest release and extract it in $TEXMFHOME/tex/latex/.

    wget not.available.right.now
    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/meneldal/Warp-Lords-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/meneldal/Warp-Lords-LaTeX-Template lib/wl

LaTeX will not find the template automatically. Set TEXINPUTS when compiling your project to locate the package:

TEXINPUTS=./lib//: pdflatex project.tex

Usage

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.

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-full

Arch

sudo pacman -S texlive-bin texlive-core texlive-latexextra

Contributing

Preparing a new release

  1. Run ./bin/bump-version to tag the new version.

    ./bin/bumpversion <version>
  2. Compile the example PDF.

  3. Save the first page of the PDF as scrot.jpg.

  4. Update the change log for the new release; commit your changes.

  5. Push changes.

    git push && git push --tags
  6. Create a new release and attach the PDF and scrot.

Credits

License

MIT

About

A Small Template For Warp Lord Book and Extensions

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TeX 98.6%
  • Shell 1.3%
  • Makefile 0.1%