Skip to content

Build Guide

Jump to bottom
Niko Lepka edited this page Dec 14, 2017 · 2 revisions

The build guide will show you how to make your own PDF from the source-code if you don’t already know how.

The project uses two different files:

  1. Scribus for the character sheet, located in /docs
  2. LaTeX for the main source files, located in /src

Scribus

Scribus is an open source publishing tool, a-la Microsoft Publisher, and works on Mac, Linux, and Windows. Just download the program and edit the file. Or if you’re super adventurous, open the scribus file in a text editor and edit the XML code directly.

LaTeX

LaTeX is a bit more difficult. It’s an old standard, and there are quite a few different compilers for it out there.

There’s MikTeX for Windows, MacTeX for Mac, TeXLive for all major platforms, and a few more.

Personally, I’ve had great success with TeXLive on my machines, but results may varry, and LaTeX is sometimes a bit finnicky to install.

Once you get it installed and working, make sure it also installed pdflatex. This is the main compiler used for turning .tex files into .pdf files.

Then, clone the project to your hard-drive (if you haven’t already), go into the /src directory and compile main.tex.

If the PDF is missing some references compile the file again. LaTeX sometimes needs multiple rounds of re-compilation, because the first pass looks through the document and records chapter numbers, and then the future passes apply the recorded numbers into the final file.

It’s a lot of work, but it’s worth it in the end.

Clone this wiki locally