[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 11/04/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 10/04/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

@@ -259,4 +259,44 @@ inline Drawable* GameClient::findDrawableByID( const DrawableID id )
 // the singleton
 extern GameClient *TheGameClient;
 
+
+// TheSuperHackers @logic-client-separation helmutbuhler 11/04/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 = DummyGameWindowManager
+//			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/Include/GameClient/GameWindowManager.h

@@ -380,6 +380,49 @@ extern WindowMsgHandledType PassMessagesToParentSystem( GameWindow *window,
 																															 WindowMsgData mData2 );
 
 
+// TheSuperHackers @feature helmutbuhler 24/04/2025
+// GameWindow that does nothing. Used for Headless Mode.
+class DummyGameWindow : public GameWindow
+{
+	MEMORY_POOL_GLUE_WITH_USERLOOKUP_CREATE(DummyGameWindow, "DummyGameWindow")
+public:
+	//virtual ~DummyGameWindow();
+	virtual void winDrawBorder() { }
+};
+
+// TheSuperHackers @feature helmutbuhler 24/04/2025
+// GameWindowManager that does nothing. Used for Headless Mode.
+class DummyGameWindowManager : public GameWindowManager
+{
+public:
+	virtual GameWindow *winGetWindowFromId(GameWindow *window, Int id);
+	virtual GameWindow *winCreateFromScript(AsciiString filenameString, WindowLayoutInfo *info);
+
+	virtual GameWindow *allocateNewWindow() { return newInstance(DummyGameWindow); }
+
+	virtual GameWinDrawFunc getPushButtonImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getPushButtonDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getCheckBoxImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getCheckBoxDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getRadioButtonImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getRadioButtonDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getTabControlImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getTabControlDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getListBoxImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getListBoxDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getComboBoxImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getComboBoxDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getHorizontalSliderImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getHorizontalSliderDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getVerticalSliderImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getVerticalSliderDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getProgressBarImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getProgressBarDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getStaticTextImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getStaticTextDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getTextEntryImageDrawFunc() { return NULL; }
+	virtual GameWinDrawFunc getTextEntryDrawFunc() { return NULL; }
+};
 
 #endif // __GAMEWINDOWMANAGER_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 11/04/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);
 
 

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/System/MemoryInit.cpp

@@ -416,6 +416,7 @@ static PoolSizeRec sizes[] =
 	{ "Overridable", 32, 32 },
 
 	{ "W3DGameWindow", 700, 256 },
+	{ "DummyGameWindow", 700, 256 },
 	{ "SuccessState", 32, 32 },
 	{ "FailureState", 32, 32 },
 	{ "ContinueState", 32, 32 },

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)

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

@@ -4097,3 +4097,36 @@ void GameWindowManager::clearTabList( void )
 {
 	m_tabList.clear();
 }
+
+
+GameWindow *DummyGameWindowManager::winGetWindowFromId(GameWindow *window, Int id)
+{
+	window = GameWindowManager::winGetWindowFromId(window, id);
+	if (window != NULL)
+		return window;
+
+	// Just return any window, callers expect this to be non-null
+	return m_windowList;
+}
+
+WindowMsgHandledType DummyWindowSystem(GameWindow *window, UnsignedInt msg, WindowMsgData mData1, WindowMsgData mData2)
+{
+	return MSG_IGNORED;
+}
+
+GameWindow *DummyGameWindowManager::winCreateFromScript(AsciiString filenameString, WindowLayoutInfo *info)
+{
+	WindowLayoutInfo scriptInfo;
+	GameWindow* dummyWindow = winCreate(NULL, 0, 0, 0, 100, 100, DummyWindowSystem, NULL);
+	scriptInfo.windows.push_back(dummyWindow);
+	if (info)
+		*info = scriptInfo;
+	return dummyWindow;
+}
+
+DummyGameWindow::~DummyGameWindow()
+{
+}
+
+
+

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();
@@ -340,7 +346,7 @@ void GameClient::init( void )
 	}
 
 	// create the window manager
