aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Fischer <florian.fl.fischer@fau.de>2021-01-03 13:07:06 +0100
committerFlorian Fischer <florian.fl.fischer@fau.de>2021-01-03 13:07:06 +0100
commiteb9a5797c24eca8bff9e5a2c64598b2c0f6041d7 (patch)
tree46c6e805b3d1459fe95e1c0e9f7e838151c3a0b8
parent63767a954c71b05ac529679fa5160bb7d6f05636 (diff)
downloadmuhqs-game-eb9a5797c24eca8bff9e5a2c64598b2c0f6041d7.tar.gz
muhqs-game-eb9a5797c24eca8bff9e5a2c64598b2c0f6041d7.zip
Use root README for technical instruction and html/ for fluff
-rw-r--r--README.md35
-rw-r--r--html/index.md22
2 files changed, 37 insertions, 20 deletions
diff --git a/README.md b/README.md
index 21937df6..4cfea6d1 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,17 @@
# Muhq' Game (working title)
-Muhq's game is a mashup of multiple game mechanics I enjoy.
-It is a complex strategy game involving playing cards as well a board.
-Games which inspired the rules and gameplay:
+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.
-* Magic: The Gathering
-* Dominion
-* El Dorado
-* Chess
-* Decent
-* Faeria
-* Age of Empires
+# Build everything
-Relevant Mechanics are:
+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.
-* Separate sets of playing cards using different gameplay aspects
-* Draft the players Decks to prevent repetitive gameplay
-* Deck building to adapt to the current board position and your opponents
-* Map and card independent rules to allow the players to play the game the way they enjoy the most
-* Deep strategic decision making, how to use all available resources on the board or in your hand
-* Clean and simple economy system using a single resource
-
-# Generate latex cards
+## Generate latex cards
To generate all latex files for the cards in the base set run:
@@ -37,9 +27,14 @@ Available Sets:
* magic
* nautics
-# Building cards
+## 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>`.
diff --git a/html/index.md b/html/index.md
new file mode 100644
index 00000000..0d322565
--- /dev/null
+++ b/html/index.md
@@ -0,0 +1,22 @@
+# Muhq' Game (working title)
+
+Muhq's game is a mashup of multiple game mechanics I enjoy.
+It is a complex strategy game involving playing cards as well a board.
+Games which inspired the rules and gameplay:
+
+* Magic: The Gathering
+* Dominion
+* El Dorado
+* Chess
+* Decent
+* Faeria
+* Age of Empires
+
+Relevant Mechanics are:
+
+* Separate sets of playing cards using different gameplay aspects
+* Draft the players Decks to prevent repetitive gameplay
+* Deck building to adapt to the current board position and your opponents
+* Map and card independent rules to allow the players to play the game the way they enjoy the most
+* Deep strategic decision making, how to use all available resources on the board or in your hand
+* Clean and simple economy system using a single resource