Broadcast and filter game options #874

11EJDE11 · 2025-11-08T05:17:39Z

Closes or helps close

Adds game options to the GAME broadcast
Adds broadcasted game options to the filters in CnCNetLobby
Adds broadcasted game options to the GameListBox and GameInformationPanel
Adds setting to disable the game icon from showing in the GameListBox

New INI settings for GameSessionCheckBox (located in GameLobbyBase.ini):

BroadcastToLobby=Yes|No
ShowInGameList=Yes|No
ShowInGameListOnRight=Yes|No
ShowInGameInformationPanel=Yes|No
ShowInGameInformationPanelAsIconOnly=Yes|No
ShowIconInGameLobby=Yes|No
ShowInFilters=Yes|No
EnabledIcon=<filename.png>
DisabledIcon=<filename.png>
SortOrder=<integer>

New settings for GameSessionDropDown (located in GameLobbyBase.ini):

BroadcastToLobby=Yes|No
ShowInGameList=Yes|No
ShowInGameListOnRight=Yes|No
ShowInGameInformationPanel=Yes|No
ShowInGameInformationPanelAsIconOnly=Yes|No
ShowIconInGameLobby=Yes|No
ShowInFilters=Yes|No
Icons=<icon1.png>,<icon2.png>,...
SortOrder=<integer>

New setting in ClientDefinitions.ini:

[Settings]
ShowGameIconInGameList=Yes|No

GameListBox and GameInformationPanel changes:

Filters menu:

Fix issue with lblSkillLevel visibility Add layout constants Co-authored-by: devo1929 <devo1929@users.noreply.github.com>

Add extra param to CreateDivider to specify a custom height Add constant for spacing in icon panel

Add game options to the filters in CnCNetLobby Add broadcasted game options to the GameListBox and GameInformationPanel Adds setting to disable the game icon from the GameListBox

github-actions · 2025-11-08T05:22:12Z

Nightly build for this pull request:

artifacts.zip
This comment is automatic and is meant to allow guests to get latest automatic builds without registering. It is updated on every successful build.

Metadorius

Good work so far mate!

I don't see if credits are shown in the game info panel, is this intended? I thought if you're able to filter by it - it should also be visible there.

Also maybe the panel should be made two-column and use the same font as the main game info?

Also I think the icons here should be item icons, because so far per the idea icons convey the value, not what option it is. See my review comments on how to make this work.

Some of the comments that I left are more of open questions, so curious to hear your thoughts on them.

Metadorius · 2025-11-09T17:12:16Z

ClientCore/Settings/UserINISettings.cs

+        /// <summary>
+        /// Gets the filter value for a checkbox game option.
+        /// Returns 0 for "All", 1 for "On", 2 for "Off".
+        /// </summary>
+        public int GetCheckboxFilterValue(string optionName) => SettingsIni.GetIntValue(GAME_OPTION_FILTERS, optionName, 0);
+
+        /// <summary>
+        /// Sets the filter value for a checkbox game option.
+        /// 0 = "All", 1 = "On", 2 = "Off".
+        /// </summary>
+        public void SetCheckboxFilterValue(string optionName, int value)  => SettingsIni.SetIntValue(GAME_OPTION_FILTERS, optionName, value);
+
+        /// <summary>
+        /// Gets the filter value for a dropdown game option.
+        /// Returns -1 for "All", or the selected index.
+        /// </summary>
+        public int GetDropdownFilterValue(string optionName) => SettingsIni.GetIntValue(GAME_OPTION_FILTERS, optionName, -1);
+
+        /// <summary>
+        /// Sets the filter value for a dropdown game option.
+        /// -1 = "All", or the selected index.
+        /// </summary>
+        public void SetDropdownFilterValue(string optionName, int value) => SettingsIni.SetIntValue(GAME_OPTION_FILTERS, optionName, value);


This is a bit inconsistent, I think -1 should mean "irrelevant" in both the dropdown and the checkbox.

I am not sure yet, but to me int? and bool? sounds like a more obvious choice here. Curious to hear what you think about that.

True - nullable is better. Fixed in dda5b0c.

Metadorius · 2025-11-09T17:13:48Z

DXMainClient/DXGUI/Generic/GameSessionCheckBox.cs

+    /// Whether the icon should be shown on the right side of the game list.
+    /// Only applies if IconShownInGameList is true.
+    /// </summary>
+    public bool IconShownInGameListOnRight { get; private set; }


Clever customisation!

Thanks! Perhaps it would be better to have both "ShownInGameListLHS" and "ShownInGameListRHS". What do you think?

Not sure, is there a use for having both?

