Cleanup new game data system and provide fallbacks to default sigs (#177)

Author: yonilerner

README.md

@@ -26,6 +26,22 @@ This plugin is made to run alongside B3none's retakes implementation: https://gi
     - `mp_afterroundmoney 65535`
     - More info about this in the "Buy Menu" section below
 
+## Game Data/Signatures (Optional Information)
+This section is optional. If you dont care, you can skip it. The defaults are fine.
+
+This plugin relies on some function signatures that:
+- Regularly break with game updates:
+  - `GetCSWeaponDataFromKey`
+  - `CCSPlayer_ItemServices_CanAcquire`
+- Are not included in the default CS# signatures:
+  - `GiveNamedItem2`
+
+Custom game data signatures are maintained in https://github.com/yonilerner/cs2-retakes-allocator/blob/main/Resources/RetakesAllocator_gamedata.json. There are a few ways to keep these up to date:
+- If you want the plugin to automatically download the signatures, you can do so by running the plugin with the `AutoUpdateSignatures` config set to `true`. **This is the recommended approach**. See more below in the "Configuration" section.
+- If you want to manually download the signatures, you can do so by downloading the `RetakesAllocator_gamedata.json` file from Github and placing it in the `RetakesAllocator/gamedata` folder in the plugin. You may have to create that folder if it does not exist.
+
+If you do not want to use any custom game data/signatures, you can disable `AutoUpdateSignatures` and `CapabilityWeaponPaints`. If you do this (and if you previously had downloaded custom game data, make sure to delete the `RetakesAllocator/gamedata/RetakesAllocator_gamedata.json` file), the plugin will fallback to using the default CS# signatures. See more below in the "Configuration" section.
+
 ## Usage
 
 ### Round Types
@@ -311,6 +327,8 @@ room for it*.
 - `UseOnTickFeatures`: Set to false if you want better performance and dont want any OnTick features, including:
   - Bombsite center announcement
   - Advanced gun menu
+- `AutoUpdateSignatures `: When true, the plugin will always try to download the latest custom game data/signatures on startup. A game server restart may be required to apply the new signatures after they have been downloaded. If this is disabled, the plugin will fallback to using the default CS# game data/signatures.
+- `CapabilityWeaponPaints`: When true, will try to use the custom game data `GiveNamedItem2` that will maintain weapon paints in non-standard situations. This is enabled by default for backwards compatibility, but is less stable. If this option is enabled, `AutoUpdateSignatures` should also be enabled. If you dont want to use `AutoUpdateSignatures`, at least ensure that the custom game data/signatures are updated correctly, since this `GiveNamedItem2` is not in the default game data/signatures.
 
 ### Commands
 

RetakesAllocator/CustomGameData.cs

@@ -5,69 +5,95 @@
 using RetakesAllocatorCore;
 using CounterStrikeSharp.API.Modules.Memory.DynamicFunctions;
 using System.Text.Json;
+// ReSharper disable InconsistentNaming
 
 namespace RetakesAllocator;
 
 public class CustomGameData
 {
-    public static Dictionary<string, Dictionary<OSPlatform, string>> _customGameData = new();
-    private readonly MemoryFunctionVoid<IntPtr, string, IntPtr, IntPtr, IntPtr, IntPtr, IntPtr, IntPtr> GiveNamedItem2;
-    public readonly MemoryFunctionWithReturn<CCSPlayer_ItemServices, CEconItemView, AcquireMethod, NativeObject, AcquireResult> CCSPlayer_ItemServices_CanAcquireFunc;
-    public readonly MemoryFunctionWithReturn<int, string, CCSWeaponBaseVData> GetCSWeaponDataFromKeyFunc;
+    private static readonly Dictionary<string, Dictionary<OSPlatform, string>> _customGameData = new();
+    private MemoryFunctionVoid<IntPtr, string, IntPtr, IntPtr, IntPtr, IntPtr, IntPtr, IntPtr>? GiveNamedItem2;
+    public MemoryFunctionWithReturn<CCSPlayer_ItemServices, CEconItemView, AcquireMethod, NativeObject, AcquireResult>? CCSPlayer_ItemServices_CanAcquireFunc;
+    public MemoryFunctionWithReturn<int, string, CCSWeaponBaseVData>? GetCSWeaponDataFromKeyFunc;
 
     public CustomGameData()
     {
-        LoadCustomGameDataFromJson();
-        
-        GiveNamedItem2 = new(GetCustomGameDataKey("GiveNamedItem2"));
-        CCSPlayer_ItemServices_CanAcquireFunc = new(GetCustomGameDataKey("CCSPlayer_ItemServices_CanAcquire"));
-        GetCSWeaponDataFromKeyFunc = new(GetCustomGameDataKey("GetCSWeaponDataFromKey"));
+        LoadCustomGameData();
     }
-    public void LoadCustomGameDataFromJson()
+
+    public void LoadCustomGameData()
     {
-        string jsonFilePath = $"{Configs.Shared.Module}/../../plugins/RetakesAllocator/gamedata/RetakesAllocator_gamedata.json";
-        if (!File.Exists(jsonFilePath))
+        if (Configs.Shared.Module == null)
         {
-            Log.Debug($"JSON file does not exist at path: {jsonFilePath}. Returning without loading custom game data.");
+            Log.Error("Module path is null. Returning without loading custom game data.");
             return;
         }
-        
-        try
+        var jsonFilePath = Path.Combine(Configs.Shared.Module, "gamedata/RetakesAllocator_gamedata.json");
+        if (File.Exists(jsonFilePath))
         {
-            var jsonData = File.ReadAllText(jsonFilePath);
-            var jsonDocument = JsonDocument.Parse(jsonData);
-            
-            foreach (var element in jsonDocument.RootElement.EnumerateObject())
+            try
             {
-                string key = element.Name;
+                var jsonData = File.ReadAllText(jsonFilePath);
+                var jsonDocument = JsonDocument.Parse(jsonData);
+            
+                foreach (var element in jsonDocument.RootElement.EnumerateObject())
+                {
+                    string key = element.Name;
 
-                var platformData = new Dictionary<OSPlatform, string>();
+                    var platformData = new Dictionary<OSPlatform, string>();
 
-                if (element.Value.TryGetProperty("signatures", out var signatures))
-                {
-                    if (signatures.TryGetProperty("windows", out var windows))
+                    if (element.Value.TryGetProperty("signatures", out var signatures))
                     {
-                        platformData[OSPlatform.Windows] = windows.GetString()!;
-                    }
+                        if (signatures.TryGetProperty("windows", out var windows))
+                        {
+                            platformData[OSPlatform.Windows] = windows.GetString()!;
+                        }
 
-                    if (signatures.TryGetProperty("linux", out var linux))
-                    {
-                        platformData[OSPlatform.Linux] = linux.GetString()!;
+                        if (signatures.TryGetProperty("linux", out var linux))
+                        {
+                            platformData[OSPlatform.Linux] = linux.GetString()!;
+                        }
                     }
+                    _customGameData[key] = platformData;
                 }
-                _customGameData[key] = platformData;
+            }
+            catch (Exception ex)
+            {
+                Log.Error($"Error loading custom game data: {ex.Message}");
             }
         }
-        catch (Exception ex)
+        else
         {
-            Log.Debug($"Error loading custom game data: {ex.Message}");
+            Log.Debug($"JSON file does not exist at path: {jsonFilePath}. Returning without loading custom game data.");
         }
+        
+        try
+        {
+            GiveNamedItem2 = new(GetCustomGameDataKey("GiveNamedItem2"));
+        }
+        catch
+        {
+            // GiveNamedItem2 failing to load shouldnt crash because we will try to fallback to GiveNamedItem
+        }
+        GetCSWeaponDataFromKeyFunc = new(GetCustomGameDataKey("GetCSWeaponDataFromKey"));
+        CCSPlayer_ItemServices_CanAcquireFunc = new(GetCustomGameDataKey("CCSPlayer_ItemServices_CanAcquire"));
     }
 
     private string GetCustomGameDataKey(string key)
     {
         if (!_customGameData.TryGetValue(key, out var customGameData))
         {
+            try
+            {
+                var defaultGameData = GameData.GetSignature(key);
+                Log.Info($"Using default gamedata for {key} because no custom data was found.");
+                return defaultGameData;
+            }
+            catch
+            {
+                // ignored
+            }
+
             throw new Exception($"Invalid key {key}");
         }
 
@@ -90,6 +116,11 @@ private string GetCustomGameDataKey(string key)
             : throw new Exception($"Missing custom data for {key} on {platform}");
     }
 
+    public bool PlayerGiveNamedItemEnabled()
+    {
+        return GiveNamedItem2 != null;
+    }
+
     public void PlayerGiveNamedItem(CCSPlayerController player, string item)
     {
         if (!player.PlayerPawn.IsValid) return;
@@ -98,7 +129,7 @@ public void PlayerGiveNamedItem(CCSPlayerController player, string item)
         if (player.PlayerPawn.Value.ItemServices == null) return;
 
         // Log.Debug("Using custom function for GiveNamedItem2");
-        GiveNamedItem2.Invoke(player.PlayerPawn.Value.ItemServices.Handle, item, 0, 0, 0, 0, 0, 0);
+        GiveNamedItem2?.Invoke(player.PlayerPawn.Value.ItemServices.Handle, item, 0, 0, 0, 0, 0, 0);
     }
 }
 

RetakesAllocator/Helpers.cs

@@ -203,18 +203,23 @@ public static bool IsWindows()
 
     public static bool IsVip(CCSPlayerController player) => AdminManager.PlayerHasPermissions(player, "@css/vip");
 
-    public static async Task DownloadMissingFiles()
+    public static async Task<bool> DownloadMissingFiles()
     {
+        if (!Configs.GetConfigData().AutoUpdateSignatures)
+        {
+            return false;
+        }
         string baseFolderPath = Configs.Shared.Module!;
 
         string gamedataFileName = "gamedata/RetakesAllocator_gamedata.json";
         string gamedataGithubUrl = "https://raw.githubusercontent.com/yonilerner/cs2-retakes-allocator/main/Resources/RetakesAllocator_gamedata.json";
         string gamedataFilePath = Path.Combine(baseFolderPath, gamedataFileName);
         string gamedataDirectoryPath = Path.GetDirectoryName(gamedataFilePath)!;
-        await CheckAndDownloadFile(gamedataFilePath, gamedataGithubUrl, gamedataDirectoryPath);
+        
+        return await CheckAndDownloadFile(gamedataFilePath, gamedataGithubUrl, gamedataDirectoryPath);
     }
 
-    public static async Task<bool> CheckAndDownloadFile(string filePath, string githubUrl, string directoryPath)
+    private static async Task<bool> CheckAndDownloadFile(string filePath, string githubUrl, string directoryPath)
     {
         if (!File.Exists(filePath))
         {
@@ -225,26 +230,19 @@ public static async Task<bool> CheckAndDownloadFile(string filePath, string gith
             await DownloadFileFromGithub(githubUrl, filePath);
             return true;
         }
-        else
+
+        bool isFileDifferent = await IsFileDifferent(filePath, githubUrl);
+        if (isFileDifferent)
         {
-            if (Configs.GetConfigData().AutoUpdateSignatures)
-            {
-                bool isFileDifferent = await IsFileDifferent(filePath, githubUrl);
-                if (isFileDifferent)
-                {
-                    File.Delete(filePath);
-                    await DownloadFileFromGithub(githubUrl, filePath);
-                    return true;
-                }
-            }
-            
+            File.Delete(filePath);
+            await DownloadFileFromGithub(githubUrl, filePath);
+            return true;
         }
 
         return false;
     }
 
-
-    public static async Task<bool> IsFileDifferent(string localFilePath, string githubUrl)
+    private static async Task<bool> IsFileDifferent(string localFilePath, string githubUrl)
     {
         try
         {
@@ -260,12 +258,12 @@ public static async Task<bool> IsFileDifferent(string localFilePath, string gith
         }
         catch (Exception ex)
         {
-            Log.Debug($"Error comparing files: {ex.Message}");
+            Log.Warn($"Error comparing files: {ex.Message}");
             return false;
         }
     }
 
-    public static string GetFileHash(byte[] fileBytes)
+    private static string GetFileHash(byte[] fileBytes)
     {
         using (var md5 = System.Security.Cryptography.MD5.Create())
         {
@@ -274,7 +272,7 @@ public static string GetFileHash(byte[] fileBytes)
         }
     }
 
-    public static async Task DownloadFileFromGithub(string url, string destinationPath)
+    private static async Task DownloadFileFromGithub(string url, string destinationPath)
     {
         using (HttpClient client = new HttpClient())
         {
@@ -285,7 +283,7 @@ public static async Task DownloadFileFromGithub(string url, string destinationPa
             }
             catch (Exception ex)
             {
-                Log.Debug($"Error downloading file: {ex.Message}");
+                Log.Warn($"Error downloading file: {ex.Message}");
             }
         }
     }