feat(gui): Distinguish patch players from retail players by a colored name and different status #1404

Caball009 · 2025-08-01T20:16:20Z

With this PR it'll become clear which clients are on a patched version with this feature and which are not:

the patched clients inform all other clients in the lobby and pre-match of their patch version.
the retail clients ignore the patch version data.
the patched clients show the player names of patched clients in a different color.
the patched clients show the player status of patched clients with a [SH] tag.

LAN Lobby:

Pre-match / Game Options:

Status in match:

TODO:

Add code comments.
Replicate in Generals.

… status.

Caball009 · 2025-08-10T19:34:40Z

GeneralsMD/Code/GameEngine/Source/GameNetwork/LANAPI.cpp

@@ -461,6 +465,14 @@ void LANAPI::update( void )
 		}
 	}

+	if (m_inLobby || (m_currentGame && !m_currentGame->isGameInProgress())) {


This is broadcast every 200 ms to all other clients. It works perfectly, but it's a bit 'spammy'. Should try to find a more elegant solution for this.

It should only be broadcasted when a new player joins the lobby. It is a fixed value that doesn't change.

Eliminating the broadcast spam would good.

FWIW, the game periodically broadcasts other data that may or may not have changed. This happens with 10 second intervals, which I found to be a bit too slow for this feature.

It should only be broadcasted when a new player joins the lobby.

It's a bit more complicated than that, though. I also need data about the hosts of each game and about other players in the same match.

I think this needs to be redesigned with new message versions.

On RETAIL_COMPATIBLE_NETWORK versions, send the original messages

MSG_GAME_ANNOUNCE MSG_LOBBY_ANNOUNCE MSG_REQUEST_JOIN

and on top send new messages, give them a generous offset to avoid colliding with other community products.

MSG_COMMUNITY_GAME_ANNOUNCE = 1000 MSG_COMMUNITY_LOBBY_ANNOUNCE MSG_COMMUNITY_REQUEST_JOIN

Then try to design the packets so that they cover all sorts of use cases we will have.

I assume MSG_COMMUNITY_GAME_ANNOUNCE equals MSG_GAME_ANNOUNCE + some patch information. Wouldn't it be better to do this when we break compatibility? Otherwise we'll be sending this data in duplicate. Also, redesigning these packets is absolutely outside the scope of this PR as far as I'm concerned.

I do agree that if we keep MSG_PATCH_VERSION or similar, it should be given a decent offset.

Well ideally we build this feature here without the packet spam every 200 ms. Instead send 2 packets on the announcements, which is better than the spamming. The 2 packets will also only be sent on RETAIL_COMPATIBLE_NETWORK clients, so it is temporary. I did not think this fully through but my instict tells me this is the way to go?

I'm not sure if we understand well enough what our messages will look like after we break retail compatibility, so I propose we delay redesigning them until we have a better idea what that should look like.

I think it's possible to avoid spamming MSG_PATCH_VERSION by sending it whenever certain other messages are sent as well. This doesn't require newly designed messages.

Yes you can also send the product version message side by side with other messages. Try to anticipate future requirements for communications so that we do not need to touch it often.

roossienb · 2025-08-11T18:17:10Z

GeneralsMD/Code/GameEngine/Source/GameNetwork/GUIUtil.cpp

@@ -423,6 +423,12 @@ void UpdateSlotList( GameInfo *myGame, GameWindow *comboPlayer[],
 			}
 			if(slot->isHuman())
 			{
+				if (i == myGame->getLocalSlotNum() || myGame->getSlot(i)->getPatchVersion() > 0)
+				{
+					GadgetComboBoxSetEnabledTextColors(comboPlayer[i], 0xFFFFFF00, 0xFF000000);


These colours should be put into variables, preferably configurable through INI.

roossienb · 2025-08-11T18:17:51Z

GeneralsMD/Code/GameEngine/Source/GameNetwork/LANAPICallbacks.cpp

@@ -642,7 +642,8 @@ void LANAPI::OnPlayerList( LANPlayer *playerList )
 		LANPlayer *player = m_lobbyPlayers;
 		while (player)
 		{
-			Int addedIndex = GadgetListBoxAddEntryText(listboxPlayers, player->getName(), playerColor, -1, -1);
+			const Color color = (player->getPatchVersion() > 0 || m_localIP == player->getIP()) ? 0xFFFFFF00 : playerColor;


magic colour, create INI configurable variable

Put it by the others

const Color playerColor = GameMakeColor(255,255,255,255);

magic colour, create INI configurable variable

The current white and grey colors are not configurable either, and I don't see that as an issue.

Put it by the others

Will do.

roossienb · 2025-08-11T18:18:22Z

GeneralsMD/Code/GameEngine/Source/GameNetwork/LANGameInfo.cpp

@@ -226,7 +226,10 @@ void LANDisplayGameList( GameWindow *gameListbox, LANGameInfo *gameList )
 			{
 				txtGName.concat(L"]");
 			}
-			Int addedIndex = GadgetListBoxAddEntryText(gameListbox, txtGName, (gameList->isGameInProgress())?gameInProgressColor:gameColor, -1, -1);
+			const Color color = (gameList->getSlot(0)->getPatchVersion() > 0)
+				? ((gameList->isGameInProgress()) ? 0xFF808000 : 0xFFFFFF00)


magic colours

xezon

Good effort.

This work relates to #16

I think the packets need redesigning.

xezon · 2025-08-11T18:26:01Z

GeneralsMD/Code/GameEngine/Source/GameNetwork/LANAPI.cpp

@@ -461,6 +465,14 @@ void LANAPI::update( void )
 		}
 	}

+	if (m_inLobby || (m_currentGame && !m_currentGame->isGameInProgress())) {


Eliminating the broadcast spam would good.

xezon · 2025-08-11T18:27:05Z

GeneralsMD/Code/GameEngine/Source/GameNetwork/LANAPICallbacks.cpp

@@ -642,7 +642,8 @@ void LANAPI::OnPlayerList( LANPlayer *playerList )
 		LANPlayer *player = m_lobbyPlayers;
 		while (player)
 		{
-			Int addedIndex = GadgetListBoxAddEntryText(listboxPlayers, player->getName(), playerColor, -1, -1);
+			const Color color = (player->getPatchVersion() > 0 || m_localIP == player->getIP()) ? 0xFFFFFF00 : playerColor;


Put it by the others

const Color playerColor = GameMakeColor(255,255,255,255);

xezon · 2025-08-11T18:30:09Z

GeneralsMD/Code/GameEngine/Source/GameNetwork/LANAPIhandlers.cpp

+	}
+	else if (m_currentGame && !m_currentGame->isGameInProgress())
+	{
+		for (int player = 0; player < MAX_SLOTS; ++player)


Can split this into 2 functions:

handlePatchVersionInLobby(LANMessage* msg, UnsignedInt senderIP) handlePatchVersionInGameRoom(LANMessage* msg, UnsignedInt senderIP)

xezon · 2025-08-11T18:32:24Z

GeneralsMD/Code/GameEngine/Include/GameNetwork/GameInfo.h

@@ -146,6 +149,7 @@ class GameSlot
 	FirewallHelperClass::FirewallBehaviorType m_NATBehavior;	///< The NAT behavior for this slot's player.
 	UnsignedInt m_lastFrameInGame;	// only valid for human players
 	Bool m_disconnected;						// only valid for human players
+	UnsignedInt m_patchVersion;	// TheSuperHackers patch version


Can label this as "Community made product version"

xezon · 2025-08-11T18:42:08Z

GeneralsMD/Code/GameEngine/Source/GameNetwork/LANAPI.cpp

+		LANMessage msg;
+		fillInLANMessage(&msg);
+		msg.LANMessageType = LANMessage::MSG_PATCH_VERSION;
+		msg.PatchInfo.patchVersion = TheVersion->getVersionNumber();


This will only contain major 1 minor 4 for Zero Hour. This means the version will not change between builds.

I think this data can be extended with more version information.

The least we need is a product name and its version.

For reference, see

Version::getUnicodeProductTitle Version::getUnicodeProductVersion Version::getUnicodeProductAuthor

xezon · 2025-08-11T18:44:22Z

GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Diplomacy.cpp

 					}
 				}
+
+				if (slot->isHuman() && (TheGameInfo->getLocalSlotNum() == slotNum || slot->getPatchVersion() > 0))
+					text.concat(L"[SH]");


This string ideally is build from the product title and not hardcoded like this.

xezon · 2025-08-11T18:46:48Z

GeneralsMD/Code/GameEngine/Include/GameNetwork/LANAPI.h

@@ -282,6 +282,7 @@ class LANAPI : public LANAPIInterface
 	void handleGameStartTimer( LANMessage *msg, UnsignedInt senderIP );
 	void handleGameOptions( LANMessage *msg, UnsignedInt senderIP );
 	void handleInActive( LANMessage *msg, UnsignedInt senderIP );
+	void handlePatchVersion( LANMessage *msg, UnsignedInt senderIP );


I suggest use terminology

"ProductTitle"
"ProductVersion"
"ProductAuthor"

xezon · 2025-08-11T18:53:03Z

GeneralsMD/Code/GameEngine/Source/GameNetwork/LANAPI.cpp

@@ -461,6 +465,14 @@ void LANAPI::update( void )
 		}
 	}

