From c1122e1f90248a65b8640b3d369afbcdcb06571e Mon Sep 17 00:00:00 2001
From: Martin Michelsen <fuzziqersoftware+g@gmail.com>
Date: Wed, 27 Dec 2023 23:21:36 -0800
Subject: [PATCH] add comment about client_config scrambling

---
 src/CommandFormats.hh | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/CommandFormats.hh b/src/CommandFormats.hh
index f6ebe213..aa071f12 100644
--- a/src/CommandFormats.hh
+++ b/src/CommandFormats.hh
@@ -3081,6 +3081,9 @@ struct S_ClientInit_BB_00E6 {
   le_uint32_t error_code = 0;
   le_uint32_t player_tag = 0x00010000;
   le_uint32_t guild_card_number = 0;
+  // If security_token is zero, the client scrambles client_config before
+  // sending it back in a later 93 command. See scramble_bb_security_data in
+  // ReceiveCommands.cc for details on how this is done.
   le_uint32_t security_token = 0;
   parray<uint8_t, 0x28> client_config;
   uint8_t can_create_team = 1;