Overlay: read/write overlay settings to .overlay.ini

course editor should also be written, haven't tested it that much yet though

merged letterboxing & overlay hooks into a single hook, since letterboxing is technically an overlay after all

Author: emoose

OutRun2006Tweaks.ini

@@ -265,23 +265,6 @@ DemonwareServerOverride = clarissa.port0.org
 # Enables OR2006Tweaks overlay
 Enabled = true
 
-# Font scale to use for overlay
-FontScale = 1.5
-
-# How many seconds notifications should show on-screen before being hidden
-# 0 will disable notifications
-NotifyDisplayTime = 7
-
-# Allows checking online services & notifying when new lobbies are created
-NotifyOnlineEnable = true
-
-# How often to check for new lobbies, in seconds
-NotifyOnlineUpdateTime = 20
-
-# Hides notifications during gameplay, either during online races only, or during any race
-# 0 = never hide, 1 = hide during online races, 2 = hide during any race
-NotifyHideMode = 1
-
 [Bugfixes]
 # Fixes looping clop sound effect remaining active through the session.
 FixPegasusClopping = true
@@ -354,4 +337,4 @@ HideOnlineSigninText = false
 25_Shiny_World_prototype.ogg = Shiny World (Prototype)
 26_Night_Flight_prototype.ogg = Night Flight (Prototype)
 27_Life_was_a_Bore_Instrumental.ogg = Life was a Bore (Instrumental)
-28_Night_Flight_Instrumental.ogg = Night Flight (Instrumental)
+28_Night_Flight_Instrumental.ogg = Night Flight (Instrumental)

external/ini-cpp/ini/ini.h