Metadorius · 2025-11-09T17:16:32Z

DXMainClient/DXGUI/Generic/GameSessionDropDown.cs

+    /// <summary>
+    /// The texture name for the icon.
+    /// </summary>
+    public string Icon { get; private set; }


I think for this to be more useful, we have to have not one icon per dropdown but actually an icon per option in the dropdown. If the icon is missing -- then no icon would be shown.

This would also streamline the behavior between the checkbox and the dropdown. The icon could be then drawn as ItemTexture or however the option was called.

Thanks and fixed.

Metadorius · 2025-11-09T17:19:55Z

DXMainClient/DXGUI/Multiplayer/CnCNet/CnCNetGameLoadingLobby.cs

+            sb.Append(";"); // Packed checkbox values (empty for loaded lobbies)
+            sb.Append(";"); // Dropdown indices (empty for loaded lobbies)


Is it necessary to separate dropdowns and indices like this? They are essentially both the same, checkbox is an option with 0, 1 states, and dropdown has 0, 1, 2, ... etc. I've created an interface for game settings specifically to generalize this kind of behavior. What do you think?

Not needed. That stuff was mostly copied from the existing game options broadcast which had it split. See:

xna-cncnet-client/DXMainClient/DXGUI/Multiplayer/GameLobby/CnCNetGameLobby.cs

Line 1036 in 3cf078b

// We don't gain much in most cases by packing the drop-down values

RE the interface - makes sense. I was working on an outdated copy and didn't see those changes. Hopefully 60b23c5 sorts it as you imagined.

Metadorius · 2025-11-09T17:20:56Z

DXMainClient/DXGUI/Multiplayer/CnCNet/CnCNetLobby.cs

+            var broadcastableCheckboxes = gameLobby.CheckBoxes.Where(cb => cb.BroadcastToLobby).ToList();
+            if (game.BroadcastedCheckboxValues != null && broadcastableCheckboxes.Count > 0)
+            {
+                for (int i = 0; i < broadcastableCheckboxes.Count; i++)
+                {
+                    if (i >= game.BroadcastedCheckboxValues.Length)
+                        break;
+
+                    var checkbox = broadcastableCheckboxes[i];
+                    int filterValue = UserINISettings.Instance.GetCheckboxFilterValue(checkbox.Name);
+
+                    // 0 = All, 1 = On, 2 = Off
+                    if (filterValue == 0)
+                        continue;
+
+                    bool isChecked = game.BroadcastedCheckboxValues[i];
+
+                    bool shouldBeChecked = filterValue == 1;
+                    if (isChecked != shouldBeChecked)
+                        return false;
+                }
+            }
+
+            // dropdown filters
+            var broadcastableDropdowns = gameLobby.DropDowns.Where(dd => dd.BroadcastToLobby).ToList();
+            if (game.BroadcastedDropdownIndices != null && broadcastableDropdowns.Count > 0)
+            {
+                for (int i = 0; i < broadcastableDropdowns.Count; i++)
+                {
+                    if (i >= game.BroadcastedDropdownIndices.Length)
+                        break;
+
+                    var dropdown = broadcastableDropdowns[i];
+                    int filterValue = UserINISettings.Instance.GetDropdownFilterValue(dropdown.Name);
+
+                    // -1 = All, otherwise check for exact match
+                    if (filterValue == -1)
+                        continue;
+
+                    int gameSelectedIndex = game.BroadcastedDropdownIndices[i];
+
+                    if (gameSelectedIndex != filterValue)
+                        return false;
+                }
+            }


this could be deduplicated I think?

60b23c5 sorts it.

Metadorius · 2025-11-09T17:42:47Z

DXMainClient/DXGUI/Multiplayer/GameInformationPanel.cs