-	TheWindowManager = createWindowManager();
+	TheWindowManager = TheGlobalData->m_headless ? NEW DummyGameWindowManager : createWindowManager();
 	if( TheWindowManager )
 	{
 
@@ -397,11 +403,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");
@@ -532,7 +537,7 @@ void GameClient::update( void )
 	//Initial Game Codition.  We must show the movie first and then we can display the shell	
 	if(TheGlobalData->m_afterIntro && !TheDisplay->isMoviePlaying())
 	{
-		if( playSizzle && TheGlobalData->m_playSizzle )
+		if( playSizzle && TheGlobalData->m_playSizzle && !TheGlobalData->m_headless )
 		{
 			TheWritableGlobalData->m_allowExitOutOfMovies = TRUE;
 			if(TheGameLODManager && TheGameLODManager->didMemPass())
@@ -623,10 +628,9 @@ void GameClient::update( void )
 	if(TheGlobalData->m_playIntro || TheGlobalData->m_afterIntro)
 	{
 		// redraw all views, update the GUI
+		if (!TheGlobalData->m_headless)
 		{
 			TheDisplay->DRAW();
-		}
-		{
 			TheDisplay->UPDATE();
 		}
 		return;
@@ -746,10 +750,12 @@ void GameClient::update( void )
 	}
 
 	// update display
+	if (!TheGlobalData->m_headless)
 	{
 		TheDisplay->UPDATE();
 	}
 
+	if (!TheGlobalData->m_headless)
 	{
 		USE_PERF_TIMER(GameClient_draw)
 

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

@@ -1298,7 +1298,7 @@ void InGameUI::setRadiusCursor(RadiusCursorType cursorType, const SpecialPowerTe
 //-------------------------------------------------------------------------------------------------
 void InGameUI::handleRadiusCursor()
 {
-	if (!m_curRadiusCursor.isEmpty())
+	if (!m_curRadiusCursor.isEmpty() && TheMouse != NULL)
 	{
 		const MouseIO* mouseIO = TheMouse->getMouseStatus();
 		Coord3D pos;
@@ -1337,6 +1337,8 @@ void InGameUI::handleRadiusCursor()
 
 void InGameUI::triggerDoubleClickAttackMoveGuardHint( void ) 
 {
+	if (TheMouse == NULL)
+		return;
   m_duringDoubleClickAttackMoveGuardHintTimer = 11; 
 	const MouseIO* mouseIO = TheMouse->getMouseStatus();
 	TheTacticalView->screenToTerrain( &mouseIO->pos, &m_duringDoubleClickAttackMoveGuardHintStashedPosition );
@@ -2936,8 +2938,9 @@ void InGameUI::setGUICommand( const CommandButton *command )
 		}
 		setRadiusCursorNone();
 	}
-
-	m_mouseModeCursor = TheMouse->getMouseCursor();
+
+	if (TheMouse != NULL)
+		m_mouseModeCursor = TheMouse->getMouseCursor();
 
 }  // end setGUICommand
 

GeneralsMD/Code/GameEngine/Source/GameLogic/Map/TerrainLogic.cpp

@@ -2218,6 +2218,8 @@ const WaterHandle* TerrainLogic::getWaterHandle( Real x, Real y )
 
 	/**@todo: Remove this after we have all water types included
 		in water triggers.  For now do special check for water grid mesh. */
+	// TheSuperHackers @logic-client-separation helmutbuhler 11/04/2025
+	// We shouldn't depend on TerrainVisual here.
 	Real meshZ;
 	if( TheTerrainVisual->getWaterGridHeight( x, y, &meshZ ) )
 	{	

GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Object.cpp

@@ -6096,6 +6096,9 @@ const AsciiString& Object::getCommandSetString() const
 //=============================================================================
 Bool Object::canProduceUpgrade( const UpgradeTemplate *upgrade )
 {
+	// TheSuperHackers @logic-client-separation helmutbuhler 11/04/2025
+	// TheControlBar belongs to the client, we shouldn't depend on that to check this.
+
 	// We need to have the button to make the upgrade.  CommandSets are a weird Logic/Client hybrid.
 	const CommandSet *set = TheControlBar->findCommandSet(getCommandSetString());
 

GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Update/DockUpdate/DockUpdate.cpp

@@ -510,6 +510,10 @@ void DockUpdate::loadDockPositions()
 			if( m_numberApproachPositions != DYNAMIC_APPROACH_VECTOR_FLAG )
 			{
 				// Dynamic means no bones
+
+				// TheSuperHackers @logic-client-separation helmutbuhler 11/04/2025
+				// We shouldn't depend on bones of a drawable here!
+
 				Coord3D approachBones[DEFAULT_APPROACH_VECTOR_SIZE];
 				m_numberApproachPositionBones = myDrawable->getPristineBonePositions( "DockWaiting", 1, approachBones, NULL, m_numberApproachPositions);
 				if( m_numberApproachPositions == m_approachPositions.size() )//safeguard: will always be true

GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Weapon.cpp

@@ -2598,6 +2598,8 @@ Bool Weapon::privateFireWeapon(
 	Bool reloaded = false;
 	if (m_ammoInClip > 0)
 	{
+		// TheSuperHackers @logic-client-separation helmutbuhler 11/04/2025
+		// barrelCount shouln't depend on Drawable, which belongs to client.
 		Int barrelCount = sourceObj->getDrawable()->getBarrelCount(m_wslot);
 		if (m_curBarrel >= barrelCount)
 		{