diff options
| author | Star Rauchenberger <fefferburbia@gmail.com> | 2024-03-15 04:26:00 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-03-15 09:26:00 +0100 |
| commit | e016228d2b76fa367889c9d98d6eb9e783f98cb4 (patch) | |
| tree | 5c4fd5427ee1c89a832b3327eef6d39d4ce82d82 /data/README.md | |
| parent | fcb3b36f44a7d475aa49c5c44971a2b7cabc4ca8 (diff) | |
| download | lingo-apworld-e016228d2b76fa367889c9d98d6eb9e783f98cb4.tar.gz lingo-apworld-e016228d2b76fa367889c9d98d6eb9e783f98cb4.tar.bz2 lingo-apworld-e016228d2b76fa367889c9d98d6eb9e783f98cb4.zip | |
Lingo: Pre-compile datafile to improve loading time (#2829)
Diffstat (limited to 'data/README.md')
| -rw-r--r-- | data/README.md | 5 |
1 files changed, 5 insertions, 0 deletions
| 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 @@ | |||
| 1 | # lingo data | ||
| 2 | |||
| 3 | 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. | ||
| 4 | |||
| 5 | 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. | ||