Replays POC (#492)

* Initial POC commit of replay code

* Added more debug logs and update tick recording

* Working version of replays.

* Working version of demo replays. Still rare issues with long term replays.

* Add replay POC

* Temp muting logging for events

* updating projet files

* Updating Cmakelist

* updating project and merging some files

* Ignoring modcache

* Merge of 1.15 code

* More logging cleanup and simplifying code.

* More merging of the 1.15 code.

* Additional Merging

* updating ui and filters

* ensuring version is 141 instead of 143

* Removing sdl import

* Removed unused dependencies

* Removing unreachable code

* Removing inused includes

* Updating strcpy call

* Don't open folder in linux

* Remove stale replay logging

* Fix up pathing for linux

* Updating UI to support linux and change the mod checking behavior for dark fores assets.

* Change functinoality of mod checker.

* temp debug logging

* Rewriting log

* Fix for linux paths and sorting

* Clean up some empty space - make it look nicer on linux.

* Updating version - removing eye requirement in the events - adding recording/replay start messages.

* Add logging toggle for replays

* update linux offsets

* Change playback counter

* Adding append more for filestreaming.

* fix log

* never skip priority by default

* Adding an option to run a replay via commandline. Also add parameter to show debug logs so you can add them to github action build to ensure there are no deltas

* adding param to auto exit.

* Adding latest editor changes from master.

* Minor cleanup

* Removing spurious log messages

* Adding replay test mechanism

* Ignore any replays

* fixing tests workflow

* Fix path

* more debug

* more workflow testing

* More workflow debugging

* More testing

* workflow fix

* more bug fixing

* more workflow testing

* more workflow test

* add cmake Tests folder

* testing

* updating

* more tests

* top fix

* test

* log is ignored - changing to txt

* Disable tests through actions.

* Remove mousebot and turret number checking

* Added testing

---------

Co-authored-by: Karjala22 <78927981+Karjala22@users.noreply.github.com>

Author: ifeldshteyn

.github/workflows/ubuntu-gcc.yml

@@ -33,4 +33,4 @@ jobs:
 
     - name: Build
       # Build your program with the given configuration
-      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}

.gitignore

@@ -61,9 +61,11 @@
 .vs/
 Internal/
 TheForceEngine/Games/
+TheForceEngine/ModCache/
 TheForceEngine/Mods/
 TheForceEngine/screenshots/
 TheForceEngine/Reference/
+TheForceEngine/Replays/
 TheForceEngine/LawMaker/
 TheForceEngine/Backup/
 TheForceEngine/Exports/

CMakeLists.txt

@@ -85,6 +85,7 @@ if(ENABLE_TFE)
 		execute_process(COMMAND ln -sf ${CMAKE_SOURCE_DIR}/TheForceEngine/UI_Images)
 		execute_process(COMMAND ln -sf ${CMAKE_SOURCE_DIR}/TheForceEngine/UI_Text)
 		execute_process(COMMAND ln -sf ${CMAKE_SOURCE_DIR}/TheForceEngine/EditorDef)
+		execute_process(COMMAND ln -sf ${CMAKE_SOURCE_DIR}/TheForceEngine/Tests)
 		include(CreateGitVersionH.cmake)
 		create_git_version_h()
 	endif()
@@ -137,6 +138,7 @@ if(ENABLE_TFE)
 		"${CMAKE_CURRENT_SOURCE_DIR}/TheForceEngine/Shaders"
 		"${CMAKE_CURRENT_SOURCE_DIR}/TheForceEngine/SoundFonts"
 		"${CMAKE_CURRENT_SOURCE_DIR}/TheForceEngine/Fonts"
+		"${CMAKE_CURRENT_SOURCE_DIR}/TheForceEngine/Tests"
 		DESTINATION "${CMAKE_INSTALL_DATADIR}"
 		    FILE_PERMISSIONS
 		      OWNER_READ OWNER_WRITE

TheForceEngine/TFE_DarkForces/Actor/mousebot.cpp

@@ -148,7 +148,7 @@ namespace TFE_DarkForces
 				local(tick) = s_curTick;
 			}
 			else
