From e016228d2b76fa367889c9d98d6eb9e783f98cb4 Mon Sep 17 00:00:00 2001 From: Star Rauchenberger Date: Fri, 15 Mar 2024 04:26:00 -0400 Subject: Lingo: Pre-compile datafile to improve loading time (#2829) --- data/README.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 data/README.md (limited to 'data/README.md') diff --git a/data/README.md b/data/README.md new file mode 100644 index 0000000..fe834ce --- /dev/null +++ b/data/README.md @@ -0,0 +1,5 @@ +# lingo data + +The source of truth for the Lingo randomizer is (currently) the LL1.yaml and ids.yaml files located here. These files are used by the generator, the game client, and the tracker, in order to have logic that is consistent across them all. + +The generator does not actually read in the yaml files. Instead, a compiled datafile called generated.dat is also located in this directory. If you update LL1.yaml and/or ids.yaml, you must also regenerate the datafile using `python worlds/lingo/utils/pickle_static_data.py`. A unit test will fail if you don't. -- cgit 1.4.1