+                            Texture2D icon = AssetLoader.LoadTexture(iconName);
+                            if (icon != null)
+                            {
+                                string text = $"{checkbox.Text}: {(isChecked ? "On".L10N("Client:Main:On") : "Off".L10N("Client:Main:Off"))}";


I think we use Yes/No already in other places? not sure, need to check

I think on/off is more appropriate as we're displaying the status of an option not answering a yes/no question. We do use yes/no throughout the ini files though.
Happy to change it if you want, I have no strong preference either way.

SW: On
Crates: Off

SW: Yes
Crates: No

Metadorius · 2025-11-09T17:43:31Z

DXMainClient/DXGUI/Multiplayer/GameFiltersPanel.cs

+                }
+                else
+                {
+                    // For dropdowns: -1 = All (default), actual indices are offset by 1


Not sure what is the reason for that math here?

Sorted with 60b23c5.

Metadorius · 2025-11-09T17:46:16Z

DXMainClient/DXGUI/Multiplayer/GameFiltersPanel.cs

If there are many options you could use the ScrollablePanel I implemented. How does it fare with a lot of options? Say, every option added to broadcast.

Wonder if there's a point in making this all INItializable...

Thanks, it is using the scroll panel now. There is an annoying issue where scrolling with the mousewheel, if the cursor is over a dropdown, the dropdown scrolls too.

Metadorius · 2025-11-09T17:50:13Z

DXMainClient/DXGUI/Generic/GameSessionCheckBox.cs

+    /// <summary>
+    /// Whether the icon should be shown in the game information panel.
+    /// </summary>
+    public bool IconShownInGameInfo { get; private set; }
+
+    /// <summary>
+    /// Whether the icon should be shown in the game filters panel.
+    /// </summary>
+    public bool IconShownInFilters { get; private set; }


Hmm, I know I said previously that it would be good to have it customisable, but I am not sure now. Do you think there would be any case when the modder or game maintainer would want to have an icon in game list but not have the icon anywhere else? ATM I am not sure if this makes sense, because the game info/filters icon work as legend, so probably could omit that.

Also I think we could draw the icons near game options in the lobby themselves the same way?

Yeah, I think we keep the settings but make it apply to the whole thing not just the icon. So "ShownInGameInfo" instead of "IconShownInGameInfo", etc. It's programmed a bit like that already - hence the missing Credits in that screenshot.

I was having hassles with icons in the game lobby. I'll take another look.

I think the filter and the game info should be switched on by the same option, otherwise it would be pretty user unfriendly to have something in filter but not in game info, and vice versa. Same for icons in the list - if the icon is shown in the game list - it must have the same icon (working as legend) in filter and in game info, so the users don't get confused on the meaning.

Metadorius · 2025-11-09T18:04:41Z

DXMainClient/DXGUI/Multiplayer/GameListBox.cs

+            int rightIconsWidth = rightIcons.Count > 0 ?
+                (rightIcons.Sum(icon => icon.Width) + (rightIcons.Count * ICON_MARGIN)) : 0;
+
+            int gameTextureWidth = ClientConfiguration.Instance.ShowGameIconInGameList ? hg.Game.Texture.Width : 0;


I do think that if LocalGame is different from the one the game has, the texture should be always on, as we would have no way of easily telling what game is that game room for.

Add 2 column drawing in GameInformationPanel Add SortOrder property Add icons to dropdowns Rename settings Use scrollpanel

Metadorius · 2025-11-25T00:09:40Z

DXMainClient/DXGUI/Generic/GameSessionDropDown.cs

+    /// Sort order for displaying icons in the GameInformationPanel and GameListBox.
+    /// Lower values appear first.
+    /// </summary>
+    public int SortOrder { get; private set; } = 100;


Not sure why this is 100 😅

So people can easily specify a lower or higher control? Seems like a common way, like the default metric for a network interface.

Mabybe we can make this 100 a constant but 100 is definitely better than a default 0 (unless we want to allow negative numbers, then 0 will be a perfect default value) or int.Max

I don't see why would we disallow negative values

I've changed it to 0 as I'm not blocking negatives so I guess it makes more sense. Setting it to 100 just read better to me.

SadPencil

LGTM. Only some minor comments

SadPencil · 2025-11-25T02:33:01Z

DXMainClient/DXGUI/Multiplayer/GameInformationPanel.cs

+            // First show icons in a row
+            if (optionIconsOnly.Count > 0)
+            {
+                var sortedIconsOnly = optionIconsOnly.OrderBy(x => x.sortOrder).ToList();


Nitpick. The List<T>.Sort method sorts the list in-place and has a higher efficiency than an .OrderBy.ToList().

(It's a pity that PriorityQueue is only provided in .NET 6+ but sorting a list here is totally acceptable)

Thanks SP. Let's leave it as is for now. It's not sorting much and would require a bit more code otherwise.

SadPencil · 2025-11-25T02:35:38Z

DXMainClient/DXGUI/Multiplayer/GameInformationPanel.cs

+                currentY += maxIconHeight + legendPadding;
+            }
+
+            // Then show icons with text ( two columns)


( two columns) -> (two columns)

Fixed thanks.

SadPencil · 2025-11-25T02:37:07Z

DXMainClient/DXGUI/Multiplayer/GameInformationPanel.cs

+                    pnlGameOptions.AddChild(iconPanel);
+
+                    if (isLeftColumn)
+                        leftY += legendIconHeight + 2;


You have defined const int iconSpacing = 4; private const int legendPadding = 5; but here we got another magic number 2. You might want to define another constant

Thanks, have added a constant.

SadPencil · 2025-11-25T02:46:44Z

ClientCore/Settings/UserINISettings.cs

+        {
+            var section = SettingsIni.GetSection(GAME_OPTION_FILTERS);
+            if (section != null)
+                section.RemoveAllKeys();


section?.RemoveAllKeys();

Fixed, thanks.

SadPencil · 2025-11-25T02:50:04Z

DXMainClient/DXGUI/Generic/GameSessionDropDown.cs

+    /// Sort order for displaying icons in the GameInformationPanel and GameListBox.
+    /// Lower values appear first.
+    /// </summary>
+    public int SortOrder { get; private set; } = 100;


So people can easily specify a lower or higher control? Seems like a common way, like the default metric for a network interface.

Mabybe we can make this 100 a constant but 100 is definitely better than a default 0 (unless we want to allow negative numbers, then 0 will be a perfect default value) or int.Max

SadPencil · 2025-11-25T02:52:50Z

DXMainClient/DXGUI/Multiplayer/GameLobby/CnCNetGameLobby.cs

+
+                // Convert bytes to integers
+                for (int i = 0; i < byteArray.Length / 4; i++)
+                    gameOptionValues.Add(BitConverter.ToInt32(byteArray, i * 4));


Same as the V3 PR: be careful using BitConverter. You can throw if BitConverter.IsLittleEndian does not match our expect, or use BinaryPrimitives instead

Update: looks like we already have ~20 BitConverter usages. Maybe we should change them to BinaryPrimitives or globally throw on unexpected BitConverter.IsLittleEndian in another PR

OK - let's do this in another PR.

SadPencil · 2025-11-25T02:54:01Z

DXMainClient/DXGUI/Multiplayer/GameInformationIconPanel.cs

+            int textHeight = (int)textSize.Y;
+
+            int iconY = (textHeight - icon.Height) / 2;
+            if (iconY < 0) iconY = 0;


Our style requires a line break after if (condition)

Sorted, thanks.

…e-settings

11EJDE11 and others added 3 commits November 8, 2025 17:11

Add icon legend to GameInformationPanel

9fa3227

Fix issue with lblSkillLevel visibility Add layout constants Co-authored-by: devo1929 <devo1929@users.noreply.github.com>

Update using statements for alphabetical order

dfb6184

Add extra param to CreateDivider to specify a custom height Add constant for spacing in icon panel

Add game options to the GAME broadcast

54c2562

Add game options to the filters in CnCNetLobby Add broadcasted game options to the GameListBox and GameInformationPanel Adds setting to disable the game icon from the GameListBox

Metadorius requested changes Nov 9, 2025

View reviewed changes

Metadorius requested review from SadPencil and Starkku November 9, 2025 18:07

11EJDE11 added 4 commits November 10, 2025 10:56

Change saved filters to nullable

dda5b0c

Refactor game options to use unified integer-based interface

60b23c5

Fix duplicate L10N

fec6165

Switch to regular font instead of bold

9470f99

SadPencil force-pushed the develop branch from 9db87a8 to e0d174c Compare November 14, 2025 16:50

11EJDE11 added 2 commits November 17, 2025 13:08

Add draw items in row on GameInformationPanel

d3a1a17

Add 2 column drawing in GameInformationPanel Add SortOrder property Add icons to dropdowns Rename settings Use scrollpanel

Fix icons in dropdowns in filter panel

5ae535f

Metadorius reviewed Nov 25, 2025

View reviewed changes

SadPencil reviewed Nov 25, 2025

View reviewed changes

11EJDE11 added 8 commits December 5, 2025 12:45

Merge remote-tracking branch 'origin/develop' into feat-broadcast-gam…

16caf05

…e-settings

Fix formatting

1b2ca9f

Add SortOrder constant

12d5448

Fix null check

9e3077a

Add constant for padding

f694b7f

Fix spacing

8936ad1

Make default sort order 0

5e8966c

Restore other games icons

7b5b445

		sb.Append(";"); // Packed checkbox values (empty for loaded lobbies)
		sb.Append(";"); // Dropdown indices (empty for loaded lobbies)

Uh oh!

Broadcast and filter game options #874

Are you sure you want to change the base?

Broadcast and filter game options #874

Uh oh!

Conversation

11EJDE11 commented Nov 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Nov 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Metadorius 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!

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!

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!

SadPencil 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!

11EJDE11 commented Nov 8, 2025 •

edited

Loading

github-actions bot commented Nov 8, 2025 •

edited

Loading