# Muhq' Game (working title)

Welcome to the source repository of muhq's game.
This repository is the home of all the rules and game material as well as a
website making all this accessible for normal people.

A checkout of the game material can be found at: [](https://muhq.space/muhqs-game/).

## Retrieve sources

To retrieve the all game material run

```shell
git clone https://muhq.space/muhqs-game.git
```

## Build everything

In the root directory there exits a Makefile which searches the directory tree for
Makefiles and executes them.
Therefore to build all the stuff (cads, maps, website) from subdirectories just
running `make` should be enough.

## Generate latex cards

To generate all latex files for the cards in the base set run:

```shell
scripts/generate_latex.py data/base.ini --latex-root=latex
```

All base cards in latex/cards will be regenerated.
Available Sets:

* base
* equipment
* magic
* nautics

## Building cards

The Makefile in `latex` is used to build pdfs and or pngs from the latex files in `latex/cards`.
Enter the `latex/` directory and run: `make`

The build files will be in `/latex/build`.

## Rendering maps

Map definitions files `*.map` are located in `map/` and can be rendered to pngs using
`scripts/generate_map_img.py <map-dir | map-definition-file>`.