Merge pull request #1081 from PlayEveryWare/fix/steam-integration

paulhazen · web-flow · commit 94769f659e87 · 2025-01-13T10:17:44.000-08:00
fix: Restore Steam Integration
diff --git a/Assets/Plugins/Windows/x64/DynamicLibraryLoaderHelper-x64.dll b/Assets/Plugins/Windows/x64/DynamicLibraryLoaderHelper-x64.dll
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:b2566815097f8df84c3481ef36648226a4f184744154e19335eb58b643c53f15
+oid sha256:969153308fe56d512c998509226a5a84918b8624c4691f06345a434396d136a7
 size 122880
diff --git a/Assets/Plugins/Windows/x64/GfxPluginNativeRender-x64.dll b/Assets/Plugins/Windows/x64/GfxPluginNativeRender-x64.dll
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:5984497fc9cb68e8dd2d25dc8e6fe45b8322d282f88b82b1bfe6eea3c10d7732
-size 592896
+oid sha256:fcd9618285bb1bf56c72f46f64e228cda95aa27e64ea2a0199d649dbfebd8c10
+size 604672
diff --git a/Assets/Plugins/Windows/x86/DynamicLibraryLoaderHelper-x86.dll b/Assets/Plugins/Windows/x86/DynamicLibraryLoaderHelper-x86.dll
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:1926250dbc34f8519f4fab17ca42aea9808bbd6472fe7f6490bf4a40fe7fb7ed
+oid sha256:cf018202e613caa46f9f32301f728a6386cfb9b3c036b0f4b300725336f4e5e1
 size 87040
diff --git a/Assets/Plugins/Windows/x86/GfxPluginNativeRender-x86.dll b/Assets/Plugins/Windows/x86/GfxPluginNativeRender-x86.dll
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:feb614c1f35aa2339572866a481cb293924701dd3970922170537cd518f1743a
-size 457728
+oid sha256:361b0b0201d2b0afbf8f982cd529faa6cf148aeb7e9d303df7dff7854b61414f
+size 467968
diff --git a/lib/NativeCode/DynamicLibraryLoaderHelper/Directory.Build.props b/lib/NativeCode/DynamicLibraryLoaderHelper/Directory.Build.props
@@ -15,12 +15,19 @@
     <NormalizedPlatform Condition="'$(Platform)' == 'x86' or '$(Platform)' == 'Win32'">x86</NormalizedPlatform>
     <NormalizedPlatform Condition="'$(Platform)' == 'x64'">x64</NormalizedPlatform>
     
