monorail
/
Archipelago
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Make data package contents more descriptive

This commit is contained in:
Hussein Farran 2021-08-04 16:01:03 -04:00 committed by Fabian Dill
parent 6e51b1d50c
commit 928b341fb3
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/network protocol.md
View File

@ -364,8 +364,13 @@ Note:
#### Contents
| Name | Type | Notes |
| ------ | ----- | ------ |
| games | dict[str, dict] | Mapping of all Games and their respective data |
| games[<game_name>]["item_name_to_id"] | dict[int, str] | Mapping of all item names to their respective ID. |
| games[<game_name>]["location_name_to_id"] | dict[str, int] | Mapping of all location names to their respective ID. |
| games[<game_name>]["version"] | int | Version number of this game's data |
| games | dict[str, GameData] | Mapping of all Games and their respective data |
| version | int | Sum of all per-game version numbers, for clients that don't bother with per-game caching/updating. |
#### GameData
GameData is a **dict** but contains these keys and values. It's broken out into another "type" for ease of documentation.
| Name | Type | Notes |
| ---- | ---- | ----- |
| item_name_to_id | dict[int, str] | Mapping of all item names to their respective ID. |
| location_name_to_id | dict[str, int] | Mapping of all location names to their respective ID. |
| version | int | Version number of this game's data |