diff --git a/README.md b/README.md
index c2ff42ff2..e076a2b5e 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/docfx.json b/docs/docfx.json
index b22927779..0e49ca97d 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"]
diff --git a/docs/index.md b/docs/index.md
index bab349348..5c974c3e7 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/template/api_wiki/public/main.css b/docs/template/api_wiki/public/main.css
index 023126588..7e6ec02d3 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;
}
@@ -401,4 +401,89 @@ 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;
+}
+
+.toc li > a {
+ padding-left: 0.5rem;
+}
+
+.nodeLabel,
+.nodeLabel p {
+ font-family: var(--code-font);
+ font-size: var(--code-font-size) !important;
+ 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 p {
+ font-family: var(--code-font);
+ font-size: var(--code-font-size) !important;
+ line-height: var(--code-line-height) !important;
+ box-sizing: border-box;
+}
+
+.edgeLabel p {
+ 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;
+}
+
+div.mermaidTooltip {
+ font-family: var(--code-font);
+ font-size: var(--code-font-size) !important;
+ 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;
+ margin: 0;
+ box-sizing: border-box;
+}
+
+.node rect,
+.node circle,
+.node ellipse,
+.node polygon,
+.node path {
+ rx: 4px;
+ ry: 4px;
+ stroke: var(--bs-border-color, #444) !important;
+ stroke-width: 4px !important;
+ fill: var(--bs-tertiary-bg, #e9ecef) !important;
+}
+
+.labelBkg {
+ background: transparent !important;
+}
+
+.mermaid {
+ width: 100%;
+ max-width: 100%;
+ display: block;
+ overflow-x: auto;
+}
+
+.mermaid svg {
+ display: block;
+ 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 2561fe374..81ceee867 100644
--- a/docs/template/api_wiki/public/main.js
+++ b/docs/template/api_wiki/public/main.js
@@ -1,6 +1,186 @@
-export default {
- defaultTheme: 'dark'
-}
+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 clamp = (value, min, max) => Math.min(max, Math.max(min, value));
+
+const readCodeFontSize = () => {
+ const size = parseFloat(
+ getComputedStyle(document.documentElement).getPropertyValue('--code-font-size')
+ );
+
+ return Number.isFinite(size) && size > 0 ? clamp(size, 8, 40) : 18;
+};
+
+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',
+
+ get mermaid() {
+ const width = getNodeWidth();
+ 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))),
+ padding: Math.max(4, Math.round(15 * scale)),
+ nodeSpacing: Math.max(12, Math.round(50 * scale)),
+ rankSpacing: Math.max(12, Math.round(50 * scale))
+ }
+ };
+ },
+
+ start: () => {
+ const article = document.querySelector('article');
+
+ if (!article || !window.ResizeObserver) {
+ return;
+ }
+
+ const MERMAID_FALLBACK =
+ 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
+
+ let mermaidPromise;
+
+ const loadMermaid = () => {
+ mermaidPromise ??= (async () => {
+ const chunk = performance
+ .getEntriesByType('resource')
+ .map(entry => entry.name)
+ .find(url => /\/mermaid[.\-][\w\-]*\.min\.js$/.test(url));
+
+ return (await import(chunk || MERMAID_FALLBACK)).default;
+ })().catch(error => {
+ mermaidPromise = null;
+ throw error;
+ });
+
+ return mermaidPromise;
+ };
+
+ let lastWidth = article.clientWidth;
+ let lastSignature = readLayoutSignature();
+ let timer = 0;
+ let pendingForce = false;
+ let running = false;
+
+ 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 (!force && articleWidth === lastWidth) {
+ return;
+ }
+
+ lastWidth = articleWidth;
+
+ if (article.querySelector('pre code.lang-mermaid')) {
+ schedule(force);
+ return;
+ }
+
+ const nodes = [];
+
+ article.querySelectorAll('pre.mermaid[data-mermaid]').forEach(diagram => {
+ if (!diagram.offsetParent) {
+ return;
+ }
+
+ diagram.removeAttribute('data-processed');
+ diagram.innerHTML = diagram.getAttribute('data-mermaid');
+
+ nodes.push(diagram);
+ });
+
+ 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(() => 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]
+ });
+
+ document.fonts?.ready.then(() => schedule(true));
+ }
+};
+
+export default options;
const docUrl = document.querySelector('meta[name="docfx:docurl"]')?.content || '';
diff --git a/docs/wiki/getting_started.md b/docs/wiki/getting_started.md
index b6a020885..ada50727b 100644
--- a/docs/wiki/getting_started.md
+++ b/docs/wiki/getting_started.md
@@ -1,145 +1,153 @@
-## Getting Started: Installation
+## Getting Started: Modding
---
-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.
+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.
-### 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'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 you have any issues with Mac/Linux, Steam Deck, or Manual head over to the discord for this game:
+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.
-* **Inscryption Modding Discord:** [Here](https://discord.gg/ZQPvfKEpwM)
-
-## 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.
-
-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 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/wiki/getting_started/index.md b/docs/wiki/getting_started/index.md
new file mode 100644
index 000000000..334a7905f
--- /dev/null
+++ b/docs/wiki/getting_started/index.md
@@ -0,0 +1,68 @@
+# 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)
+
+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.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"
+```
+
+
+
+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.
+
+
+
+### 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/api_projects_rider_edition/index.md b/docs/wiki/getting_started/modders/api_projects_rider_edition/index.md
new file mode 100644
index 000000000..2cbe55052
--- /dev/null
+++ 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_rider_edition/toc.yml b/docs/wiki/getting_started/modders/api_projects_rider_edition/toc.yml
new file mode 100644
index 000000000..f54cdfb30
--- /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 000000000..58bdd0e39
--- /dev/null
+++ 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/api_projects_vs_edition/toc.yml b/docs/wiki/getting_started/modders/api_projects_vs_edition/toc.yml
new file mode 100644
index 000000000..f54cdfb30
--- /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 000000000..0cc5e9681
--- /dev/null
+++ 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/c_sharp_basics/toc.yml b/docs/wiki/getting_started/modders/c_sharp_basics/toc.yml
new file mode 100644
index 000000000..f54cdfb30
--- /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
new file mode 100644
index 000000000..7771d4095
--- /dev/null
+++ 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.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"
+```
+
+
+
+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 000000000..aae836a00
--- /dev/null
+++ b/docs/wiki/getting_started/modders/jsonloader_projects/index.md
@@ -0,0 +1 @@
+# JSONLoader Projects
\ No newline at end of file
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 000000000..f54cdfb30
--- /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
new file mode 100644
index 000000000..ea9a90991
--- /dev/null
+++ b/docs/wiki/getting_started/modders/toc.yml
@@ -0,0 +1,13 @@
+items:
+- 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/toc.yml b/docs/wiki/getting_started/toc.yml
new file mode 100644
index 000000000..549d4a4b9
--- /dev/null
+++ b/docs/wiki/getting_started/toc.yml
@@ -0,0 +1,7 @@
+items:
+- name: Getting Started (Users)
+ href: users/toc.yml
+ homepage: users/index.md
+- name: Getting Started (Modders)
+ href: modders/toc.yml
+ homepage: modders/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
new file mode 100644
index 000000000..a65b17fd5
--- /dev/null
+++ 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](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
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 000000000..8ac44d99d
--- /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 000000000..0a28fe844
--- /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 000000000..e73e296ac
--- /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 000000000..2084f7deb
--- /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 000000000..f7b5abcb5
--- /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
new file mode 100644
index 000000000..009798e44
--- /dev/null
+++ b/docs/wiki/getting_started/users/toc.yml
@@ -0,0 +1,11 @@
+items:
+- 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
diff --git a/docs/wiki/toc.yml b/docs/wiki/toc.yml
index 523a45e33..13a826994 100644
--- a/docs/wiki/toc.yml
+++ b/docs/wiki/toc.yml
@@ -2,7 +2,8 @@ items:
- name: Home
href: index.md
- name: Getting Started
- href: getting_started.md
+ href: getting_started/toc.yml
+ homepage: getting_started/index.md
- name: Cards
href: card_management.md
items: