[ZH] Implement Headless Mode

GeneralsMD/Code/GameEngine/Include/Common/GlobalData.h

@@ -100,6 +100,11 @@ class GlobalData : public SubsystemInterface
 	Bool m_dumpAssetUsage;
 	Int m_framesPerSecondLimit;
 	Int	m_chipSetType;	///<See W3DShaderManager::ChipsetType for options
+
+	// TheSuperHackers @feature helmutbuhler 04/11/2025
+	// Run game without graphics, input or audio.
+	Bool m_headless;
+
 	Bool m_windowed;
 	Int m_xResolution;
 	Int m_yResolution;

GeneralsMD/Code/GameEngine/Include/Common/Radar.h

@@ -293,6 +293,16 @@ class Radar : public Snapshot,
 // EXTERNALS //////////////////////////////////////////////////////////////////////////////////////
 extern Radar *TheRadar;  ///< the radar singleton extern
 
+// TheSuperHackers @feature helmutbuhler 04/10/2025
+// Radar that does nothing. Used for Headless Mode.
+class RadarDummy : public Radar
+{
+public:
+	virtual void draw(Int pixelX, Int pixelY, Int width, Int height) { }
+	virtual void clearShroud() { }
+	virtual void setShroudLevel(Int x, Int y, CellShroudStatus setting) { }
+};
+
 #endif  // __RADAR_H_
 
 

GeneralsMD/Code/GameEngine/Include/GameClient/GameClient.h

@@ -251,4 +251,44 @@ inline Drawable* GameClient::findDrawableByID( const DrawableID id )
 // the singleton
 extern GameClient *TheGameClient;
 
+
+// TheSuperHackers @logic-client-separation helmutbuhler 04/11/2025
+// Some information about the architecture and headless mode:
+// The game is structurally separated into GameLogic and GameClient.
+// The Logic is responsible for everything that affects the game mechanic and what is synchronized over
+// the network. The Client is responsible for rendering, input, audio and similar stuff.
+// 
+// Unfortunately there are some places in the code that make the Logic depend on the Client.
+// (Search for @logic-client-separation)
+// That means if we want to run the game headless, we cannot just disable the Client. We need to disable
+// the parts in the Client that don't work in headless mode and need to keep the parts that are needed
+// to run the Logic.
+// The following describes which parts we disable in headless mode:
+//
+//	GameEngine:
+//		TheGameClient is partially disabled:
+//			TheKeyboard = NULL
+//			TheMouse = NULL
+//			TheDisplay is partially disabled:
+//				m_3DInterfaceScene = NULL
+//				m_2DScene = NULL
+//				m_3DScene = NULL
+//				(m_assetManager remains!)
+//			TheWindowManager = NULL
+//			TheIMEManager = NULL
+//			TheTerrainVisual is partially disabled:
+//				TheTerrainTracksRenderObjClassSystem = NULL
+//				TheW3DShadowManager = NULL
+//				TheWaterRenderObj = NULL
+//				TheSmudgeManager = NULL
+//				TheTerrainRenderObject is partially disabled:
+//					m_treeBuffer = NULL
+//					m_propBuffer = NULL
+//					m_bibBuffer = NULL
+//					m_bridgeBuffer = NULL
+//					m_waypointBuffer = NULL
+//					m_roadBuffer = NULL
+//					m_shroud = NULL
+//		TheRadar = RadarDummy
+
 #endif // _GAME_INTERFACE_H_

GeneralsMD/Code/GameEngine/Source/Common/CommandLine.cpp

@@ -862,6 +862,15 @@ Int parseQuickStart( char *args[], int num )
 	return 1;
 }
 
