Skip to content

Dev doc upgrades - #352

Open
Chaosyr wants to merge 39 commits into
InscryptionModding:Update-Installation-Guides-and-Documentation-and-Bug-Fixesfrom
Chaosyr:Dev-Doc-Upgrades
Open

Chaosyr wants to merge 39 commits into
InscryptionModding:Update-Installation-Guides-and-Documentation-and-Bug-Fixesfrom
Chaosyr:Dev-Doc-Upgrades

Conversation

@Chaosyr

@Chaosyr Chaosyr commented Nov 19, 2026

Copy link
Copy Markdown
Collaborator

This PR is aimed at upgrading developer docs under the Wiki. Such as the Getting Started With Modding Guide.

@HumabHatterZed HumabHatterZed left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are several grammar and punctuation errors here and there to fix. Otherwise, I provided some suggestions for you to review. I don't know much about Jetbrains or VS 2024/26/most recent year so I'm assuming everything's up to snuff there.

I will say that the rewritten guide is much longer and comes off as more overwhelming and complicated because of that. Unless you/I rewrite everything to be shorter/more succinct, I want to float the idea of moving the Jetbrains and VS sections to their own subpages/pages. If that's what subfolders do then ignore this last bit.

Comment thread docs/wiki/getting_started.md Resolved
## 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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix run-on sentence: "{...} such as Java. In many cases, an understand of {...} using Harmony{just Harmony, not HarmonyPatch} will also be required; you can find the docs [here](basic Harmony link), as well as [here](HarmonyX link) for HarmonyX in specific."

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#.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace "if you wish to avoid learning #" with "which uses JSON files as an alternative to coding."

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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar: "If your" -> "If you're" (multiple instances). Move this section to Modding with C#.


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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rewrite this section to be more succinct, less editorialising. I suggest reverting to the original and adding Jetbrains alongside VS for recommended IDEs.

The rewritten section also has a couple grammar and punctuation errors: "reccomend" -> "recommend" and "note its" -> "note it's"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you do revert to the original, also update the target framework line to say netstandard2.0 or above/4.7.2, since either works beyond missing features or whatever 4.7.2 adds (I still use 2.0, so I'm a tad biased).

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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change comma after "Exclusive folders" to period or semicolon.

Click me to expand
</summary>

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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Target framework can be 2.0 or 4.7.2. This applies to any instance where this is mentioned. Yes, I will die on this hill, I am old and numbers greater than 2 scare me.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wait thats also a typo, thats meant to be netframework XD

Comment thread 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

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything I said on getting_started.md applies here.

@Chaosyr

Chaosyr commented Nov 21, 2026

Copy link
Copy Markdown
Collaborator Author

Will work on resolving soon ^^

@Chaosyr

Chaosyr commented Nov 22, 2026

Copy link
Copy Markdown
Collaborator Author

All the commit's earlier primarily relate to mermaid styling, and some miscellaneous fixes to make things look nicer. The notable difference can be seen here: https://chaosyr.github.io/InscryptionAPI-Dev/wiki/getting_started/index.html

image

It's not done yet, but getting started now looks roughly like this, we just need to do the docs under each of the 4 new sections of getting started (modders).

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants