Mod upgrade pipeline (#91)

* Create ModUpgradePipeline modding patch. This patch will store and use mods' versions when running SaveUpgradePipeline scripts. * Go back to storing versions for all assemblies. Bump KSPCF version to minor, not revision. * Fix readme to link PR
KSPModdingLibs · Dec 7, 2022 · 565302e · 565302e
1 parent 1596a17
commit 565302e
Show file tree

Hide file tree

Showing 6 changed files with 496 additions and 4 deletions.
diff --git a/GameData/KSPCommunityFixes/KSPCommunityFixes.version b/GameData/KSPCommunityFixes/KSPCommunityFixes.version
@@ -2,7 +2,7 @@
   "NAME": "KSPCommunityFixes",
   "URL": "https://raw.githubusercontent.com/KSPModdingLibs/KSPCommunityFixes/master/GameData/KSPCommunityFixes/KSPCommunityFixes.version",
   "DOWNLOAD": "https://github.com/KSPModdingLibs/KSPCommunityFixes/releases",
-  "VERSION": {"MAJOR": 1, "MINOR": 21, "PATCH": 1, "BUILD": 0},
+  "VERSION": {"MAJOR": 1, "MINOR": 22, "PATCH": 0, "BUILD": 0},
   "KSP_VERSION": {"MAJOR": 1, "MINOR": 12, "PATCH": 3},
   "KSP_VERSION_MIN": {"MAJOR": 1, "MINOR": 8, "PATCH": 0},
   "KSP_VERSION_MAX": {"MAJOR": 1, "MINOR": 12, "PATCH": 3}

diff --git a/GameData/KSPCommunityFixes/Settings.cfg b/GameData/KSPCommunityFixes/Settings.cfg
@@ -325,6 +325,11 @@ KSP_COMMUNITY_FIXES
   // Fix Admin Building not using HeadImage if that is defined for a Department
   DepartmentHeadImage = true
 
+  // Stores mod versions in sfs and craft files, and uses those versions for the SaveUpgradePipeline,
+  // so mods can do versioning based on their own version numbers and not have to always run their
+  // upgrade scripts.
+  ModUpgradePipeline = false
+
   // ##########################
   // Localization tools
   // ##########################

diff --git a/KSPCommunityFixes/KSPCommunityFixes.csproj b/KSPCommunityFixes/KSPCommunityFixes.csproj
@@ -87,6 +87,7 @@
   <ItemGroup>
     <Publicize Include="Assembly-CSharp" />
     <DoNotPublicize Include="Assembly-CSharp:BaseField`1.OnValueModified" />
+    <DoNotPublicize Include="Assembly-CSharp:SaveUpgradePipeline.SaveUpgradePipeline.OnSetCfgNodeVersion" />
     <Publicize Include="UnityEngine.CoreModule:UnityEngine.Object.m_CachedPtr" />
     <Publicize Include="mscorlib:System.Reflection.Assembly.GetTypes" />
   </ItemGroup>
@@ -99,6 +100,7 @@
     <Compile Include="BugFixes\CometMiningNotRemovingMass.cs" />
     <Compile Include="BugFixes\EnginePlateAirstreamShieldedTopPart.cs" />
     <Compile Include="BugFixes\StrategyDuration.cs" />
+    <Compile Include="Modding\ModUpgradePipeline.cs" />
     <Compile Include="Performance\AsteroidAndCometDrillCache.cs" />
     <Compile Include="BugFixes\DoubleCurvePreserveTangents.cs" />
     <Compile Include="Performance\CommNetThrottling.cs" />