From ad7b600345778d0f4c699c439c23f12b26169e9e Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Tue, 17 Nov 2026 11:14:55 -0500 Subject: [PATCH 01/37] Try Fix Doc Bugs --- .../api_wiki/ManagedReference.extension.js | 52 ++++++++++++------- .../ManagedReference.html.primary.tmpl | 26 ++++++++++ .../partials/class.header.tmpl.partial | 24 ++++++--- 3 files changed, 77 insertions(+), 25 deletions(-) create mode 100644 docs/template/api_wiki/ManagedReference.html.primary.tmpl diff --git a/docs/template/api_wiki/ManagedReference.extension.js b/docs/template/api_wiki/ManagedReference.extension.js index a59b870c..9ccebc40 100644 --- a/docs/template/api_wiki/ManagedReference.extension.js +++ b/docs/template/api_wiki/ManagedReference.extension.js @@ -1,23 +1,16 @@ - exports.postTransform = function (model) { - console.log("ManagedReference.extension.js EXECUTED"); - console.log("Root model: " + JSON.stringify(model)); - setMemberFlags(model); - return model; }; function setMemberFlags(item, inheritedType) { if (!item || typeof item !== 'object') return; - // Determine the current item's declaration type. var t = item.type ? String(item.type).toLowerCase() : inheritedType; - // DocFX member-group containers identify their children - // through properties such as inMethod, inProperty, etc. + // Member-group containers carry their kind in typePropertyName (inMethod, ...) if (item.typePropertyName) { var groupType = String(item.typePropertyName) .replace(/^in/, '') @@ -28,15 +21,25 @@ function setMemberFlags(item, inheritedType) { } } - // Container / Type declarations + // ---- Declaration kinds ------------------------------------------------- + // postTransform runs AFTER ManagedReference.common.js's transform, which + // already set isClass = true for class/struct/interface/delegate because + // ManagedReference.html.primary.tmpl dispatches on isClass. Setting + // isClass = (t === 'class') here would clobber that and blank every + // interface, struct and delegate page. Mirror common.js instead. item.isNamespace = (t === 'namespace'); - item.isClass = (t === 'class'); + item.isClass = ( + t === 'class' || + t === 'struct' || + t === 'interface' || + t === 'delegate' + ); item.isStruct = (t === 'struct'); item.isInterface = (t === 'interface'); item.isEnum = (t === 'enum'); item.isDelegate = (t === 'delegate'); - // Member declarations + // ---- Member kinds ------------------------------------------------------ item.isConstructor = (t === 'constructor'); item.isMethod = (t === 'method'); item.isProperty = (t === 'property'); @@ -44,13 +47,28 @@ function setMemberFlags(item, inheritedType) { item.isEvent = (t === 'event'); item.isOperator = (t === 'operator'); - // Useful grouped helpers + // ---- in* flags, as consumed by the partials ({{#inClass}}, {{#inEnum}}) -- + // common.js sets these only on the root and on group containers. Emit them + // here too so the partials never depend on transform order. + item.inNamespace = (t === 'namespace'); + item.inClass = (t === 'class'); + item.inStruct = (t === 'struct'); + item.inInterface = (t === 'interface'); + item.inEnum = (t === 'enum'); + item.inDelegate = (t === 'delegate'); + + item.inConstructor = (t === 'constructor'); + item.inMethod = (t === 'method'); + item.inProperty = (t === 'property'); + item.inField = (t === 'field'); + item.inEvent = (t === 'event'); + item.inOperator = (t === 'operator'); + + // ---- Aggregates -------------------------------------------------------- item.isType = ( item.isClass || - item.isStruct || - item.isInterface || item.isEnum || - item.isDelegate + item.isNamespace ); item.isMember = ( @@ -62,8 +80,6 @@ function setMemberFlags(item, inheritedType) { item.isOperator ); - // Recursively process nested models. - // Pass the current group type down to its children. if (Array.isArray(item.children)) { item.children.forEach(function (child) { setMemberFlags(child, t); @@ -75,4 +91,4 @@ function setMemberFlags(item, inheritedType) { setMemberFlags(child, t); }); } -} +} \ No newline at end of file diff --git a/docs/template/api_wiki/ManagedReference.html.primary.tmpl b/docs/template/api_wiki/ManagedReference.html.primary.tmpl new file mode 100644 index 00000000..56288236 --- /dev/null +++ b/docs/template/api_wiki/ManagedReference.html.primary.tmpl @@ -0,0 +1,26 @@ +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} +{{!master(layout/_master.tmpl)}} + +{{#isNamespace}} + {{>partials/namespace}} +{{/isNamespace}} + +{{#_splitReference}} +{{#isClass}} + {{>partials/class.memberpage}} +{{/isClass}} +{{/_splitReference}} + +{{^_splitReference}} +{{^isEnum}} +{{#isType}} + {{>partials/class}} +{{/isType}} +{{/isEnum}} +{{/_splitReference}} + +{{#isEnum}} + {{>partials/enum}} +{{/isEnum}} + +{{>partials/customMREFContent}} \ No newline at end of file diff --git a/docs/template/api_wiki/partials/class.header.tmpl.partial b/docs/template/api_wiki/partials/class.header.tmpl.partial index 1405c1ff..a413dd75 100644 --- a/docs/template/api_wiki/partials/class.header.tmpl.partial +++ b/docs/template/api_wiki/partials/class.header.tmpl.partial @@ -212,13 +212,23 @@ {{/extensionMethods.0}} {{#extensionMethods}} -
- {{#definition}} - - {{/definition}} - {{^definition}} - - {{/definition}} +
+
+ {{#definition}} + + {{/definition}} + {{^definition}} + + {{/definition}} +
+ {{#specName.0.value}} +
+
{{{specName.0.value}}}
+
+ {{/specName.0.value}} + {{#summary}} +
{{{summary}}}
+ {{/summary}}
{{/extensionMethods}} From 48b313e4cd3665ca3610f8ccfc75bd4f5d4c69b8 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Tue, 17 Nov 2026 11:20:27 -0500 Subject: [PATCH 02/37] Remove Namespace from Aggregate --- docs/template/api_wiki/ManagedReference.extension.js | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/template/api_wiki/ManagedReference.extension.js b/docs/template/api_wiki/ManagedReference.extension.js index 9ccebc40..2206836f 100644 --- a/docs/template/api_wiki/ManagedReference.extension.js +++ b/docs/template/api_wiki/ManagedReference.extension.js @@ -67,8 +67,7 @@ function setMemberFlags(item, inheritedType) { // ---- Aggregates -------------------------------------------------------- item.isType = ( item.isClass || - item.isEnum || - item.isNamespace + item.isEnum ); item.isMember = ( From b677e4c5091541a19893c460ae9138ab2612a6c5 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Tue, 17 Nov 2026 11:33:46 -0500 Subject: [PATCH 03/37] Make summary match the correct extension --- .../api_wiki/ManagedReference.extension.js | 59 +++++++++++++++++++ .../partials/class.header.tmpl.partial | 22 +++---- 2 files changed, 71 insertions(+), 10 deletions(-) diff --git a/docs/template/api_wiki/ManagedReference.extension.js b/docs/template/api_wiki/ManagedReference.extension.js index 2206836f..f59bb320 100644 --- a/docs/template/api_wiki/ManagedReference.extension.js +++ b/docs/template/api_wiki/ManagedReference.extension.js @@ -1,8 +1,67 @@ exports.postTransform = function (model) { + var uidLookup = {}; + buildUidLookup(model, uidLookup); + setMemberFlags(model); + setExtensionMethodSummaries(model, uidLookup); + return model; }; +function buildUidLookup(item, lookup) { + if (!item || typeof item !== 'object') return; + + if (item.uid) { + lookup[String(item.uid)] = item; + } + + if (Array.isArray(item.children)) { + item.children.forEach(function (child) { + buildUidLookup(child, lookup); + }); + } + + if (Array.isArray(item.items)) { + item.items.forEach(function (child) { + buildUidLookup(child, lookup); + }); + } +} + +function setExtensionMethodSummaries(item, uidLookup) { + if (!item || typeof item !== 'object') return; + + if (Array.isArray(item.extensionMethods)) { + item.extensionMethods.forEach(function (extensionMethod) { + if (!extensionMethod || typeof extensionMethod !== 'object') return; + + var definitionUid = extensionMethod.definition || extensionMethod.uid; + + if (!definitionUid) return; + + var definition = uidLookup[String(definitionUid)]; + + if (!definition) return; + + if (definition.summary) { + extensionMethod.summary = definition.summary; + } + }); + } + + if (Array.isArray(item.children)) { + item.children.forEach(function (child) { + setExtensionMethodSummaries(child, uidLookup); + }); + } + + if (Array.isArray(item.items)) { + item.items.forEach(function (child) { + setExtensionMethodSummaries(child, uidLookup); + }); + } +} + function setMemberFlags(item, inheritedType) { if (!item || typeof item !== 'object') return; diff --git a/docs/template/api_wiki/partials/class.header.tmpl.partial b/docs/template/api_wiki/partials/class.header.tmpl.partial index a413dd75..c92d1701 100644 --- a/docs/template/api_wiki/partials/class.header.tmpl.partial +++ b/docs/template/api_wiki/partials/class.header.tmpl.partial @@ -207,28 +207,30 @@

Extension Methods (Click me to Expand)

-

The following are methods in which you can use that act as extensions to this type:

+

The following are methods which can be used as extensions to this type:

{{/extensionMethods.0}} {{#extensionMethods}}
- {{#definition}} - - {{/definition}} - {{^definition}} - - {{/definition}} + {{#definition}} + + {{/definition}} + {{^definition}} + + {{/definition}}
+ + {{#summary}} +
{{{summary}}}
+ {{/summary}} + {{#specName.0.value}}
{{{specName.0.value}}}
{{/specName.0.value}} - {{#summary}} -
{{{summary}}}
- {{/summary}}
{{/extensionMethods}} From 9ee39a62f4ad5506213ada4e62271001dc18d176 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Tue, 17 Nov 2026 11:46:40 -0500 Subject: [PATCH 04/37] Fix Extension Summaries --- .../api_wiki/ManagedReference.extension.js | 59 ------------------- .../partials/class.header.tmpl.partial | 13 +--- .../partials/extensionMethod.summary.tmpl | 3 + 3 files changed, 6 insertions(+), 69 deletions(-) create mode 100644 docs/template/api_wiki/partials/extensionMethod.summary.tmpl diff --git a/docs/template/api_wiki/ManagedReference.extension.js b/docs/template/api_wiki/ManagedReference.extension.js index f59bb320..2206836f 100644 --- a/docs/template/api_wiki/ManagedReference.extension.js +++ b/docs/template/api_wiki/ManagedReference.extension.js @@ -1,67 +1,8 @@ exports.postTransform = function (model) { - var uidLookup = {}; - buildUidLookup(model, uidLookup); - setMemberFlags(model); - setExtensionMethodSummaries(model, uidLookup); - return model; }; -function buildUidLookup(item, lookup) { - if (!item || typeof item !== 'object') return; - - if (item.uid) { - lookup[String(item.uid)] = item; - } - - if (Array.isArray(item.children)) { - item.children.forEach(function (child) { - buildUidLookup(child, lookup); - }); - } - - if (Array.isArray(item.items)) { - item.items.forEach(function (child) { - buildUidLookup(child, lookup); - }); - } -} - -function setExtensionMethodSummaries(item, uidLookup) { - if (!item || typeof item !== 'object') return; - - if (Array.isArray(item.extensionMethods)) { - item.extensionMethods.forEach(function (extensionMethod) { - if (!extensionMethod || typeof extensionMethod !== 'object') return; - - var definitionUid = extensionMethod.definition || extensionMethod.uid; - - if (!definitionUid) return; - - var definition = uidLookup[String(definitionUid)]; - - if (!definition) return; - - if (definition.summary) { - extensionMethod.summary = definition.summary; - } - }); - } - - if (Array.isArray(item.children)) { - item.children.forEach(function (child) { - setExtensionMethodSummaries(child, uidLookup); - }); - } - - if (Array.isArray(item.items)) { - item.items.forEach(function (child) { - setExtensionMethodSummaries(child, uidLookup); - }); - } -} - function setMemberFlags(item, inheritedType) { if (!item || typeof item !== 'object') return; diff --git a/docs/template/api_wiki/partials/class.header.tmpl.partial b/docs/template/api_wiki/partials/class.header.tmpl.partial index c92d1701..e58070d5 100644 --- a/docs/template/api_wiki/partials/class.header.tmpl.partial +++ b/docs/template/api_wiki/partials/class.header.tmpl.partial @@ -207,24 +207,17 @@

Extension Methods (Click me to Expand)

-

The following are methods which can be used as extensions to this type:

+

The following are methods which can be used as extensions to this type:

{{/extensionMethods.0}} {{#extensionMethods}}
- {{#definition}} - - {{/definition}} - {{^definition}} - - {{/definition}} +
- {{#summary}} -
{{{summary}}}
- {{/summary}} + {{#specName.0.value}}
diff --git a/docs/template/api_wiki/partials/extensionMethod.summary.tmpl b/docs/template/api_wiki/partials/extensionMethod.summary.tmpl new file mode 100644 index 00000000..064f6a87 --- /dev/null +++ b/docs/template/api_wiki/partials/extensionMethod.summary.tmpl @@ -0,0 +1,3 @@ +{{#summary}} +
{{{summary}}}
+{{/summary}} \ No newline at end of file From 66b72cc18fc44e1a645490748afbeee760afb69e Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Tue, 17 Nov 2026 11:50:59 -0500 Subject: [PATCH 05/37] Extension stuff --- docs/template/api_wiki/ManagedReference.extension.js | 7 +++++++ docs/template/api_wiki/partials/class.header.tmpl.partial | 7 ++++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/template/api_wiki/ManagedReference.extension.js b/docs/template/api_wiki/ManagedReference.extension.js index 2206836f..1feda089 100644 --- a/docs/template/api_wiki/ManagedReference.extension.js +++ b/docs/template/api_wiki/ManagedReference.extension.js @@ -1,4 +1,11 @@ exports.postTransform = function (model) { + if (model.extensionMethods && model.extensionMethods.length > 0) { + console.log( + "EXTENSION METHOD MODEL:", + JSON.stringify(model.extensionMethods[0], null, 2) + ); + } + setMemberFlags(model); return model; }; diff --git a/docs/template/api_wiki/partials/class.header.tmpl.partial b/docs/template/api_wiki/partials/class.header.tmpl.partial index e58070d5..1459f509 100644 --- a/docs/template/api_wiki/partials/class.header.tmpl.partial +++ b/docs/template/api_wiki/partials/class.header.tmpl.partial @@ -214,7 +214,12 @@ {{#extensionMethods}}
- + {{#definition}} + + {{/definition}} + {{^definition}} + + {{/definition}}
From 37826e1b2b165b3160b9e946bcc37bd671b60d6f Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Tue, 17 Nov 2026 11:54:47 -0500 Subject: [PATCH 06/37] More Extension Stuff --- docs/template/api_wiki/ManagedReference.extension.js | 2 +- docs/template/api_wiki/partials/class.header.tmpl.partial | 7 ++++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/template/api_wiki/ManagedReference.extension.js b/docs/template/api_wiki/ManagedReference.extension.js index 1feda089..3c2a969a 100644 --- a/docs/template/api_wiki/ManagedReference.extension.js +++ b/docs/template/api_wiki/ManagedReference.extension.js @@ -1,7 +1,7 @@ exports.postTransform = function (model) { if (model.extensionMethods && model.extensionMethods.length > 0) { console.log( - "EXTENSION METHOD MODEL:", + "EXTENSION METHOD MODEL: " + JSON.stringify(model.extensionMethods[0], null, 2) ); } diff --git a/docs/template/api_wiki/partials/class.header.tmpl.partial b/docs/template/api_wiki/partials/class.header.tmpl.partial index 1459f509..f5e62d06 100644 --- a/docs/template/api_wiki/partials/class.header.tmpl.partial +++ b/docs/template/api_wiki/partials/class.header.tmpl.partial @@ -222,7 +222,12 @@ {{/definition}}
- + {{#definition}} + + {{/definition}} + {{^definition}} + + {{/definition}} {{#specName.0.value}}
From ae1164db82a4d4e422463d58fa6f4de72d923be2 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Tue, 17 Nov 2026 12:05:47 -0500 Subject: [PATCH 07/37] remove debug logging in wiki builds --- docs/template/api_wiki/ManagedReference.extension.js | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/template/api_wiki/ManagedReference.extension.js b/docs/template/api_wiki/ManagedReference.extension.js index 3c2a969a..2206836f 100644 --- a/docs/template/api_wiki/ManagedReference.extension.js +++ b/docs/template/api_wiki/ManagedReference.extension.js @@ -1,11 +1,4 @@ exports.postTransform = function (model) { - if (model.extensionMethods && model.extensionMethods.length > 0) { - console.log( - "EXTENSION METHOD MODEL: " + - JSON.stringify(model.extensionMethods[0], null, 2) - ); - } - setMemberFlags(model); return model; }; From 0f0f7acac7ddfa4ec192823b50b1e941586d5f8f Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Wed, 18 Nov 2026 22:48:58 -0500 Subject: [PATCH 08/37] Update Getting Started With C# Guide --- README.md | 165 +++++++++++++++++++++++++++------- docs/index.md | 168 +++++++++++++++++++++++++++-------- docs/wiki/getting_started.md | 165 +++++++++++++++++++++++++++------- 3 files changed, 399 insertions(+), 99 deletions(-) diff --git a/README.md b/README.md index c2ff42ff..e076a2b5 100644 --- a/README.md +++ b/README.md @@ -120,53 +120,154 @@ If you have any issues with Mac/Linux, Steam Deck, or Manual head over to the di ## Getting Started: Modding --- -Modding Inscryption requires a knowledge of coding in C#, and in many cases an understanding of how to patch the game using HarmonyPatch. +Modding Inscryption requires a knowledge of coding in C# or a similar programming language such as Java, and in many cases an understanding of how to patch the game using HarmonyPatch, which you can find the docs for [here](https://github.com/BepInEx/HarmonyX/wiki) for HarmonyX, and [here](https://harmony.pardeike.net/v2/articles/intro.html) for the underlying basic Harmony. -If you're unfamiliar with any of this, or just want to create cards and sigils, you can use [JSONLoader](https://inscryption.thunderstore.io/package/MADH95Mods/JSONCardLoader/). +If you're unfamiliar with any of this, or just want to create cards and sigils, you can use [JSONLoader](https://inscryption.thunderstore.io/package/MADH95Mods/JSONCardLoader/), if you wish to avoid learning C#. + +If your up for the task, a good entry point to learning C# is [this tutorial by freeCodeCamp.org](https://www.youtube.com/watch?v=GhQdlIFylQ8). It's around a 4 hour video, we'd advise you to tackle it in portions. One deviation from the video however, we are going to advise you to grab a thing called [JetBrains Rider](https://www.jetbrains.com/rider/), you'll specifically want the `Free for non-commerical use` version. If your familiar with the UX of [IntelliJ Idea](https://www.jetbrains.com/idea/) for Java based modding, than it should feel familiar to you. + +If at any point your confused while doing the tutorial, feel free to ask for help in [the discord](https://discord.gg/qEqtF29ZEt) specifically, the channel entitled `programming-help` will be your friend. Mind you help will not be immediate, but we will try and get help to you as soon as we are able. ### Modding with JSONLoader - JSONLoader is a versatile mode that provides a more beginner-friendly way of creating new cards and abilities for Inscryption using JSON syntax, which is much simpler than C#. +> JSONLoader is a versatile mod that provides a more beginner-friendly way of creating new cards and abilities for Inscryption using JSON syntax, which is much simpler than C#. If you don't know the basics of JSON you can find a useful video on the subject [here](https://www.youtube.com/watch?v=iiADhChRriM). -JSONLoader's documentation can be found [here](https://github.com/MADH95/JSONLoader). +JSONLoader's official documentation can be found in the following places, note Nightly refers to the Beta version, and Stable refers to the Main-Line version. +- Nightly GitHub Wiki: [GitHub Wiki](https://github.com/Chaosyr/JSONCardLoaderWiki/wiki) +- Nightly Thunderstore Wiki: [Thunderstore Wiki](https://thunderstore.io/c/inscryption/p/MADH95Mods/JSON_and_CSV_Loader_Nightly/wiki) +- Stable GitHub Wiki: [GitHub Wiki](https://github.com/MADH95/JSONLoader/wiki) +- Stable Thunderstore Wiki: [Thunderstore Wiki](https://thunderstore.io/c/inscryption/p/MADH95Mods/JSONCardLoader/wiki) -A video tutorial covering how to use JSONLoader in a basic form can be found [here](https://www.youtube.com/watch?v=grTSkpI4U7g). +A video tutorial covering how to use JSONLoader in a basic form can be found [here](https://www.youtube.com/watch?v=grTSkpI4U7g). A more updated series of sorts by JamesGames can be found [here](https://youtube.com/playlist?list=PLy57qL2R3Z6NaRJKF4QBaBn6WH8Vztya9&si=npQ2ZxF4gHRXa0B3). If you at any point need any help with JSONLoader, you can ask your questions in [the discord](https://discord.gg/BNDVDA5Gvh), specifically the `jsonloader-help` channel. ### Modding with C# -To begin modding with C#, you will need to create a new C# project using a code editor. -We recommend and assume you're using Microsoft's Visual Studio. - -Your project's target framework needs to be `netstandard2.0`. -Once your project's created, go to `Project > Manage NuGet Packages`. -Click the dropdown menu for 'Package source' and check that 'BepInEx' and 'nuget' is there. +First things first, in order to even make a mod for the game you will need a few things setup. First off if you haven't installed it yet, we reccomend getting a tool called [JetBrains Rider](https://www.jetbrains.com/rider/). This guide will follow the layout of this IDE. If you still want to use [Visual Studio](https://visualstudio.microsoft.com/) instead, no one is going to stop you, there will be a foldout below this guide with the setup for that IDE, note its a little outdated. + +#### JetBrains Rider Based Project Setups + +
+ +Click me to close + + +Now that you have your IDE, we'll start by making our Project. + +1. Open up the IDE, than click on `New`, followed by `New Solution`. +2. One the menu pops up select `Class Library` from the Left-Side panel. +3. Next we want to fill in some fields + 1. Where it says `Solution Name`, update the associated field to the name of your mod. + 2. Next to that field theres a little thing that says `format`, click the drop down and change it to `sln`. + 3. Where it says `Target Framework`, select the dropdown and change it to `v4.7.2`. If it is not present, that means you don't have the SDK or Framework installed. + 1. First ensure the [Net10 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/10.0) is installed, you'll want the `SDK` associated with your OS and Architecture. Note you will want to download an `Installer` not a `Binary`. + 2. Now ensure the [Netframework 4.7.2](https://dotnet.microsoft.com/en-us/download/dotnet-framework/net472) is installed, you'll want the `Offline Installer` under `Build Apps` called the `Developer Pack`. + 4. Ensure the `Language` is set to `C#`, and the Type is set to `Class Library`. +4. Now press `Create`. + +Now we have your basic project setup, if you see a pop up about Microsoft Defender affecting the IDE click `Exclude folders`, this will allow the IDE to do its job much quicker than it would be able to otherwise. + +Alright now we'll need to make sure you have the NuGet Package sources you'll need for success. The following steps will guide you through the process. + +1. Right-Click on the `Solution`, hover over `Open In`, than select `Explorer`. +2. Once open you should see the File Explorer opened to a folder containing an `sln` file with a name matching your Project's. +3. In this folder create a new text file, than open it in a text editor. Now enter the following into the text file: + ```xml + + + + + + + + + ``` +4. Save the file, and rename it to `NuGet.Config`. +5. If you don't see the sources in your IDE, try following this short guide and try again: [File Explorer (Windows); JSONLoader Wiki](https://github.com/Chaosyr/JSONCardLoaderWiki/wiki/JSON-and-CSV-Loader-API-Documentation-%E2%80%90-JSON-Inscrybing#file-explorer-windows). Simply put, your windows might not of overwrote the file extension because your extensions are hidden by default. + +Now that we have this setup when you hit `All enabled feeds` under the `NuGet` menu found in the bottom of the left-hand toolbar, you should see 3 feeds, labeled `BepInEx`, `nuget.org`, and `ts-nuget`. Also ensure `Prerelease` is ticked on. + +Next up, press `Discover` under the `Packages` tab of the `NuGet` menu. Search up the following packages in the table below, than install the version specified to the solution, also ensure the source matches. + +| Package Name | Version | Source | +| :--------------------- | :--------: | ----------: | +| `BepInEx.Analyzers` | 1.0.8 | `BepInEx` | +| `BepInEx.Core` | 5.4.21 | `BepInEx` | +| `HarmonyX` | 2.10.2 | `nuget.org` | +| `Inscryption.GameLibs` | v1.9.0-r.0 | `BepInEx` | +| `UnityEngine.Modules` | v2019.4.24 | `BepInEx` | +| `API_dev-API` | 2.24.1 | `ts-nuget` | + +If you need any other dependencies that are mods on Thunderstore, search up its package identifier in the NuGet Search, for example `Nevernamed-Nevernameds_Sigilarium`. You can get the package identifier by going to the mods page on the Thunderstore Website, such as: [Nevernameds Sigilarium](https://thunderstore.io/c/inscryption/p/Nevernamed/Nevernameds_Sigilarium/). Beneath the Download, Like and Report Buttons, there will be a string of text resembling `Team-Name-Version`. You'll want to copy that string and remove the version part of it, that is what you will put in the NuGet Search. + +
+ +#### Visual Studio Based Project Setups + +
+ +Click me to expand + + +Now that you have your IDE, do the following to begin with. Your project's target framework needs to be `netstandard4.7.2`. Once your project's created, go to `Project > Manage NuGet Packages`. Click the dropdown menu for `Package source` and check that `BepInEx`, `nuget.org` and `ts-nuget` are there. + +If `BepInEx`, `nuget.org` or `ts-nuget` aren't an available source, we need to add them. There are two methods you can use to address this, the first of which is entirely within Visual Studio, the second of which is through file, which may be less complicated. + +
+ +Via Package Source Configuration + +For each missing source you will want to do the following: + +1. Click on the `Gear` icon next to the package source selector. +2. Click the large green `Plus`. +3. Set the fields to match what is shown in the below list: + - To add `BepInEx`, change the name to `BepInEx` and the source link to `https://nuget.bepinex.dev/v3/index.json`. + - To add `nuget.org`, change the name to `nuget.org` and the source link to `https://api.nuget.org/v3/index.json`. + - To add `ts-nuget`, change the name to `ts-nuget` and the source link to `https://nuget.windows10ce.com/nuget/v3/index.json`. + +
+ +
+ +Via File + + +1. Right-Click the `Solution` found at the top of the `Solution Explorer`. +2. Click `Open Folder in File Explorer`. +3. Once open you should see the File Explorer opened to a folder containing an `sln` file with a name matching your Project's. +4. In this folder create a new text file, than open it in a text editor. Now enter the following into the text file: + ```xml + + + + + + + + + ``` +5. Save the file, and rename it to `NuGet.Config`. +6. If you don't see the sources in your IDE, try following this short guide and try again: [File Explorer (Windows); JSONLoader Wiki](https://github.com/Chaosyr/JSONCardLoaderWiki/wiki/JSON-and-CSV-Loader-API-Documentation-%E2%80%90-JSON-Inscrybing#file-explorer-windows). Simply put, your windows might not of overwrote the file extension because your extensions are hidden by default. If that fails try the `Via Package Source Configuration` method. -If BepInEx or nuget aren't an available source, we need to add them. -To add a new package source, click on the gear icon next to the package source selector, then click the large green plus-sign. +
-To add BepInEx, change the name to 'BepInEx' and the source link to 'https://nuget.bepinex.dev/v3/index.json'. -To add nuget, change the name to 'nuget' and the source link to 'https://nuget.windows10ce.com/nuget/v3/index.json'. +Now that we have this setup change the package source to `All`. Also ensure `Prerelease` is ticked on. -Change the package source to 'All' then click 'Browse'. -We want to install the following packages (**Make sure the version numbers match!**): -- BepInEx.Analyzers v1.0.8 -- BepInEx.Core v5.4.19 -- HarmonyX v2.9.0 -- Inscryption.GameLibs v1.9.0-r.0 -- UnityEngine.Modules v2019.4.24 +Next up, press `Browse` in the menu. Search up the following packages in the table below, than install the version specified to the solution, also ensure the source matches. -You will also need to add the API as a reference. -There are a couple ways to do this, detailed below; whichever way you choose to do this, you'll also need to need to reference `InscryptionAPI.dll`, which should be in your BepInEx plugins folder; copy this path for future use. +| Package Name | Version | Source | +| :--------------------- | :--------: | ----------: | +| `BepInEx.Analyzers` | 1.0.8 | `BepInEx` | +| `BepInEx.Core` | 5.4.21 | `BepInEx` | +| `HarmonyX` | 2.10.2 | `nuget.org` | +| `Inscryption.GameLibs` | v1.9.0-r.0 | `BepInEx` | +| `UnityEngine.Modules` | v2019.4.24 | `BepInEx` | +| `API_dev-API` | 2.24.1 | `ts-nuget` | -To do so, go to your 'BepInEx/plugins' folder and copy the folder path. -Then, navigate to `Project > Add Project Reference` and click 'Browse'. -Copy the folder path and add 'InscryptionAPI.dll' as a reference. -You can do this for other mods' .dll files if you want to reference them as a mod dependency (a separate mod that your mod relies on to work). +If you need any other dependencies that are mods on Thunderstore, search up its package identifier in the NuGet Search, for example `Nevernamed-Nevernameds_Sigilarium`. You can get the package identifier by going to the mods page on the Thunderstore Website, such as: [Nevernameds Sigilarium](https://thunderstore.io/c/inscryption/p/Nevernamed/Nevernameds_Sigilarium/). Beneath the Download, Like and Report Buttons, there will be a string of text resembling `Team-Name-Version`. You'll want to copy that string and remove the version part of it, that is what you will put in the NuGet Search. -An alternative method to adding the API (and other mods) as a reference is to use NuGet packages by adding 'https://nuget.bepinex.dev/v3/index.json' as a package source, and then adding 'API_dev-API' as a reference. +
-With all this, you are now ready to begin creating your mod! -Some resources are provided below for you to use, including an example mod to look at for examples. -Otherwise, continue reading this wiki. +You are now ready to begin creating your mod! Some resources are provided below for you to use, including an example mod to look at for examples. Otherwise, continue reading this wiki. ### Modding Resources [Inscryption Modding Discord](https://discord.gg/QrJEF5Denm) diff --git a/docs/index.md b/docs/index.md index bab34934..5c974c3e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -137,53 +137,154 @@ If you have any issues with Mac/Linux, Steam Deck, or Manual head over to the di ## Getting Started: Modding --- -Modding Inscryption requires a knowledge of coding in C#, and in many cases an understanding of how to patch the game using HarmonyPatch. +Modding Inscryption requires a knowledge of coding in C# or a similar programming language such as Java, and in many cases an understanding of how to patch the game using HarmonyPatch, which you can find the docs for [here](https://github.com/BepInEx/HarmonyX/wiki) for HarmonyX, and [here](https://harmony.pardeike.net/v2/articles/intro.html) for the underlying basic Harmony. -If you're unfamiliar with any of this, or just want to create cards and sigils, you can use [JSONLoader](https://inscryption.thunderstore.io/package/MADH95Mods/JSONCardLoader/). +If you're unfamiliar with any of this, or just want to create cards and sigils, you can use [JSONLoader](https://inscryption.thunderstore.io/package/MADH95Mods/JSONCardLoader/), if you wish to avoid learning C#. + +If your up for the task, a good entry point to learning C# is [this tutorial by freeCodeCamp.org](https://www.youtube.com/watch?v=GhQdlIFylQ8). It's around a 4 hour video, we'd advise you to tackle it in portions. One deviation from the video however, we are going to advise you to grab a thing called [JetBrains Rider](https://www.jetbrains.com/rider/), you'll specifically want the `Free for non-commerical use` version. If your familiar with the UX of [IntelliJ Idea](https://www.jetbrains.com/idea/) for Java based modding, than it should feel familiar to you. + +If at any point your confused while doing the tutorial, feel free to ask for help in [the discord](https://discord.gg/qEqtF29ZEt) specifically, the channel entitled `programming-help` will be your friend. Mind you help will not be immediate, but we will try and get help to you as soon as we are able. ### Modding with JSONLoader -JSONLoader is a versatile mod that provides a more beginner-friendly way of creating new cards and abilities for Inscryption using JSON syntax, which is much simpler than C#. +> JSONLoader is a versatile mod that provides a more beginner-friendly way of creating new cards and abilities for Inscryption using JSON syntax, which is much simpler than C#. If you don't know the basics of JSON you can find a useful video on the subject [here](https://www.youtube.com/watch?v=iiADhChRriM). -JSONLoader's documentation can be found [here](https://github.com/MADH95/JSONLoader). +JSONLoader's official documentation can be found in the following places, note Nightly refers to the Beta version, and Stable refers to the Main-Line version. +- Nightly GitHub Wiki: [GitHub Wiki](https://github.com/Chaosyr/JSONCardLoaderWiki/wiki) +- Nightly Thunderstore Wiki: [Thunderstore Wiki](https://thunderstore.io/c/inscryption/p/MADH95Mods/JSON_and_CSV_Loader_Nightly/wiki) +- Stable GitHub Wiki: [GitHub Wiki](https://github.com/MADH95/JSONLoader/wiki) +- Stable Thunderstore Wiki: [Thunderstore Wiki](https://thunderstore.io/c/inscryption/p/MADH95Mods/JSONCardLoader/wiki) -A video tutorial covering how to use JSONLoader in a basic form can be found [here](https://www.youtube.com/watch?v=grTSkpI4U7g). +A video tutorial covering how to use JSONLoader in a basic form can be found [here](https://www.youtube.com/watch?v=grTSkpI4U7g). A more updated series of sorts by JamesGames can be found [here](https://youtube.com/playlist?list=PLy57qL2R3Z6NaRJKF4QBaBn6WH8Vztya9&si=npQ2ZxF4gHRXa0B3). If you at any point need any help with JSONLoader, you can ask your questions in [the discord](https://discord.gg/BNDVDA5Gvh), specifically the `jsonloader-help` channel. ### Modding with C# -To begin modding with C#, you will need to create a new C# project using a code editor. -We recommend and assume you're using Microsoft's Visual Studio. - -Your project's target framework needs to be `netstandard2.0`. -Once your project's created, go to `Project > Manage NuGet Packages`. -Click the dropdown menu for 'Package source' and check that 'BepInEx' and 'nuget' is there. +First things first, in order to even make a mod for the game you will need a few things setup. First off if you haven't installed it yet, we reccomend getting a tool called [JetBrains Rider](https://www.jetbrains.com/rider/). This guide will follow the layout of this IDE. If you still want to use [Visual Studio](https://visualstudio.microsoft.com/) instead, no one is going to stop you, there will be a foldout below this guide with the setup for that IDE, note its a little outdated. + +#### JetBrains Rider Based Project Setups + +
+ +Click me to close + + +Now that you have your IDE, we'll start by making our Project. + +1. Open up the IDE, than click on `New`, followed by `New Solution`. +2. One the menu pops up select `Class Library` from the Left-Side panel. +3. Next we want to fill in some fields + 1. Where it says `Solution Name`, update the associated field to the name of your mod. + 2. Next to that field theres a little thing that says `format`, click the drop down and change it to `sln`. + 3. Where it says `Target Framework`, select the dropdown and change it to `v4.7.2`. If it is not present, that means you don't have the SDK or Framework installed. + 1. First ensure the [Net10 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/10.0) is installed, you'll want the `SDK` associated with your OS and Architecture. Note you will want to download an `Installer` not a `Binary`. + 2. Now ensure the [Netframework 4.7.2](https://dotnet.microsoft.com/en-us/download/dotnet-framework/net472) is installed, you'll want the `Offline Installer` under `Build Apps` called the `Developer Pack`. + 4. Ensure the `Language` is set to `C#`, and the Type is set to `Class Library`. +4. Now press `Create`. + +Now we have your basic project setup, if you see a pop up about Microsoft Defender affecting the IDE click `Exclude folders`, this will allow the IDE to do its job much quicker than it would be able to otherwise. + +Alright now we'll need to make sure you have the NuGet Package sources you'll need for success. The following steps will guide you through the process. + +1. Right-Click on the `Solution`, hover over `Open In`, than select `Explorer`. +2. Once open you should see the File Explorer opened to a folder containing an `sln` file with a name matching your Project's. +3. In this folder create a new text file, than open it in a text editor. Now enter the following into the text file: + ```xml + + + + + + + + + ``` +4. Save the file, and rename it to `NuGet.Config`. +5. If you don't see the sources in your IDE, try following this short guide and try again: [File Explorer (Windows); JSONLoader Wiki](https://github.com/Chaosyr/JSONCardLoaderWiki/wiki/JSON-and-CSV-Loader-API-Documentation-%E2%80%90-JSON-Inscrybing#file-explorer-windows). Simply put, your windows might not of overwrote the file extension because your extensions are hidden by default. + +Now that we have this setup when you hit `All enabled feeds` under the `NuGet` menu found in the bottom of the left-hand toolbar, you should see 3 feeds, labeled `BepInEx`, `nuget.org`, and `ts-nuget`. Also ensure `Prerelease` is ticked on. + +Next up, press `Discover` under the `Packages` tab of the `NuGet` menu. Search up the following packages in the table below, than install the version specified to the solution, also ensure the source matches. + +| Package Name | Version | Source | +| :--------------------- | :--------: | ----------: | +| `BepInEx.Analyzers` | 1.0.8 | `BepInEx` | +| `BepInEx.Core` | 5.4.21 | `BepInEx` | +| `HarmonyX` | 2.10.2 | `nuget.org` | +| `Inscryption.GameLibs` | v1.9.0-r.0 | `BepInEx` | +| `UnityEngine.Modules` | v2019.4.24 | `BepInEx` | +| `API_dev-API` | 2.24.1 | `ts-nuget` | + +If you need any other dependencies that are mods on Thunderstore, search up its package identifier in the NuGet Search, for example `Nevernamed-Nevernameds_Sigilarium`. You can get the package identifier by going to the mods page on the Thunderstore Website, such as: [Nevernameds Sigilarium](https://thunderstore.io/c/inscryption/p/Nevernamed/Nevernameds_Sigilarium/). Beneath the Download, Like and Report Buttons, there will be a string of text resembling `Team-Name-Version`. You'll want to copy that string and remove the version part of it, that is what you will put in the NuGet Search. + +
+ +#### Visual Studio Based Project Setups + +
+ +Click me to expand + + +Now that you have your IDE, do the following to begin with. Your project's target framework needs to be `netstandard4.7.2`. Once your project's created, go to `Project > Manage NuGet Packages`. Click the dropdown menu for `Package source` and check that `BepInEx`, `nuget.org` and `ts-nuget` are there. + +If `BepInEx`, `nuget.org` or `ts-nuget` aren't an available source, we need to add them. There are two methods you can use to address this, the first of which is entirely within Visual Studio, the second of which is through file, which may be less complicated. + +
+ +Via Package Source Configuration + +For each missing source you will want to do the following: + +1. Click on the `Gear` icon next to the package source selector. +2. Click the large green `Plus`. +3. Set the fields to match what is shown in the below list: + - To add `BepInEx`, change the name to `BepInEx` and the source link to `https://nuget.bepinex.dev/v3/index.json`. + - To add `nuget.org`, change the name to `nuget.org` and the source link to `https://api.nuget.org/v3/index.json`. + - To add `ts-nuget`, change the name to `ts-nuget` and the source link to `https://nuget.windows10ce.com/nuget/v3/index.json`. + +
+ +
+ +Via File + + +1. Right-Click the `Solution` found at the top of the `Solution Explorer`. +2. Click `Open Folder in File Explorer`. +3. Once open you should see the File Explorer opened to a folder containing an `sln` file with a name matching your Project's. +4. In this folder create a new text file, than open it in a text editor. Now enter the following into the text file: + ```xml + + + + + + + + + ``` +5. Save the file, and rename it to `NuGet.Config`. +6. If you don't see the sources in your IDE, try following this short guide and try again: [File Explorer (Windows); JSONLoader Wiki](https://github.com/Chaosyr/JSONCardLoaderWiki/wiki/JSON-and-CSV-Loader-API-Documentation-%E2%80%90-JSON-Inscrybing#file-explorer-windows). Simply put, your windows might not of overwrote the file extension because your extensions are hidden by default. If that fails try the `Via Package Source Configuration` method. -If BepInEx or nuget aren't an available source, we need to add them. -To add a new package source, click on the gear icon next to the package source selector, then click the large green plus-sign. +
-To add BepInEx, change the name to 'BepInEx' and the source link to 'https://nuget.bepinex.dev/v3/index.json'. -To add nuget, change the name to 'nuget' and the source link to 'https://nuget.windows10ce.com/nuget/v3/index.json'. +Now that we have this setup change the package source to `All`. Also ensure `Prerelease` is ticked on. -Change the package source to 'All' then click 'Browse'. -We want to install the following packages (**Make sure the version numbers match!**): -- BepInEx.Analyzers v1.0.8 -- BepInEx.Core v5.4.19 -- HarmonyX v2.9.0 -- Inscryption.GameLibs v1.9.0-r.0 -- UnityEngine.Modules v2019.4.24 +Next up, press `Browse` in the menu. Search up the following packages in the table below, than install the version specified to the solution, also ensure the source matches. -You will also need to add the API as a reference. -There are a couple ways to do this, detailed below; whichever way you choose to do this, you'll also need to need to reference `InscryptionAPI.dll`, which should be in your BepInEx plugins folder; copy this path for future use. +| Package Name | Version | Source | +| :--------------------- | :--------: | ----------: | +| `BepInEx.Analyzers` | 1.0.8 | `BepInEx` | +| `BepInEx.Core` | 5.4.21 | `BepInEx` | +| `HarmonyX` | 2.10.2 | `nuget.org` | +| `Inscryption.GameLibs` | v1.9.0-r.0 | `BepInEx` | +| `UnityEngine.Modules` | v2019.4.24 | `BepInEx` | +| `API_dev-API` | 2.24.1 | `ts-nuget` | -To do so, go to your 'BepInEx/plugins' folder and copy the folder path. -Then, navigate to `Project > Add Project Reference` and click 'Browse'. -Copy the folder path and add 'InscryptionAPI.dll' as a reference. -You can do this for other mods' .dll files if you want to reference them as a mod dependency (a separate mod that your mod relies on to work). +If you need any other dependencies that are mods on Thunderstore, search up its package identifier in the NuGet Search, for example `Nevernamed-Nevernameds_Sigilarium`. You can get the package identifier by going to the mods page on the Thunderstore Website, such as: [Nevernameds Sigilarium](https://thunderstore.io/c/inscryption/p/Nevernamed/Nevernameds_Sigilarium/). Beneath the Download, Like and Report Buttons, there will be a string of text resembling `Team-Name-Version`. You'll want to copy that string and remove the version part of it, that is what you will put in the NuGet Search. -An alternative method to adding the API (and other mods) as a reference is to use NuGet packages by adding 'https://nuget.bepinex.dev/v3/index.json' as a package source, and then adding 'API_dev-API' as a reference. +
-With all this, you are now ready to begin creating your mod! -Some resources are provided below for you to use, including an example mod to look at for examples. -Otherwise, continue reading this wiki. +You are now ready to begin creating your mod! Some resources are provided below for you to use, including an example mod to look at for examples. Otherwise, continue reading this wiki. ### Modding Resources [Inscryption Modding Discord](https://discord.gg/QrJEF5Denm) @@ -196,9 +297,6 @@ Otherwise, continue reading this wiki. [Vanilla and Modded Enumerations](https://github.com/SaxbyMod/SabyModEnums) -An example mod utilising this plugin can be found [here](https://github.com/debugman18/InscryptionExampleMod), -and the modding wiki and documentation can be found [here](https://inscryptionmodding.github.io/InscryptionAPI/wiki/index.html). - ___ ## Modded Save File diff --git a/docs/wiki/getting_started.md b/docs/wiki/getting_started.md index b6a02088..b4e7a536 100644 --- a/docs/wiki/getting_started.md +++ b/docs/wiki/getting_started.md @@ -93,53 +93,154 @@ If you have any issues with Mac/Linux, Steam Deck, or Manual head over to the di ## Getting Started: Modding --- -Modding Inscryption requires a knowledge of coding in C#, and in many cases an understanding of how to patch the game using HarmonyPatch. +Modding Inscryption requires a knowledge of coding in C# or a similar programming language such as Java, and in many cases an understanding of how to patch the game using HarmonyPatch, which you can find the docs for [here](https://github.com/BepInEx/HarmonyX/wiki) for HarmonyX, and [here](https://harmony.pardeike.net/v2/articles/intro.html) for the underlying basic Harmony. -If you're unfamiliar with any of this, or just want to create cards and sigils, you can use [JSONLoader](https://inscryption.thunderstore.io/package/MADH95Mods/JSONCardLoader/). +If you're unfamiliar with any of this, or just want to create cards and sigils, you can use [JSONLoader](https://inscryption.thunderstore.io/package/MADH95Mods/JSONCardLoader/), if you wish to avoid learning C#. + +If your up for the task, a good entry point to learning C# is [this tutorial by freeCodeCamp.org](https://www.youtube.com/watch?v=GhQdlIFylQ8). It's around a 4 hour video, we'd advise you to tackle it in portions. One deviation from the video however, we are going to advise you to grab a thing called [JetBrains Rider](https://www.jetbrains.com/rider/), you'll specifically want the `Free for non-commerical use` version. If your familiar with the UX of [IntelliJ Idea](https://www.jetbrains.com/idea/) for Java based modding, than it should feel familiar to you. + +If at any point your confused while doing the tutorial, feel free to ask for help in [the discord](https://discord.gg/qEqtF29ZEt) specifically, the channel entitled `programming-help` will be your friend. Mind you help will not be immediate, but we will try and get help to you as soon as we are able. ### Modding with JSONLoader - JSONLoader is a versatile mode that provides a more beginner-friendly way of creating new cards and abilities for Inscryption using JSON syntax, which is much simpler than C#. +> JSONLoader is a versatile mod that provides a more beginner-friendly way of creating new cards and abilities for Inscryption using JSON syntax, which is much simpler than C#. If you don't know the basics of JSON you can find a useful video on the subject [here](https://www.youtube.com/watch?v=iiADhChRriM). -JSONLoader's documentation can be found [here](https://github.com/MADH95/JSONLoader). +JSONLoader's official documentation can be found in the following places, note Nightly refers to the Beta version, and Stable refers to the Main-Line version. +- Nightly GitHub Wiki: [GitHub Wiki](https://github.com/Chaosyr/JSONCardLoaderWiki/wiki) +- Nightly Thunderstore Wiki: [Thunderstore Wiki](https://thunderstore.io/c/inscryption/p/MADH95Mods/JSON_and_CSV_Loader_Nightly/wiki) +- Stable GitHub Wiki: [GitHub Wiki](https://github.com/MADH95/JSONLoader/wiki) +- Stable Thunderstore Wiki: [Thunderstore Wiki](https://thunderstore.io/c/inscryption/p/MADH95Mods/JSONCardLoader/wiki) -A video tutorial covering how to use JSONLoader in a basic form can be found [here](https://www.youtube.com/watch?v=grTSkpI4U7g). +A video tutorial covering how to use JSONLoader in a basic form can be found [here](https://www.youtube.com/watch?v=grTSkpI4U7g). A more updated series of sorts by JamesGames can be found [here](https://youtube.com/playlist?list=PLy57qL2R3Z6NaRJKF4QBaBn6WH8Vztya9&si=npQ2ZxF4gHRXa0B3). If you at any point need any help with JSONLoader, you can ask your questions in [the discord](https://discord.gg/BNDVDA5Gvh), specifically the `jsonloader-help` channel. ### Modding with C# -To begin modding with C#, you will need to create a new C# project using a code editor. -We recommend and assume you're using Microsoft's Visual Studio. - -Your project's target framework needs to be `netstandard2.0`. -Once your project's created, go to `Project > Manage NuGet Packages`. -Click the dropdown menu for 'Package source' and check that 'BepInEx' and 'nuget' is there. +First things first, in order to even make a mod for the game you will need a few things setup. First off if you haven't installed it yet, we reccomend getting a tool called [JetBrains Rider](https://www.jetbrains.com/rider/). This guide will follow the layout of this IDE. If you still want to use [Visual Studio](https://visualstudio.microsoft.com/) instead, no one is going to stop you, there will be a foldout below this guide with the setup for that IDE, note its a little outdated. + +#### JetBrains Rider Based Project Setups + +
+ +Click me to close + + +Now that you have your IDE, we'll start by making our Project. + +1. Open up the IDE, than click on `New`, followed by `New Solution`. +2. One the menu pops up select `Class Library` from the Left-Side panel. +3. Next we want to fill in some fields + 1. Where it says `Solution Name`, update the associated field to the name of your mod. + 2. Next to that field theres a little thing that says `format`, click the drop down and change it to `sln`. + 3. Where it says `Target Framework`, select the dropdown and change it to `v4.7.2`. If it is not present, that means you don't have the SDK or Framework installed. + 1. First ensure the [Net10 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/10.0) is installed, you'll want the `SDK` associated with your OS and Architecture. Note you will want to download an `Installer` not a `Binary`. + 2. Now ensure the [Netframework 4.7.2](https://dotnet.microsoft.com/en-us/download/dotnet-framework/net472) is installed, you'll want the `Offline Installer` under `Build Apps` called the `Developer Pack`. + 4. Ensure the `Language` is set to `C#`, and the Type is set to `Class Library`. +4. Now press `Create`. + +Now we have your basic project setup, if you see a pop up about Microsoft Defender affecting the IDE click `Exclude folders`, this will allow the IDE to do its job much quicker than it would be able to otherwise. + +Alright now we'll need to make sure you have the NuGet Package sources you'll need for success. The following steps will guide you through the process. + +1. Right-Click on the `Solution`, hover over `Open In`, than select `Explorer`. +2. Once open you should see the File Explorer opened to a folder containing an `sln` file with a name matching your Project's. +3. In this folder create a new text file, than open it in a text editor. Now enter the following into the text file: + ```xml + + + + + + + + + ``` +4. Save the file, and rename it to `NuGet.Config`. +5. If you don't see the sources in your IDE, try following this short guide and try again: [File Explorer (Windows); JSONLoader Wiki](https://github.com/Chaosyr/JSONCardLoaderWiki/wiki/JSON-and-CSV-Loader-API-Documentation-%E2%80%90-JSON-Inscrybing#file-explorer-windows). Simply put, your windows might not of overwrote the file extension because your extensions are hidden by default. + +Now that we have this setup when you hit `All enabled feeds` under the `NuGet` menu found in the bottom of the left-hand toolbar, you should see 3 feeds, labeled `BepInEx`, `nuget.org`, and `ts-nuget`. Also ensure `Prerelease` is ticked on. + +Next up, press `Discover` under the `Packages` tab of the `NuGet` menu. Search up the following packages in the table below, than install the version specified to the solution, also ensure the source matches. + +| Package Name | Version | Source | +| :--------------------- | :--------: | ----------: | +| `BepInEx.Analyzers` | 1.0.8 | `BepInEx` | +| `BepInEx.Core` | 5.4.21 | `BepInEx` | +| `HarmonyX` | 2.10.2 | `nuget.org` | +| `Inscryption.GameLibs` | v1.9.0-r.0 | `BepInEx` | +| `UnityEngine.Modules` | v2019.4.24 | `BepInEx` | +| `API_dev-API` | 2.24.1 | `ts-nuget` | + +If you need any other dependencies that are mods on Thunderstore, search up its package identifier in the NuGet Search, for example `Nevernamed-Nevernameds_Sigilarium`. You can get the package identifier by going to the mods page on the Thunderstore Website, such as: [Nevernameds Sigilarium](https://thunderstore.io/c/inscryption/p/Nevernamed/Nevernameds_Sigilarium/). Beneath the Download, Like and Report Buttons, there will be a string of text resembling `Team-Name-Version`. You'll want to copy that string and remove the version part of it, that is what you will put in the NuGet Search. + +
+ +#### Visual Studio Based Project Setups + +
+ +Click me to expand + + +Now that you have your IDE, do the following to begin with. Your project's target framework needs to be `netstandard4.7.2`. Once your project's created, go to `Project > Manage NuGet Packages`. Click the dropdown menu for `Package source` and check that `BepInEx`, `nuget.org` and `ts-nuget` are there. + +If `BepInEx`, `nuget.org` or `ts-nuget` aren't an available source, we need to add them. There are two methods you can use to address this, the first of which is entirely within Visual Studio, the second of which is through file, which may be less complicated. + +
+ +Via Package Source Configuration + +For each missing source you will want to do the following: + +1. Click on the `Gear` icon next to the package source selector. +2. Click the large green `Plus`. +3. Set the fields to match what is shown in the below list: + - To add `BepInEx`, change the name to `BepInEx` and the source link to `https://nuget.bepinex.dev/v3/index.json`. + - To add `nuget.org`, change the name to `nuget.org` and the source link to `https://api.nuget.org/v3/index.json`. + - To add `ts-nuget`, change the name to `ts-nuget` and the source link to `https://nuget.windows10ce.com/nuget/v3/index.json`. + +
+ +
+ +Via File + + +1. Right-Click the `Solution` found at the top of the `Solution Explorer`. +2. Click `Open Folder in File Explorer`. +3. Once open you should see the File Explorer opened to a folder containing an `sln` file with a name matching your Project's. +4. In this folder create a new text file, than open it in a text editor. Now enter the following into the text file: + ```xml + + + + + + + + + ``` +5. Save the file, and rename it to `NuGet.Config`. +6. If you don't see the sources in your IDE, try following this short guide and try again: [File Explorer (Windows); JSONLoader Wiki](https://github.com/Chaosyr/JSONCardLoaderWiki/wiki/JSON-and-CSV-Loader-API-Documentation-%E2%80%90-JSON-Inscrybing#file-explorer-windows). Simply put, your windows might not of overwrote the file extension because your extensions are hidden by default. If that fails try the `Via Package Source Configuration` method. -If BepInEx or nuget aren't an available source, we need to add them. -To add a new package source, click on the gear icon next to the package source selector, then click the large green plus-sign. +
-To add BepInEx, change the name to 'BepInEx' and the source link to 'https://nuget.bepinex.dev/v3/index.json'. -To add nuget, change the name to 'nuget' and the source link to 'https://nuget.windows10ce.com/nuget/v3/index.json'. +Now that we have this setup change the package source to `All`. Also ensure `Prerelease` is ticked on. -Change the package source to 'All' then click 'Browse'. -We want to install the following packages (**Make sure the version numbers match!**): -- BepInEx.Analyzers v1.0.8 -- BepInEx.Core v5.4.19 -- HarmonyX v2.9.0 -- Inscryption.GameLibs v1.9.0-r.0 -- UnityEngine.Modules v2019.4.24 +Next up, press `Browse` in the menu. Search up the following packages in the table below, than install the version specified to the solution, also ensure the source matches. -You will also need to add the API as a reference. -There are a couple ways to do this, detailed below; whichever way you choose to do this, you'll also need to need to reference `InscryptionAPI.dll`, which should be in your BepInEx plugins folder; copy this path for future use. +| Package Name | Version | Source | +| :--------------------- | :--------: | ----------: | +| `BepInEx.Analyzers` | 1.0.8 | `BepInEx` | +| `BepInEx.Core` | 5.4.21 | `BepInEx` | +| `HarmonyX` | 2.10.2 | `nuget.org` | +| `Inscryption.GameLibs` | v1.9.0-r.0 | `BepInEx` | +| `UnityEngine.Modules` | v2019.4.24 | `BepInEx` | +| `API_dev-API` | 2.24.1 | `ts-nuget` | -To do so, go to your 'BepInEx/plugins' folder and copy the folder path. -Then, navigate to `Project > Add Project Reference` and click 'Browse'. -Copy the folder path and add 'InscryptionAPI.dll' as a reference. -You can do this for other mods' .dll files if you want to reference them as a mod dependency (a separate mod that your mod relies on to work). +If you need any other dependencies that are mods on Thunderstore, search up its package identifier in the NuGet Search, for example `Nevernamed-Nevernameds_Sigilarium`. You can get the package identifier by going to the mods page on the Thunderstore Website, such as: [Nevernameds Sigilarium](https://thunderstore.io/c/inscryption/p/Nevernamed/Nevernameds_Sigilarium/). Beneath the Download, Like and Report Buttons, there will be a string of text resembling `Team-Name-Version`. You'll want to copy that string and remove the version part of it, that is what you will put in the NuGet Search. -An alternative method to adding the API (and other mods) as a reference is to use NuGet packages by adding 'https://nuget.bepinex.dev/v3/index.json' as a package source, and then adding 'API_dev-API' as a reference. +
-With all this, you are now ready to begin creating your mod! -Some resources are provided below for you to use, including an example mod to look at for examples. -Otherwise, continue reading this wiki. +You are now ready to begin creating your mod! Some resources are provided below for you to use, including an example mod to look at for examples. Otherwise, continue reading this wiki. ### Modding Resources [Inscryption Modding Discord](https://discord.gg/QrJEF5Denm) From 5521f56233e5550598409ef6fcd5aa7116a09dd6 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Thu, 19 Nov 2026 13:54:41 -0500 Subject: [PATCH 09/37] Update getting_started.md --- docs/wiki/getting_started.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/wiki/getting_started.md b/docs/wiki/getting_started.md index b4e7a536..70c05a5b 100644 --- a/docs/wiki/getting_started.md +++ b/docs/wiki/getting_started.md @@ -1,3 +1,7 @@ +# Getting Started + +This article covers both getting started for users and modders. If you want to skip directly to either section, click the relavent section under `IN THIS ARTICLE`. If you want to change articles, you can do so on the Left side of the page, which is the Table Of Contents of our Wiki. + ## Getting Started: Installation --- To begin, we'll go over how to install BepInEx, the framework all Inscryption mods use. This is a necessary step to playing modded Inscryption, so be sure to follow this carefully. From a78de469dc734e7d12c40e3481a3054cc3d77999 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Thu, 19 Nov 2026 14:04:13 -0500 Subject: [PATCH 10/37] Blockquote CSS Improvements --- docs/template/api_wiki/public/main.css | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/template/api_wiki/public/main.css b/docs/template/api_wiki/public/main.css index 02312658..4234cf81 100644 --- a/docs/template/api_wiki/public/main.css +++ b/docs/template/api_wiki/public/main.css @@ -401,4 +401,11 @@ a.active { .typelist-content > div { padding: 0.2rem 0; +} + +blockquote { + border-left-style: solid; + border-right-style: none; + border-top-style: none; + border-bottom-style: none; } \ No newline at end of file From 9fdb2706fdd53b511eab4c0c47073f2279580e71 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 10:24:43 -0500 Subject: [PATCH 11/37] testing --- docs/wiki/getting_started/index.md | 0 docs/wiki/getting_started/modders/index.md | 0 docs/wiki/getting_started/modders/toc.yml | 0 docs/wiki/getting_started/toc.yml | 5 +++++ docs/wiki/getting_started/users/index.md | 0 docs/wiki/getting_started/users/toc.yml | 0 docs/wiki/toc.yml | 2 +- 7 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 docs/wiki/getting_started/index.md create mode 100644 docs/wiki/getting_started/modders/index.md create mode 100644 docs/wiki/getting_started/modders/toc.yml create mode 100644 docs/wiki/getting_started/toc.yml create mode 100644 docs/wiki/getting_started/users/index.md create mode 100644 docs/wiki/getting_started/users/toc.yml diff --git a/docs/wiki/getting_started/index.md b/docs/wiki/getting_started/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/wiki/getting_started/modders/index.md b/docs/wiki/getting_started/modders/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/wiki/getting_started/modders/toc.yml b/docs/wiki/getting_started/modders/toc.yml new file mode 100644 index 00000000..e69de29b diff --git a/docs/wiki/getting_started/toc.yml b/docs/wiki/getting_started/toc.yml new file mode 100644 index 00000000..f726e763 --- /dev/null +++ b/docs/wiki/getting_started/toc.yml @@ -0,0 +1,5 @@ +items: +- name: Getting Started (Users) + href: getting_started/users/toc.yml +- name: Getting Started (Modders) + href: getting_started/modders/toc.yml \ No newline at end of file diff --git a/docs/wiki/getting_started/users/index.md b/docs/wiki/getting_started/users/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/wiki/getting_started/users/toc.yml b/docs/wiki/getting_started/users/toc.yml new file mode 100644 index 00000000..e69de29b diff --git a/docs/wiki/toc.yml b/docs/wiki/toc.yml index 523a45e3..ea3acc7e 100644 --- a/docs/wiki/toc.yml +++ b/docs/wiki/toc.yml @@ -2,7 +2,7 @@ items: - name: Home href: index.md - name: Getting Started - href: getting_started.md + href: getting_started/toc.yml - name: Cards href: card_management.md items: From 16195e85970b54800b2260c18456afbfd73bb1e0 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 10:27:37 -0500 Subject: [PATCH 12/37] testing pt.2 --- docs/wiki/getting_started/toc.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/wiki/getting_started/toc.yml b/docs/wiki/getting_started/toc.yml index f726e763..fc4c2b89 100644 --- a/docs/wiki/getting_started/toc.yml +++ b/docs/wiki/getting_started/toc.yml @@ -1,5 +1,5 @@ items: - name: Getting Started (Users) - href: getting_started/users/toc.yml + href: users/toc.yml - name: Getting Started (Modders) - href: getting_started/modders/toc.yml \ No newline at end of file + href: modders/toc.yml \ No newline at end of file From c7b6fbe0cc98101dd45cf22ecc2bb24cb7b41c40 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 10:31:10 -0500 Subject: [PATCH 13/37] testing pt.3 --- docs/wiki/getting_started/modders/toc.yml | 3 +++ docs/wiki/getting_started/toc.yml | 2 ++ docs/wiki/getting_started/users/toc.yml | 3 +++ 3 files changed, 8 insertions(+) diff --git a/docs/wiki/getting_started/modders/toc.yml b/docs/wiki/getting_started/modders/toc.yml index e69de29b..3a0e999a 100644 --- a/docs/wiki/getting_started/modders/toc.yml +++ b/docs/wiki/getting_started/modders/toc.yml @@ -0,0 +1,3 @@ +items: +- name: Getting Started (Modders) + href: index.md \ No newline at end of file diff --git a/docs/wiki/getting_started/toc.yml b/docs/wiki/getting_started/toc.yml index fc4c2b89..d4d97128 100644 --- a/docs/wiki/getting_started/toc.yml +++ b/docs/wiki/getting_started/toc.yml @@ -1,4 +1,6 @@ items: +- name: Getting Started + href: index.md - name: Getting Started (Users) href: users/toc.yml - name: Getting Started (Modders) diff --git a/docs/wiki/getting_started/users/toc.yml b/docs/wiki/getting_started/users/toc.yml index e69de29b..b227618e 100644 --- a/docs/wiki/getting_started/users/toc.yml +++ b/docs/wiki/getting_started/users/toc.yml @@ -0,0 +1,3 @@ +items: +- name: Getting Started (Users) + href: index.md \ No newline at end of file From 27b2209cb04f5e56ca53dbb27451c4254b822024 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 10:39:09 -0500 Subject: [PATCH 14/37] Add YML to inclusions for wiki --- docs/docfx.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docfx.json b/docs/docfx.json index b2292777..0e49ca97 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -58,7 +58,7 @@ "files": ["community/**.yml", "community/index.md"] }, { - "files": ["wiki/toc.yml", "wiki/**.md"] + "files": ["wiki/toc.yml", "wiki/**.md", "wiki/**.yml"] }, { "files": ["toc.yml", "index.md"] From a4de41f116b1d4e2a6f440e70f355a5ce4ecc73d Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 10:45:42 -0500 Subject: [PATCH 15/37] Update TOCs --- docs/wiki/getting_started/toc.yml | 6 +++--- docs/wiki/toc.yml | 1 + 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/wiki/getting_started/toc.yml b/docs/wiki/getting_started/toc.yml index d4d97128..549d4a4b 100644 --- a/docs/wiki/getting_started/toc.yml +++ b/docs/wiki/getting_started/toc.yml @@ -1,7 +1,7 @@ items: -- name: Getting Started - href: index.md - name: Getting Started (Users) href: users/toc.yml + homepage: users/index.md - name: Getting Started (Modders) - href: modders/toc.yml \ No newline at end of file + href: modders/toc.yml + homepage: modders/index.md \ No newline at end of file diff --git a/docs/wiki/toc.yml b/docs/wiki/toc.yml index ea3acc7e..13a82699 100644 --- a/docs/wiki/toc.yml +++ b/docs/wiki/toc.yml @@ -3,6 +3,7 @@ items: href: index.md - name: Getting Started href: getting_started/toc.yml + homepage: getting_started/index.md - name: Cards href: card_management.md items: From 616d08ab82dd89e01f0a4b99b92bf39fff9d6e8e Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 11:57:14 -0500 Subject: [PATCH 16/37] Part 1 of Getting Started Rework into Sub-Items --- docs/wiki/getting_started.md | 97 ------------------- docs/wiki/getting_started/index.md | 17 ++++ docs/wiki/getting_started/users/index.md | 11 +++ .../installing_manually_on_windows_x64.md | 29 ++++++ .../installing_manually_on_windows_x86.md | 28 ++++++ .../users/installing_on_mac_and_linux.md | 11 +++ .../users/installing_on_the_steam_deck.md | 12 +++ .../users/installing_with_a_mod_manager.md | 11 +++ docs/wiki/getting_started/users/toc.yml | 12 ++- 9 files changed, 129 insertions(+), 99 deletions(-) create mode 100644 docs/wiki/getting_started/users/installing_manually_on_windows_x64.md create mode 100644 docs/wiki/getting_started/users/installing_manually_on_windows_x86.md create mode 100644 docs/wiki/getting_started/users/installing_on_mac_and_linux.md create mode 100644 docs/wiki/getting_started/users/installing_on_the_steam_deck.md create mode 100644 docs/wiki/getting_started/users/installing_with_a_mod_manager.md diff --git a/docs/wiki/getting_started.md b/docs/wiki/getting_started.md index 70c05a5b..ada50727 100644 --- a/docs/wiki/getting_started.md +++ b/docs/wiki/getting_started.md @@ -1,100 +1,3 @@ -# Getting Started - -This article covers both getting started for users and modders. If you want to skip directly to either section, click the relavent section under `IN THIS ARTICLE`. If you want to change articles, you can do so on the Left side of the page, which is the Table Of Contents of our Wiki. - -## Getting Started: Installation ---- -To begin, we'll go over how to install BepInEx, the framework all Inscryption mods use. This is a necessary step to playing modded Inscryption, so be sure to follow this carefully. - -**FOR LINUX AND STEAMDECK:** Ensure that the game is set to run using `Proton` in he game settings on steam. Should be a setting like this: `Change launch behaviour` -> `Proton`. - -### Installing with a Mod Manager -1. Download and install [Thunderstore Mod Manager](https://www.overwolf.com/app/Thunderstore-Thunderstore_Mod_Manager), [Gale](https://thunderstore.io/c/inscryption/p/Kesomannen/GaleModManager/), [Pulsar](https://pulsarmods.com/) or [r2modman](https://thunderstore.io/c/inscryption/p/ebkr/r2modman/). -2. Click the **Install with Mod Manager** button on the top of [BepInEx's](https://thunderstore.io/c/inscryption/p/BepInEx/BepInExPack_Inscryption/) page. -3. Run the game via the mod manager. - -If you have issues with Mod Managers head to one of these discords; - -* **Thunderstore Support Discord:** [Here](https://discord.gg/Fbz54kQAxg) -* **R2ModMan Support Discord:** [Here](https://discord.gg/R85wjqa4WN) -* **Gale Mod Manager Support Discord:** [Here](https://discord.gg/sfuWXRfeTt) - -### Installing Manually -1. Install [BepInEx](https://thunderstore.io/package/download/BepInEx/BepInExPack_Inscryption/5.4.2305/) by pressing `Manual Download` and extract the contents into a folder. **Do not extract into the game folder!** -2. Move the contents of the `BepInExPack_Inscryption` folder into the game folder (where the game executable is; usually found here: `C:\Program Files (x86)\Steam\steamapps\common\Inscryption`). -3. Run the game. If everything was done correctly, you will see the BepInEx console appear on your desktop. Close the game after it finishes loading. -4. Install [MonoModLoader](https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/) and extract the contents into a folder. -5. Move the contents of the `patchers` folder into `BepInEx/patchers` (If any of the mentioned BepInEx folders don't exist, just create them). -6. Install [Inscryption API](https://inscryption.thunderstore.io/package/API_dev/API/) and extract the contents into a folder. -7. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder. -8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded. -9. For any additional mods create a new subfolder, it can be called anything and extract the zips archive into it and if there is a `BepInEx` folder within the zip instead drop the contents of that folder into the `BepInEx` root for the modding instance. EX; - ``` - BepInEx // These go within the BepInEx root folder - |-- config - |-- patchers - |-- plugins - |-- monomod - |-- core - plugins // Files within go into the created plugin subfolder that was created for the mod - |-- Art - |-- Scripts - |-- MyMod.dll - manifest.json // Ignorable, but if kept, goes in plugin subfolder - README.md // Ignorable, but if kept, goes in plugin subfolder - CHANGELOG.md // Ignorable, but if kept, goes in plugin subfolder - icon.png // Ignorable, but if kept, goes in plugin subfolder - ``` -10. Run the game once more and everything should be correct and working. - -### Installing Manually (XBOX Game-Pass) -1. Install [BepInEx](https://thunderstore.io/package/download/BepInEx/BepInExPack_Inscryption/5.4.2305/) by pressing `Manual Download` and extract the contents into a folder. **Do not extract into the game folder!** -2. Move the contents of the `BepInExPack_Inscryption` folder into the game folder (where the game executable is; usually found here: `C:\XboxGames\Inscryption\Content`). -3. Install the following package: [XboxSilencio](https://thunderstore.io/c/inscryption/p/CORE_API_TEAM/GamepassSilencio/), this is a package which aims to solve frictions with XBOX Gamepass specific installations, such as HueyFS related errors. -4. Run the game. If everything was done correctly, you will see the BepInEx console appear on your desktop. Close the game after it finishes loading. -5. Install [MonoModLoader](https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/) and extract the contents into a folder. -6. Move the contents of the `patchers` folder into `BepInEx/patchers` (If any of the mentioned BepInEx folders don't exist, just create them). -7. Install [Inscryption API](https://inscryption.thunderstore.io/package/API_dev/API/) and extract the contents into a folder. -8. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder. -9. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded. -10. For any additional mods create a new subfolder, it can be called anything and extract the zips archive into it and if there is a `BepInEx` folder within the zip instead drop the contents of that folder into the `BepInEx` root for the modding instance. EX; - ``` - BepInEx // These go within the BepInEx root folder - |-- config - |-- patchers - |-- plugins - |-- monomod - |-- core - plugins // Files within go into the created plugin subfolder that was created for the mod - |-- Art - |-- Scripts - |-- MyMod.dll - manifest.json // Ignorable, but if kept, goes in plugin subfolder - README.md // Ignorable, but if kept, goes in plugin subfolder - CHANGELOG.md // Ignorable, but if kept, goes in plugin subfolder - icon.png // Ignorable, but if kept, goes in plugin subfolder - ``` -11. Run the game once more and everything should be correct and working. - -### Installing on the Steam Deck -1. Download [r2modman](https://thunderstore.io/c/inscryption/p/ebkr/r2modman/) on the Steam Deck's Desktop Mode and open it from its download using its `AppImage` file. -2. Download the mods you plan on using and their dependencies. -3. Go to the setting of the profile you are using for the mods and click `Browse Profile Folder`. -4. Copy the BepInEx folder, then go to Steam and open Inscryption's Properties menu -5. Go to `Installed Files` click `Browse` to open the folder containing Inscryption's local files; paste the BepInEx folder there. -6. Enter Gaming Mode and check 'Force the use of a specific Steam Play compatibility tool' in the Properties menu under `Compatibility`. -7. Go to the launch parameters and enter `WINEDLLOVERRIDES="winhttp.dll=n,b" %command%`. -8. Open Inscryption. If everything was done correctly, you should see a console appear on your screen. - -### Mac & Linux -1. Follow the steps here first: -2. Next do steps 4-10 of the Manual Installation -3. Your game should be setup for inscryption modding now - -If you have any issues with Mac/Linux, Steam Deck, or Manual head over to the discord for this game: - -* **Inscryption Modding Discord:** [Here](https://discord.gg/ZQPvfKEpwM) - ## Getting Started: Modding --- Modding Inscryption requires a knowledge of coding in C# or a similar programming language such as Java, and in many cases an understanding of how to patch the game using HarmonyPatch, which you can find the docs for [here](https://github.com/BepInEx/HarmonyX/wiki) for HarmonyX, and [here](https://harmony.pardeike.net/v2/articles/intro.html) for the underlying basic Harmony. diff --git a/docs/wiki/getting_started/index.md b/docs/wiki/getting_started/index.md index e69de29b..092da12e 100644 --- a/docs/wiki/getting_started/index.md +++ b/docs/wiki/getting_started/index.md @@ -0,0 +1,17 @@ +# Getting Started + +This set of articles covers getting started for both users and modders. This page acts as the homepage that links out to them. You can switch between them through the table of contents, which is on the left hand of the screen. You can also switch to other articles through the table of contents. + +## Getting Started (Users) + +The following are links to articles relavent for Users of the API. Namely covering the topic of installation of mods for Inscryption that utilize the API. This also includes how to install BepInEx, the underlying framework for all Inscryption Mods, for all of the given scenarios the Articles tackle. + +**FOR LINUX AND STEAMDECK:** Ensure that the game is set to run using `Proton` in he game settings on steam. Should be a setting like this: `Change launch behaviour` -> `Proton`. + +* [Installing With a Mod Manager](users/installing_with_a_mod_manager.md) +* [Installing Manually on Windows (x86)](users/installing_manually_on_windows_x86.md) +* [Installing Manually on Windows (x64)](users/installing_manually_on_windows_x64.md) +* [Installing on The Steam Deck](users/installing_on_the_steam_deck.md) +* [Installing on Mac & Linux](users/installing_on_mac_and_linux.md) + +## Getting Started (Modders) \ No newline at end of file diff --git a/docs/wiki/getting_started/users/index.md b/docs/wiki/getting_started/users/index.md index e69de29b..ca8b3ad0 100644 --- a/docs/wiki/getting_started/users/index.md +++ b/docs/wiki/getting_started/users/index.md @@ -0,0 +1,11 @@ +# Getting Started (Users) + +The following are links to articles relavent for Users of the API. Namely covering the topic of installation of mods for Inscryption that utilize the API. This also includes how to install BepInEx, the underlying framework for all Inscryption Mods, for all of the given scenarios the Articles tackle. + +**FOR LINUX AND STEAMDECK:** Ensure that the game is set to run using `Proton` in he game settings on steam. Should be a setting like this: `Change launch behaviour` -> `Proton`. + +* [Installing With a Mod Manager](users/installing_with_a_mod_manager.md) +* [Installing Manually on Windows (x86)](users/installing_manually_on_windows_x86.md) +* [Installing Manually on Windows (x64)](users/installing_manually_on_windows_x64.md) +* [Installing on The Steam Deck](users/installing_on_the_steam_deck.md) +* [Installing on Mac & Linux](users/installing_on_mac_and_linux.md) \ No newline at end of file diff --git a/docs/wiki/getting_started/users/installing_manually_on_windows_x64.md b/docs/wiki/getting_started/users/installing_manually_on_windows_x64.md new file mode 100644 index 00000000..8ac44d99 --- /dev/null +++ b/docs/wiki/getting_started/users/installing_manually_on_windows_x64.md @@ -0,0 +1,29 @@ +# Installing Manually on Windows (x64) + +1. Install [BepInEx](https://thunderstore.io/package/download/BepInEx/BepInExPack_Inscryption/5.4.2305/) by pressing `Manual Download` and extract the contents into a folder. **Do not extract into the game folder!** +2. Move the contents of the `BepInExPack_Inscryption` folder into the game folder (where the game executable is; usually found here: `C:\XboxGames\Inscryption\Content`). +3. Install the following package: [XboxSilencio](https://thunderstore.io/c/inscryption/p/CORE_API_TEAM/GamepassSilencio/), this is a package which aims to solve frictions with XBOX Gamepass specific installations, such as HueyFS related errors. +4. Run the game. If everything was done correctly, you will see the BepInEx console appear on your desktop. Close the game after it finishes loading. +5. Install [MonoModLoader](https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/) and extract the contents into a folder. +6. Move the contents of the `patchers` folder into `BepInEx/patchers` (If any of the mentioned BepInEx folders don't exist, just create them). +7. Install [Inscryption API](https://inscryption.thunderstore.io/package/API_dev/API/) and extract the contents into a folder. +8. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder. +9. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded. +10. For any additional mods create a new subfolder, it can be called anything and extract the zips archive into it and if there is a `BepInEx` folder within the zip instead drop the contents of that folder into the `BepInEx` root for the modding instance. EX; + ``` + BepInEx // These go within the BepInEx root folder + |-- config + |-- patchers + |-- plugins + |-- monomod + |-- core + plugins // Files within go into the created plugin subfolder that was created for the mod + |-- Art + |-- Scripts + |-- MyMod.dll + manifest.json // Ignorable, but if kept, goes in plugin subfolder + README.md // Ignorable, but if kept, goes in plugin subfolder + CHANGELOG.md // Ignorable, but if kept, goes in plugin subfolder + icon.png // Ignorable, but if kept, goes in plugin subfolder + ``` +11. Run the game once more and everything should be correct and working. \ No newline at end of file diff --git a/docs/wiki/getting_started/users/installing_manually_on_windows_x86.md b/docs/wiki/getting_started/users/installing_manually_on_windows_x86.md new file mode 100644 index 00000000..0a28fe84 --- /dev/null +++ b/docs/wiki/getting_started/users/installing_manually_on_windows_x86.md @@ -0,0 +1,28 @@ +# Installing Manually on Windows (x86) + +1. Install [BepInEx](https://thunderstore.io/package/download/BepInEx/BepInExPack_Inscryption/5.4.2305/) by pressing `Manual Download` and extract the contents into a folder. **Do not extract into the game folder!** +2. Move the contents of the `BepInExPack_Inscryption` folder into the game folder (where the game executable is; usually found here: `C:\Program Files (x86)\Steam\steamapps\common\Inscryption`). +3. Run the game. If everything was done correctly, you will see the BepInEx console appear on your desktop. Close the game after it finishes loading. +4. Install [MonoModLoader](https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/) and extract the contents into a folder. +5. Move the contents of the `patchers` folder into `BepInEx/patchers` (If any of the mentioned BepInEx folders don't exist, just create them). +6. Install [Inscryption API](https://inscryption.thunderstore.io/package/API_dev/API/) and extract the contents into a folder. +7. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder. +8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded. +9. For any additional mods create a new subfolder, it can be called anything and extract the zips archive into it and if there is a `BepInEx` folder within the zip instead drop the contents of that folder into the `BepInEx` root for the modding instance. EX; + ``` + BepInEx // These go within the BepInEx root folder + |-- config + |-- patchers + |-- plugins + |-- monomod + |-- core + plugins // Files within go into the created plugin subfolder that was created for the mod + |-- Art + |-- Scripts + |-- MyMod.dll + manifest.json // Ignorable, but if kept, goes in plugin subfolder + README.md // Ignorable, but if kept, goes in plugin subfolder + CHANGELOG.md // Ignorable, but if kept, goes in plugin subfolder + icon.png // Ignorable, but if kept, goes in plugin subfolder + ``` +10. Run the game once more and everything should be correct and working. \ No newline at end of file diff --git a/docs/wiki/getting_started/users/installing_on_mac_and_linux.md b/docs/wiki/getting_started/users/installing_on_mac_and_linux.md new file mode 100644 index 00000000..6c0715f9 --- /dev/null +++ b/docs/wiki/getting_started/users/installing_on_mac_and_linux.md @@ -0,0 +1,11 @@ +# Installing on Mac & Linux + +**FOR LINUX:** Ensure that the game is set to run using `Proton` in he game settings on steam. Should be a setting like this: `Change launch behaviour` -> `Proton`. + +1. Follow the steps here first: +2. Next do steps 4-10 of the Manual Installation +3. Your game should be setup for inscryption modding now + +If you have any issues with Mac/Linux, Steam Deck, or Manual head over to the discord for this game: + +* **Inscryption Modding Discord:** [Here](https://discord.gg/ZQPvfKEpwM) \ No newline at end of file diff --git a/docs/wiki/getting_started/users/installing_on_the_steam_deck.md b/docs/wiki/getting_started/users/installing_on_the_steam_deck.md new file mode 100644 index 00000000..c9e7f0b7 --- /dev/null +++ b/docs/wiki/getting_started/users/installing_on_the_steam_deck.md @@ -0,0 +1,12 @@ +# Installing on The Steam Deck + +**FOR STEAMDECK:** Ensure that the game is set to run using `Proton` in he game settings on steam. Should be a setting like this: `Change launch behaviour` -> `Proton`. + +1. Download [r2modman](https://thunderstore.io/c/inscryption/p/ebkr/r2modman/) on the Steam Deck's Desktop Mode and open it from its download using its `AppImage` file. +2. Download the mods you plan on using and their dependencies. +3. Go to the setting of the profile you are using for the mods and click `Browse Profile Folder`. +4. Copy the BepInEx folder, then go to Steam and open Inscryption's Properties menu +5. Go to `Installed Files` click `Browse` to open the folder containing Inscryption's local files; paste the BepInEx folder there. +6. Enter Gaming Mode and check 'Force the use of a specific Steam Play compatibility tool' in the Properties menu under `Compatibility`. +7. Go to the launch parameters and enter `WINEDLLOVERRIDES="winhttp.dll=n,b" %command%`. +8. Open Inscryption. If everything was done correctly, you should see a console appear on your screen. \ No newline at end of file diff --git a/docs/wiki/getting_started/users/installing_with_a_mod_manager.md b/docs/wiki/getting_started/users/installing_with_a_mod_manager.md new file mode 100644 index 00000000..f7b5abcb --- /dev/null +++ b/docs/wiki/getting_started/users/installing_with_a_mod_manager.md @@ -0,0 +1,11 @@ +# Installing With a Mod Manager + +1. Download and install [Thunderstore Mod Manager](https://www.overwolf.com/app/Thunderstore-Thunderstore_Mod_Manager), [Gale](https://thunderstore.io/c/inscryption/p/Kesomannen/GaleModManager/), [Pulsar](https://pulsarmods.com/) or [r2modman](https://thunderstore.io/c/inscryption/p/ebkr/r2modman/). +2. Click the **Install with Mod Manager** button on the top of [BepInEx's](https://thunderstore.io/c/inscryption/p/BepInEx/BepInExPack_Inscryption/) page. +3. Run the game via the mod manager. + +If you have issues with Mod Managers head to one of these discords; + +* **Thunderstore Support Discord:** [Here](https://discord.gg/Fbz54kQAxg) +* **R2ModMan Support Discord:** [Here](https://discord.gg/R85wjqa4WN) +* **Gale Mod Manager Support Discord:** [Here](https://discord.gg/sfuWXRfeTt) \ No newline at end of file diff --git a/docs/wiki/getting_started/users/toc.yml b/docs/wiki/getting_started/users/toc.yml index b227618e..009798e4 100644 --- a/docs/wiki/getting_started/users/toc.yml +++ b/docs/wiki/getting_started/users/toc.yml @@ -1,3 +1,11 @@ items: -- name: Getting Started (Users) - href: index.md \ No newline at end of file +- name: Installing With a Mod Manager + href: installing_with_a_mod_manager.md +- name: Installing Manually on Windows (x86) + href: installing_manually_on_windows_x86.md +- name: Installing Manually on Windows (x64) + href: installing_manually_on_windows_x64.md +- name: Installing on The Steam Deck + href: installing_on_the_steam_deck.md +- name: Installing on Mac & Linux + href: installing_on_mac_and_linux.md \ No newline at end of file From ddd71b2c9344ede717f135b6c6c537f1cdece9d4 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 12:05:06 -0500 Subject: [PATCH 17/37] resolve a heading overflow issue at zoom 220%, 240%, 260%, 280%, 300%, Based on a screen of size; 1920x1080, 60hz, but this will fix it for the sizes in which the search bar is below the nav titles, and not in mobile layout. --- docs/template/api_wiki/public/main.css | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/template/api_wiki/public/main.css b/docs/template/api_wiki/public/main.css index 4234cf81..d5f7282c 100644 --- a/docs/template/api_wiki/public/main.css +++ b/docs/template/api_wiki/public/main.css @@ -140,11 +140,11 @@ b, strong { } body > header, body[data-layout="landing"] > header { - min-height: 90px; + min-height: 120px; } body > footer, body[data-layout="landing"] > footer { - min-height: 90px; + min-height: 120px; display: flex; align-items: stretch; } From fa8f4780329e88003cdd3d7c96c109a4e35dad0b Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 12:06:14 -0500 Subject: [PATCH 18/37] Quick fix user level index.md under Getting Started --- docs/wiki/getting_started/users/index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/wiki/getting_started/users/index.md b/docs/wiki/getting_started/users/index.md index ca8b3ad0..189bca86 100644 --- a/docs/wiki/getting_started/users/index.md +++ b/docs/wiki/getting_started/users/index.md @@ -4,8 +4,8 @@ The following are links to articles relavent for Users of the API. Namely coveri **FOR LINUX AND STEAMDECK:** Ensure that the game is set to run using `Proton` in he game settings on steam. Should be a setting like this: `Change launch behaviour` -> `Proton`. -* [Installing With a Mod Manager](users/installing_with_a_mod_manager.md) -* [Installing Manually on Windows (x86)](users/installing_manually_on_windows_x86.md) -* [Installing Manually on Windows (x64)](users/installing_manually_on_windows_x64.md) -* [Installing on The Steam Deck](users/installing_on_the_steam_deck.md) -* [Installing on Mac & Linux](users/installing_on_mac_and_linux.md) \ No newline at end of file +* [Installing With a Mod Manager](installing_with_a_mod_manager.md) +* [Installing Manually on Windows (x86)](installing_manually_on_windows_x86.md) +* [Installing Manually on Windows (x64)](installing_manually_on_windows_x64.md) +* [Installing on The Steam Deck](installing_on_the_steam_deck.md) +* [Installing on Mac & Linux](installing_on_mac_and_linux.md) \ No newline at end of file From 2f807cb352c8c1feee4faa98f67a1957243e4696 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 12:10:02 -0500 Subject: [PATCH 19/37] Make the spacing between the arrow and toc item larger --- docs/template/api_wiki/public/main.css | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/template/api_wiki/public/main.css b/docs/template/api_wiki/public/main.css index d5f7282c..836f28c9 100644 --- a/docs/template/api_wiki/public/main.css +++ b/docs/template/api_wiki/public/main.css @@ -408,4 +408,8 @@ blockquote { border-right-style: none; border-top-style: none; border-bottom-style: none; +} + +.toc li > a { + padding-left: 0.5rem; } \ No newline at end of file From 66e7102955561c99714b57a78554bf19287fe34f Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 13:01:46 -0500 Subject: [PATCH 20/37] Part 2 of Getting Started Rework into Sub-Items --- docs/wiki/getting_started/index.md | 48 ++++++++++++++++- .../api_projects_rider_edition/index.md | 0 .../api_projects_rider_edition/toc.yml | 1 + .../modders/api_projects_vs_edition/index.md | 0 .../modders/api_projects_vs_edition/toc.yml | 1 + .../modders/c_sharp_basics/index.md | 0 .../modders/c_sharp_basics/toc.yml | 1 + docs/wiki/getting_started/modders/index.md | 52 +++++++++++++++++++ .../modders/jsonloader_projects/index.md | 0 .../modders/jsonloader_projects/toc.yml | 1 + docs/wiki/getting_started/modders/toc.yml | 14 ++++- docs/wiki/getting_started/users/index.md | 2 +- .../users/installing_on_mac_and_linux.md | 2 +- .../users/installing_on_the_steam_deck.md | 2 +- 14 files changed, 117 insertions(+), 7 deletions(-) create mode 100644 docs/wiki/getting_started/modders/api_projects_rider_edition/index.md create mode 100644 docs/wiki/getting_started/modders/api_projects_rider_edition/toc.yml create mode 100644 docs/wiki/getting_started/modders/api_projects_vs_edition/index.md create mode 100644 docs/wiki/getting_started/modders/api_projects_vs_edition/toc.yml create mode 100644 docs/wiki/getting_started/modders/c_sharp_basics/index.md create mode 100644 docs/wiki/getting_started/modders/c_sharp_basics/toc.yml create mode 100644 docs/wiki/getting_started/modders/jsonloader_projects/index.md create mode 100644 docs/wiki/getting_started/modders/jsonloader_projects/toc.yml diff --git a/docs/wiki/getting_started/index.md b/docs/wiki/getting_started/index.md index 092da12e..cc063145 100644 --- a/docs/wiki/getting_started/index.md +++ b/docs/wiki/getting_started/index.md @@ -6,7 +6,7 @@ This set of articles covers getting started for both users and modders. This pag The following are links to articles relavent for Users of the API. Namely covering the topic of installation of mods for Inscryption that utilize the API. This also includes how to install BepInEx, the underlying framework for all Inscryption Mods, for all of the given scenarios the Articles tackle. -**FOR LINUX AND STEAMDECK:** Ensure that the game is set to run using `Proton` in he game settings on steam. Should be a setting like this: `Change launch behaviour` -> `Proton`. +***FOR LINUX AND STEAMDECK:*** Ensure that the game is set to run using `Proton` in he game settings on steam. Should be a setting like this: `Change launch behaviour` -> `Proton`. * [Installing With a Mod Manager](users/installing_with_a_mod_manager.md) * [Installing Manually on Windows (x86)](users/installing_manually_on_windows_x86.md) @@ -14,4 +14,48 @@ The following are links to articles relavent for Users of the API. Namely coveri * [Installing on The Steam Deck](users/installing_on_the_steam_deck.md) * [Installing on Mac & Linux](users/installing_on_mac_and_linux.md) -## Getting Started (Modders) \ No newline at end of file +## Getting Started (Modders) + +So your interested in learning how to modify Inscryption? Well this section of our guide should come in really handy for you! Albeit if your a artist, a developer, or just passing by, we hope you find these guides of value. + +First off let's get you to the right branch of the guides. Let's get some groundworks out of the way now. Based on the item below, you should be funneled to the level your after. + +```mermaid +flowchart TD + A["Are you trying to make a Simple Cardpack?"] + A --> A1["If this item applied to you, than let's head to the
[JSONLoader Branch]()
Unless your willing to challenge yourself?
If you want the challenge, follow the other tree!"] + + B["Are you after something more Complex in terms of your Project?"] + B --> C["Are you already familiar with C#?"] + + C -->|Yes| D["What is your preferred of the two? Visual Studio, or JetBrains Rider?"] + C -->|No| C1["If this was your case, than let's head into the
[C# Basics Branch](), to get you familiar with the underlying concepts,
and knowledge you will need in order to make your mod."] + + D -->|Visual Studio| D1["If this was your choice, let us navigate into the
[API Project Setup Guide for Visual Studio]()."] + D -->|JetBrains Rider| D2["If this was your choice, let us navigate into the
[API Project Setup Guide for JetBrains Rider]()."] + + click A1 "modders/jsonloader_projects/index.md" "Open JSONLoader Branch" + click C1 "modders/c_sharp_basics/index.md" "Open C# Basics Branch" + click D1 "modders/api_projects_vs_edition/index.md" "Open Visual Studio Setup Guide" + click D2 "modders/api_projects_rider_edition/index.md" "Open JetBrains Rider Setup Guide" +``` + +
+ +Plain-Text Version + + +1. Are you trying to make a Simple Cardpack? + - If this item applied to you, than let's head to the [JSONLoader Branch](modders/jsonloader_projects/index.md) shallst we? Unless your willing to challenge yourself? +2. Are you after something more Complex in terms of your Project? + 1. Are you already familiar with C#? + * If `Yes` was your choice: + 1. What is your preferred of the two? Visual Studio, or JetBrains Rider? + * If `Visual Studio` was your choice: + - If this was your choice, let us navigate into the [API Project Setup Guide for Visual Studio](modders/api_projects_vs_edition/index.md). + * If `JetBrains Rider` was your choice: + - If this was your choice, let us navigate into the [API Project Setup Guide for JetBrains Rider](modders/api_projects_rider_edition/index.md). + * If `No` was your choice: + - If this was your case, than let's head into the [C# Basics Branch](modders/c_sharp_basics/index.md), to get you familiar with the underlying concepts and knowledge you will need in order to make your mod. + +
\ No newline at end of file diff --git a/docs/wiki/getting_started/modders/api_projects_rider_edition/index.md b/docs/wiki/getting_started/modders/api_projects_rider_edition/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/wiki/getting_started/modders/api_projects_rider_edition/toc.yml b/docs/wiki/getting_started/modders/api_projects_rider_edition/toc.yml new file mode 100644 index 00000000..f54cdfb3 --- /dev/null +++ b/docs/wiki/getting_started/modders/api_projects_rider_edition/toc.yml @@ -0,0 +1 @@ +items: \ No newline at end of file diff --git a/docs/wiki/getting_started/modders/api_projects_vs_edition/index.md b/docs/wiki/getting_started/modders/api_projects_vs_edition/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/wiki/getting_started/modders/api_projects_vs_edition/toc.yml b/docs/wiki/getting_started/modders/api_projects_vs_edition/toc.yml new file mode 100644 index 00000000..f54cdfb3 --- /dev/null +++ b/docs/wiki/getting_started/modders/api_projects_vs_edition/toc.yml @@ -0,0 +1 @@ +items: \ No newline at end of file diff --git a/docs/wiki/getting_started/modders/c_sharp_basics/index.md b/docs/wiki/getting_started/modders/c_sharp_basics/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/wiki/getting_started/modders/c_sharp_basics/toc.yml b/docs/wiki/getting_started/modders/c_sharp_basics/toc.yml new file mode 100644 index 00000000..f54cdfb3 --- /dev/null +++ b/docs/wiki/getting_started/modders/c_sharp_basics/toc.yml @@ -0,0 +1 @@ +items: \ No newline at end of file diff --git a/docs/wiki/getting_started/modders/index.md b/docs/wiki/getting_started/modders/index.md index e69de29b..8396a522 100644 --- a/docs/wiki/getting_started/modders/index.md +++ b/docs/wiki/getting_started/modders/index.md @@ -0,0 +1,52 @@ +# Getting Started (Modders) + +So your interested in learning how to modify Inscryption? Well this section of our guide should come in really handy for you! Albeit if your a artist, a developer, or just passing by, we hope you find these guides of value. + +First off let's get you to the right branch of the guides. Let's get some groundworks out of the way now. Based on the item below, you should be funneled to the level your after. + +```mermaid +flowchart TD + A["Are you trying to make a Simple Cardpack?"] + A --> A1["If this item applied to you, than let's head to the
[JSONLoader Branch]()
Unless your willing to challenge yourself?
If you want the challenge, follow the other tree!"] + + B["Are you after something more Complex in terms of your Project?"] + B --> C["Are you already familiar with C#?"] + + C -->|Yes| D["What is your preferred of the two? Visual Studio, or JetBrains Rider?"] + C -->|No| C1["If this was your case, than let's head into the
[C# Basics Branch](), to get you familiar with the underlying concepts,
and knowledge you will need in order to make your mod."] + + D -->|Visual Studio| D1["If this was your choice, let us navigate into the
[API Project Setup Guide for Visual Studio]()."] + D -->|JetBrains Rider| D2["If this was your choice, let us navigate into the
[API Project Setup Guide for JetBrains Rider]()."] + + click A1 "jsonloader_projects/index.md" "Open JSONLoader Branch" + click C1 "c_sharp_basics/index.md" "Open C# Basics Branch" + click D1 "api_projects_vs_edition/index.md" "Open Visual Studio Setup Guide" + click D2 "api_projects_rider_edition/index.md" "Open JetBrains Rider Setup Guide" +``` + +
+ +Plain-Text Version + + +1. Are you trying to make a Simple Cardpack? + - If this item applied to you, than let's head to the [JSONLoader Branch](jsonloader_projects/index.md) shallst we? Unless your willing to challenge yourself? +2. Are you after something more Complex in terms of your Project? + 1. Are you already familiar with C#? + * If `Yes` was your choice: + 1. What is your preferred of the two? Visual Studio, or JetBrains Rider? + * If `Visual Studio` was your choice: + - If this was your choice, let us navigate into the [API Project Setup Guide for Visual Studio](api_projects_vs_edition/index.md). + * If `JetBrains Rider` was your choice: + - If this was your choice, let us navigate into the [API Project Setup Guide for JetBrains Rider](api_projects_rider_edition/index.md). + * If `No` was your choice: + - If this was your case, than let's head into the [C# Basics Branch](c_sharp_basics/index.md), to get you familiar with the underlying concepts and knowledge you will need in order to make your mod. + +
+ +### Modding Resources +- [Inscryption Modding Discord](https://discord.gg/QrJEF5Denm) +- [BepInEx documentation](https://docs.bepinex.dev/) +- [Harmony patching article](https://harmony.pardeike.net/articles/patching.html) +- [Example Mod using C#](https://github.com/debugman18/InscryptionExampleMod) +- [Vanilla and Modded Enumerations](https://github.com/SaxbyMod/SabyModEnums) diff --git a/docs/wiki/getting_started/modders/jsonloader_projects/index.md b/docs/wiki/getting_started/modders/jsonloader_projects/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/wiki/getting_started/modders/jsonloader_projects/toc.yml b/docs/wiki/getting_started/modders/jsonloader_projects/toc.yml new file mode 100644 index 00000000..f54cdfb3 --- /dev/null +++ b/docs/wiki/getting_started/modders/jsonloader_projects/toc.yml @@ -0,0 +1 @@ +items: \ No newline at end of file diff --git a/docs/wiki/getting_started/modders/toc.yml b/docs/wiki/getting_started/modders/toc.yml index 3a0e999a..ea9a9099 100644 --- a/docs/wiki/getting_started/modders/toc.yml +++ b/docs/wiki/getting_started/modders/toc.yml @@ -1,3 +1,13 @@ items: -- name: Getting Started (Modders) - href: index.md \ No newline at end of file +- name: JSONLoader Projects + href: jsonloader_projects/toc.yml + homepage: jsonloader_projects/index.md +- name: C# Basics + href: c_sharp_basics/toc.yml + homepage: c_sharp_basics/index.md +- name: API Projects (Visual Studio Edition) + href: api_projects_vs_edition/toc.yml + homepage: api_projects_vs_edition/index.md +- name: API Projects (JetBrains Rider Edition) + href: api_projects_rider_edition/toc.yml + homepage: api_projects_rider_edition/index.md \ No newline at end of file diff --git a/docs/wiki/getting_started/users/index.md b/docs/wiki/getting_started/users/index.md index 189bca86..a65b17fd 100644 --- a/docs/wiki/getting_started/users/index.md +++ b/docs/wiki/getting_started/users/index.md @@ -2,7 +2,7 @@ The following are links to articles relavent for Users of the API. Namely covering the topic of installation of mods for Inscryption that utilize the API. This also includes how to install BepInEx, the underlying framework for all Inscryption Mods, for all of the given scenarios the Articles tackle. -**FOR LINUX AND STEAMDECK:** Ensure that the game is set to run using `Proton` in he game settings on steam. Should be a setting like this: `Change launch behaviour` -> `Proton`. +***FOR LINUX AND STEAMDECK:*** Ensure that the game is set to run using `Proton` in he game settings on steam. Should be a setting like this: `Change launch behaviour` -> `Proton`. * [Installing With a Mod Manager](installing_with_a_mod_manager.md) * [Installing Manually on Windows (x86)](installing_manually_on_windows_x86.md) diff --git a/docs/wiki/getting_started/users/installing_on_mac_and_linux.md b/docs/wiki/getting_started/users/installing_on_mac_and_linux.md index 6c0715f9..e73e296a 100644 --- a/docs/wiki/getting_started/users/installing_on_mac_and_linux.md +++ b/docs/wiki/getting_started/users/installing_on_mac_and_linux.md @@ -1,6 +1,6 @@ # Installing on Mac & Linux -**FOR LINUX:** Ensure that the game is set to run using `Proton` in he game settings on steam. Should be a setting like this: `Change launch behaviour` -> `Proton`. +***FOR LINUX:*** Ensure that the game is set to run using `Proton` in he game settings on steam. Should be a setting like this: `Change launch behaviour` -> `Proton`. 1. Follow the steps here first: 2. Next do steps 4-10 of the Manual Installation diff --git a/docs/wiki/getting_started/users/installing_on_the_steam_deck.md b/docs/wiki/getting_started/users/installing_on_the_steam_deck.md index c9e7f0b7..2084f7de 100644 --- a/docs/wiki/getting_started/users/installing_on_the_steam_deck.md +++ b/docs/wiki/getting_started/users/installing_on_the_steam_deck.md @@ -1,6 +1,6 @@ # Installing on The Steam Deck -**FOR STEAMDECK:** Ensure that the game is set to run using `Proton` in he game settings on steam. Should be a setting like this: `Change launch behaviour` -> `Proton`. +***FOR STEAMDECK:*** Ensure that the game is set to run using `Proton` in he game settings on steam. Should be a setting like this: `Change launch behaviour` -> `Proton`. 1. Download [r2modman](https://thunderstore.io/c/inscryption/p/ebkr/r2modman/) on the Steam Deck's Desktop Mode and open it from its download using its `AppImage` file. 2. Download the mods you plan on using and their dependencies. From 4edad5833f5427102e74e6d4796eef2563a3dabd Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 14:48:00 -0500 Subject: [PATCH 21/37] Mermaid Styling --- docs/template/api_wiki/public/main.css | 27 ++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/template/api_wiki/public/main.css b/docs/template/api_wiki/public/main.css index 836f28c9..1865bcd9 100644 --- a/docs/template/api_wiki/public/main.css +++ b/docs/template/api_wiki/public/main.css @@ -412,4 +412,31 @@ blockquote { .toc li > a { padding-left: 0.5rem; +} + +.nodeLabel { + font-family: var(--code-font); + font-size: var(--code-font-size) !important; + line-height: var(--code-line-height); +} + +.edgeLabel { + font-family: var(--code-font); + font-size: var(--code-font-size) !important; + line-height: var(--code-line-height); +} + +.edgeLabel p { + background-color: var(--bs-tertiary-bg, #e9ecef); + padding: 0.15em 0.35em; + border-radius: 4px; +} + +.mermaidTooltip { + font-family: var(--code-font); + font-size: var(--code-font-size) !important; + line-height: var(--code-line-height); + background-color: var(--bs-tertiary-bg, #e9ecef); + padding: 0.15em 0.35em; + border-radius: 4px; } \ No newline at end of file From 282ea90df1c736f5cfa0c7fa8f56c9da5fe8cc85 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 15:13:26 -0500 Subject: [PATCH 22/37] add color to mermaid styling --- docs/template/api_wiki/public/main.css | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/template/api_wiki/public/main.css b/docs/template/api_wiki/public/main.css index 1865bcd9..ce832b9a 100644 --- a/docs/template/api_wiki/public/main.css +++ b/docs/template/api_wiki/public/main.css @@ -418,6 +418,7 @@ blockquote { font-family: var(--code-font); font-size: var(--code-font-size) !important; line-height: var(--code-line-height); + color: var(--bs-code-color); } .edgeLabel { @@ -430,6 +431,7 @@ blockquote { background-color: var(--bs-tertiary-bg, #e9ecef); padding: 0.15em 0.35em; border-radius: 4px; + color: var(--bs-code-color); } .mermaidTooltip { @@ -439,4 +441,5 @@ blockquote { background-color: var(--bs-tertiary-bg, #e9ecef); padding: 0.15em 0.35em; border-radius: 4px; + color: var(--bs-code-color); } \ No newline at end of file From 9317e8275e732027bc01dd3a772e7159b3167440 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 15:39:34 -0500 Subject: [PATCH 23/37] More Mermaid Styling --- docs/template/api_wiki/public/main.css | 38 +++++++++++++++++++++----- 1 file changed, 31 insertions(+), 7 deletions(-) diff --git a/docs/template/api_wiki/public/main.css b/docs/template/api_wiki/public/main.css index ce832b9a..6ed09bd3 100644 --- a/docs/template/api_wiki/public/main.css +++ b/docs/template/api_wiki/public/main.css @@ -414,24 +414,35 @@ blockquote { padding-left: 0.5rem; } -.nodeLabel { +.nodeLabel, +.nodeLabel p { font-family: var(--code-font); font-size: var(--code-font-size) !important; - line-height: var(--code-line-height); - color: var(--bs-code-color); + line-height: var(--code-line-height) !important; + box-sizing: border-box; +} + +.nodeLabel p { + color: var(--bs-code-color) !important; + padding: 0.15em 0.35em; + border-radius: 4px; + margin: 0; } -.edgeLabel { +.edgeLabel, +.edgeLabel p { font-family: var(--code-font); font-size: var(--code-font-size) !important; - line-height: var(--code-line-height); + line-height: var(--code-line-height) !important; + box-sizing: border-box; } .edgeLabel p { - background-color: var(--bs-tertiary-bg, #e9ecef); + background: var(--bs-tertiary-bg, #e9ecef) !important; + color: var(--bs-code-color) !important; padding: 0.15em 0.35em; border-radius: 4px; - color: var(--bs-code-color); + margin: 0; } .mermaidTooltip { @@ -439,7 +450,20 @@ blockquote { font-size: var(--code-font-size) !important; line-height: var(--code-line-height); background-color: var(--bs-tertiary-bg, #e9ecef); + background: var(--bs-tertiary-bg, #e9ecef); padding: 0.15em 0.35em; border-radius: 4px; color: var(--bs-code-color); +} + +.node rect, +.node circle, +.node ellipse, +.node polygon, +.node path { + rx: 4px; + ry: 4px; + stroke: var(--bs-border-color, #444); + stroke-width: 4px; + fill: var(--bs-tertiary-bg, #e9ecef) !important } \ No newline at end of file From ee57ab7b8b847d97b40404c92204fcceccfad811 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 15:56:34 -0500 Subject: [PATCH 24/37] Even More Mermaid Styling --- docs/template/api_wiki/public/main.css | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/template/api_wiki/public/main.css b/docs/template/api_wiki/public/main.css index 6ed09bd3..a13a0faa 100644 --- a/docs/template/api_wiki/public/main.css +++ b/docs/template/api_wiki/public/main.css @@ -441,8 +441,10 @@ blockquote { background: var(--bs-tertiary-bg, #e9ecef) !important; color: var(--bs-code-color) !important; padding: 0.15em 0.35em; + border: 4px solid var(--bs-border-color, #444); border-radius: 4px; margin: 0; + box-sizing: border-box; } .mermaidTooltip { @@ -463,7 +465,11 @@ blockquote { .node path { rx: 4px; ry: 4px; - stroke: var(--bs-border-color, #444); - stroke-width: 4px; - fill: var(--bs-tertiary-bg, #e9ecef) !important + stroke: var(--bs-border-color, #444) !important; + stroke-width: 4px !important; + fill: var(--bs-tertiary-bg, #e9ecef) !important; +} + +.labelBkg { + background: transparent !important; } \ No newline at end of file From c416dcf1a1859b14715d3edbcb2126d62778759d Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 16:02:55 -0500 Subject: [PATCH 25/37] Yet Again More Mermaid --- docs/template/api_wiki/public/main.css | 12 ++++++----- docs/wiki/getting_started/index.md | 25 ++++++++++++++-------- docs/wiki/getting_started/modders/index.md | 8 +++---- 3 files changed, 27 insertions(+), 18 deletions(-) diff --git a/docs/template/api_wiki/public/main.css b/docs/template/api_wiki/public/main.css index a13a0faa..88a8f614 100644 --- a/docs/template/api_wiki/public/main.css +++ b/docs/template/api_wiki/public/main.css @@ -447,15 +447,17 @@ blockquote { box-sizing: border-box; } -.mermaidTooltip { +div.mermaidTooltip { font-family: var(--code-font); font-size: var(--code-font-size) !important; - line-height: var(--code-line-height); - background-color: var(--bs-tertiary-bg, #e9ecef); - background: var(--bs-tertiary-bg, #e9ecef); + line-height: var(--code-line-height) !important; + background: var(--bs-tertiary-bg, #e9ecef) !important; + color: var(--bs-code-color) !important; padding: 0.15em 0.35em; + border: 4px solid var(--bs-border-color, #444); border-radius: 4px; - color: var(--bs-code-color); + margin: 0; + box-sizing: border-box; } .node rect, diff --git a/docs/wiki/getting_started/index.md b/docs/wiki/getting_started/index.md index cc063145..42ca4c16 100644 --- a/docs/wiki/getting_started/index.md +++ b/docs/wiki/getting_started/index.md @@ -23,21 +23,21 @@ First off let's get you to the right branch of the guides. Let's get some ground ```mermaid flowchart TD A["Are you trying to make a Simple Cardpack?"] - A --> A1["If this item applied to you, than let's head to the
[JSONLoader Branch]()
Unless your willing to challenge yourself?
If you want the challenge, follow the other tree!"] + A --> A1["If this item applied to you, than let's head to the
~~ JSONLoader Branch ~~
Unless your willing to challenge yourself?
If you want the challenge, follow the other tree!"] B["Are you after something more Complex in terms of your Project?"] B --> C["Are you already familiar with C#?"] C -->|Yes| D["What is your preferred of the two? Visual Studio, or JetBrains Rider?"] - C -->|No| C1["If this was your case, than let's head into the
[C# Basics Branch](), to get you familiar with the underlying concepts,
and knowledge you will need in order to make your mod."] + C -->|No| C1["If this was your case, than let's head into the
~~ C# Basics Branch ~~
To get you familiar with the underlying concepts,
and knowledge you will need in order to make your mod."] - D -->|Visual Studio| D1["If this was your choice, let us navigate into the
[API Project Setup Guide for Visual Studio]()."] - D -->|JetBrains Rider| D2["If this was your choice, let us navigate into the
[API Project Setup Guide for JetBrains Rider]()."] + D -->|Visual Studio| D1["If this was your choice, let us navigate into the
~~ API Project Setup Guide for Visual Studio ~~"] + D -->|JetBrains Rider| D2["If this was your choice, let us navigate into the
~~ API Project Setup Guide for JetBrains Rider ~~"] - click A1 "modders/jsonloader_projects/index.md" "Open JSONLoader Branch" - click C1 "modders/c_sharp_basics/index.md" "Open C# Basics Branch" - click D1 "modders/api_projects_vs_edition/index.md" "Open Visual Studio Setup Guide" - click D2 "modders/api_projects_rider_edition/index.md" "Open JetBrains Rider Setup Guide" + click A1 "jsonloader_projects/index.md" "Open JSONLoader Branch" + click C1 "c_sharp_basics/index.md" "Open C# Basics Branch" + click D1 "api_projects_vs_edition/index.md" "Open Visual Studio Setup Guide" + click D2 "api_projects_rider_edition/index.md" "Open JetBrains Rider Setup Guide" ```
@@ -58,4 +58,11 @@ Plain-Text Version * If `No` was your choice: - If this was your case, than let's head into the [C# Basics Branch](modders/c_sharp_basics/index.md), to get you familiar with the underlying concepts and knowledge you will need in order to make your mod. -
\ No newline at end of file + + +### Modding Resources +- [Inscryption Modding Discord](https://discord.gg/QrJEF5Denm) +- [BepInEx documentation](https://docs.bepinex.dev/) +- [Harmony patching article](https://harmony.pardeike.net/articles/patching.html) +- [Example Mod using C#](https://github.com/debugman18/InscryptionExampleMod) +- [Vanilla and Modded Enumerations](https://github.com/SaxbyMod/SabyModEnums) diff --git a/docs/wiki/getting_started/modders/index.md b/docs/wiki/getting_started/modders/index.md index 8396a522..f57ae454 100644 --- a/docs/wiki/getting_started/modders/index.md +++ b/docs/wiki/getting_started/modders/index.md @@ -7,16 +7,16 @@ First off let's get you to the right branch of the guides. Let's get some ground ```mermaid flowchart TD A["Are you trying to make a Simple Cardpack?"] - A --> A1["If this item applied to you, than let's head to the
[JSONLoader Branch]()
Unless your willing to challenge yourself?
If you want the challenge, follow the other tree!"] + A --> A1["If this item applied to you, than let's head to the
~~ JSONLoader Branch ~~
Unless your willing to challenge yourself?
If you want the challenge, follow the other tree!"] B["Are you after something more Complex in terms of your Project?"] B --> C["Are you already familiar with C#?"] C -->|Yes| D["What is your preferred of the two? Visual Studio, or JetBrains Rider?"] - C -->|No| C1["If this was your case, than let's head into the
[C# Basics Branch](), to get you familiar with the underlying concepts,
and knowledge you will need in order to make your mod."] + C -->|No| C1["If this was your case, than let's head into the
~~ C# Basics Branch ~~
To get you familiar with the underlying concepts,
and knowledge you will need in order to make your mod."] - D -->|Visual Studio| D1["If this was your choice, let us navigate into the
[API Project Setup Guide for Visual Studio]()."] - D -->|JetBrains Rider| D2["If this was your choice, let us navigate into the
[API Project Setup Guide for JetBrains Rider]()."] + D -->|Visual Studio| D1["If this was your choice, let us navigate into the
~~ API Project Setup Guide for Visual Studio ~~"] + D -->|JetBrains Rider| D2["If this was your choice, let us navigate into the
~~ API Project Setup Guide for JetBrains Rider ~~"] click A1 "jsonloader_projects/index.md" "Open JSONLoader Branch" click C1 "c_sharp_basics/index.md" "Open C# Basics Branch" From c57e0d09f0a0f3e15e197b5c2a2deb52a8329a35 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 16:08:21 -0500 Subject: [PATCH 26/37] change linking from .md to .html for getting started (modders) --- docs/wiki/getting_started/index.md | 8 ++++---- docs/wiki/getting_started/modders/index.md | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/wiki/getting_started/index.md b/docs/wiki/getting_started/index.md index 42ca4c16..f89eb91d 100644 --- a/docs/wiki/getting_started/index.md +++ b/docs/wiki/getting_started/index.md @@ -34,10 +34,10 @@ flowchart TD D -->|Visual Studio| D1["If this was your choice, let us navigate into the
~~ API Project Setup Guide for Visual Studio ~~"] D -->|JetBrains Rider| D2["If this was your choice, let us navigate into the
~~ API Project Setup Guide for JetBrains Rider ~~"] - click A1 "jsonloader_projects/index.md" "Open JSONLoader Branch" - click C1 "c_sharp_basics/index.md" "Open C# Basics Branch" - click D1 "api_projects_vs_edition/index.md" "Open Visual Studio Setup Guide" - click D2 "api_projects_rider_edition/index.md" "Open JetBrains Rider Setup Guide" + click A1 "jsonloader_projects/index.html" "Open JSONLoader Branch" + click C1 "c_sharp_basics/index.html" "Open C# Basics Branch" + click D1 "api_projects_vs_edition/index.html" "Open Visual Studio Setup Guide" + click D2 "api_projects_rider_edition/index.html" "Open JetBrains Rider Setup Guide" ```
diff --git a/docs/wiki/getting_started/modders/index.md b/docs/wiki/getting_started/modders/index.md index f57ae454..7771d409 100644 --- a/docs/wiki/getting_started/modders/index.md +++ b/docs/wiki/getting_started/modders/index.md @@ -18,10 +18,10 @@ flowchart TD D -->|Visual Studio| D1["If this was your choice, let us navigate into the
~~ API Project Setup Guide for Visual Studio ~~"] D -->|JetBrains Rider| D2["If this was your choice, let us navigate into the
~~ API Project Setup Guide for JetBrains Rider ~~"] - click A1 "jsonloader_projects/index.md" "Open JSONLoader Branch" - click C1 "c_sharp_basics/index.md" "Open C# Basics Branch" - click D1 "api_projects_vs_edition/index.md" "Open Visual Studio Setup Guide" - click D2 "api_projects_rider_edition/index.md" "Open JetBrains Rider Setup Guide" + click A1 "jsonloader_projects/index.html" "Open JSONLoader Branch" + click C1 "c_sharp_basics/index.html" "Open C# Basics Branch" + click D1 "api_projects_vs_edition/index.html" "Open Visual Studio Setup Guide" + click D2 "api_projects_rider_edition/index.html" "Open JetBrains Rider Setup Guide" ```
From 5c3b180b37a85ec2b9c143b426c4469374df2fb4 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 16:13:31 -0500 Subject: [PATCH 27/37] Pinch More Mermaid CSS --- docs/template/api_wiki/public/main.css | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/template/api_wiki/public/main.css b/docs/template/api_wiki/public/main.css index 88a8f614..39c8a4d8 100644 --- a/docs/template/api_wiki/public/main.css +++ b/docs/template/api_wiki/public/main.css @@ -474,4 +474,21 @@ div.mermaidTooltip { .labelBkg { background: transparent !important; +} + +/* Mermaid: Full-width diagrams */ +.mermaid, +.mermaid svg { + width: 100% !important; + max-width: 100% !important; +} + +.mermaid { + display: block; + overflow-x: auto; +} + +.mermaid svg { + display: block; + height: auto !important; } \ No newline at end of file From ff37b5dd8f0f28cbed3d2c6dbe85a2bd130c39d6 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 16:23:05 -0500 Subject: [PATCH 28/37] Add Headers to the Getting Started Modders Section Index's --- .../getting_started/modders/api_projects_rider_edition/index.md | 1 + .../getting_started/modders/api_projects_vs_edition/index.md | 1 + docs/wiki/getting_started/modders/c_sharp_basics/index.md | 1 + docs/wiki/getting_started/modders/jsonloader_projects/index.md | 1 + 4 files changed, 4 insertions(+) diff --git a/docs/wiki/getting_started/modders/api_projects_rider_edition/index.md b/docs/wiki/getting_started/modders/api_projects_rider_edition/index.md index e69de29b..2cbe5505 100644 --- a/docs/wiki/getting_started/modders/api_projects_rider_edition/index.md +++ b/docs/wiki/getting_started/modders/api_projects_rider_edition/index.md @@ -0,0 +1 @@ +# API Projects (JetBrains Rider Edition) \ No newline at end of file diff --git a/docs/wiki/getting_started/modders/api_projects_vs_edition/index.md b/docs/wiki/getting_started/modders/api_projects_vs_edition/index.md index e69de29b..58bdd0e3 100644 --- a/docs/wiki/getting_started/modders/api_projects_vs_edition/index.md +++ b/docs/wiki/getting_started/modders/api_projects_vs_edition/index.md @@ -0,0 +1 @@ +# API Projects (Visual Studio Edition) \ No newline at end of file diff --git a/docs/wiki/getting_started/modders/c_sharp_basics/index.md b/docs/wiki/getting_started/modders/c_sharp_basics/index.md index e69de29b..0cc5e968 100644 --- a/docs/wiki/getting_started/modders/c_sharp_basics/index.md +++ b/docs/wiki/getting_started/modders/c_sharp_basics/index.md @@ -0,0 +1 @@ +# C# Basics \ No newline at end of file diff --git a/docs/wiki/getting_started/modders/jsonloader_projects/index.md b/docs/wiki/getting_started/modders/jsonloader_projects/index.md index e69de29b..aae836a0 100644 --- a/docs/wiki/getting_started/modders/jsonloader_projects/index.md +++ b/docs/wiki/getting_started/modders/jsonloader_projects/index.md @@ -0,0 +1 @@ +# JSONLoader Projects \ No newline at end of file From 4507b631ba48b3c3035986f07607fcbd22cf5fa6 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 16:36:10 -0500 Subject: [PATCH 29/37] More Mermaid Stuff --- docs/template/api_wiki/public/main.css | 11 +++-------- docs/template/api_wiki/public/main.js | 10 +++++++++- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/docs/template/api_wiki/public/main.css b/docs/template/api_wiki/public/main.css index 39c8a4d8..3756289c 100644 --- a/docs/template/api_wiki/public/main.css +++ b/docs/template/api_wiki/public/main.css @@ -476,19 +476,14 @@ div.mermaidTooltip { background: transparent !important; } -/* Mermaid: Full-width diagrams */ -.mermaid, -.mermaid svg { - width: 100% !important; - max-width: 100% !important; -} - .mermaid { + width: 100%; + max-width: 100%; display: block; overflow-x: auto; } .mermaid svg { display: block; - height: auto !important; + max-width: 100%; } \ No newline at end of file diff --git a/docs/template/api_wiki/public/main.js b/docs/template/api_wiki/public/main.js index 2561fe37..0d886f6e 100644 --- a/docs/template/api_wiki/public/main.js +++ b/docs/template/api_wiki/public/main.js @@ -1,5 +1,13 @@ export default { - defaultTheme: 'dark' + defaultTheme: 'dark', + mermaid: { + flowchart: { + nodeSpacing: 100, + rankSpacing: 50, + wrappingWidth: 250, + minNodeWidth: 180 + } + } } const docUrl = document.querySelector('meta[name="docfx:docurl"]')?.content || ''; From c011cba51b833f5a3ec7fcba06fa0bd54f77090b Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 17:17:40 -0500 Subject: [PATCH 30/37] Mermaid Upgrades This is partly testing, but if it works, it will be kept. --- docs/template/api_wiki/public/main.js | 85 ++++++++++++++++++++++++--- 1 file changed, 78 insertions(+), 7 deletions(-) diff --git a/docs/template/api_wiki/public/main.js b/docs/template/api_wiki/public/main.js index 0d886f6e..ee0556ea 100644 --- a/docs/template/api_wiki/public/main.js +++ b/docs/template/api_wiki/public/main.js @@ -1,14 +1,85 @@ export default { defaultTheme: 'dark', - mermaid: { - flowchart: { - nodeSpacing: 100, - rankSpacing: 50, - wrappingWidth: 250, - minNodeWidth: 180 + + start: () => { + const article = document.querySelector('article'); + + if (!article || !window.ResizeObserver) { + return; } + + import('mermaid').then(({ default: mermaid }) => { + const originalInitialize = mermaid.initialize.bind(mermaid); + const originalRun = mermaid.run.bind(mermaid); + + let lastConfig = mermaid.getConfig(); + let lastWidth = article.clientWidth; + + const getMermaidConfig = (config) => { + const articleWidth = article.clientWidth; + + const targetNodeWidth = Math.max( + 180, + Math.floor((articleWidth - 40) / 2) + ); + + return { + ...config, + flowchart: { + ...config.flowchart, + minNodeWidth: targetNodeWidth, + wrappingWidth: targetNodeWidth + } + }; + }; + + mermaid.initialize = (config = {}) => { + const result = originalInitialize(getMermaidConfig(config)); + + lastConfig = mermaid.getConfig(); + + return result; + }; + + const resizeObserver = new ResizeObserver(() => { + const articleWidth = article.clientWidth; + + if (articleWidth === lastWidth) { + return; + } + + lastWidth = articleWidth; + + const diagrams = article.querySelectorAll( + 'pre.mermaid[data-mermaid]' + ); + + const nodes = []; + + diagrams.forEach(diagram => { + if (!diagram.offsetParent) { + return; + } + + diagram.removeAttribute('data-processed'); + diagram.innerHTML = diagram.getAttribute('data-mermaid'); + + nodes.push(diagram); + }); + + if (nodes.length === 0) { + return; + } + + originalInitialize(getMermaidConfig(lastConfig)); + lastConfig = mermaid.getConfig(); + originalRun({ nodes }); + }); + + resizeObserver.observe(article); + }); } -} +}; const docUrl = document.querySelector('meta[name="docfx:docurl"]')?.content || ''; From 15a95b435d4c779256ec23cd2b6c01bd3e3d2283 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 17:35:07 -0500 Subject: [PATCH 31/37] Mermaid Upgrades Pt.2 Again testing --- docs/template/api_wiki/public/main.js | 165 +++++++++++++++++--------- 1 file changed, 106 insertions(+), 59 deletions(-) diff --git a/docs/template/api_wiki/public/main.js b/docs/template/api_wiki/public/main.js index ee0556ea..5a4be2aa 100644 --- a/docs/template/api_wiki/public/main.js +++ b/docs/template/api_wiki/public/main.js @@ -1,6 +1,36 @@ -export default { +const getContentWidth = () => { + const article = document.querySelector('article'); + + if (!article) { + return 0; + } + + const style = getComputedStyle(article); + + return article.clientWidth + - parseFloat(style.paddingLeft || 0) + - parseFloat(style.paddingRight || 0); +}; + +const getNodeWidth = () => Math.max(180, Math.floor((getContentWidth() - 40) / 2)); + +const options = { defaultTheme: 'dark', + // docfx does `const { mermaid } = await options()` then Object.assign()s it + // into initialize(), so these getters run once per render — the first + // render included. No patching, no ordering race. + get mermaid() { + const width = getNodeWidth(); + + return { + flowchart: { + minNodeWidth: width, + wrappingWidth: width + } + }; + }, + start: () => { const article = document.querySelector('article'); @@ -8,79 +38,96 @@ export default { return; } - import('mermaid').then(({ default: mermaid }) => { - const originalInitialize = mermaid.initialize.bind(mermaid); - const originalRun = mermaid.run.bind(mermaid); - - let lastConfig = mermaid.getConfig(); - let lastWidth = article.clientWidth; - - const getMermaidConfig = (config) => { - const articleWidth = article.clientWidth; - - const targetNodeWidth = Math.max( - 180, - Math.floor((articleWidth - 40) / 2) - ); - - return { - ...config, - flowchart: { - ...config.flowchart, - minNodeWidth: targetNodeWidth, - wrappingWidth: targetNodeWidth - } - }; - }; - - mermaid.initialize = (config = {}) => { - const result = originalInitialize(getMermaidConfig(config)); - - lastConfig = mermaid.getConfig(); - - return result; - }; - - const resizeObserver = new ResizeObserver(() => { - const articleWidth = article.clientWidth; - - if (articleWidth === lastWidth) { - return; - } + const MERMAID_FALLBACK = + 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs'; + + let mermaidPromise; - lastWidth = articleWidth; + // 'mermaid' is a bare specifier and there is no import map, so resolve + // the chunk docfx already loaded instead. Cached after first success. + const loadMermaid = () => { + mermaidPromise ??= (async () => { + const chunk = performance + .getEntriesByType('resource') + .map(entry => entry.name) + .find(url => /\/mermaid[.\-][\w\-]*\.min\.js$/.test(url)); - const diagrams = article.querySelectorAll( - 'pre.mermaid[data-mermaid]' - ); + return (await import(chunk || MERMAID_FALLBACK)).default; + })().catch(error => { + mermaidPromise = null; + throw error; + }); - const nodes = []; + return mermaidPromise; + }; - diagrams.forEach(diagram => { - if (!diagram.offsetParent) { - return; - } + let lastWidth = article.clientWidth; + let timer = 0; + let running = false; - diagram.removeAttribute('data-processed'); - diagram.innerHTML = diagram.getAttribute('data-mermaid'); + const render = async () => { + const articleWidth = article.clientWidth; - nodes.push(diagram); - }); + if (running || articleWidth === lastWidth) { + return; + } + + lastWidth = articleWidth; - if (nodes.length === 0) { + // docfx has not converted the code blocks yet; let it finish. + if (article.querySelector('pre code.lang-mermaid')) { + timer = setTimeout(render, 250); + return; + } + + const nodes = []; + + article.querySelectorAll('pre.mermaid[data-mermaid]').forEach(diagram => { + if (!diagram.offsetParent) { return; } - originalInitialize(getMermaidConfig(lastConfig)); - lastConfig = mermaid.getConfig(); - originalRun({ nodes }); + diagram.removeAttribute('data-processed'); + diagram.innerHTML = diagram.getAttribute('data-mermaid'); + + nodes.push(diagram); }); - resizeObserver.observe(article); - }); + if (nodes.length === 0) { + return; + } + + running = true; + + try { + const mermaid = await loadMermaid(); + const theme = document.documentElement.getAttribute('data-bs-theme') === 'dark' + ? 'dark' + : 'default'; + + mermaid.initialize({ + ...options.mermaid, + startOnLoad: false, + theme + }); + + await mermaid.run({ nodes }); + } catch (error) { + console.error(error); + } finally { + running = false; + } + }; + + new ResizeObserver(() => { + clearTimeout(timer); + timer = setTimeout(render, 150); + }).observe(article); } }; +export default options; + const docUrl = document.querySelector('meta[name="docfx:docurl"]')?.content || ''; if (docUrl.includes('/api/')) { From ae95d983aa8ed5cd1ba8f3e4a2bb79fa61b44e11 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 17:51:51 -0500 Subject: [PATCH 32/37] Mermaid Accounts for Style Changes Now --- docs/template/api_wiki/public/main.css | 2 +- docs/template/api_wiki/public/main.js | 66 +++++++++++++++++++++----- 2 files changed, 55 insertions(+), 13 deletions(-) diff --git a/docs/template/api_wiki/public/main.css b/docs/template/api_wiki/public/main.css index 3756289c..7e6ec02d 100644 --- a/docs/template/api_wiki/public/main.css +++ b/docs/template/api_wiki/public/main.css @@ -485,5 +485,5 @@ div.mermaidTooltip { .mermaid svg { display: block; - max-width: 100%; + max-width: 100% !important; } \ No newline at end of file diff --git a/docs/template/api_wiki/public/main.js b/docs/template/api_wiki/public/main.js index 5a4be2aa..a0ef6561 100644 --- a/docs/template/api_wiki/public/main.js +++ b/docs/template/api_wiki/public/main.js @@ -14,12 +14,24 @@ const getContentWidth = () => { const getNodeWidth = () => Math.max(180, Math.floor((getContentWidth() - 40) / 2)); +// These reach .nodeLabel/.edgeLabel and change measured label size, so a +// re-render is required even though the article width stays put. +const LAYOUT_STYLE_VARS = ['--code-line-height', '--code-font-size', '--code-font']; +const LAYOUT_ATTRS = ['data-code-font']; + +const readLayoutSignature = () => { + const root = document.documentElement; + const style = root.style; + + return [ + ...LAYOUT_STYLE_VARS.map(name => style.getPropertyValue(name)), + ...LAYOUT_ATTRS.map(name => root.getAttribute(name) || '') + ].join('|'); +}; + const options = { defaultTheme: 'dark', - // docfx does `const { mermaid } = await options()` then Object.assign()s it - // into initialize(), so these getters run once per render — the first - // render included. No patching, no ordering race. get mermaid() { const width = getNodeWidth(); @@ -43,8 +55,6 @@ const options = { let mermaidPromise; - // 'mermaid' is a bare specifier and there is no import map, so resolve - // the chunk docfx already loaded instead. Cached after first success. const loadMermaid = () => { mermaidPromise ??= (async () => { const chunk = performance @@ -62,13 +72,31 @@ const options = { }; let lastWidth = article.clientWidth; + let lastSignature = readLayoutSignature(); let timer = 0; + let pendingForce = false; let running = false; - const render = async () => { + const schedule = force => { + pendingForce ||= force; + clearTimeout(timer); + + timer = setTimeout(() => { + const forced = pendingForce; + pendingForce = false; + render(forced); + }, 150); + }; + + const render = async force => { + if (running) { + schedule(force); + return; + } + const articleWidth = article.clientWidth; - if (running || articleWidth === lastWidth) { + if (!force && articleWidth === lastWidth) { return; } @@ -76,7 +104,7 @@ const options = { // docfx has not converted the code blocks yet; let it finish. if (article.querySelector('pre code.lang-mermaid')) { - timer = setTimeout(render, 250); + schedule(force); return; } @@ -119,10 +147,24 @@ const options = { } }; - new ResizeObserver(() => { - clearTimeout(timer); - timer = setTimeout(render, 150); - }).observe(article); + new ResizeObserver(() => schedule(false)).observe(article); + + new MutationObserver(() => { + const signature = readLayoutSignature(); + + if (signature === lastSignature) { + return; + } + + lastSignature = signature; + schedule(true); + }).observe(document.documentElement, { + attributes: true, + attributeFilter: ['style', ...LAYOUT_ATTRS] + }); + + // DPComic is a webfont; measurements taken before it loads are wrong. + document.fonts?.ready.then(() => schedule(true)); } }; From 807e1f43f8f76d335843c7c2d3ef8d3b792824b6 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 18:00:05 -0500 Subject: [PATCH 33/37] Fixup Getting Started Index Mermaid --- docs/wiki/getting_started/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/wiki/getting_started/index.md b/docs/wiki/getting_started/index.md index f89eb91d..334a7905 100644 --- a/docs/wiki/getting_started/index.md +++ b/docs/wiki/getting_started/index.md @@ -34,10 +34,10 @@ flowchart TD D -->|Visual Studio| D1["If this was your choice, let us navigate into the
~~ API Project Setup Guide for Visual Studio ~~"] D -->|JetBrains Rider| D2["If this was your choice, let us navigate into the
~~ API Project Setup Guide for JetBrains Rider ~~"] - click A1 "jsonloader_projects/index.html" "Open JSONLoader Branch" - click C1 "c_sharp_basics/index.html" "Open C# Basics Branch" - click D1 "api_projects_vs_edition/index.html" "Open Visual Studio Setup Guide" - click D2 "api_projects_rider_edition/index.html" "Open JetBrains Rider Setup Guide" + click A1 "modders/jsonloader_projects/index.html" "Open JSONLoader Branch" + click C1 "modders/c_sharp_basics/index.html" "Open C# Basics Branch" + click D1 "modders/api_projects_vs_edition/index.html" "Open Visual Studio Setup Guide" + click D2 "modders/api_projects_rider_edition/index.html" "Open JetBrains Rider Setup Guide" ```
From 2e5c99e237a514d9f7cd1fc784bd40f72b187663 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 18:32:32 -0500 Subject: [PATCH 34/37] Mermaid Render Fixes --- docs/template/api_wiki/public/main.js | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/docs/template/api_wiki/public/main.js b/docs/template/api_wiki/public/main.js index a0ef6561..4763faf5 100644 --- a/docs/template/api_wiki/public/main.js +++ b/docs/template/api_wiki/public/main.js @@ -14,8 +14,16 @@ const getContentWidth = () => { const getNodeWidth = () => Math.max(180, Math.floor((getContentWidth() - 40) / 2)); -// These reach .nodeLabel/.edgeLabel and change measured label size, so a -// re-render is required even though the article width stays put. +const clamp = (value, min, max) => Math.min(max, Math.max(min, value)); + +const readFontScale = () => { + const size = parseFloat( + getComputedStyle(document.documentElement).getPropertyValue('--code-font-size') + ); + + return Number.isFinite(size) && size > 0 ? clamp(size / 18, 0.5, 1.6) : 1; +}; + const LAYOUT_STYLE_VARS = ['--code-line-height', '--code-font-size', '--code-font']; const LAYOUT_ATTRS = ['data-code-font']; @@ -34,11 +42,15 @@ const options = { get mermaid() { const width = getNodeWidth(); + const scale = readFontScale(); return { flowchart: { - minNodeWidth: width, - wrappingWidth: width + wrappingWidth: width, + minNodeWidth: Math.max(60, Math.round(110 * scale)), + padding: Math.max(4, Math.round(15 * scale)), + nodeSpacing: Math.max(12, Math.round(50 * scale)), + rankSpacing: Math.max(12, Math.round(50 * scale)) } }; }, @@ -102,7 +114,6 @@ const options = { lastWidth = articleWidth; - // docfx has not converted the code blocks yet; let it finish. if (article.querySelector('pre code.lang-mermaid')) { schedule(force); return; @@ -163,7 +174,6 @@ const options = { attributeFilter: ['style', ...LAYOUT_ATTRS] }); - // DPComic is a webfont; measurements taken before it loads are wrong. document.fonts?.ready.then(() => schedule(true)); } }; From 41ec7a10820aa26ff13c64037ffa62ef7828e08a Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 18:47:56 -0500 Subject: [PATCH 35/37] quick fix --- docs/template/api_wiki/public/main.js | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/template/api_wiki/public/main.js b/docs/template/api_wiki/public/main.js index 4763faf5..5799f3b0 100644 --- a/docs/template/api_wiki/public/main.js +++ b/docs/template/api_wiki/public/main.js @@ -40,14 +40,13 @@ const readLayoutSignature = () => { const options = { defaultTheme: 'dark', - get mermaid() { +get mermaid() { const width = getNodeWidth(); const scale = readFontScale(); return { flowchart: { - wrappingWidth: width, - minNodeWidth: Math.max(60, Math.round(110 * scale)), + wrappingWidth: Math.max(90, Math.min(width, Math.round(width * scale))), padding: Math.max(4, Math.round(15 * scale)), nodeSpacing: Math.max(12, Math.round(50 * scale)), rankSpacing: Math.max(12, Math.round(50 * scale)) From 464c2b964dec1f44d187237f7d69e54fc5abe8c2 Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 19:00:11 -0500 Subject: [PATCH 36/37] disable max width on mermaid --- docs/template/api_wiki/public/main.js | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/template/api_wiki/public/main.js b/docs/template/api_wiki/public/main.js index 5799f3b0..f9f494eb 100644 --- a/docs/template/api_wiki/public/main.js +++ b/docs/template/api_wiki/public/main.js @@ -46,6 +46,7 @@ get mermaid() { return { flowchart: { + useMaxWidth: false, wrappingWidth: Math.max(90, Math.min(width, Math.round(width * scale))), padding: Math.max(4, Math.round(15 * scale)), nodeSpacing: Math.max(12, Math.round(50 * scale)), From cdde6f3998c70d9ea73b37b4ada6ba134fdf5b3c Mon Sep 17 00:00:00 2001 From: Chaosyr Date: Sat, 21 Nov 2026 19:23:00 -0500 Subject: [PATCH 37/37] More Mermaid Tweaks --- docs/template/api_wiki/public/main.js | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/template/api_wiki/public/main.js b/docs/template/api_wiki/public/main.js index f9f494eb..81ceee86 100644 --- a/docs/template/api_wiki/public/main.js +++ b/docs/template/api_wiki/public/main.js @@ -16,12 +16,12 @@ const getNodeWidth = () => Math.max(180, Math.floor((getContentWidth() - 40) / 2 const clamp = (value, min, max) => Math.min(max, Math.max(min, value)); -const readFontScale = () => { +const readCodeFontSize = () => { const size = parseFloat( getComputedStyle(document.documentElement).getPropertyValue('--code-font-size') ); - return Number.isFinite(size) && size > 0 ? clamp(size / 18, 0.5, 1.6) : 1; + return Number.isFinite(size) && size > 0 ? clamp(size, 8, 40) : 18; }; const LAYOUT_STYLE_VARS = ['--code-line-height', '--code-font-size', '--code-font']; @@ -40,11 +40,13 @@ const readLayoutSignature = () => { const options = { defaultTheme: 'dark', -get mermaid() { + get mermaid() { const width = getNodeWidth(); - const scale = readFontScale(); + const size = readCodeFontSize(); + const scale = clamp(size / 18, 0.5, 1.6); return { + themeVariables: { fontSize: `${size}px` }, flowchart: { useMaxWidth: false, wrappingWidth: Math.max(90, Math.min(width, Math.round(width * scale))),