From 14d65fdf28cd8b03056dc2a967508d383cb29400 Mon Sep 17 00:00:00 2001 From: qwint Date: Mon, 1 Sep 2025 18:54:34 -0500 Subject: [PATCH] Docs: Add doc for shared cache (#5129) * adds doc file describing what the shared cache is, how to use it, and what you can currently expect in it * Update docs/shared_cache.md Co-authored-by: Duck <31627079+duckboycool@users.noreply.github.com> --------- Co-authored-by: Duck <31627079+duckboycool@users.noreply.github.com> --- docs/shared_cache.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/shared_cache.md diff --git a/docs/shared_cache.md b/docs/shared_cache.md new file mode 100644 index 00000000..0dd32392 --- /dev/null +++ b/docs/shared_cache.md @@ -0,0 +1,18 @@ +# Shared Cache + +Archipelago maintains a shared folder of information that can be persisted for a machine and reused across Libraries. +It can be found at the User Cache Directory for appname `Archipelago` in the `Cache` subfolder +(ex. `%LOCALAPPDATA%/Archipelago/Cache`). + +## Common Cache + +The Common Cache `common.json` can be used to store any generic data that is expected to be shared across programs +for the same User. + +* `uuid`: A UUID identifier used to identify clients as from the same user/machine, to be sent in the Connect packet + +## Data Package Cache + +The `datapackage` folder in the shared cache folder is used to store datapackages by game and checksum to be reused +in order to save network traffic. The expected structure is `datapackage/Game Name/checksum_value.json` with the +contents of each json file being the no-whitespace datapackage contents.