+Int parseHeadless( char *args[], int num )
+{
+	if (TheWritableGlobalData)
+	{
+		TheWritableGlobalData->m_headless = TRUE;
+	}
+	return 1;
+}
+
 Int parseConstantDebug( char *args[], int num )
 {
 	if (TheWritableGlobalData)
@@ -1205,6 +1214,10 @@ static CommandLineParam params[] =
 	{ "-noshaders", parseNoShaders },
 	{ "-quickstart", parseQuickStart },
 
+	// TheSuperHackers @feature helmutbuhler 04/11/2025
+	// This runs the game without a window, graphics, input and audio. Used for testing.
+	{ "-headless", parseHeadless },
+
 #if (defined(_DEBUG) || defined(_INTERNAL))
 	{ "-noaudio", parseNoAudio },
 	{ "-map", parseMapName },

GeneralsMD/Code/GameEngine/Source/Common/GameEngine.cpp

@@ -507,7 +507,7 @@ void GameEngine::init( int argc, char *argv[] )
 		initSubsystem(TheCrateSystem,"TheCrateSystem", MSGNEW("GameEngineSubsystem") CrateSystem(), &xferCRC, "Data\\INI\\Default\\Crate.ini", "Data\\INI\\Crate.ini");
 		initSubsystem(ThePlayerList,"ThePlayerList", MSGNEW("GameEngineSubsystem") PlayerList(), NULL);
 		initSubsystem(TheRecorder,"TheRecorder", createRecorder(), NULL);
-		initSubsystem(TheRadar,"TheRadar", createRadar(), NULL);
+		initSubsystem(TheRadar,"TheRadar", TheGlobalData->m_headless ? NEW RadarDummy : createRadar(), NULL);
 		initSubsystem(TheVictoryConditions,"TheVictoryConditions", createVictoryConditions(), NULL);
 
 
@@ -709,11 +709,15 @@ void GameEngine::init( int argc, char *argv[] )
 void GameEngine::reset( void )
 {
 
-	WindowLayout *background = TheWindowManager->winCreateLayout("Menus/BlankWindow.wnd");
-	DEBUG_ASSERTCRASH(background,("We Couldn't Load Menus/BlankWindow.wnd"));
-	background->hide(FALSE);
-	background->bringForward();
-	background->getFirstWindow()->winClearStatus(WIN_STATUS_IMAGE);
+	WindowLayout *background = TheWindowManager ? TheWindowManager->winCreateLayout("Menus/BlankWindow.wnd") : NULL;
+	if (background != NULL)
+	{
+		DEBUG_ASSERTCRASH(background,("We Couldn't Load Menus/BlankWindow.wnd"));
+		background->hide(FALSE);
+		background->bringForward();
+		background->getFirstWindow()->winClearStatus(WIN_STATUS_IMAGE);
+	}
+
 	Bool deleteNetwork = false;
 	if (TheGameLogic->isInMultiplayerGame())
 		deleteNetwork = true;

GeneralsMD/Code/GameEngine/Source/Common/GlobalData.cpp

@@ -613,6 +613,7 @@ GlobalData::GlobalData()
 	m_dumpAssetUsage = FALSE;
 	m_framesPerSecondLimit = 0;
 	m_chipSetType = 0;
+	m_headless = FALSE;
 	m_windowed = 0;
 	m_xResolution = 800;
 	m_yResolution = 600;

GeneralsMD/Code/GameEngine/Source/Common/RandomValue.cpp

@@ -249,7 +249,7 @@ Int GetGameClientRandomValue( int lo, int hi, const char *file, int line )
 /**/
 #ifdef DEBUG_RANDOM_CLIENT
 DEBUG_LOG(( "%d: GetGameClientRandomValue = %d (%d - %d), %s line %d\n",
-				TheGameLogic->getFrame(), rval, lo, hi, file, line ));
+				TheGameLogic ? TheGameLogic->getFrame() : -1, rval, lo, hi, file, line ));
 #endif
 /**/
 

GeneralsMD/Code/GameEngine/Source/Common/Recorder.cpp

