feat: Add configurable hotkey label overlay for command bar buttons on macOS

Author: Okladnoj

Core/GameEngine/Include/Common/OptionPreferences.h

@@ -82,6 +82,7 @@ class OptionPreferences : public UserPreferences
 	Bool getScreenEdgeScrollEnabledInWindowedApp() const;
 	Bool getScreenEdgeScrollEnabledInFullscreenApp() const;
 	ScreenEdgeScrollMode getScreenEdgeScrollMode() const;
+	Bool getShowHotKeyLabels() const;
 	Bool getSendDelay();
 	Int getFirewallBehavior();
 	Short getFirewallPortAllocationDelta();

Core/GameEngine/Include/GameClient/GameWindow.h

@@ -186,6 +186,9 @@ enum
 	WIN_STATUS_ALWAYS_COLOR = 0x01000000,		// Never render these buttons using greyscale renderer when button disabled.
 	WIN_STATUS_ON_MOUSE_DOWN = 0x02000000,		// Pushbutton triggers on mouse down.
 	WIN_STATUS_SHORTCUT_BUTTON = 0x04000000,   // Oh god... this is a total hack for shortcut buttons to handle rendering text top left corner...
+#ifdef __APPLE__
+	WIN_STATUS_HOTKEY_LABEL = 0x08000000,   // Mac: hotkey-letter overlay on command-bar cameos (bold + semi-transparent bg). Runtime-only, like SHORTCUT_BUTTON (not in WindowStatusNames[]).
+#endif
 	// when you edit this, remember to edit WindowStatusNames[]
 
 };

Core/GameEngine/Source/Common/OptionPreferences.cpp

@@ -430,6 +430,18 @@ ScreenEdgeScrollMode OptionPreferences::getScreenEdgeScrollMode() const
 	return mode;
 }
 
+Bool OptionPreferences::getShowHotKeyLabels() const
+{
+	OptionPreferences::const_iterator it = find("ShowHotKeyLabels");
+	if (it == end())
+		return FALSE;
+
+	if (stricmp(it->second.str(), "yes") == 0)
+		return TRUE;
+
+	return FALSE;
+}
+
 Bool OptionPreferences::usesSystemMapDir()
 {
 	OptionPreferences::const_iterator it = find("UseSystemMapDir");

Core/GameEngineDevice/Source/W3DDevice/GameClient/GUI/Gadget/W3DPushButton.cpp

@@ -56,6 +56,10 @@
 #include "W3DDevice/GameClient/W3DGameWindow.h"
 #include "W3DDevice/GameClient/W3DDisplay.h"
 #include "W3DDevice/GameClient/W3DGadget.h"
+#ifdef __APPLE__
+#include "GameClient/GameFont.h"
+#include "GameClient/Color.h"
+#endif
 
 
 
@@ -117,6 +121,39 @@ static void drawButtonText( GameWindow *window, WinInstanceData *instData )
 	if( text->getFont() != window->winGetFont() )
 		text->setFont( window->winGetFont() );
 
+#ifdef __APPLE__
+	if( BitIsSet( window->winGetStatus(), WIN_STATUS_HOTKEY_LABEL ) )
+	{
+		const Int badgeSize = ( (size.x < size.y) ? size.x : size.y ) / 4;
+
+		if( TheFontLibrary )
+		{
+			GameFont *winFont = window->winGetFont();
+			AsciiString fontName = winFont ? winFont->nameString : AsciiString( "Arial" );
+			Int fontSize = ( badgeSize * 3 ) / 4;
+			if( fontSize < 8 )
+				fontSize = 8;
+			GameFont *badgeFont = TheFontLibrary->getFont( fontName, fontSize, TRUE );
+			if( badgeFont )
+				text->setFont( badgeFont );
+		}
+
+		text->getSize( &width, &height );
+
+		ICoord2D badgeOrigin;
+		badgeOrigin.x = origin.x;
+		badgeOrigin.y = origin.y + size.y - badgeSize;
+
+		TheDisplay->drawFillRect( badgeOrigin.x, badgeOrigin.y, badgeSize, badgeSize, GameMakeColor( 0, 0, 0, 160 ) );
+
+		ICoord2D letterPos;
+		letterPos.x = badgeOrigin.x + ( badgeSize - width ) / 2;
+		letterPos.y = badgeOrigin.y + ( badgeSize - height ) / 2;
+		text->draw( letterPos.x, letterPos.y, textColor, dropColor );
+		return;
+	}
+#endif
+
 	// get text size
 	text->getSize( &width, &height );
 

GeneralsMD/Code/GameEngine/Source/GameClient/GUI/ControlBar/ControlBar.cpp

@@ -78,6 +78,9 @@
 #include "GameClient/ControlBarResizer.h"
 #include "GameClient/GadgetListBox.h"
 #include "GameClient/HotKey.h"
+#ifdef __APPLE__
+#include "Common/OptionPreferences.h"
+#endif
 #include "GameClient/GameWindowTransitions.h"
 #include "GameClient/GUICallbacks.h"
 
@@ -2445,6 +2448,16 @@ void ControlBar::setCommandBarBorder( GameWindow *button, CommandButtonMappedBor
 }
 
 
+#ifdef __APPLE__
+static UnicodeString toUpperHotKeyLabel( const AsciiString &hotKey )
+{
+	UnicodeString label;
+	for (const char *c = hotKey.str(); c && *c; ++c)
+		label.concat( (WideChar)toupper( (unsigned char)*c ) );
+	return label;
+}
+#endif
+
 //-------------------------------------------------------------------------------------------------
 /** Set the command data into the control */
 //-------------------------------------------------------------------------------------------------
@@ -2522,7 +2535,22 @@ void ControlBar::setControlCommand( GameWindow *button, const CommandButton *com
 		AsciiString hotKey =	TheHotKeyManager->searchHotKey(commandButton->getTextLabel());
 		if(hotKey.isNotEmpty())
 			TheHotKeyManager->addHotKey(button, hotKey);
+
+#ifdef __APPLE__
+		static const Bool s_showHotKeyLabels = OptionPreferences().getShowHotKeyLabels();
+
+		Bool isSpecialPowerShortcutButton = FALSE;
+		for (Int i = 0; i < MAX_SPECIAL_POWER_SHORTCUTS; ++i)
+			isSpecialPowerShortcutButton |= (m_specialPowerShortcutButtons[i] == button);
+
+		if (s_showHotKeyLabels && hotKey.isNotEmpty() && !isSpecialPowerShortcutButton)
+		{
+			GadgetButtonSetText(button, toUpperHotKeyLabel(hotKey));
+			button->winSetStatus(WIN_STATUS_HOTKEY_LABEL);
+		}
+#endif
 	}
+
 	GadgetButtonSetAltSound(button, "GUICommandBarClick");
 
 }