-			{
+			{			
 				Tick dt = s_curTick - local(tick);
 				// If enough time has past since the player was last spotted, go back to sleep.
 				if (dt > 728) // ~5 seconds.
@@ -164,8 +164,8 @@ namespace TFE_DarkForces
 			{
 				local(odd) = (s_curTick & 1) ? JTRUE : JFALSE;
 				angle14_32 deltaYaw = random(16338);
-				local(moveMod)->target.yaw = local(odd) ? (local(obj)->yaw + deltaYaw) : (local(obj)->yaw - deltaYaw);
-
+				local(moveMod)->target.yaw = local(odd) ? (local(obj)->yaw + deltaYaw) : (local(obj)->yaw - deltaYaw);				
+				
 				local(moveMod)->target.speedRotation = random(0x3555) + 0x555;
 				local(moveMod)->target.flags |= TARGET_MOVE_ROT;
 				local(flip) = JFALSE;

TheForceEngine/TFE_DarkForces/GameUI/agentMenu.cpp

@@ -501,6 +501,35 @@ namespace TFE_DarkForces
 		menu_blitToScreen(s_framebuffer);
 	}
 
+	void agentMenu_setAgentName(const char* name)
+	{
+		if (s_agentId < 0 || s_agentId >= MAX_AGENT_COUNT)
+		{
+			return;
+		}
+		strncpy(s_agentData[s_agentId].name, name, 32);
+	}
+
+	s32 agentMenu_getAgentID()
+	{
+		return s_agentId;
+	}
+
+	void agentMenu_setAgentId(s32 id)
+	{
+		s_agentId = id;
+	}
+
+	void agentMenu_setAgentCount(s32 count)
+	{
+		s_agentCount = count;
+	}
+
+	s32 agentMenu_getAgentCount()
+	{
+		return s_agentCount;
+	}
+
 	void agentMenu_createNewAgent()
 	{
 		if (s_agentCount < MAX_AGENT_COUNT)

TheForceEngine/TFE_DarkForces/GameUI/agentMenu.h

@@ -16,5 +16,12 @@ namespace TFE_DarkForces
 	void agentMenu_load(LangHotkeys* hotkeys);
 
 	// Reset Presistent State.
+
+	s32 agentMenu_getAgentID();
+	void agentMenu_setAgentId(s32 id);
+	void agentMenu_setAgentCount(s32 count);
+	s32 agentMenu_getAgentCount();
+	void agentMenu_createNewAgent();
+	void agentMenu_setAgentName(const char* name);
 	void agentMenu_resetState();
 }

TheForceEngine/TFE_DarkForces/GameUI/menu.cpp

@@ -17,6 +17,7 @@
 #include <TFE_System/system.h>
 #include <TFE_Jedi/Renderer/virtualFramebuffer.h>
 #include <TFE_Jedi/Renderer/screenDraw.h>
+#include <TFE_Input/replay.h>
 
 using namespace TFE_Jedi;
 
@@ -62,16 +63,31 @@ namespace TFE_DarkForces
 		s32 mx, my;
 		TFE_Input::getMousePos(&mx, &my);
 		s_cursorPosAccum = { 12*mx/10, my };	// Account for 320x200 in 4:3 scaling.
-
-		if (displayInfo.width >= displayInfo.height)
+		
+		// Load the replay PDA positions. 
+		if (TFE_Input::isDemoPlayback())
 		{
-			s_cursorPos.x = clamp(s_cursorPosAccum.x * (s32)height / (s32)displayInfo.height, 0, (s32)width - 3);
-			s_cursorPos.z = clamp(s_cursorPosAccum.z * (s32)height / (s32)displayInfo.height, 0, (s32)height - 3);
+			Vec2i pdap = TFE_Input::getPDAPosition();
+			s_cursorPos = pdap;
 		}
 		else
 		{
-			s_cursorPos.x = clamp(s_cursorPosAccum.x * (s32)width / (s32)displayInfo.width, 0, (s32)width - 3);
-			s_cursorPos.z = clamp(s_cursorPosAccum.z * (s32)width / (s32)displayInfo.width, 0, (s32)height - 3);
+			if (displayInfo.width >= displayInfo.height)
+			{
+				s_cursorPos.x = clamp(s_cursorPosAccum.x * (s32)height / (s32)displayInfo.height, 0, (s32)width - 3);
+				s_cursorPos.z = clamp(s_cursorPosAccum.z * (s32)height / (s32)displayInfo.height, 0, (s32)height - 3);
+			}
+			else
+			{
+				s_cursorPos.x = clamp(s_cursorPosAccum.x * (s32)width / (s32)displayInfo.width, 0, (s32)width - 3);
+				s_cursorPos.z = clamp(s_cursorPosAccum.z * (s32)width / (s32)displayInfo.width, 0, (s32)height - 3);
+			}
+		}
+
+		// Store the PDA positions for replay.
+		if (TFE_Input::isRecording())
+		{
+			TFE_Input::storePDAPosition(s_cursorPos);
 		}
 	}
 

TheForceEngine/TFE_DarkForces/GameUI/pda.cpp

@@ -29,7 +29,8 @@
 #include <TFE_Jedi/Level/rfont.h>
 #include <TFE_Jedi/Renderer/jediRenderer.h>
 #include <TFE_Settings/settings.h>
-#include <TFE_System/system.h>
+#include <TFE_Input/replay.h>
+#include <TFE_Input/inputMapping.h>
 
 using namespace TFE_Jedi;
 using namespace TFE_Input;
@@ -126,7 +127,7 @@ namespace TFE_DarkForces
 		// TFE
 		reticle_enable(false);
 		s_mouseAccum = { 0 };
-
+		mouseOldPosX = 0, mouseOldPosZ = 0;
 		pauseLevelSound();
 		if (!s_pdaLoaded)
 		{
@@ -160,6 +161,7 @@ namespace TFE_DarkForces
 					s_briefingMaxY = -BRIEF_VERT_MARGIN;
 				}
 				s_briefY = -BRIEF_VERT_MARGIN;
+				
 			}
 			s_overlayRect = s_pdaRect;
 
