feat: added GameVersions to the API

Valheim-Modding · Jul 17, 2024 · 91c2183 · 91c2183
1 parent 7b36835
commit 91c2183
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # Changelog
 
 ## Version 2.21.0
+* Added GameVersions utility to check for specific game versions
 * Added ConfigManagerUtils for soft access to common ConfigurationManager functionality
 * Added PieceManager.AddPieceCategory(string name) and PieceManager.RemovePieceCategory(string name)
 * Deprecated PieceManager.AddPieceCategory(string table, string name) and PieceManager.RemovePieceCategory(string table, string name), use the new overloads without the table parameter

diff --git a/JotunnLib/Utils/GameVersions.cs b/JotunnLib/Utils/GameVersions.cs
@@ -5,10 +5,19 @@
 
 namespace Jotunn.Utils
 {
-    internal static class GameVersions
+    /// <summary>
+    ///     Utility class for getting game versions
+    /// </summary>
+    public static class GameVersions
     {
+        /// <summary>
+        ///     The semantic version of the running Valheim game
+        /// </summary>
         public static System.Version ValheimVersion { get; } = GetValheimVersion();
 
+        /// <summary>
+        ///     The network version of the running Valheim game, determining compatibility with other clients
+        /// </summary>
         public static uint NetworkVersion { get; } = GetNetworkVersion();
 
         private static System.Version GetValheimVersion()