Merge branch 'Update-Installation-Guides-and-Documentation-and-Bug-Fixes' into bone-hooks

Author: HumabHatterZed

APIPatcher/APIPatcher.csproj

@@ -1,16 +1,26 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFramework>netframework4.7.2</TargetFramework>
+        <TargetFrameworks>netframework4.7.2</TargetFrameworks>
+        <RuntimeIdentifiers>win-x64;win-x86;win-arm64;linux-x64;linux-arm;linux-arm64;linux-musl-x64;linux-musl-arm64;osx-x64;osx-arm64</RuntimeIdentifiers>
+        <AssemblyName>Assembly-CSharp.APIPatcher.mm</AssemblyName>
+        <Description>The MonoMod Patcher for the Inscryption API.</Description>
+        <Version>2.24.2</Version>
+        <Authors>Cyantist, IngoH, WhistleWind, Chaosyr and Contibutors</Authors>
+        <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+        <LangVersion>Latest</LangVersion>
+        <RootNamespace>APIPatcher</RootNamespace>
+        <DebugType>full</DebugType>
+        <NoWarn>$(NoWarn);AD0001;CS0612;CS8604;CS0252;CS0618;Harmony003;Publicizer001</NoWarn>
         <ImplicitUsings>enable</ImplicitUsings>
         <Nullable>disable</Nullable>
-        <LangVersion>latest</LangVersion>
+        <IsPackable>false</IsPackable>
+        <SelfContained>true</SelfContained>
+        <CopyLocalLockFileAssemblies>false</CopyLocalLockFileAssemblies>
+        <IncludeBuildOutput>false</IncludeBuildOutput>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
         <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
-        <TargetName>Assembly-CSharp.APIPatcher.mm</TargetName>
-    </PropertyGroup>
-
-    <PropertyGroup>
-        <NoWarn>$(NoWarn);AD0001;CS0612;CS8604;CS0252;CS0618;Harmony003;Publicizer001</NoWarn>
+        <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
     </PropertyGroup>
 
     <ItemGroup>
@@ -22,4 +32,16 @@
     <ItemGroup>
       <ProjectReference Private="false" Include="..\InscryptionAPI\InscryptionAPI.csproj" />
     </ItemGroup>
+
+    <!--Net Framework References-->
+    <ItemGroup Condition="'$(TargetFramework.TrimEnd(`0123456789`))' == 'net'">
+        <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.2" PrivateAssets="all" />
+    </ItemGroup>
+
+    <!--Cleanup Publish for our Build System-->
+    <Target Name="StripAllNuGetFromPublish" AfterTargets="ComputeFilesToPublish">
+        <ItemGroup>
+            <ResolvedFileToPublish Remove="@(ResolvedFileToPublish)" Condition="'%(ResolvedFileToPublish.Extension)' == '.dll' and '%(ResolvedFileToPublish.RelativePath)' != 'Assembly-CSharp.APIPatcher.mm.dll'" />
+        </ItemGroup>
+    </Target>
 </Project>

APIPatcher/ScriptableObjectLoader.cs

@@ -3,9 +3,16 @@
 
 namespace APIPatcher;
 
+/// <summary>
+/// Uses MonoMod to patch Unity's ScriptableObjectLoader to also use our version of the ScriptableObjectLoader seen in the Inscryption API itself.
+/// </summary>
+/// <typeparam name="T"></typeparam>
 [MonoModPatch("global::ScriptableObjectLoader`1")]
 internal class patch_ScriptableObjectLoader<T> : ScriptableObjectLoader<T> where T : UnityObject
 {
+    /// <summary>
+    /// A List of AllData used within the overarching <see cref="ScriptableObjectLoader{T}"/> system, e.g. a List of <see cref="UnityObject"/>.
+    /// </summary>
     new public static List<T> AllData
     {
         get

APIPatcher/Singleton.cs

@@ -4,9 +4,16 @@
 
 namespace APIPatcher;
 
+/// <summary>
+/// Uses MonoMod to patch the Singleton for later usability by the Inscryption API.
+/// </summary>
+/// <typeparam name="T">A ManagedBehaviour associated with the Singleton System.</typeparam>
 [MonoModPatch("global::Singleton`1")]
 internal class patch_Singleton<T> : Singleton<T> where T : ManagedBehaviour
 {
+    /// <summary>
+    /// A simple function used to Find a Specified UnityObject of the specified Type within the Active Scene, if it fails it tosses a Warning.
+    /// </summary>
     new protected static void FindInstance()
     {
         if (m_Instance == null)
@@ -21,7 +28,13 @@ internal class patch_Singleton<T> : Singleton<T> where T : ManagedBehaviour
     }
 }
 
+/// <summary>
+/// A simple class object for singletons in correlation with the API.
+/// </summary>
 internal static class Singleton
 {
+    /// <summary>
+    /// A ManualLogSource specifically for logging issues related to Singletons.
+    /// </summary>
     internal static readonly ManualLogSource SingletonLogSource = Logger.CreateLogSource("Singleton");
 }

CHANGELOG.md

@@ -1,3 +1,15 @@
+# 2.24.2
+* Updated Installation Guides to Include Pulsar Mod Manager.
+* Added more null checks into the following patches `GainGemsForOpponents`, `LoseGemsForOpponents`, `GainTripleGemsForOpponents`, `LoseTripleGemsForOpponents`.
+* Removed `_specialSequencer` from `SpecialSequenceManager` as it was unused.
+* Removed `FontReplacementDataInitialized` from `LocalizationManager` as it was unused.
+* Added new Support for Custom Appearances.
+    - Image Handling is to be handled by the mods using the API.
+    - We now provide a storage of Base Game Decals that mods can reference without needing to instantiate their own.
+    - This comes with 5 new Dictionaries `BaseGameCustomAppearances` (Internal), `BaseGameCustomAppearancesPublic`, `ModdedCustomAppearancesDictionary` (Internal), `ModdedCustomAppearancesDictionaryPublic`, `CombinedCustomAppearancesDictionaryPublic`.
+    - This system is stored under the `TextureHelper` class.
+* Improved In-Code Documentation via XML Comments.
+
 # 2.24.1
 - Added Extensions for setting the IconTexture of a Starter Deck.
 - Added 2 Alternate Constructors for making a StarterDeck with a Display Name different from its Internal Name.