Platform/MacOS/Launcher/Sources/LauncherViewModel.swift

@@ -26,6 +26,11 @@ class LauncherViewModel: ObservableObject {
             ])
         }
     }
+    @Published var showHotkeyLabels: Bool = SettingsDefaults.showHotkeyLabels {
+        didSet {
+            OptionsIniHelper.writeValue(value: showHotkeyLabels ? "yes" : "no", forKey: "ShowHotKeyLabels")
+        }
+    }
     @Published var gameLanguage: String = SettingsDefaults.gameLanguage {
         didSet {
             guard !isInitializing else { return }
@@ -100,6 +105,7 @@ class LauncherViewModel: ObservableObject {
             ])
         }
         self.isWindowedEdgeScrollEnabled = OptionsIniHelper.readValue(forKey: "ScreenEdgeScrollEnabledInWindowedApp") == "yes"
+        self.showHotkeyLabels = OptionsIniHelper.readValue(forKey: "ShowHotKeyLabels") == "yes"
         self.gameLanguage = OptionsIniHelper.readValue(forKey: "Language") ?? SettingsDefaults.gameLanguage
 
         // Load settings.json
@@ -152,6 +158,7 @@ class LauncherViewModel: ObservableObject {
 
     func resetAllSettings() {
         isWindowedEdgeScrollEnabled = SettingsDefaults.isWindowedEdgeScrollEnabled
+        showHotkeyLabels = SettingsDefaults.showHotkeyLabels
         gameLanguage = SettingsDefaults.gameLanguage
         cameraMinHeight = SettingsDefaults.cameraMinHeight
         cameraMaxHeight = SettingsDefaults.cameraMaxHeight

Platform/MacOS/Launcher/Sources/Localization.swift

@@ -149,6 +149,9 @@ enum L10n {
         var about: String { resolve("settings.about") }
         var aboutButton: String { resolve("settings.aboutButton") }
         var cameraSection: String { resolve("settings.cameraSection") }
+        var interfaceSection: String { resolve("settings.interfaceSection") }
+        var showHotkeyLabels: String { resolve("settings.showHotkeyLabels") }
+        var showHotkeyLabelsDesc: String { resolve("settings.showHotkeyLabelsDesc") }
         var cameraMaxHeight: String { resolve("settings.cameraMaxHeight") }
         var cameraMinHeight: String { resolve("settings.cameraMinHeight") }
         var cameraSpeed: String { resolve("settings.cameraSpeed") }
@@ -239,6 +242,9 @@ enum L10n {
         "settings.about": "System",
         "settings.aboutButton": "About Generals Online",
         "settings.cameraSection": "Camera",
+        "settings.interfaceSection": "Interface",
+        "settings.showHotkeyLabels": "Show Hotkey Labels",
+        "settings.showHotkeyLabelsDesc": "Displays each command's hotkey letter on its command-bar icon.",
         "settings.cameraMaxHeight": "Max Height (Zoom)",
         "settings.cameraMinHeight": "Min Height (Close)",
         "settings.cameraSpeed": "Camera Speed",
@@ -319,6 +325,9 @@ enum L10n {
         "settings.about": "Система",
         "settings.aboutButton": "О программе",
         "settings.cameraSection": "Камера",
+        "settings.interfaceSection": "Интерфейс",
+        "settings.showHotkeyLabels": "Показывать буквы хоткеев",
+        "settings.showHotkeyLabelsDesc": "Отображает букву горячей клавиши на иконке команды в панели.",
         "settings.cameraMaxHeight": "Макс. высота (Зум)",
         "settings.cameraMinHeight": "Мин. высота (Приближение)",
         "settings.cameraSpeed": "Скорость камеры",
@@ -399,6 +408,9 @@ enum L10n {
         "settings.about": "Система",
         "settings.aboutButton": "Про програму",
         "settings.cameraSection": "Камера",
+        "settings.interfaceSection": "Інтерфейс",
+        "settings.showHotkeyLabels": "Показувати літери гарячих клавіш",
+        "settings.showHotkeyLabelsDesc": "Відображає літеру гарячої клавіші на іконці команди в панелі.",
         "settings.cameraMaxHeight": "Макс. висота (Зум)",
         "settings.cameraMinHeight": "Мін. висота (Наближення)",
         "settings.cameraSpeed": "Швидкість камери",
@@ -479,6 +491,9 @@ enum L10n {
         "settings.about": "सिस्टम (System)",
         "settings.aboutButton": "Generals Online के बारे में",
         "settings.cameraSection": "कैमरा (Camera)",
+        "settings.interfaceSection": "इंटरफ़ेस (Interface)",
+        "settings.showHotkeyLabels": "हॉटकी अक्षर दिखाएं",
+        "settings.showHotkeyLabelsDesc": "कमांड बार के आइकन पर प्रत्येक कमांड की हॉटकी का अक्षर दिखाता है।",
         "settings.cameraMaxHeight": "अधिकतम ऊंचाई (Zoom)",
         "settings.cameraMinHeight": "न्यूनतम ऊंचाई (Close)",
         "settings.cameraSpeed": "कैमरा गति",
@@ -559,6 +574,9 @@ enum L10n {
         "settings.about": "系统",
         "settings.aboutButton": "关于 Generals Online",
         "settings.cameraSection": "相机",
+        "settings.interfaceSection": "界面",
+        "settings.showHotkeyLabels": "显示快捷键字母",
+        "settings.showHotkeyLabelsDesc": "在指令栏图标上显示每个指令的快捷键字母。",
         "settings.cameraMaxHeight": "最大高度 (缩放)",
         "settings.cameraMinHeight": "最小高度 (靠近)",
         "settings.cameraSpeed": "相机速度",
@@ -639,6 +657,9 @@ enum L10n {
         "settings.about": "النظام (System)",
         "settings.aboutButton": "حول Generals Online",
         "settings.cameraSection": "الكاميرا",
+        "settings.interfaceSection": "الواجهة",
+        "settings.showHotkeyLabels": "إظهار أحرف مفاتيح الاختصار",
+        "settings.showHotkeyLabelsDesc": "يعرض حرف مفتاح الاختصار لكل أمر على أيقونته في شريط الأوامر.",
         "settings.cameraMaxHeight": "الارتفاع الأقصى (التقريب)",
         "settings.cameraMinHeight": "الارتفاع الأدنى (التبعيد)",
         "settings.cameraSpeed": "سرعة الكاميرا",
@@ -719,6 +740,9 @@ enum L10n {
         "settings.about": "Жүйе (System)",
         "settings.aboutButton": "Generals Online туралы",
         "settings.cameraSection": "Камера",
+        "settings.interfaceSection": "Интерфейс",
+        "settings.showHotkeyLabels": "Жылдам пернелер әріптерін көрсету",
+        "settings.showHotkeyLabelsDesc": "Командалар тақтасындағы белгішеде команданың жылдам перне әрпін көрсетеді.",
         "settings.cameraMaxHeight": "Максималды биіктік (Зум)",
         "settings.cameraMinHeight": "Минималды биіктік (Жақындату)",
         "settings.cameraSpeed": "Камера жылдамдығы",
@@ -799,6 +823,9 @@ enum L10n {
         "settings.about": "Hệ thống",
         "settings.aboutButton": "Về Generals Online",
         "settings.cameraSection": "Camera",
+        "settings.interfaceSection": "Giao diện",
+        "settings.showHotkeyLabels": "Hiển thị chữ phím tắt",
+        "settings.showHotkeyLabelsDesc": "Hiển thị chữ phím tắt của mỗi lệnh trên biểu tượng ở thanh lệnh.",
         "settings.cameraMaxHeight": "Chiều cao tối đa (Zoom)",
         "settings.cameraMinHeight": "Chiều cao tối thiểu (Gần)",
         "settings.cameraSpeed": "Tốc độ camera",
@@ -879,6 +906,9 @@ enum L10n {
         "settings.about": "System",
         "settings.aboutButton": "O Generals Online",
         "settings.cameraSection": "Kamera",
+        "settings.interfaceSection": "Interfejs",
+        "settings.showHotkeyLabels": "Pokaż litery skrótów",
+        "settings.showHotkeyLabelsDesc": "Wyświetla literę skrótu klawiszowego na ikonie polecenia na pasku.",
         "settings.cameraMaxHeight": "Maks. wysokość (Zoom)",
         "settings.cameraMinHeight": "Min. wysokość (Zbliżenie)",
         "settings.cameraSpeed": "Prędkość kamery",
@@ -959,6 +989,9 @@ enum L10n {
         "settings.about": "System",
         "settings.aboutButton": "Über Generals Online",
         "settings.cameraSection": "Kamera",
+        "settings.interfaceSection": "Benutzeroberfläche",
+        "settings.showHotkeyLabels": "Tastenkürzel-Buchstaben anzeigen",
+        "settings.showHotkeyLabelsDesc": "Zeigt den Tastenkürzel-Buchstaben jedes Befehls auf seinem Symbol in der Befehlsleiste an.",
         "settings.cameraMaxHeight": "Maximale Höhe (Zoom)",
         "settings.cameraMinHeight": "Minimale Höhe (Nah)",
         "settings.cameraSpeed": "Kamerageschwindigkeit",
@@ -1039,6 +1072,9 @@ enum L10n {
         "settings.about": "Sistema",
         "settings.aboutButton": "Acerca de Generals Online",
         "settings.cameraSection": "Cámara",
+        "settings.interfaceSection": "Interfaz",
+        "settings.showHotkeyLabels": "Mostrar letras de atajos",
+        "settings.showHotkeyLabelsDesc": "Muestra la letra del atajo de cada comando en su icono de la barra de comandos.",
         "settings.cameraMaxHeight": "Altura máxima (Zoom)",
         "settings.cameraMinHeight": "Altura mínima (Acercar)",
         "settings.cameraSpeed": "Velocidad de cámara",
@@ -1119,6 +1155,9 @@ enum L10n {
         "settings.about": "Sistem",
         "settings.aboutButton": "Generals Online Hakkında",
         "settings.cameraSection": "Kamera",
+        "settings.interfaceSection": "Arayüz",
+        "settings.showHotkeyLabels": "Kısayol Harflerini Göster",
+        "settings.showHotkeyLabelsDesc": "Her komutun kısayol harfini komut çubuğundaki simgesinde gösterir.",
         "settings.cameraMaxHeight": "Maks. Yükseklik (Zoom)",
         "settings.cameraMinHeight": "Min. Yükseklik (Yakınlaşma)",
         "settings.cameraSpeed": "Kamera Hızı",

Platform/MacOS/Launcher/Sources/SettingsDefaults.swift

@@ -2,6 +2,7 @@ import Foundation
 
 struct SettingsDefaults {
     static let isWindowedEdgeScrollEnabled = false
+    static let showHotkeyLabels = false
     static let gameLanguage = "english"
 
     static let cameraMinHeight: Double = 210.0

Platform/MacOS/Launcher/Sources/SidebarView.swift

@@ -80,7 +80,17 @@ struct SidebarView: View {
                         defaultValue: SettingsDefaults.cameraMoveSpeed,
                         scope: .global
                     )
-                    
+
+                    // --- INTERFACE SECTION ---
+                    _buildSectionHeader(title: L10n.settings.interfaceSection)
+
+                    _buildSidebarSettingToggle(
+                        title: L10n.settings.showHotkeyLabels,
+                        description: L10n.settings.showHotkeyLabelsDesc,
+                        isOn: $viewModel.showHotkeyLabels,
+                        scope: .global
+                    )
+
                     // --- PERFORMANCE SECTION ---
                     _buildSectionHeader(title: L10n.settings.fpsSection)