@@ -169,7 +171,7 @@ namespace TFE_DarkForces
 			}
 			s_framebuffer = ldraw_getBitmap();
 			lcanvas_getBounds(&s_viewBounds);
-
+				
 			s_pdaArt = lactorAnim_load("pda", &s_viewBounds, 0, 0, 0);
 			s_palette = lpalette_load("menu");
 			lactor_setTime(s_pdaArt, -1, -1);
@@ -210,6 +212,12 @@ namespace TFE_DarkForces
 		pda_resetState();
 	}
 
+	// Reset the tab to the map to support replay consistency. 
+	void pda_resetTab()
+	{
+		s_pdaMode = PDA_MODE_MAP;
+	}
+
 	void pda_resetState()
 	{
 		s_pdaOpen   = JFALSE;
@@ -246,6 +254,7 @@ namespace TFE_DarkForces
 			TFE_Jedi::renderer_setType(RendererType(graphics->rendererIndex));
 			TFE_Jedi::renderer_setLimits();
 		}
+
 	}
 
 	void pda_update()
@@ -255,7 +264,10 @@ namespace TFE_DarkForces
 			return;
 		}
 
-		if (inputMapping_getActionState(IADF_PDA_TOGGLE) == STATE_PRESSED || TFE_Input::keyPressed(KEY_ESCAPE))
+		// Special case to support Escape during demo playback
+		if (inputMapping_getActionState(IADF_PDA_TOGGLE) == STATE_PRESSED 
+			|| TFE_Input::keyPressed(KEY_ESCAPE) 
+			|| inputMapping_getAction(IADF_MENU_TOGGLE) == STATE_PRESSED)
 		{
 			pda_close();
 			return;
@@ -277,10 +289,10 @@ namespace TFE_DarkForces
 		u32 outWidth, outHeight;
 		vfb_getResolution(&outWidth, &outHeight);
 		memset(vfb_getCpuBuffer(), 0, outWidth * outHeight);
-
+		
 		// Draw the overlay *behind* the main view - which means we must blit it to the view.
 		pda_drawOverlay();
-
+		
 		// Finally draw the PDA background and UI controls.
 		lcanvas_eraseRect(&s_viewBounds);
 		lactor_setState(s_pdaArt, 0, 0);
@@ -351,12 +363,16 @@ namespace TFE_DarkForces
 		// Ensure that mouse movements are not lost between updates.
 		pda_handleMouseAccum(&wdx, &wdy);
 
+		// Ensure PDA key presses handle replay data
+		bool mouseDown = TFE_Input::isDemoPlayback() && inputMapping_getAction(IADF_PRIMARY_FIRE) == STATE_DOWN || TFE_Input::mouseDown(MBUTTON_LEFT);
+		bool mousePressed = TFE_Input::isDemoPlayback() && inputMapping_getAction(IADF_PRIMARY_FIRE) == STATE_PRESSED || TFE_Input::mousePressed(MBUTTON_LEFT);
+		
 		// Handle Mouse Panning
-		if (TFE_Input::mouseDown(MBUTTON_LEFT))
+		if (mouseDown)
 		{
 			s32 mouseX, mouseZ;
 			TFE_Input::getMousePos(&mouseX, &mouseZ);
-
+			
 			// Calculate deltas
 			fixed16_16 deltaX = (mouseX - mouseOldPosX) << 16;
 			fixed16_16 deltaZ = (mouseZ - mouseOldPosZ) << 16;
@@ -377,7 +393,7 @@ namespace TFE_DarkForces
 			mouseMoveReset = true;
 		}
 
-		if (TFE_Input::mousePressed(MBUTTON_LEFT) || s_simulatePressed >= 0 || wdy)
+		if (s_simulatePressed >= 0 || wdy || mousePressed)
 		{
 			s_buttonPressed = -1;
 			s32 count = (s_pdaMode == PDA_MODE_MAP || s_pdaMode == PDA_MODE_BRIEF) ? PDA_BTN_COUNT : PDA_BTN_EXIT + 1;
@@ -386,8 +402,8 @@ namespace TFE_DarkForces
 				lactor_setState(s_pdaArt, 2 * (1 + i), 0);
 				LRect buttonRect;
 				lactorAnim_getFrame(s_pdaArt, &buttonRect);
-
-				if (!TFE_Input::mousePressed(MBUTTON_LEFT))
+				
+				if (!TFE_Input::mousePressed(MBUTTON_LEFT) && !mousePressed)
 				{
 					if (i == s_simulatePressed)
 					{
@@ -408,7 +424,7 @@ namespace TFE_DarkForces
 				}
 			}
 
-			if (s_pdaMode == PDA_MODE_MAP && (s_buttonPressed || wdy) && s_frameReady)
+			if (s_pdaMode == PDA_MODE_MAP && (s_buttonPressed || wdy || mousePressed) && s_frameReady)
 			{
 				// Add support for mouse wheel scrolling.
 				if (wdy < 0)
@@ -464,7 +480,7 @@ namespace TFE_DarkForces
 					} break;
 				}
 			}