+	if (m_inLobby || (m_currentGame && !m_currentGame->isGameInProgress())) {


I think this needs to be redesigned with new message versions.

On RETAIL_COMPATIBLE_NETWORK versions, send the original messages

MSG_GAME_ANNOUNCE MSG_LOBBY_ANNOUNCE MSG_REQUEST_JOIN

and on top send new messages, give them a generous offset to avoid colliding with other community products.

MSG_COMMUNITY_GAME_ANNOUNCE = 1000 MSG_COMMUNITY_LOBBY_ANNOUNCE MSG_COMMUNITY_REQUEST_JOIN

Then try to design the packets so that they cover all sorts of use cases we will have.

Caball009 added 5 commits August 1, 2025 21:51

Added patch version member and member functions.

ad2ed81

Added (de)serialization to game options string.

06eea3c

Made patch players' names yellow and added [SH] tag to patch players'…

9ddafcb

… status.

Relaxed string length check.

549e098

Add extra scope to make the code compile with VC6.

634eb6b

Caball009 added Enhancement Is new feature or request GUI For graphical user interface Network Anything related to network, servers Gen Relates to Generals ZH Relates to Zero Hour labels Aug 1, 2025

Caball009 added 4 commits August 3, 2025 20:09

Reverted original lines.

a059c0b

Merge branch 'main' into show_clients_with_sh_patch

e1ef9d6

Merge branch 'TheSuperHackers:main' into show_clients_with_sh_patch

4019d2b

Major implementation refactor.

9fb6a01

Caball009 commented Aug 10, 2025

View reviewed changes

Caball009 marked this pull request as ready for review August 10, 2025 19:34

Caball009 requested a review from a team August 11, 2025 15:24

roossienb reviewed Aug 11, 2025

View reviewed changes

xezon reviewed Aug 11, 2025

View reviewed changes

feat(gui): Distinguish patch players from retail players by a colored name and different status #1404

Are you sure you want to change the base?

feat(gui): Distinguish patch players from retail players by a colored name and different status #1404

Uh oh!

Conversation

Caball009 commented Aug 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

TODO:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xezon left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Caball009 commented Aug 1, 2025 •

edited

Loading