diff options
Diffstat (limited to 'data/README.md')
| -rw-r--r-- | data/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/data/README.md b/data/README.md new file mode 100644 index 00000000..f266841a --- /dev/null +++ b/data/README.md @@ -0,0 +1,20 @@ +# Hurry Curry! Data + +The game data includes recipes and maps. Its only required on the server side. + +Maps are defined in YAML format containing "ASCII-art" picture of the map tiles. + +Each recipe set is a YAML file too containing a list of each possible recipe. +For the default recipe set this is generated from `recipes/default.json`. +Anticurry is based of this but just switches input and output fields via a sed +script. + +`index.yaml` is where all maps and recipe sets are listed for the server to use; +This includes additional metadata for maps. + +## Building + +- Requirements: + - make + - Deno (or Node.js in which case you need to pass `JSR=node` to make) +- Run `make` |