Merge pull request #335 from BUTR/dev

v2.8.1

.github/workflows/docfx.yml

@@ -22,30 +22,25 @@ env:
 
 jobs:
   docfx:
-    name: DocFX documentation
+    name: DocFX Documentation
     runs-on: ubuntu-latest
     steps:
     - name: DocFX Setup
-      uses: butr/actions-docfx-setup@v3.0
+      uses: butr/actions-docfx-setup@v3
       with:
         github-token: ${{secrets.GITHUB_TOKEN}}
 
     - name: Build Bannerlord.ButterLib
-      run: >-
-        dotnet build src/Bannerlord.ButterLib/Bannerlord.ButterLib.csproj;
+      run: dotnet build src/Bannerlord.ButterLib/Bannerlord.ButterLib.csproj;
       shell: pwsh
 
     - name: Run DocFX
       run: >-
         Copy-Item "README.md" -Destination "docs/index.md";
-        if ($${{runner.os == 'Windows'}}) {
-          docfx.console/tools/docfx.exe metadata docs/docfx.json;
-          docfx.console/tools/docfx.exe build docs/docfx.json;
-        }
-        else {
-          mono docfx.console/tools/docfx.exe metadata docs/docfx.json;
-          mono docfx.console/tools/docfx.exe build docs/docfx.json;
-        }
+        New-Item -Type dir "docs/images";
+        Copy-Item "resources/BUTR48.svg" -Destination "docs/images/BUTR48.svg";
+        docfx metadata docs/docfx.json;
+        docfx build docs/docfx.json;
       shell: pwsh
 
     - name: Deploy DocFX

.github/workflows/test-full.yml

@@ -37,7 +37,7 @@ jobs:
     runs-on: windows-latest
     steps:
     - name: Tests Setup
-      uses: butr/actions-tests-setup@v1.5.6
+      uses: butr/actions-tests-setup@v1
       with:
         github-token: ${{secrets.GITHUB_TOKEN}}
 
@@ -71,7 +71,7 @@ jobs:
       shell: pwsh
 
     - name: ReportGenerator
-      uses: danielpalme/[email protected].19
+      uses: danielpalme/[email protected].22
       with:
         reports: '*.xml'
         targetdir: 'coveragereport'
@@ -86,7 +86,7 @@ jobs:
         path: coveragereport
 
     - name: Upload ReportGenerator to CodeCov
-      uses: codecov/[email protected].1
+      uses: codecov/[email protected].4
       with:
         token: ${{secrets.CODECOV_TOKEN}}
         file: coveragereport/Cobertura.xml

.github/workflows/test.yml

@@ -38,7 +38,7 @@ jobs:
     runs-on: windows-latest
     steps:
     - name: Tests Setup
-      uses: butr/actions-tests-setup@v1.5.6
+      uses: butr/actions-tests-setup@v1
       with:
         github-token: ${{secrets.GITHUB_TOKEN}}
         steam-login: ${{secrets.STEAM_LOGIN}}
@@ -77,7 +77,7 @@ jobs:
       shell: pwsh
 
     - name: ReportGenerator
-      uses: danielpalme/[email protected].19
+      uses: danielpalme/[email protected].22
       with:
         reports: 'coverage_butterlib_stable_debug.xml;coverage_butterlib_stable_release.xml;coverage_butterlib_impl_stable_debug.xml;coverage_butterlib_impl_stable_release.xml;coverage_butterlib_impl_beta_debug.xml;coverage_butterlib_impl_beta_release.xml;'
         targetdir: 'coveragereport'
@@ -92,7 +92,7 @@ jobs:
         path: coveragereport
 
     - name: Upload ReportGenerator to CodeCov
-      uses: codecov/[email protected].1
+      uses: codecov/[email protected].4
       with:
         token: ${{secrets.CODECOV_TOKEN}}
         file: coveragereport/Cobertura.xml

build/common.props

@@ -4,7 +4,7 @@
   <!--Development Variables-->
   <PropertyGroup>
     <!--Module Version-->
-    <Version>2.8.0</Version>
+    <Version>2.8.1</Version>
     <!--Harmony Version-->
     <HarmonyVersion>2.2.2</HarmonyVersion>
     <HarmonyExtensionsVersion>3.2.0.77</HarmonyExtensionsVersion>
@@ -13,9 +13,9 @@
     <!--Serilog depends on abstraction 2.0.0, and since we can't do app redirects, we're stuck with that-->
     <ExtensionVersion>2.0.0</ExtensionVersion>
     <!--BuildResources Version-->
