Join us on Discord to help with translating or just to get in touch!
Download your desired version of the rule book from one of the available versions below 👇
These are made from the main branch every time a new change is introduced. You can expect things to break, like having incorrect layout or not all the text translated.
| Language | Latest Build ⚗️ (Experimental) |
||
|---|---|---|---|
| 🌍 | 🖥️ Digital |
🖨️ Printable |
🤑 Economy Printable |
| 🇬🇧 English | ️download | download | download |
🇵🇱 Polski
|
️pobierz | pobierz | pobierz |
🇪🇸 Español
|
️descargar | descargar | descargar |
🇫🇷 Français
|
️télécharger | télécharger | télécharger |
🇷🇺 Русский
|
️скачать | скачать | скачать |
🇺🇦 Українська
|
️завантажити | завантажити | завантажити |
🇩🇪 Deutsch
|
️speichern | speichern | speichern |
🇨🇿 Čeština
|
stáhnout | stáhnout | stáhnout |
🇮🇱 עברית
|
הורדה | הורדה | הורדה |
Those builds are the ones officially released, with a specific cutoff point in time, to give translators time to create localized versions.
They should be free of any major issues.
| Language | Version 1.2 (22.05.2024) |
Version 1.3 (23.11.2024) |
Version 2.0 (2025) |
|||
|---|---|---|---|---|---|---|
| 🌍 | 🖥️ Digital |
🖨️ Printable |
🖥️ Digital |
🖨️ Printable |
🖥️ Digital |
|
| 🇬🇧 English | download | download | download | download | preview | |
| 🇵🇱 Polski | pobierz | pobierz | pobierz | pobierz | — | |
| 🇪🇸 Español | descargar | descargar | descargar | descargar | — | |
| 🇫🇷 Français | télécharger | télécharger | télécharger | télécharger | — | |
| 🇷🇺 Русский | — | — | скачать | скачать | — | |
| 🇺🇦 Українська | ️завантажити | завантажити | — | — | — | |
| 🇩🇪 Deutsch | — | — | — | — | — | |
| 🇨🇿 Čeština | — | — | stáhnout | stáhnout | — | |
| 🇮🇱 עברית | — | — | הורדה | הורדה | — | |
Click to see the details regarding every version
🖥️ The digital build is intended to be read on electronic devices.
It has convenient hyperlinks that navigate you around the text.
🖨️ The printable build introduces the following changes:
- appends page numbers to clickable hyperlinks 👆
- includes an index page at the end 📋
- in stable releases, makes sure the document page count is divisible by 4 🪄
- makes margins asymmetric for easier binding/gluing 📕
- uses CMYK 🎨
all of which to be print friendly.
Best served for those who would like to have it on paper 🤞
🤑 The economy printable build has no art backgrounds. Other than that, it's the same as the regular printable build.
This is for people who want to save their toners.
This project aims to rewrite the original rule book, in which the amount of vague language was just too vast to ignore. Its aim is to explain the rules clearly and concisely, and should eventually have an answer for any basic rules query you might have.
Please see the original thread on BoardGameGeek.
The content in the official English rule book is, simply put, insufficient as a teaching tool for the game or as a general rules reference. If you read the thread linked above you should understand how frustrating this has been for the original author.
This is a communal effort. This repository serves both as a means to preserve the work, but also for others to contribute to it as writers, proofreaders, or layout designers.
Please discuss any and all factual errors, bad language or other errors you've found. You can do this by opening issues/PRs with suggestions, writing in the BGG thread, or joining us on Discord.
You can help translate this project using Weblate. Click the image to get started:
All new version of the rule book and their change logs will be published here and in the BGG thread.
To work on the document on your machine, you need the following:
- MiKTeX for Windows, MacTeX for MacOS, TeX Live for Linux (required) to build the PDF file from LaTeX files
- Inkscape (required) to render glyphs in the document - download the
.exeinstaller (not.msi!) and while installing on Windows, make sure to tickAdd Inkscape to the System Pathoption) - Perl (optional but recommended) to use the build script - use the Strawberry distribution
- TeXstudio (optional) to edit LaTeX files and rebuild the PDF file quickly
- Poedit (optional) to edit translation files conveniently
- po4a (optional) to work on translating the document to other languages
- delta (optional) to find changes in already translated passages
- pdftoppm (optional) to make screenshots of rendered PDF pages
- ImageMagick (optional) to combine screenshots into convenient diffs
- ghostscript (optional) to optimize PDF file sizes
- entr (optional) to automatically rebuild the document on file changes
- Podman (preferable) or Docker container engine if you want to use a container without installing all of the above
- GIMP or Krita (optional) to edit some images in
assetsdirectory
Click to learn about the technicalities
There is a number of ways to build the project:
To build the document in English, it's best to use the script (requires Perl, works on Win/Lin/Mac):
tools/build.shTo build the document in any language (currently, pl, es, fr, ru, ua, de cs, and he are supported, en is the default), make sure you have po4a (version 0.74 or higher) and use the script (works on Lin/Mac):
tools/build.sh <LANGUAGE>If you're working on a single section and want to build only that, you can save time by using the -s option.
For example:
tools/build.sh fr -s ai_rulesIt will compile just the AI Rules section in French.
See tools/build.sh --help for more details.
To automatically rebuild any given section on every file change, use the script:
tools/watch_and_build.shIt will watch changes in the sections/*tex files, and build them on every change.
For instance, if you change the sections/setup.tex file, it will trigger tools/build.sh -s setup and build this section automatically.
If you have Podman or Docker installed, you can use the wrapper script:
./run.sh tools/build.shIt will download our container and then use it to build the document.
You can select in-browser development option by clicking on the green Code button and then selecting Codespaces.
This will start a unique container with the whole development IDE called VS Code.
Once the IDE is started, you can use the bash scripts and git as usual, and build the project in your web browser just like described above ☝️
Please note that on GitHub's free tier you're eligible for 60 hours of Codespaces per month.
If you prefer a TeX editor, use latexmk to build the document. For instance, to configure TeXstudio to build the document, you can use this command:
latexmk -pdflua -file-line-error -halt-on-error -interaction=nonstopmode -shell-escape -recorder %.tex
After setting it in options, press the Build & View main_en.tex file.
Click to see details
We have a guide on using AI for translations.
Make sure you have po4a installed.
To translate a particular section:
-
Go to
translations/<section_name>and open<lang>.pofile, e.g.,translations/introduction.tex/pl.po -
Choose a fragment to translate. Those start with
msgid. Write your new text in the line below starting withmsgstr. Example:msgid "\\addsection{Introduction}{\\spells/magic_arrow.png}" msgstr "\\addsection{Wprowadzenie}{\\spells/magic_arrow.png}"
This text (
msgstr) will replace the original (msgid) in your translation. -
Rebuild using the script:
tools/build.sh <LANGUAGE> -s introduction
-
Commit and repeat!
Sometimes it is not clear, what changes in the original document rendered into fuzzy sections.
You can use continuous_fuzzy_diff.sh script to visualize the fuzzy sections in a selected file.
For example, the command:
tools/continuous_fuzzy_diff.sh translations/ai_rules.tex/cs.powill show the difference between the old and new version of the original language for the first fuzzy section in the Czech translation of the file ai_rules.tex.
Once you remove the fuzzy flag and save the file, it will show you the next fuzzy section.
In common cases there are only simple changes in the original language, such as change of formatting.
Therefore, you don't need to update the whole translation.
Click to see details
It is a good practice to share screenshots of your work in pull requests. You can use the script to make PNG images of specified page(s):
tools/pdf2image.sh <language> -r <first_page>-<last_page>Language defaults to "en" if unspecified. Example:
tools/pdf2image.sh -r 5-7Screenshots will appear in ignored screenshots directory, in the form of en-05.png, en-06.png, etc.
To process a single page, use:
tools/pdf2image.sh fr -r 15This will produce a fr-15.png file.
If you'd like to show a single image of two instances of the same page side-by-side (before|after style), you can use the following script:
tools/compare_pages.sh <language> -r <range> [OPTIONS]The script takes local main_<language>.pdf that you built and which contains your changes and compares it with the latest build
of the same language in this repository (e.i. the baseline).
Imagine you want to compare pages 1, then range from 5 to 7, and page 30 in English version. Here's how to use it:
tools/compare_pages.sh -r 1,5-7,30It will produce the following files in the screenshots directory: en-01.png, en-05.png, en-06.png, en-07.png and en-30.png.
Open help for more examples and detailed description:
tools/compare_pages.sh -hThis script requires pdftoppm and imagemagick utilities.
Click to see details
To reduce output PDF file size significantly, you can use the script utilizing ghostscript utility:
tools/optimize.sh <language>It will output main_<language>_optimized.pdf file.
As of writing, for English it produces 42 MB main_en_optimized.pdf file without noticeable drop in quality compared to 142 MB main_en.pdf built by LaTeX.
All assets come from publicly available sources.
Some of the images in the rule book (all in the assets/examples directory as of writing) were generated by GIMP.
Their respective XCF files reside in assets/gimp-files directory.