[ZH] Implement Headless Mode

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

@@ -68,9 +68,11 @@
 	void dumpReal(Real r, AsciiString name, AsciiString fname, Int line);
 
 	void outputCRCDebugLines( void );
+	void CRCDebugStartNewGame( void );
 	void outputCRCDumpLines( void );
 
 	void addCRCDebugLine(const char *fmt, ...);
+	void addCRCDebugLineNoCounter(const char *fmt, ...);
 	void addCRCDumpLine(const char *fmt, ...);
 	void addCRCGenLine(const char *fmt, ...);
 	#define CRCDEBUG_LOG(x) addCRCDebugLine x
@@ -97,7 +99,9 @@
 	extern Bool g_crcModuleDataFromLogic;
 
 	extern Bool g_keepCRCSaves;
-
+	extern Bool g_saveDebugCRCPerFrame;
+	extern AsciiString g_saveDebugCRCPerFrameDir;
+
 	extern Bool g_logObjectCRCs;
 
 #else // DEBUG_CRC

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,30 @@ class Radar : public Snapshot,
 // EXTERNALS //////////////////////////////////////////////////////////////////////////////////////
 extern Radar *TheRadar;  ///< the radar singleton extern
 
+// TheSuperHackers @feature helmutbuhler 04/10/2025
+// Radar that does nothing
+class RadarHeadless : public Radar
+{
+public:
+	RadarHeadless(){}
+	virtual ~RadarHeadless() {}
+
+	virtual void init() { }
+	virtual void reset() { Radar::reset(); }
+	virtual void update() { Radar::update(); }
+
+	virtual void refreshTerrain(TerrainLogic *terrain) { Radar::refreshTerrain(terrain); }
+	virtual void queueTerrainRefresh() { Radar::queueTerrainRefresh(); }
+	virtual void newMap(TerrainLogic *terrain) { Radar::newMap(terrain); }
+	virtual void draw(Int pixelX, Int pixelY, Int width, Int height) { }
+	virtual void clearShroud() { }
+	virtual void setShroudLevel(Int x, Int y, CellShroudStatus setting) { }
+
+	virtual void crc(Xfer *xfer) { }
+	virtual void xfer(Xfer *xfer) { }
+	virtual void loadPostProcess() { Radar::loadPostProcess(); }
+};
+
 #endif  // __RADAR_H_
 
 

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

@@ -27,6 +27,14 @@
 // Desc:   The Xfer system is capable of setting up operations to work with blocks of data
 //				 from other subsystems.  It can work things such as file reading, file writing,
 //				 CRC computations etc
+//
+// TheSuperHackers @info helmutbuhler 04/09/2025
+//         The baseclass Xfer has 3 implementations:
+//          - XferLoad: Load gamestate
+//          - XferSave: Save gamestate
+//          - XferCRC: Calculate gamestate CRC
+//            - XferDeepCRC: This derives from XferCRC and also writes the gamestate data relevant
+//              to crc calculation to a file (only used in developer builds)
 ///////////////////////////////////////////////////////////////////////////////////////////////////
 
 #pragma once

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 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 = RadarHeadless
+
 #endif // _GAME_INTERFACE_H_

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

@@ -28,6 +28,7 @@
 #include "Common/CRCDebug.h"
 #include "Common/Debug.h"
 #include "Common/PerfTimer.h"
+#include "Common/LocalFileSystem.h"
 #include "GameClient/InGameUI.h"
 #include "GameNetwork/IPEnumeration.h"
 #include <cstdarg>
@@ -41,11 +42,12 @@
 #ifdef DEBUG_CRC
 
 static const Int MaxStrings = 64000;
+static const Int MaxStringLen = 1024;
 
-static char DebugStrings[MaxStrings][1024];
+static char DebugStrings[MaxStrings][MaxStringLen];
 static Int nextDebugString = 0;
 static Int numDebugStrings = 0;
-//static char DumpStrings[MaxStrings][1024];
+//static char DumpStrings[MaxStrings][MaxStringLen];
 //static Int nextDumpString = 0;
 //static Int numDumpStrings = 0;
 
@@ -91,12 +93,8 @@ CRCVerification::~CRCVerification()
 #endif
 }
 
-static Bool dumped = FALSE;
 void outputCRCDebugLines( void )
 {
-	if (dumped)
-		return;
-	dumped = TRUE;
 	IPEnumeration ips;
 	AsciiString fname;
 	fname.format("crcDebug%s.txt", ips.getMachineName().str());
@@ -116,6 +114,60 @@ void outputCRCDebugLines( void )
 	if (fp) fclose(fp);
 }
 