-    <BuildResourcesVersion>1.0.1.92</BuildResourcesVersion>
-    <BUTRSharedVersion>3.0.0.135</BUTRSharedVersion>
-    <BUTRModuleManagerVersion>5.0.198</BUTRModuleManagerVersion>
+    <BuildResourcesVersion>1.1.0.102</BuildResourcesVersion>
+    <BUTRSharedVersion>3.0.0.136</BUTRSharedVersion>
+    <BUTRModuleManagerVersion>5.0.209</BUTRModuleManagerVersion>
   </PropertyGroup>
 
   <PropertyGroup>

changelog.txt

@@ -1,4 +1,8 @@
 ---------------------------------------------------------------------------------------------------
+Version: 2.8.1
+Game Versions: v1.0.0,v1.0.1,v1.0.2,v1.0.3,v1.1.0,v1.1.1,v1.1.2,v1.1.3,v1.1.4,v1.1.5,v1.2.0
+* Added support for v1.2.0
+---------------------------------------------------------------------------------------------------
 Version: 2.8.0
 Game Versions: v1.0.0,v1.0.1,v1.0.2,v1.0.3,v1.1.0,v1.1.1,v1.1.2
 * Switched back to Lib.Harmony

docs/CNAME

@@ -0,0 +1 @@
+butterlib.butr.link

docs/articles/AssemblyVerifier/toc.yml

@@ -0,0 +1,3 @@
+- name: Overview
+  href: Overview.md
+

docs/articles/CampaignIdentifier/Overview.md

