diff options
| -rw-r--r-- | README.md | 50 |
1 files changed, 38 insertions, 12 deletions
@@ -1,32 +1,52 @@ # 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. +Its main location is [git.muhq.space/muhqs-game](git.muhq.space/muhqs-game). +This repository is the home of all the rules and game material as well as the website making all this accessible for normal people. -A checkout of the game material can be found at: [](https://muhq.space/muhqs-game/). +A checkout of the game material can be found at: [https://muhq.space/muhqs-game/](https://muhq.space/muhqs-game/). ## Retrieve sources -To retrieve the all game material run +To retrieve all game sources run: ```shell -git clone https://muhq.space/muhqs-game.git +git clone https://git.muhq.space/muhqs-game +``` + +## Repository layout + +Muhq's game is contained in a huge mono repository. +Its top-level layout looks like this: + +``` +. +├── assets - Game assets like tiles and icons +├── data - Machine readable Definition of cards and decks +├── go - Home of all of muhq's game's Go code +├── html - Sources of the website +├── latex - LaTeX code to generate the cards +├── maps - Machine readable map definitions +├── rules - The comprehensive rules +└── scripts - Helper scripts used in the repository ``` ## Build dependencies +In order to build the game material from source you need the following software installed on your system: + * Working TeX installation * poppler (pdfunite, pdftoppm) * opencv-python * pyyaml +Building the game material should be dons in a POSIX environment. +Windows environment are not tested or supported. + ## 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. +In the root directory there exits a Makefile which searches the directory tree for Makefiles and executes them. +Therefore, to build everything (cards, maps, website) from all subdirectories simply running `make` should be enough. ## Generate latex cards @@ -46,12 +66,18 @@ Available Sets: ## Building cards -The Makefile in `latex` is used to build pdfs and or pngs from the latex files in `latex/cards`. +The Makefile in the `latex` directory 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`. +The generated PDF files will be in `/latex/build`. ## Rendering maps -Map definitions files `*.map` are located in `map/` and can be rendered to pngs using +Map definitions files `*.map` are located in the `map/` directory and can be rendered to PNGs using `scripts/generate_map_img.py <map-dir | map-definition-file>`. + +## Contribution + +Please reach out to me if you have questions, need help, want to propose changes or just want to talk about the game. +The easiest way is to send me an email to [muhqs-game@muhq.space](mailto://muhqs-game@muhq.space). +Even changes can be contributed via email ([git-send-mail tutorial](https://git-send-email.io/)). |