-			else if (s_pdaMode == PDA_MODE_BRIEF && (s_buttonPressed || wdy) && s_frameReady)
+			else if (s_pdaMode == PDA_MODE_BRIEF && (s_buttonPressed || wdy || mousePressed) && s_frameReady)
 			{
 				// Add support for mouse wheel scrolling.
 				if (wdy > 0) // up
@@ -506,7 +522,7 @@ namespace TFE_DarkForces
 				}
 			}
 		}
-		else if (TFE_Input::mouseDown(MBUTTON_LEFT) && s_buttonPressed >= 0)
+		else if (mouseDown && s_buttonPressed >= 0)
 		{
 			lactor_setState(s_pdaArt, 2 * (1 + s_buttonPressed), 0);
 			LRect buttonRect;
@@ -850,7 +866,7 @@ namespace TFE_DarkForces
 		u32 outWidth, outHeight;
 		vfb_getResolution(&outWidth, &outHeight);
 		memset(vfb_getCpuBuffer(), 0, outWidth * outHeight);
-
+		
 		u32 palette[256] = { 0 };
 		vfb_setPalette(palette);
 	}

TheForceEngine/TFE_DarkForces/GameUI/pda.h

@@ -11,6 +11,7 @@ namespace TFE_DarkForces
 	void pda_start(const char* levelName);
 	void pda_cleanup();
 	void pda_resetState();
+	void pda_resetTab();
 
 	JBool pda_isOpen();
 	void  pda_update();

TheForceEngine/TFE_DarkForces/agent.h

@@ -48,13 +48,15 @@ namespace TFE_DarkForces
 
 	void agent_serialize(Stream* stream);
 	void agent_restartEndLevelTask();
+
 	s32 agent_loadData();
 	JBool agent_loadLevelList(const char* fileName);
 	void  agent_updateAgentSavedData();
 	void  agent_levelEndTask();
-
 	JBool agent_readConfigData(FileStream* file, s32 agentId, LevelSaveData* saveData);
 	JBool agent_writeAgentConfigData(FileStream* file, s32 agentId, const LevelSaveData* saveData);
+	void  agent_writeSavedData(s32 agentId, LevelSaveData* saveData);
+	void  agent_readSavedData(s32 agentId, LevelSaveData* levelData);
 	void  agent_readSavedDataForLevel(s32 agentId, s32 levelIndex);
 	void  agent_saveLevelCompletion(u8 diff, s32 levelIndex);
 	s32   agent_saveInventory(s32 agentId, s32 nextLevel);
@@ -72,6 +74,8 @@ namespace TFE_DarkForces
 
 	void agent_levelComplete();
 	void agent_createLevelEndTask();
+
+	JBool createDarkPilotConfig(const char* path);
 
 	extern AgentData s_agentData[MAX_AGENT_COUNT];
 	extern s32 s_maxLevelIndex;