From 37b87e3fde88758e2a10296c192a0e2f0e9b5e71 Mon Sep 17 00:00:00 2001 From: Jacob Lewis Date: Sat, 8 Nov 2025 15:15:29 -0600 Subject: [PATCH] [Docs] Update docs/network protocol.md/NetworkVersion to include class field (#5377) * update docs NetworkVersion * added in non-common-client version clarification * Update docs/network protocol.md Co-authored-by: Duck <31627079+duckboycool@users.noreply.github.com> --------- Co-authored-by: Duck <31627079+duckboycool@users.noreply.github.com> --- docs/network protocol.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/network protocol.md b/docs/network protocol.md index c3fc578a89..0f6a246c1d 100644 --- a/docs/network protocol.md +++ b/docs/network protocol.md @@ -647,6 +647,16 @@ class Version(NamedTuple): build: int ``` +If constructing version information as a dict for a custom client rather than as a NamedTuple built into the CommonClient, you must add the `class` key to allow Archipelago to compare version support. +``` +"version": { + "class": "Version", + "build": X, + "major": Y, + "minor": Z + } +``` + ### SlotType An enum representing the nature of a slot.