Skip to content

Local Setup

In order to contribute, you'll need a minimum of LaTeX distribution, Inkscape ang git. Please read the instructions for your operating system (or container).

Windows

Install required software

Download and install the following:

  • MiKTeX - a LaTeX distribution for Windows

  • Inkscape - while installing on Windows, make sure to tick Add Inkscape to the System Path option, if you're prompted with one

  • git to commit files to the repository

  • Perl (optional but recommended) to use a build script

Optionally, to edit the TeX files conveniently:

GitHub Account

If you don't have an account on GitHub, please create one now.

Fork and clone the repository

In the Mission Book's GitHub repository, click "Fork":

fork

Go to your repositories in GitHub, open the forked Mission Book repository, click the green "Code" button, and copy the clone URL:

fork

Open the git program you installed. Run this command:

git clone <copied_url>

A new directory titled Homm3bg-mission-book should appear now in your file explorer.

Building the project

In the git bash console, run this command (see the build script for details):

tools/build.sh -d

This will build the draft scenarios book. If the build is successful, you are all set to start working on your scenario.

MacOS

You can install everything using Homebrew:

brew install mactex inkscape perl

Fork the repository and clone it. To build the project, it's best to use the script (see the build script for details):

tools/build.sh -d

For building a single scenario (the -s flag, useful if you're working on one), you also need newer versions of bash and grep than the ones MacOS ships with:

brew install bash grep

Then, you can use the script like this (see best practices for details):

tools/build.sh -s 'my scenario'

To work on localizations, make screenshots, optimize PDFs, etc., you will need some additional tools: 

brew install poppler po4a ghostscript imagemagick

Linux

Install a texlive distribution, inkscape, and perl using your package manager.

Fork and clone the repo. To build the project, it's best to use the script (see the build script for details):

tools/build.sh -d

To work on localizations, make screenshots, optimize PDFs, etc., you will need some additional tools:

  • po4a
  • poppler-utils
  • ghostscript
  • imagemagick

Container

There is also a container available, which contains all the necessary tools.