Door keys (#530)

* Fix for remaster darkpilo.cfg which is not located in the game folder.

* Add for linux compatibility

* Update Linux pathing.

* fix for nix paths

* change the path path based on testing on proton.

* Add map colors POC

---------

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

Author: ifeldshteyn

TheForceEngine/TFE_DarkForces/automap.cpp

@@ -8,9 +8,11 @@
 #include <TFE_Jedi/Level/rwall.h>
 #include <TFE_Jedi/Memory/list.h>
 #include <TFE_Jedi/InfSystem/infSystem.h>
+#include <TFE_Jedi/InfSystem/infTypesInternal.h>
 #include <TFE_Jedi/Renderer/jediRenderer.h>
 #include <TFE_Jedi/Renderer/screenDraw.h>
 #include <TFE_Jedi/Serialization/serialization.h>
+#include <TFE_Settings/settings.h>
 
 using namespace TFE_Jedi;
 
@@ -35,6 +37,14 @@ namespace TFE_DarkForces
 		MOBJCOLOR_SCENERY  = 21,
 	};
 
+	enum MapKeyColor
+	{
+		KEY_COLOR_RED = 6,
+		KEY_COLOR_BLUE = 17,
+		// Not sure which yellow to use which overlaps with elevators (19). 
+		KEY_COLOR_YELLOW = 20
+	};
+
 	enum MapConstants
 	{
 		MOBJSPRITE_DRAW_LEN = FIXED(2)
@@ -489,9 +499,31 @@ namespace TFE_DarkForces
 		automap_drawLine(x0, z0, x1, z1, color);
 	}
 
+	// Note it assumes the wall adjoins a door sector
+	u8 getDoorKeyColor(RWall* wall)
+	{	
+		KeyItem key = (KeyItem)sector_getKey(wall->sector);
+		if (key == KEY_NONE)
+		{
+			key = (KeyItem)sector_getKey(wall->nextSector);	
+		}
+		switch (key)
+		{
+			case KEY_YELLOW:
+				return KEY_COLOR_YELLOW;
+			case KEY_RED:
+				return KEY_COLOR_RED;
+			case KEY_BLUE:
+				return KEY_COLOR_BLUE;
+			default:
+				return WCOLOR_DOOR;
+		}
+	}
+
 	u8 automap_getWallColor(RWall* wall)
 	{
 		u8 color;
+		bool showKeyDoors = TFE_Settings::getGameSettings()->df_showKeyColors;
 		if (wall->flags1 & WF1_HIDE_ON_MAP)
 		{
 			color = WCOLOR_INVISIBLE;
@@ -508,7 +540,11 @@ namespace TFE_DarkForces
 		{
 			color = WCOLOR_NORMAL;
 		}
-		else if (sector_isDoor(wall->sector) || sector_isDoor(wall->nextSector))
+		else if (showKeyDoors && (sector_getKey(wall->nextSector) || sector_getKey(wall->sector)))
+		{
+			color = getDoorKeyColor(wall);
+		}		
+		else if (sector_isDoor(wall->sector) || sector_isDoor(wall->nextSector) )
 		{
 			color = WCOLOR_DOOR;
 		}

TheForceEngine/TFE_FrontEndUI/frontEndUi.cpp

@@ -1230,6 +1230,12 @@ namespace TFE_FrontEndUI
 			gameSettings->df_autoEndMission = autoEndMission;
 		}
 
+		bool showKeyColors = gameSettings->df_showKeyColors;
+		if (ImGui::Checkbox("Show the key color of the door on the map", &showKeyColors))
+		{
+			gameSettings->df_showKeyColors = showKeyColors;
+		}
+
 		ImGui::Separator();
 
 		ImGui::PushFont(s_versionFont);

TheForceEngine/TFE_Jedi/InfSystem/infSystem.cpp

@@ -3835,4 +3835,15 @@ namespace TFE_Jedi
 		}
 		return JFALSE;
 	}
+
+	u8 sector_getKey(RSector* sector)
+	{
+		InfLink* link = (InfLink*)allocator_getHead(sector->infLink);
+		if (link && link->type == LTYPE_SECTOR)
+		{
+			InfElevator* elev = link->elev;
+			return elev->key;			
+		}
+		return KEY_NONE;
+	}
 }

TheForceEngine/TFE_Jedi/InfSystem/infSystem.h

@@ -87,4 +87,5 @@ namespace TFE_Jedi
 	void inf_sendLinkMessages(Allocator* infLink, SecObject* entity, u32 evt, MessageType msgType);
 
 	JBool sector_isDoor(RSector* sector);
+	u8 sector_getKey(RSector* sector);
 }

TheForceEngine/TFE_Settings/settings.cpp

@@ -545,6 +545,7 @@ namespace TFE_Settings
 		writeKeyValue_Bool(settings, "df_enableRecordingAll", s_gameSettings.df_enableRecordingAll);
 		writeKeyValue_Bool(settings, "df_demologging", s_gameSettings.df_demologging);
 		writeKeyValue_Bool(settings, "df_autoNextMission", s_gameSettings.df_autoEndMission);
+		writeKeyValue_Bool(settings, "df_showKeyColors", s_gameSettings.df_showKeyColors);
 	}
 
 	void writePerGameSettings(FileStream& settings)
@@ -1206,6 +1207,10 @@ namespace TFE_Settings
 		{
 			s_gameSettings.df_autoEndMission = parseBool(value);
 		}
+		else if (strcasecmp("df_showKeyColors", key) == 0)
+		{
+			s_gameSettings.df_showKeyColors = parseBool(value);
+		}
 	}
 
 	void parseOutlawsSettings(const char* key, const char* value)

TheForceEngine/TFE_Settings/settings.h

@@ -227,7 +227,8 @@ struct TFE_Settings_Game
 	bool df_enableReplay = false;       // Enable replay of gameplay.
 	bool df_showReplayCounter = false;  // Show the replay counter on the HUD.
 	bool df_demologging = false;        // Log the record/playback logging
-	bool df_autoEndMission = false;    // Automatically skip to the next mission
+	bool df_autoEndMission = false;     // Automatically skip to the next mission
+	bool df_showKeyColors = false;      // Shows the door key color on the minimap
 	s32  df_recordFrameRate = 4;        // Recording Framerate value
 	s32  df_playbackFrameRate = 2;      // Playback Framerate value
 	PitchLimit df_pitchLimit  = PITCH_VANILLA_PLUS;