@@ -1610,7 +1610,7 @@ RecorderModeType RecorderClass::getMode() {
 void RecorderClass::initControls()
 {
 	NameKeyType parentReplayControlID = TheNameKeyGenerator->nameToKey( AsciiString("ReplayControl.wnd:ParentReplayControl") );
-	GameWindow *parentReplayControl = TheWindowManager->winGetWindowFromId( NULL, parentReplayControlID );
+	GameWindow *parentReplayControl = TheWindowManager ? TheWindowManager->winGetWindowFromId( NULL, parentReplayControlID ) : NULL;
 
 	Bool show = (getMode() != RECORDERMODETYPE_PLAYBACK);
 	if (parentReplayControl)

GeneralsMD/Code/GameEngine/Source/Common/System/Radar.cpp

@@ -335,8 +335,11 @@ void Radar::newMap( TerrainLogic *terrain )
 
 	// keep a pointer for our radar window
 	Int id = NAMEKEY( "ControlBar.wnd:LeftHUD" );
-	m_radarWindow = TheWindowManager->winGetWindowFromId( NULL, id );
-	DEBUG_ASSERTCRASH( m_radarWindow, ("Radar::newMap - Unable to find radar game window\n") );
+	if (TheWindowManager != NULL)
+	{
+		m_radarWindow = TheWindowManager->winGetWindowFromId( NULL, id );
+		DEBUG_ASSERTCRASH( m_radarWindow, ("Radar::newMap - Unable to find radar game window\n") );
+	}
 
 	// reset all the data in the radar
 	reset();

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

@@ -1382,6 +1382,8 @@ void ControlBar::reset( void )
 //-------------------------------------------------------------------------------------------------
 void ControlBar::update( void )
 {
+	if (TheGlobalData->m_headless)
+		return;
 	getStarImage();
 	updateRadarAttackGlow();
 	if(m_controlBarSchemeManager)
@@ -1652,6 +1654,8 @@ const Image *ControlBar::getStarImage(void )
 	else
 		m_lastFlashedAtPointValue = ThePlayerList->getLocalPlayer()->getSciencePurchasePoints();
 
+	if (TheWindowManager == NULL)
+		return NULL;
 	GameWindow *win= TheWindowManager->winGetWindowFromId( NULL, TheNameKeyGenerator->nameToKey( "ControlBar.wnd:ButtonGeneral" ) );
 	if(!win)
 		return NULL;
@@ -2141,6 +2145,12 @@ void ControlBar::switchToContext( ControlBarContext context, Drawable *draw )
 	// save a pointer for the currently selected drawable
 	m_currentSelectedDrawable = draw;
 
+	if (TheWindowManager == NULL)
+	{
+		m_currContext = context;
+		return;
+	}
+
 	if (IsInGameChatActive() == FALSE && TheGameLogic && !TheGameLogic->isInShellGame()) {
 		TheWindowManager->winSetFocus( NULL );
 	}
@@ -2593,6 +2603,8 @@ void ControlBar::setPortraitByImage( const Image *image )
 //-------------------------------------------------------------------------------------------------
 void ControlBar::setPortraitByObject( Object *obj )
 {
+	if (TheWindowManager == NULL)
+		return;
 
 	if( obj )
 	{
@@ -2754,7 +2766,8 @@ void ControlBar::setControlBarSchemeByPlayer(Player *p)
 {
 	if(m_controlBarSchemeManager)
 		m_controlBarSchemeManager->setControlBarSchemeByPlayer(p);
-
+	if (TheWindowManager == NULL)
+		return;
 	static NameKeyType buttonPlaceBeaconID = NAMEKEY( "ControlBar.wnd:ButtonPlaceBeacon" );
 	static NameKeyType buttonIdleWorkerID = NAMEKEY("ControlBar.wnd:ButtonIdleWorker");
 	static NameKeyType buttonGeneralID = NAMEKEY("ControlBar.wnd:ButtonGeneral");
@@ -2961,7 +2974,7 @@ void ControlBar::showPurchaseScience( void )
 
 void ControlBar::hidePurchaseScience( void )
 {
-	if(m_contextParent[ CP_PURCHASE_SCIENCE ]->winIsHidden())
+	if(m_contextParent[ CP_PURCHASE_SCIENCE ] == NULL || m_contextParent[ CP_PURCHASE_SCIENCE ]->winIsHidden())
 		return;
 
 	if( m_contextParent[ CP_PURCHASE_SCIENCE ] )
@@ -2986,6 +2999,8 @@ void ControlBar::hidePurchaseScience( void )
 
 void ControlBar::togglePurchaseScience( void )
 {
+	if (m_contextParent[ CP_PURCHASE_SCIENCE ] == NULL)
+		return;
 	if(m_contextParent[ CP_PURCHASE_SCIENCE ]->winIsHidden())
 		showPurchaseScience();
 	else
@@ -3244,7 +3259,8 @@ void ControlBar::initSpecialPowershortcutBar( Player *player)
 	if(!player || !pt|| !player->isLocalPlayer()
 			|| pt->getSpecialPowerShortcutButtonCount() == 0  
 			|| pt->getSpecialPowerShortcutWinName().isEmpty()
-			|| !player->isPlayerActive())
+			|| !player->isPlayerActive()
+			|| TheWindowManager == NULL)
 		return;
 	m_currentlyUsedSpecialPowersButtons = pt->getSpecialPowerShortcutButtonCount();
 	AsciiString layoutName, tempName, windowName, parentName;

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

@@ -1162,6 +1162,8 @@ void ControlBarSchemeManager::setControlBarSchemeByPlayerTemplate( const PlayerT
 //-----------------------------------------------------------------------------
 void ControlBarSchemeManager::setControlBarSchemeByPlayer(Player *p)
 {
+	if (TheWindowManager == NULL)
+		return;
 	GameWindow *communicatorButton = TheWindowManager->winGetWindowFromId( NULL, NAMEKEY("ControlBar.wnd:PopupCommunicator") );
 	if (communicatorButton && TheControlBar)
 	{

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

@@ -702,7 +702,7 @@ void ControlBar::deleteBuildTooltipLayout( void )
 {
 	m_showBuildToolTipLayout = FALSE;
 	prevWindow= NULL;
-	m_buildToolTipLayout->hide(TRUE);
+	if (m_buildToolTipLayout) m_buildToolTipLayout->hide(TRUE);
 //	if(!m_buildToolTipLayout)
 //		return;
 //	

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

@@ -169,6 +169,8 @@ BriefingList* GetBriefingTextList(void)
 //-------------------------------------------------------------------------------------------------
 void UpdateDiplomacyBriefingText(AsciiString newText, Bool clear)
 {
+	if (TheWindowManager == NULL)
+		return;
 	GameWindow *listboxSolo = TheWindowManager->winGetWindowFromId(theWindow, NAMEKEY("Diplomacy.wnd:ListboxSolo"));
 
 	if (clear)

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

@@ -114,7 +114,7 @@ void HideInGameChat( Bool immediate )
 		chatTextEntry->winEnable(FALSE);
 		TheWindowManager->winSetFocus( NULL );
 	}
-	TheWindowManager->winSetFocus( NULL );
+	if (TheWindowManager) TheWindowManager->winSetFocus( NULL );
 }
 
 // ------------------------------------------------------------------------------------------------

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

@@ -496,7 +496,7 @@ void Shell::showShellMap(Bool useShellMap )
 			TheMessageStream->appendMessage( GameMessage::MSG_CLEAR_GAME_DATA );
 
 		// if the shell is active,we need a background
-		if(!m_isShellActive)
+		if(!m_isShellActive || TheWindowManager == NULL)
 			return;
 		if(!m_background)
 			m_background = TheWindowManager->winCreateLayout("Menus/BlankWindow.wnd");

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

@@ -270,10 +270,13 @@ void GameClient::init( void )
 		TheDisplayStringManager->setName("TheDisplayStringManager");
 	}
 
-	// create the keyboard
-	TheKeyboard = createKeyboard();
-	TheKeyboard->init();
-	TheKeyboard->setName("TheKeyboard");
+	if (!TheGlobalData->m_headless)
+	{
+		// create the keyboard
+		TheKeyboard = createKeyboard();
+		TheKeyboard->init();
+		TheKeyboard->setName("TheKeyboard");
+	}
 
 	// allocate and load image collection for the GUI and just load the 256x256 ones for now
 	TheMappedImageCollection = MSGNEW("GameClientSubsystem") ImageCollection;
@@ -321,11 +324,14 @@ void GameClient::init( void )
 	if( TheFontLibrary )
 		TheFontLibrary->init();
 
-	// create the mouse
-	TheMouse = createMouse();
-	TheMouse->parseIni();
-	TheMouse->initCursorResources();
- 	TheMouse->setName("TheMouse");
+	if (!TheGlobalData->m_headless)
+	{
+		// create the mouse
+		TheMouse = createMouse();
+		TheMouse->parseIni();
+		TheMouse->initCursorResources();
+ 		TheMouse->setName("TheMouse");
+	}
 
 	// instantiate the display
 	TheDisplay = createGameDisplay();
@@ -339,23 +345,25 @@ void GameClient::init( void )
 		TheHeaderTemplateManager->init();
 	}
 
-	// create the window manager
-	TheWindowManager = createWindowManager();
-	if( TheWindowManager )
+	if (!TheGlobalData->m_headless)
 	{
+		// create the window manager
+		TheWindowManager = createWindowManager();
+		if( TheWindowManager )
+		{
 
-		TheWindowManager->init();
- 		TheWindowManager->setName("TheWindowManager");
-//		TheWindowManager->initTestGUI();
+			TheWindowManager->init();
+ 			TheWindowManager->setName("TheWindowManager");
+	//		TheWindowManager->initTestGUI();
 
-	}  // end if
-
-	// create the IME manager
-	TheIMEManager = CreateIMEManagerInterface();
-	if ( TheIMEManager )
-	{
-		TheIMEManager->init();
- 		TheIMEManager->setName("TheIMEManager");
+		}  // end if
+		// create the IME manager
+		TheIMEManager = CreateIMEManagerInterface();
+		if ( TheIMEManager )
+		{
+			TheIMEManager->init();
+ 			TheIMEManager->setName("TheIMEManager");
+		}
 	}
 
 	// create the shell
@@ -397,11 +405,10 @@ void GameClient::init( void )
  		TheRayEffects->setName("TheRayEffects");
 	}
 
-	TheMouse->init();	//finish initializing the mouse.
-
 	// set the limits of the mouse now that we've created the display and such
 	if( TheMouse )
 	{
+		TheMouse->init();	//finish initializing the mouse.
 		TheMouse->setPosition( 0, 0 );
 		TheMouse->setMouseLimits();
  		TheMouse->setName("TheMouse");
@@ -634,6 +641,7 @@ void GameClient::update( void )
 	}
 
 	// update the window system itself
+	if (TheWindowManager)
 	{
 		TheWindowManager->UPDATE();
 	}