From 928b341fb39ba1003cb807a83869a93ba10a48cd Mon Sep 17 00:00:00 2001 From: Hussein Farran Date: Wed, 4 Aug 2021 16:01:03 -0400 Subject: [PATCH] Make data package contents more descriptive --- docs/network protocol.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/network protocol.md b/docs/network protocol.md index 720aecdb75..810d9720b7 100644 --- a/docs/network protocol.md +++ b/docs/network protocol.md @@ -364,8 +364,13 @@ Note: #### Contents | Name | Type | Notes | | ------ | ----- | ------ | -| games | dict[str, dict] | Mapping of all Games and their respective data | -| games[]["item_name_to_id"] | dict[int, str] | Mapping of all item names to their respective ID. | -| games[]["location_name_to_id"] | dict[str, int] | Mapping of all location names to their respective ID. | -| games[]["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 |