@@ -1,3 +1,7 @@
+> [!IMPORTANT]
+> This SubSystem is obsolete!
+>
+
 [``CampaignIdentifier``](xref:Bannerlord.ButterLib.CampaignIdentifier) associates unique string ID with every campaign basing on the initial character.
 ```csharp
 // Get current campaign ID

docs/articles/CampaignIdentifier/toc.yml

@@ -0,0 +1,3 @@
+- name: Overview
+  href: Overview.md
+

docs/articles/Common/Extensions/Overview.md

@@ -7,11 +7,10 @@
 ### [``DependencyInjectionExtensions``](xref:Bannerlord.ButterLib.Common.Extensions.DependencyInjectionExtensions)
 
 
-### [``DictionaryExtensions``](xref:Bannerlord.ButterLib.Common.Extensions.DictionaryExtensions)
-
-
 ### [``ICampaignExtensions``](xref:Bannerlord.ButterLib.Common.Extensions.ICampaignExtensions)
 
 
+### [``IInputContextExtensions``](xref:Bannerlord.ButterLib.Common.Extensions.IInputContextExtensions)
+
+
 ### [``MbEventExtensions``](xref:Bannerlord.ButterLib.Common.Extensions.MbEventExtensions)
-

docs/articles/Common/Extensions/toc.yml

@@ -0,0 +1,3 @@
+- name: Overview
+  href: Overview.md
+

docs/articles/Common/Helpers/Overview.md

@@ -1,20 +1,5 @@
-### [``AccessTools2``](xref:Bannerlord.ButterLib.Common.Helpers.AccessTools2)
-Gives the ability to get a ``Delegate`` from a method. 
-
-### [``SymbolExtensions2``](xref:Bannerlord.ButterLib.Common.Helpers.SymbolExtensions2)
-
-
-### [``AlphanumComparatorFast``](xref:Bannerlord.ButterLib.Common.Helpers.AlphanumComparatorFast)
-Alphanumeric sort. This sorting algorithm logically handles numbers in strings. It makes sense to humans.  
-
-### [``ApplicationVersionUtils``](xref:Bannerlord.ButterLib.Common.Helpers.ApplicationVersionUtils)
+### [``ApplicationVersionComparer``](xref:Bannerlord.ButterLib.Common.Helpers.ApplicationVersionComparer)
 
 
 ### [``ElegantPairHelper``](xref:Bannerlord.ButterLib.Common.Helpers.ElegantPairHelper)
 
-
-### [``LocalizationHelper``](xref:Bannerlord.ButterLib.Common.Helpers.LocalizationHelper)
-A number of useful methods to work with [``TextObjects``](xref:TaleWorlds.Localization.TextObject) for easier and more efficient localization.
-
-### [``ModuleInfoHelper``](xref:Bannerlord.ButterLib.Common.Helpers.ModuleInfoHelper)
-

docs/articles/Common/Helpers/toc.yml

@@ -0,0 +1,3 @@
+- name: Overview
+  href: Overview.md
+

docs/articles/Common/toc.yml

@@ -1,7 +1,7 @@
 - name: Extensions
-  href: Extensions/
+  href: Extensions/toc.yml
   homepage: Extensions/Overview.md
 
 - name: Helpers
-  href: Helpers/
+  href: Helpers/toc.yml
   homepage: Helpers/Overview.md

docs/articles/DelayedSubModule/toc.yml

@@ -0,0 +1,3 @@
+- name: Overview
+  href: Overview.md
+

docs/articles/Development/toc.yml

@@ -0,0 +1,3 @@
+- name: Overview
+  href: Overview.md
+

docs/articles/DistanceMatrix/toc.yml

@@ -0,0 +1,3 @@
+- name: Overview
+  href: Overview.md
+

docs/articles/HotKeys/toc.yml

@@ -0,0 +1,3 @@
+- name: Overview
+  href: Overview.md
+

docs/articles/MBSubModuleBaseExtended/toc.yml

@@ -0,0 +1,3 @@
+- name: Overview
+  href: Overview.md
+

docs/articles/Optional/toc.yml

@@ -1,6 +1,4 @@
 - name: Dependency Injection
   href: DependencyInjection/toc.yml
-  homepage: DependencyInjection/Overview.md
 - name: Logging
   href: Logging/toc.yml
-  homepage: Logging/Overview.md

docs/articles/SaveSystem/toc.yml

@@ -0,0 +1,3 @@
+- name: Overview
+  href: Overview.md
+

docs/articles/SubModuleWrappers/toc.yml

@@ -0,0 +1,3 @@
+- name: Overview
+  href: Overview.md
+

docs/articles/toc.yml

@@ -1,41 +1,32 @@
 - name: Development
-  href: Development/
-  homepage: Development/Overview.md
+  href: Development/toc.yml
 
 - name: AssemblyVerifier
-  href: AssemblyVerifier/
-  homepage: AssemblyVerifier/Overview.md
+  href: AssemblyVerifier/toc.yml
 
 - name: Common
   href: Common/toc.yml
 
 - name: DelayedSubModule
-  href: DelayedSubModule/
-  homepage: DelayedSubModule/Overview.md
+  href: DelayedSubModule/toc.yml
 
 - name: CampaignIdentifier
-  href: CampaignIdentifier/
-  homepage: CampaignIdentifier/Overview.md
+  href: CampaignIdentifier/toc.yml
 
 - name: DistanceMatrix
-  href: DistanceMatrix/
-  homepage: DistanceMatrix/Overview.md
+  href: DistanceMatrix/toc.yml
 
 - name: HotKeys
-  href: HotKeys/
-  homepage: HotKeys/Overview.md
+  href: HotKeys/toc.yml
 
 - name: MBSubModuleBaseExtended
-  href: MBSubModuleBaseExtended/
-  homepage: MBSubModuleBaseExtended/Overview.md
+  href: MBSubModuleBaseExtended/toc.yml
 
 - name: Optional
   href: Optional/toc.yml
 
 - name: SaveSystem
-  href: SaveSystem/
-  homepage: SaveSystem/Overview.md
+  href: SaveSystem/toc.yml
 
 - name: SubModuleWrappers
-  href: SubModuleWrappers/
-  homepage: SubModuleWrappers/Overview.md
+  href: SubModuleWrappers/toc.yml

docs/docfx.json

@@ -20,46 +20,32 @@
     ],
     "content": [
       {
-        "files": [
-          "api/**.yml",
-          "api/index.md"
-        ]
-      },
-      {
-        "files": [
-          "articles/**.md",
-          "articles/**/toc.yml",
-          "toc.yml",
-          "*.md"
-        ]
+        "files": [ "**/**.{md,yml}" ],
+        "exclude": [ "_site/**", "obj/**" ]
       }
     ],
     "resource": [
       {
-        "files": [
-		  "langwordMapping.yml",
-          "images/**"
-        ]
-      },
-      {
-        "src": "../",
-        "files": [ "resources/**" ]
+        "files": [ "**/images/**", "codesnippet/**", "CNAME" ],
+        "exclude": [ "_site/**", "obj/**" ]
       }
     ],
-    "overwrite": [ ],
     "dest": "_site",
     "globalMetadata": {
       "_enableSearch": "true",
+      "_appLogoPath": "images/BUTR48.svg",
+      "_appName": "ButterLib",
       "_appTitle": "ButterLib Documentation",
-      "_appFooter": "© 2020 BUTR",
+      "_appFooter": "© 2020-2023 Bannerlord's Unofficial Tools & Resources"
     },
     "globalMetadataFiles": [],
     "fileMetadataFiles": [],
     "template": [
       "default",
-      "_template/dark-theme"
+      "modern"
     ],
-    "postProcessors": ["ExtractSearchIndex"],
-    "markdownEngineName": "markdig"
+    "postProcessors": [
+      "ExtractSearchIndex"
+    ]
   }
 }