@@ -206,6 +206,9 @@ class INIReader {
     // about the parsing.
     INIReader(std::string filename);
 
+	// Construct INIReader and parse given filepath, unicode paths supported
+	INIReader(const std::filesystem::path& filepath);
+
     // Construct INIReader and parse given file. See ini.h for more info
     // about the parsing.
     INIReader(FILE* file);
@@ -240,20 +243,12 @@ class INIReader {
                              const std::vector<T>& default_v) const;
 
     template <typename T = std::string>
-    void InsertEntry(const std::string& section, const std::string& name,
-                     const T& v);
-
-    template <typename T = std::string>
-    void InsertEntry(const std::string& section, const std::string& name,
-                     const std::vector<T>& vs);
-
-    template <typename T = std::string>
-    void UpdateEntry(const std::string& section, const std::string& name,
-                     const T& v);
+    void Set(const std::string& section, const std::string& name,
+             const T& v);
 
     template <typename T = std::string>
-    void UpdateEntry(const std::string& section, const std::string& name,
-                     const std::vector<T>& vs);
+    void Set(const std::string& section, const std::string& name,
+             const std::vector<T>& vs);
 
    protected:
     int _error;
@@ -290,6 +285,20 @@ inline INIReader::INIReader(std::string filename) {
     ParseError();
 }
 
+/**
+ * @brief Construct an INIReader object from a file path
+ * @param filepath The path of the INI file to parse
+ * @throws std::runtime_error if there is an error parsing the INI file
+ */
+inline INIReader::INIReader(const std::filesystem::path& filepath) {
+	const std::wstring path_str = filepath.wstring();
+	FILE* iniFile;
+	errno_t result = _wfopen_s(&iniFile, path_str.c_str(), L"r");
+	_error = ini_parse_file(iniFile, ValueHandler, this);
+	ParseError();
+	fclose(iniFile);
+}
+
 /**
  * @brief Construct an INIReader object from a file pointer
  * @param file A pointer to the INI file to parse
@@ -461,41 +470,6 @@ inline std::vector<T> INIReader::GetVector(
     };
 }
 
-/**
- * @brief Insert a key-value pair into the INI file
- * @param section The section name
- * @param name The key name
- * @param v The value to insert
- * @throws std::runtime_error if the key already exists in the section
- */
-template <typename T>
-inline void INIReader::InsertEntry(const std::string& section,
-                                   const std::string& name, const T& v) {
-    if (_values[section][name].size() > 0) {
-        throw std::runtime_error("duplicate key '" + std::string(name) +
-                                 "' in section '" + section + "'.");
-    }
-    _values[section][name] = V2String(v);
-}
-
-/**
- * @brief Insert a vector of values into the INI file
- * @param section The section name
- * @param name The key name
- * @param vs The vector of values to insert
- * @throws std::runtime_error if the key already exists in the section
- */
-template <typename T>
-inline void INIReader::InsertEntry(const std::string& section,
-                                   const std::string& name,
-                                   const std::vector<T>& vs) {
-    if (_values[section][name].size() > 0) {
-        throw std::runtime_error("duplicate key '" + std::string(name) +
-                                 "' in section '" + section + "'.");
-    }
-    _values[section][name] = Vec2String(vs);
-}
-
 /**
  * @brief Update a key-value pair in the INI file
  * @param section The section name
@@ -504,12 +478,8 @@ inline void INIReader::InsertEntry(const std::string& section,
  * @throws std::runtime_error if the key does not exist in the section
  */
 template <typename T>
-inline void INIReader::UpdateEntry(const std::string& section,
-                                   const std::string& name, const T& v) {
-    if (!_values[section][name].size()) {
-        throw std::runtime_error("key '" + std::string(name) +
-                                 "' not exist in section '" + section + "'.");
-    }
+inline void INIReader::Set(const std::string& section,
+                           const std::string& name, const T& v) {
     _values[section][name] = V2String(v);
 }
 
@@ -521,9 +491,9 @@ inline void INIReader::UpdateEntry(const std::string& section,
  * @throws std::runtime_error if the key does not exist in the section
  */
 template <typename T>
-inline void INIReader::UpdateEntry(const std::string& section,
-                                   const std::string& name,
-                                   const std::vector<T>& vs) {
+inline void INIReader::Set(const std::string& section,
+                           const std::string& name,
+                           const std::vector<T>& vs) {
     if (!_values[section][name].size()) {
         throw std::runtime_error("key '" + std::string(name) +
                                  "' not exist in section '" + section + "'.");
@@ -604,15 +574,12 @@ class INIWriter {
      * @throws std::runtime_error if the output file already exists or cannot be
      * opened
      */
-    inline static void write(const std::string& filepath,
+    inline static void write(const std::filesystem::path& filepath,
                              const INIReader& reader) {
-        if (struct stat buf; stat(filepath.c_str(), &buf) == 0) {
-            throw std::runtime_error("file: " + filepath + " already exist.");
-        }
         std::ofstream out;
         out.open(filepath);
         if (!out.is_open()) {
-            throw std::runtime_error("cannot open output file: " + filepath);
+            throw std::runtime_error("cannot open output file: " + filepath.string());
         }
         for (const auto& section : reader.Sections()) {
             out << "[" << section << "]\n";

src/dllmain.cpp

@@ -17,6 +17,7 @@ namespace Module
 	constexpr std::string_view IniFileName = "OutRun2006Tweaks.ini";
 	constexpr std::string_view UserIniFileName = "OutRun2006Tweaks.user.ini";
 	constexpr std::string_view LodIniFileName = "OutRun2006Tweaks.lods.ini";
+	constexpr std::string_view OverlayIniFileName = "OutRun2006Tweaks.overlay.ini";
 	constexpr std::string_view LogFileName = "OutRun2006Tweaks.log";
 
 	void init()
@@ -36,6 +37,7 @@ namespace Module
 		IniPath = dllParent / IniFileName;
 		UserIniPath = dllParent / UserIniFileName;
 		LodIniPath = dllParent / LodIniFileName;
+		OverlayIniPath = dllParent / OverlayIniFileName;
 
 		Game::init();
 	}
@@ -128,11 +130,6 @@ namespace Settings
 		spdlog::info(" - DemonwareServerOverride: {}", DemonwareServerOverride);
 
 		spdlog::info(" - OverlayEnabled: {}", OverlayEnabled);
-		spdlog::info(" - OverlayFontScale: {}", OverlayFontScale);
-		spdlog::info(" - OverlayNotifyDisplayTime: {}", OverlayNotifyDisplayTime);
-		spdlog::info(" - OverlayNotifyOnlineEnable: {}", OverlayNotifyOnlineEnable);
-		spdlog::info(" - OverlayNotifyOnlineUpdateTime: {}", OverlayNotifyOnlineUpdateTime);
-		spdlog::info(" - OverlayNotifyHideMode: {}", OverlayNotifyHideMode);
 
 		spdlog::info(" - FixPegasusClopping: {}", FixPegasusClopping);
 		spdlog::info(" - FixRightSideBunkiAnimations: {}", FixRightSideBunkiAnimations);
@@ -260,11 +257,6 @@ namespace Settings
 		DemonwareServerOverride = ini.Get("Misc", "DemonwareServerOverride", DemonwareServerOverride);
 
 		OverlayEnabled = ini.Get("Overlay", "Enabled", OverlayEnabled);
-		OverlayFontScale = ini.Get("Overlay", "FontScale", OverlayFontScale);
-		OverlayNotifyDisplayTime = ini.Get("Overlay", "NotifyDisplayTime", OverlayNotifyDisplayTime);
-		OverlayNotifyOnlineEnable = ini.Get("Overlay", "NotifyOnlineEnable", OverlayNotifyOnlineEnable);
-		OverlayNotifyOnlineUpdateTime = ini.Get("Overlay", "NotifyOnlineUpdateTime", OverlayNotifyOnlineUpdateTime);
-		OverlayNotifyHideMode = ini.Get("Overlay", "NotifyHideMode", OverlayNotifyHideMode);
 
 		FixPegasusClopping = ini.Get("Bugfixes", "FixPegasusClopping", FixPegasusClopping);
 		FixRightSideBunkiAnimations = ini.Get("Bugfixes", "FixRightSideBunkiAnimations", FixRightSideBunkiAnimations);

src/hooks_uiscaling.cpp

@@ -635,117 +635,3 @@ class UIScaling : public Hook
 	static UIScaling instance;
 };
 UIScaling UIScaling::instance;
-
-struct CUSTOMVERTEX
-{
-	FLOAT x, y, z, rhw;
-	D3DCOLOR color;
-};
-#define CUSTOMFVF (D3DFVF_XYZRHW | D3DFVF_DIFFUSE)
-
-class UILetterboxing : public Hook
-{
-	const static int D3DEndSceneCaller_Addr = 0x17D4E;
-
-	inline static IDirect3DVertexBuffer9* VertexBuf = nullptr;
-
-	inline static SafetyHookMid dest_hook = {};
-	static void destination(SafetyHookContext& ctx)
-	{
-		IDirect3DDevice9* d3ddev = Game::D3DDevice();
-
-		if (!VertexBuf)
-		{
-			float screenWidth = float(Game::screen_resolution->x);
-			float screenHeight = float(Game::screen_resolution->y);
-			float contentWidth = screenHeight / (3.f / 4.f);
-			float borderWidth = ((screenWidth - contentWidth) / 2) + 0.5f;
-
-			// Add half-pixel offset so there's no white border...
-			screenHeight = screenHeight + 0.5f;
-			screenWidth = screenWidth + 0.5f;
-
-			CUSTOMVERTEX vertices[] =
-			{
-				// Left border
-				{ -0.5f, -0.5f, 0.0f, 1.0f, D3DCOLOR_XRGB(0, 0, 0) },
-				{ borderWidth, -0.5f, 0.0f, 1.0f, D3DCOLOR_XRGB(0, 0, 0) },
-				{ -0.5f, screenHeight, 0.0f, 1.0f, D3DCOLOR_XRGB(0, 0, 0) },
-				{ borderWidth, screenHeight, 0.0f, 1.0f, D3DCOLOR_XRGB(0, 0, 0) },
-
-				// Right border
-				{ (screenWidth - borderWidth), -0.5f, 0.0f, 1.0f, D3DCOLOR_XRGB(0, 0, 0) },
-				{ screenWidth, -0.5f, 0.0f, 1.0f, D3DCOLOR_XRGB(0, 0, 0) },
-				{ (screenWidth - borderWidth), screenHeight, 0.0f, 1.0f, D3DCOLOR_XRGB(0, 0, 0) },
-				{ screenWidth, screenHeight, 0.0f, 1.0f, D3DCOLOR_XRGB(0, 0, 0) }
-			};
-
-			d3ddev->CreateVertexBuffer(8 * sizeof(CUSTOMVERTEX),
-				0,
-				CUSTOMFVF,
-				D3DPOOL_MANAGED,
-				&VertexBuf,
-				NULL);
-
-			void* pVoid;
-			VertexBuf->Lock(0, 0, &pVoid, 0);
-			memcpy(pVoid, vertices, sizeof(vertices));
-			VertexBuf->Unlock();
-		}
-
-		if (Settings::UILetterboxing == 1 && Game::is_in_game())
-			return; // disable letterboxing while in-game
-
-		// Backup existing cullmode and set to none, otherwise we won't get drawn
-		DWORD prevCullMode = D3DCULL_NONE;
-		d3ddev->GetRenderState(D3DRS_CULLMODE, &prevCullMode);
-		d3ddev->SetRenderState(D3DRS_CULLMODE, D3DCULL_NONE);
-
-		// TODO: not sure if we might need these in future, if game overrides some state during gameplay it may affect letterbox
-#if 0
-		// Set render states
-		d3ddev->SetRenderState(D3DRS_ALPHABLENDENABLE, FALSE);
-		d3ddev->SetRenderState(D3DRS_ZENABLE, D3DZB_FALSE);
-		d3ddev->SetRenderState(D3DRS_LIGHTING, FALSE);
-
-		// Set texture stage states to avoid any texture influence
-		d3ddev->SetTexture(0, NULL);
-		d3ddev->SetTextureStageState(0, D3DTSS_COLOROP, D3DTOP_DISABLE);
-		d3ddev->SetTextureStageState(0, D3DTSS_ALPHAOP, D3DTOP_DISABLE);
-#endif
-
-		// Set FVF and stream source
-		d3ddev->SetFVF(CUSTOMFVF);
-		d3ddev->SetStreamSource(0, VertexBuf, 0, sizeof(CUSTOMVERTEX));
-
-		// Draw left border
-		d3ddev->DrawPrimitive(D3DPT_TRIANGLESTRIP, 0, 2);
-
-		// Draw right border
-		d3ddev->DrawPrimitive(D3DPT_TRIANGLESTRIP, 4, 2);
-
-		// Restore original cullmode
-		d3ddev->SetRenderState(D3DRS_CULLMODE, prevCullMode);
-	}
-
-public:
-	std::string_view description() override
-	{
-		return "UILetterboxing";
-	}
-
-	bool validate() override
-	{
-		return Settings::UILetterboxing > 0 && Settings::UIScalingMode > 0;
-	}
-
-	bool apply() override
-	{
-		dest_hook = safetyhook::create_mid(Module::exe_ptr(D3DEndSceneCaller_Addr), destination);
-
-		return true;
-	}
-
-	static UILetterboxing instance;
-};
-UILetterboxing UILetterboxing::instance;