-    <!-- 
+    <EOS_SDK_DLL_NAME Condition="'$(NormalizedPlatform)' == 'x64'">EOSSDK-Win64-Shipping.dll</EOS_SDK_DLL_NAME>
+    <STEAM_API_DLL_NAME Condition="'$(NormalizedPlatform)' == 'x64'">steam_api64.dll</STEAM_API_DLL_NAME>
+
+    <EOS_SDK_DLL_NAME Condition="'$(NormalizedPlatform)' == 'x86'">EOSSDK-Win32-Shipping.dll</EOS_SDK_DLL_NAME>
+    <STEAM_API_DLL_NAME Condition="'$(NormalizedPlatform)' == 'x86'">steam_api.dll</STEAM_API_DLL_NAME>
+
+      <!-- 
       Define a property with the SolutionDir path but with backslashes replaced 
       by forward slashes 
       -->
     <SolutionDirForwardSlashes>$(SolutionDir.Replace('\', '/'))</SolutionDirForwardSlashes>
     <UnityStreamingAssetsDirectory>$(SolutionDirForwardSlashes)../../../Assets/StreamingAssets/</UnityStreamingAssetsDirectory>
-    <OutputUnityAssetsDirectory>$(SolutionDir)..\..\..\Assets\Plugins\Windows\$(NormalizedPlatform)\</OutputUnityAssetsDirectory>
+    <SteamLibraryDirectory>$(SolutionDirForwardSlashes)../../../Library/PackageCache/com.rlabrecque.steamworks.net*/Plugins/</SteamLibraryDirectory>
+    <OutputUnityAssetsDirectory>$(SolutionDirForwardSlashes)../../../Assets/Plugins/Windows/$(NormalizedPlatform)/</OutputUnityAssetsDirectory>
   </PropertyGroup>
 </Project>
diff --git a/lib/NativeCode/DynamicLibraryLoaderHelper/NativeRender/NativeRender.vcxproj b/lib/NativeCode/DynamicLibraryLoaderHelper/NativeRender/NativeRender.vcxproj
@@ -81,23 +81,16 @@
       <PreprocessorDefinitions>PEW_EOS_EXPORT;OVERLAY_DLL_NAME="$(OverlayDllName)";STEAM_API_DLL="$(SteamApiDll)";SDK_DLL_NAME="$(SdkDllName)";CONFIG_DIRECTORY="$(ConfigDirectory)";_DEBUG;NATIVERENDER_EXPORTS;_WINDOWS;_USRDLL;%(PreprocessorDefinitions)</PreprocessorDefinitions>
     </ClCompile>
     <PreBuildEvent>
-      <!-- When debugging, make sure to copy the EOSSDK Dll to the output directory -->
-      <Command>
-        @echo Copying "$(OutputUnityAssetsDirectory)$(SdkDllName)" to "$(TargetDir)"
-        copy "$(OutputUnityAssetsDirectory)$(SdkDllName)" "$(TargetDir)" /Y
-      </Command>
+      <!-- Execute the prebuild powershell command -->
+      <Command>powershell -NoProfile -ExecutionPolicy Bypass -File "$(ProjectDir)scripts\prebuild.ps1" -Configuration "$(Configuration)" -OutputUnityAssetsDirectory "$(OutputUnityAssetsDirectory)" -EOS_SDK_DLL_NAME "$(EOS_SDK_DLL_NAME)" -STEAM_API_DLL_NAME "$(STEAM_API_DLL_NAME)" -TargetDir $(TargetDir) -SteamLibraryDirectory "$(SteamLibraryDirectory)" -SolutionDir "$(SolutionDir)"</Command>
     </PreBuildEvent>
     <PostBuildEvent>
       <!-- Copy the meta file stored in the solution directory, since it's values have been properly set in such a way that Unity interacts with the DLL in the intended manner. -->
-      <Command>
-        @echo Copying "$(SolutionDir)$(ProjectName)-$(NormalizedPlatform).dll.meta" to "$(OutputUnityAssetsDirectory)"
-        copy $(SolutionDir)$(ProjectName)-$(NormalizedPlatform).dll.meta $(OutputUnityAssetsDirectory) /Y
-      </Command>
+      <Command>@echo Copying "$(SolutionDir)$(ProjectName)-$(NormalizedPlatform).dll.meta" to "$(OutputUnityAssetsDirectory)"
+copy $(SolutionDir)$(ProjectName)-$(NormalizedPlatform).dll.meta $(OutputUnityAssetsDirectory) /Y</Command>
       <!-- Copy the output files into the appropriate assets directory alongside the aforementioned .dll.meta file.-->
-      <Command>
-        @echo Copying "$(TargetDir)$(ProjectName)-$(NormalizedPlatform)*" to "$(OutputUnityAssetsDirectory)"
-        copy "$(TargetDir)$(ProjectName)*" "$(OutputUnityAssetsDirectory)" /Y
-      </Command>
+      <Command>@echo Copying "$(TargetDir)$(ProjectName)-$(NormalizedPlatform)*" to "$(OutputUnityAssetsDirectory)"
+copy "$(TargetDir)$(ProjectName)*" "$(OutputUnityAssetsDirectory)" /Y</Command>
     </PostBuildEvent>
   </ItemDefinitionGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)'=='Release'">
diff --git a/lib/NativeCode/DynamicLibraryLoaderHelper/NativeRender/include/Config/SteamConfig.hpp b/lib/NativeCode/DynamicLibraryLoaderHelper/NativeRender/include/Config/SteamConfig.hpp
@@ -107,15 +107,23 @@ namespace pew::eos::config
             steam_sdk_major_version(0),
             steam_sdk_minor_version(0)
         {
-            // TODO: Restore STEAM_SDK_DLL_NAME
-            //_library_path = common::get_path_relative_to_current_module(STEAM_SDK_DLL_NAME);
+            _library_path = io_helpers::get_path_relative_to_current_module(STEAM_SDK_DLL_NAME);
         }
 
         void parse_json_element(const std::string& name, json_value_s& value) override
         {
             if (name == "overrideLibraryPath")
             {
-              // TODO: Make sure this is applied appropriately.
+                const auto override_library_path_element = json_value_as_string(&value);
+                if (override_library_path_element == nullptr)
+                {
+                    return;
+                }
+                const char* path = override_library_path_element->string;
+                if (!string_helpers::is_empty_or_whitespace(path))
+                {
+                    _library_path = path;
+                }
             }
             else if (name == "steamSDKMajorVersion")
             {
diff --git a/lib/NativeCode/DynamicLibraryLoaderHelper/NativeRender/include/string_helpers.h b/lib/NativeCode/DynamicLibraryLoaderHelper/NativeRender/include/string_helpers.h
@@ -146,5 +146,12 @@ namespace pew::eos::string_helpers
      * @return A UTF-8 encoded `std::string` representation of the path.
      */
     std::string to_utf8_str(const std::filesystem::path& path);
+
+    /**
+     * @brief Determines if a given C string is either empty or contains only whitespace characters.
+     * @param str The string to check.
+     * @return True if the string is empty or contains only whitespace characters.
+     */
+    bool is_empty_or_whitespace(const char* str);
 }
 #endif
diff --git a/lib/NativeCode/DynamicLibraryLoaderHelper/NativeRender/pch.h b/lib/NativeCode/DynamicLibraryLoaderHelper/NativeRender/pch.h
@@ -33,6 +33,12 @@
 #include "eos_sdk.h"
 #include "Windows/eos_Windows.h"
 
+#if _WIN64
+#define STEAM_SDK_DLL_NAME "steam_api64.dll"
+#elif _WIN32
+#define STEAM_SDK_DLL_NAME "steam_api.dll"
+#endif
+
 #define SHOW_DIALOG_BOX_ON_WARN 0
 #define ENABLE_DLL_BASED_EOS_CONFIG 1
 #define XAUDIO2_DLL_NAME "xaudio2_9redist.dll"
diff --git a/lib/NativeCode/DynamicLibraryLoaderHelper/NativeRender/scripts/prebuild.ps1 b/lib/NativeCode/DynamicLibraryLoaderHelper/NativeRender/scripts/prebuild.ps1
@@ -0,0 +1,35 @@
+param(
+  [string]$Configuration,
+  [string]$OutputUnityAssetsDirectory,
+  [string]$EOS_SDK_DLL_NAME,
+  [string]$STEAM_API_DLL_NAME,
+  [string]$TargetDir,
+  [string]$SteamLibraryDirectory,
+  [string]$SolutionDir
+)
+
+Write-Host "=============== Start of Prebuild Script =========================="
+
+# If in debug mode, we want to copy the eos sdk dll, the steam app id file, and
+# The steam DLL into the output directory
+if ($Configuration -eq "Debug")
+{
+  $filesToCopy = @(
+    (Join-Path $SolutionDir "..\..\..\steam_appid.txt"),
+    (Join-Path $SteamLibraryDirectory $STEAM_API_DLL_NAME),
+    (Join-Path $OutputUnityAssetsDirectory $EOS_SDK_DLL_NAME)
+  )
+
+  $filesToCopy | ForEach-Object {
+    if (-Not(Test-Path -LiteralPath $_)) {
+      Write-Host ("WARNING: Could not copy file '{0}' because it does not exist. This might not be a problem." -f $_);
+      continue
+    }
+
+    $itemBeingCopied = Get-Item $_;
+    Write-Host ('Copying file "{0}" to "{1}".' -f $itemBeingCopied.FullName, $TargetDir);
+    Copy-Item -LiteralPath $itemBeingCopied.FullName -Destination $TargetDir -Force;
+  }
+}
+
+Write-Host "=============== End of Prebuild Script =========================="
diff --git a/lib/NativeCode/DynamicLibraryLoaderHelper/NativeRender/src/eos_helpers.cpp b/lib/NativeCode/DynamicLibraryLoaderHelper/NativeRender/src/eos_helpers.cpp
@@ -44,7 +44,17 @@ namespace pew::eos
     {
         return eos_library_helpers::eos_platform_handle;
     }
-    
+
+    typedef bool(__cdecl* SteamAPI_Init_t)();
+
+    /**
+     * @brief Initializes the steam api using the given function name.
+     * @param steam_dll_handle Pointer to the steam dll 
+     * @param function_name The name of the function to initialize with.
+     * @return True if the steam api was initialized, false otherwise.
+     */
+    static bool initialize_steam_api(void* steam_dll_handle, const std::string& function_name);
+
     /**
      * @brief Loads and initializes the Steam API DLL using a string path.
      *
@@ -245,35 +255,41 @@ namespace pew::eos
             "attempting to load a pointer to the SteamAPI_Init function from "
             "within it.");
 
-        // TODO: Typedef should be moved outside the scope of the function?
-        typedef bool(__cdecl* SteamAPI_Init_t)();
+        // Usage
+        if (!initialize_steam_api(steam_dll_handle, "SteamAPI_InitSafe"))
+        {
+            // Retry with "SteamAPI_Init" if "SteamAPI_InitSafe" fails.
+            initialize_steam_api(steam_dll_handle, "SteamAPI_Init");
+        }
+    }
 
-        // Get a pointer to the SteamAPI_Init function within the steam
-        // library.
-        const auto SteamAPI_Init = pew::eos::eos_library_helpers::load_function_with_name<SteamAPI_Init_t>(steam_dll_handle, "SteamAPI_Init");
+    static bool initialize_steam_api(void* steam_dll_handle, const std::string& function_name)
+    {
+        // Get a pointer to the specified SteamAPI_Init function within the steam library.
+        const auto SteamAPI_Init_Fn = pew::eos::eos_library_helpers::load_function_with_name<SteamAPI_Init_t>(steam_dll_handle, function_name.c_str());
 
-        // If the SteamAPI_Init function pointer is null, then it was not
-        // correctly retrieved from the steam library. Log an error and stop
-        if (SteamAPI_Init == nullptr)
+        // If the function pointer is null, log an error and return false.
+        if (SteamAPI_Init_Fn == nullptr)
         {
             logging::log_error(
-                "Could not load a pointer to the SteamAPI_Init "
-                "function within the loaded steam library handle.");
-            return;
+                "Could not load a pointer to the " + function_name +
+                " function within the loaded steam library handle.");
+            return false;
         }
 
-        if (SteamAPI_Init())
+        // Attempt to initialize Steam and log the result.
+        if (SteamAPI_Init_Fn())
         {
-            logging::log_inform("SteamAPI_Init returned true. "
-                "Steam has been initialized.");
+            logging::log_inform(function_name + " returned true. Steam has been initialized.");
+            return true;
         }
         else
         {
-            logging::log_error(
-                "SteamAPI_Init returned false. Steam was not able "
-                "to be initialized.");
+            logging::log_error(function_name + " returned false. Steam was not able to be initialized.");
+            return false;
         }
     }
+    
 
     void apply_steam_settings(EOS_Platform_Options& platform_options) 
     {
@@ -373,7 +389,7 @@ namespace pew::eos
 
         platform_options.RTCOptions = platform_config.get_platform_rtc_options().get();
 
-        // TODO-STEAM: enable apply_steam_settings(platform_options);
+        apply_steam_settings(platform_options);
 
         return platform_options;
     }
diff --git a/lib/NativeCode/DynamicLibraryLoaderHelper/NativeRender/src/string_helpers.cpp b/lib/NativeCode/DynamicLibraryLoaderHelper/NativeRender/src/string_helpers.cpp
@@ -151,4 +151,22 @@ namespace pew::eos::string_helpers
     {
         return to_utf8_str(path.native());
     }
+
+    bool is_empty_or_whitespace(const char* str)
+    {
+        if (str == nullptr) 
+        {
+            return true; // Treat null as empty
+        }
+
+        while (*str != '\0') 
+        {
+            if (!std::isspace(static_cast<unsigned char>(*str))) 
+            {
+                return false; // Found a non-whitespace character
+            }
+            ++str;
+        }
+        return true; // All characters were whitespace or the string was empty
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -107,15 +107,23 @@ namespace pew::eos::config`
`107`	`107`	`steam_sdk_major_version(0),`
`108`	`108`	`steam_sdk_minor_version(0)`
`109`	`109`	`{`
`110`		`- // TODO: Restore STEAM_SDK_DLL_NAME`
`111`		`- //_library_path = common::get_path_relative_to_current_module(STEAM_SDK_DLL_NAME);`
	`110`	`+ _library_path = io_helpers::get_path_relative_to_current_module(STEAM_SDK_DLL_NAME);`
`112`	`111`	`}`
`113`	`112`
`114`	`113`	`void parse_json_element(const std::string& name, json_value_s& value) override`
`115`	`114`	`{`
`116`	`115`	`if (name == "overrideLibraryPath")`
`117`	`116`	`{`
`118`		`- // TODO: Make sure this is applied appropriately.`
	`117`	`+ const auto override_library_path_element = json_value_as_string(&value);`
	`118`	`+ if (override_library_path_element == nullptr)`
	`119`	`+ {`
	`120`	`+ return;`
	`121`	`+ }`
	`122`	`+ const char* path = override_library_path_element->string;`
	`123`	`+ if (!string_helpers::is_empty_or_whitespace(path))`
	`124`	`+ {`
	`125`	`+ _library_path = path;`
	`126`	`+ }`
`119`	`127`	`}`
`120`	`128`	`else if (name == "steamSDKMajorVersion")`
`121`	`129`	`{`