+Int lastCRCDebugFrame = 0;
+Int lastCRCDebugIndex = 0;
+extern Bool inCRCGen;
+
+void CRCDebugStartNewGame()
+{
+	if (g_saveDebugCRCPerFrame)
+	{
+		// Create folder for frame data, if it doesn't exist yet.
+		CreateDirectory(g_saveDebugCRCPerFrameDir.str(), NULL);
+
+		// Delete existing files
+		FilenameList files;
+		AsciiString dir = g_saveDebugCRCPerFrameDir;
+		dir.concat("/");
+		TheLocalFileSystem->getFileListInDirectory(dir.str(), "", "DebugFrame_*.txt", files, FALSE);
+		FilenameList::iterator it;
+		for (it = files.begin(); it != files.end(); ++it)
+		{
+			DeleteFile(it->str());
+		}
+	}
+	nextDebugString = 0;
+	numDebugStrings = 0;
+	lastCRCDebugFrame = 0;
+	lastCRCDebugIndex = 0;
+}
+
+static void outputCRCDebugLinesPerFrame()
+{
+	if (!g_saveDebugCRCPerFrame || numDebugStrings == 0)
+		return;
+	AsciiString fname;
+	fname.format("%s/DebugFrame_%06d.txt", g_saveDebugCRCPerFrameDir.str(), lastCRCDebugFrame);
+	FILE *fp = fopen(fname.str(), "wt");
+	int start = 0;
+	int end = nextDebugString;
+	if (numDebugStrings >= MaxStrings)
+		start = nextDebugString - MaxStrings;
+	nextDebugString = 0;
+	numDebugStrings = 0;
+	if (!fp)
+		return;
+
+	for (Int i=start; i<end; ++i)
+	{
+		const char *line = DebugStrings[ (i + MaxStrings) % MaxStrings ];
+		//DEBUG_LOG(("%s\n", line));
+		fprintf(fp, "%s\n", line);
+	}
+
+	fclose(fp);
+}
+
 void outputCRCDumpLines( void )
 {
 	/*
@@ -137,64 +189,76 @@ static AsciiString getFname(AsciiString path)
 	return path.reverseFind('\\') + 1;
 }
 
-Int lastCRCDebugFrame = 0;
-Int lastCRCDebugIndex = 0;
-extern Bool inCRCGen;
-void addCRCDebugLine(const char *fmt, ...)
+static void addCRCDebugLineInternal(bool count, const char *fmt, va_list args)
 {
-	if (dumped)// || inCRCGen /*|| !TheGameLogic->isInGameLogicUpdate()*/)
+	if (TheGameLogic == NULL || !(IS_FRAME_OK_TO_LOG))
 		return;
 
-	if (IS_FRAME_OK_TO_LOG)
+	if (lastCRCDebugFrame != TheGameLogic->getFrame())
 	{
+		outputCRCDebugLinesPerFrame();
+		lastCRCDebugFrame = TheGameLogic->getFrame();
+		lastCRCDebugIndex = 0;
+	}
 
-		if (lastCRCDebugFrame != TheGameLogic->getFrame())
-		{
-			lastCRCDebugFrame = TheGameLogic->getFrame();
-			lastCRCDebugIndex = 0;
-		}
-
-		sprintf(DebugStrings[nextDebugString], "%d:%d ",  TheGameLogic->getFrame(), lastCRCDebugIndex++);
-		//DebugStrings[nextDebugString][0] = 0;
-		Int len = strlen(DebugStrings[nextDebugString]);
+	if (count)
+		sprintf(DebugStrings[nextDebugString], "%d:%05d ", TheGameLogic->getFrame(), lastCRCDebugIndex++);
+	else
+		DebugStrings[nextDebugString][0] = 0;
+	Int len = strlen(DebugStrings[nextDebugString]);
 
-		va_list va;
-		va_start( va, fmt );
-		_vsnprintf(DebugStrings[nextDebugString]+len, 1024-len, fmt, va );
-		DebugStrings[nextDebugString][1023] = 0;
-		va_end( va );
+	_vsnprintf(DebugStrings[nextDebugString]+len, MaxStringLen-len, fmt, args);
+	DebugStrings[nextDebugString][MaxStringLen-1] = 0;
 
