You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-6Lines changed: 17 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,3 @@
1
-
2
1
# API
3
2
4
3
## Inscryption API
@@ -26,11 +25,16 @@ It can currently create and modify:
26
25
27
26
Additionally, a number of quality-of-life patches from the community are included with each release.
28
27
29
-
### Installing with a Mod Manager (recommended)
30
-
1. Download and install [Thunderstore Mod Manager](https://www.overwolf.com/app/Thunderstore-Thunderstore_Mod_Manager)or [r2modman](https://Timberborn.thunderstore.io/package/ebkr/r2modman/).
28
+
### Installing with a Mod Manager
29
+
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/)or [r2modman](https://thunderstore.io/c/inscryption/p/ebkr/r2modman/).
31
30
2. Click the **Install with Mod Manager** button on the top of [BepInEx's](https://thunderstore.io/package/download/BepInEx/BepInExPack_Inscryption/5.4.1902/) page.
32
31
3. Run the game via the mod manager.
33
32
33
+
If you have issues with ModmManagers head to one of these discords;
34
+
35
+
***Thunderstore/R2ModMan Support Discord:**[Here](https://discord.gg/Fbz54kQAxg)
36
+
***Gale Mod Manager Support Discord:**[Here](https://discord.gg/sfuWXRfeTt)
37
+
34
38
### Installing Manually
35
39
1. Install [BepInEx](https://thunderstore.io/package/download/BepInEx/BepInExPack_Inscryption/5.4.1902/) by pressing 'Manual Download' and extract the contents into a folder. **Do not extract into the game folder!**
36
40
2. Move the contents of the 'BepInExPack_Inscryption' folder into the game folder (where the game executable is).
@@ -42,7 +46,7 @@ Additionally, a number of quality-of-life patches from the community are include
42
46
8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
43
47
44
48
### Installing on the Steam Deck
45
-
1. Download [r2modman](https://Timberborn.thunderstore.io/package/ebkr/r2modman/) on the Steam Deck’s Desktop Mode and open it from its download using its `AppImage` file.
49
+
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.
46
50
2. Download the mods you plan on using and their dependencies..
47
51
3. Go to the setting of the profile you are using for the mods and click `Browse Profile Folder`.
48
52
4. Copy the BepInEx folder, then go to Steam and open Inscryption's Properties menu
@@ -52,10 +56,14 @@ Additionally, a number of quality-of-life patches from the community are include
52
56
8. Open Inscryption. If everything was done correctly, you should see a console appear on your screen.
53
57
54
58
### Mac & Linux
55
-
1. Follow the steps here first: [Installing BepInEx](https://docs.bepinex.dev/articles/user_guide/installation/index.html?tabs=tabid-nix)
59
+
1. Follow the steps here first: <https://docs.bepinex.dev/articles/user_guide/installation/index.html>
56
60
2. Next do steps 4-8 of the Manual Installation
57
61
3. Your game should be setup for inscryption modding now
58
62
63
+
If you have any issues with Mac/Linux, Steam Deck, or Manual head over to the discord for this game:
An example mod utilising this plugin can be found [here](https://github.com/debugman18/InscryptionExampleMod),
60
68
and the modding wiki and documentation can be found [here](https://inscryptionmodding.github.io/InscryptionAPI/wiki/index.html).
61
69
@@ -110,9 +118,10 @@ Fixes the OverrideAbilityIcon method to work in Act 2.
110
118
# Using the API
111
119
112
120
Inscryption API 2.0 tries to have you use the original game's objects as much as possible. For example, there are no more 'NewCard' and 'CustomCard' objects; instead, you are responsible to create CardInfo objects yourself and add them.
121
+
113
122
The API does provide a number of helper methods to make this process simpler for you.
114
123
115
-
For more information, please check out the wiki: https://inscryptionmodding.github.io/InscryptionAPI/wiki/
124
+
For more information, please check out the wiki: [Here](https://inscryptionmodding.github.io/InscryptionAPI/wiki/), and if you need any help with anything related to the API send a message over in [Inscryption Modding Discord](https://discord.gg/QrJEF5Denm).
116
125
117
126
## Contribution
118
127
@@ -141,3 +150,5 @@ Contributors and builders of API 2.0:
Copy file name to clipboardExpand all lines: docs/wiki/getting_started.md
+12-5Lines changed: 12 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,12 +3,15 @@
3
3
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.
4
4
5
5
### Installing with a Mod Manager
6
-
This is the recommended way to install BepInEx to the game.
7
-
8
-
1. Download and install [Thunderstore Mod Manager](https://www.overwolf.com/app/Thunderstore-Thunderstore_Mod_Manager) or [r2modman](https://Timberborn.thunderstore.io/package/ebkr/r2modman/).
6
+
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/) or [r2modman](https://thunderstore.io/c/inscryption/p/ebkr/r2modman/).
9
7
2. Click the **Install with Mod Manager** button on the top of [BepInEx's](https://thunderstore.io/package/download/BepInEx/BepInExPack_Inscryption/5.4.1902/) page.
10
8
3. Run the game via the mod manager.
11
9
10
+
If you have issues with ModmManagers head to one of these discords;
11
+
12
+
***Thunderstore/R2ModMan Support Discord:**[Here](https://discord.gg/Fbz54kQAxg)
13
+
***Gale Mod Manager Support Discord:**[Here](https://discord.gg/sfuWXRfeTt)
14
+
12
15
### Installing Manually
13
16
1. Install [BepInEx](https://thunderstore.io/package/download/BepInEx/BepInExPack_Inscryption/5.4.1902/) by pressing 'Manual Download' and extract the contents into a folder. **Do not extract into the game folder!**
14
17
2. Move the contents of the 'BepInExPack_Inscryption' folder into the game folder (where the game executable is).
@@ -20,7 +23,7 @@ This is the recommended way to install BepInEx to the game.
20
23
8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
21
24
22
25
### Installing on the Steam Deck
23
-
1. Download [r2modman](https://Timberborn.thunderstore.io/package/ebkr/r2modman/) on the Steam Deck’s Desktop Mode and open it from its download using its `AppImage` file.
26
+
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.
24
27
2. Download the mods you plan on using and their dependencies..
25
28
3. Go to the setting of the profile you are using for the mods and click `Browse Profile Folder`.
26
29
4. Copy the BepInEx folder, then go to Steam and open Inscryption's Properties menu
@@ -34,6 +37,10 @@ This is the recommended way to install BepInEx to the game.
34
37
2. Next do steps 4-8 of the Manual Installation
35
38
3. Your game should be setup for inscryption modding now
36
39
40
+
If you have any issues with Mac/Linux, Steam Deck, or Manual head over to the discord for this game:
0 commit comments