From 10ef9cc31c82ada3625eab232d8c4b81a1356f1a Mon Sep 17 00:00:00 2001 From: metamuffin Date: Sun, 13 Jul 2025 16:44:00 +0200 Subject: Split off component-specific content into seperate readme files --- data/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 data/README.md (limited to 'data') 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` -- cgit v1.2.3-70-g09d2