-		char *tmp = DebugStrings[nextDebugString];
-		while (tmp && *tmp)
+	char *tmp = DebugStrings[nextDebugString];
+	while (tmp && *tmp)
+	{
+		if (*tmp == '\r' || *tmp == '\n')
 		{
-			if (*tmp == '\r' || *tmp == '\n')
-			{
-				*tmp = ' ';
-			}
-			++tmp;
+			*tmp = ' ';
 		}
+		++tmp;
+	}
 
-		//DEBUG_LOG(("%s\n", DebugStrings[nextDebugString]));
+	//DEBUG_LOG(("%s\n", DebugStrings[nextDebugString]));
 
-		++nextDebugString;
-		++numDebugStrings;
-		if (nextDebugString == MaxStrings)
-			nextDebugString = 0;
+	++nextDebugString;
+	++numDebugStrings;
+	if (nextDebugString == MaxStrings)
+		nextDebugString = 0;
+}
 
-	}
+void addCRCDebugLine(const char *fmt, ...)
+{
+    va_list args;
+    va_start(args, fmt);
+    addCRCDebugLineInternal(true, fmt, args);
+    va_end(args);
+}
+
+void addCRCDebugLineNoCounter(const char *fmt, ...)
+{
+	// TheSuperHackers @feature helmutbuhler 04/09/2025
+	// This version doesn't increase the lastCRCDebugIndex counter
+	// and can be used for logging lines that don't necessarily match up on all peers.
+	// (Otherwise the numbers would no longer match up and the diff would be very difficult to read)
+    va_list args;
+    va_start(args, fmt);
+    addCRCDebugLineInternal(false, fmt, args);
+    va_end(args);
 }
 
 void addCRCGenLine(const char *fmt, ...)
 {
-	if (dumped || !(IS_FRAME_OK_TO_LOG))
+	if (!(IS_FRAME_OK_TO_LOG))
 		return;
 
-	static char buf[1024];
+	static char buf[MaxStringLen];
 	va_list va;
 	va_start( va, fmt );
-	_vsnprintf(buf, 1024, fmt, va );
+	_vsnprintf(buf, MaxStringLen, fmt, va );
 	va_end( va );
-	buf[1023] = 0;
+	buf[MaxStringLen-1] = 0;
 	addCRCDebugLine("%s", buf);
 
 	//DEBUG_LOG(("%s", buf));
@@ -205,8 +269,8 @@ void addCRCDumpLine(const char *fmt, ...)
 	/*
 	va_list va;
 	va_start( va, fmt );
-	_vsnprintf(DumpStrings[nextDumpString], 1024, fmt, va );
-	DumpStrings[nextDumpString][1023] = 0;
+	_vsnprintf(DumpStrings[nextDumpString], MaxStringLen, fmt, va );
+	DumpStrings[nextDumpString][MaxStringLen-1] = 0;
 	va_end( va );
 
 	++nextDumpString;
@@ -218,9 +282,6 @@ void addCRCDumpLine(const char *fmt, ...)
 
 void dumpVector3(const Vector3 *v, AsciiString name, AsciiString fname, Int line)
 {
-	if (dumped)
-		return;
-
 	if (!(IS_FRAME_OK_TO_LOG)) return;
 	fname.toLower();
 	fname = getFname(fname);
@@ -231,9 +292,6 @@ void dumpVector3(const Vector3 *v, AsciiString name, AsciiString fname, Int line
 
 void dumpCoord3D(const Coord3D *c, AsciiString name, AsciiString fname, Int line)
 {
-	if (dumped)
-		return;
-
 	if (!(IS_FRAME_OK_TO_LOG)) return;
 	fname.toLower();
 	fname = getFname(fname);
@@ -244,9 +302,6 @@ void dumpCoord3D(const Coord3D *c, AsciiString name, AsciiString fname, Int line
 
 void dumpMatrix3D(const Matrix3D *m, AsciiString name, AsciiString fname, Int line)
 {
-	if (dumped)
-		return;
-
 	if (!(IS_FRAME_OK_TO_LOG)) return;
 	fname.toLower();
 	fname = getFname(fname);
@@ -260,9 +315,6 @@ void dumpMatrix3D(const Matrix3D *m, AsciiString name, AsciiString fname, Int li
 
 void dumpReal(Real r, AsciiString name, AsciiString fname, Int line)
 {
-	if (dumped)
-		return;
-
 	if (!(IS_FRAME_OK_TO_LOG)) return;
 	fname.toLower();
 	fname = getFname(fname);