Giter VIP home page Giter VIP logo

dnd-5e-latex-template's Introduction

D&D 5e LaTeX Template

Latest release

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.

Preview

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 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/dnd

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

dnd-5e-latex-template's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.