Skip to content

Commit e423070

Browse files
IngoHHacksIngoHHacks
authored
Merge pull request #332 from Chaosyr/patch-5
Update Website Link to Org GitHub URL
2 parents ace7036 + d2c2f5e commit e423070

3 files changed

Lines changed: 86 additions & 24 deletions

File tree

‎README.md‎

Lines changed: 41 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,24 +31,53 @@ To begin, we'll go over how to install BepInEx, the framework all Inscryption mo
3131

3232
### Installing with a Mod Manager
3333
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/).
34-
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.
34+
2. Click the **Install with Mod Manager** button on the top of [BepInEx's](https://thunderstore.io/c/inscryption/p/BepInEx/BepInExPack_Inscryption/) page.
3535
3. Run the game via the mod manager.
3636

37-
If you have issues with ModmManagers head to one of these discords;
37+
If you have issues with Mod Managers head to one of these discords;
3838

39-
* **Thunderstore/R2ModMan Support Discord:** [Here](https://discord.gg/Fbz54kQAxg)
39+
* **Thunderstore Support Discord:** [Here](https://discord.gg/Fbz54kQAxg)
40+
* **R2ModMan Support Discord:** [Here](https://discord.gg/R85wjqa4WN)
4041
* **Gale Mod Manager Support Discord:** [Here](https://discord.gg/sfuWXRfeTt)
4142

4243
### Installing Manually
43-
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!**
44-
2. Move the contents of the 'BepInExPack_Inscryption' folder into the game folder (where the game executable is).
44+
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!**
45+
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`).
4546
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.
4647
4. Install [MonoModLoader](https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/) and extract the contents into a folder.
47-
5. Move the contents of the 'patchers' folder into 'BepInEx/patchers' (If any of the mentioned BepInEx folders don't exist, just create them).
48+
5. Move the contents of the `patchers` folder into `BepInEx/patchers` (If any of the mentioned BepInEx folders don't exist, just create them).
4849
6. Install [Inscryption API](https://inscryption.thunderstore.io/package/API_dev/API/) and extract the contents into a folder.
49-
7. Move the contents of the 'plugins' folder into 'BepInEx/plugins' and the contents of the 'monomod' folder into the 'BepInEx/monomod' folder.
50+
7. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder.
5051
8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
51-
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;
52+
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;
53+
```
54+
BepInEx // These go within the BepInEx root folder
55+
|-- config
56+
|-- patchers
57+
|-- plugins
58+
|-- monomod
59+
|-- core
60+
plugins // Files within go into the created plugin subfolder that was created for the mod
61+
|-- Art
62+
|-- Scripts
63+
|-- MyMod.dll
64+
manifest.json --|
65+
README.md |-- These can be ignored but if you want to keep them put them in the plugin subfolder
66+
CHANGELOG.md |--
67+
icon.png --|
68+
```
69+
10. Run the game once more and everything should be correct and working.
70+
71+
### Installing Manually (XBOX Game-Pass)
72+
1. Install [BepInEx](<https://github.com/BepInEx/BepInEx/releases/tag/v5.4.21>) by pressing `BepInEx_x64_5.4.21.0.zip` and extract the contents into a folder.
73+
2. Move the contents into the game folder (where the game executable is; usually found here: `C:\XboxGames\D30AC640-4EC1-4D15-96F3-384052F09699\Content`).
74+
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. (psst. Enable Logging in `BepInEx/config`)
75+
4. Install [MonoModLoader](<https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/>) and extract the contents into a folder.
76+
5. Move the contents of the `patchers` folder into `BepInEx/patchers` (If any of the mentioned BepInEx folders don't exist, just create them).
77+
6. Install [Inscryption API](<https://inscryption.thunderstore.io/package/API_dev/API/>) and extract the contents into a folder.
78+
7. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder.
79+
8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
80+
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;
5281
```
5382
BepInEx // These go within the BepInEx root folder
5483
|-- config
@@ -68,13 +97,13 @@ icon.png --|
6897
10. Run the game once more and everything should be correct and working.
6998

7099
### Installing on the Steam Deck
71-
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.
72-
2. Download the mods you plan on using and their dependencies..
100+
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.
101+
2. Download the mods you plan on using and their dependencies.
73102
3. Go to the setting of the profile you are using for the mods and click `Browse Profile Folder`.
74103
4. Copy the BepInEx folder, then go to Steam and open Inscryption's Properties menu
75104
5. Go to `Installed Files` click `Browse` to open the folder containing Inscryption's local files; paste the BepInEx folder there.
76105
6. Enter Gaming Mode and check 'Force the use of a specific Steam Play compatibility tool' in the Properties menu under `Compatibility`.
77-
7. Go to the launch parameters and enter `WINEDLLOVERRIDES=“winhttp.dll=n,b” %command%`.
106+
7. Go to the launch parameters and enter `WINEDLLOVERRIDES="winhttp.dll=n,b" %command%`.
78107
8. Open Inscryption. If everything was done correctly, you should see a console appear on your screen.
79108

80109
### Mac & Linux
@@ -234,4 +263,4 @@ Contributors and builders of API 2.0:
234263
- WhistleWind
235264
- Windows10CE
236265
- Keks307
237-
- ThinCreator3483
266+
- ThinCreator3483

‎docs/wiki/getting_started.md‎

Lines changed: 44 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,26 @@ To begin, we'll go over how to install BepInEx, the framework all Inscryption mo
44

55
### Installing with a Mod Manager
66
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/).
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.
7+
2. Click the **Install with Mod Manager** button on the top of [BepInEx's](https://thunderstore.io/c/inscryption/p/BepInEx/BepInExPack_Inscryption/) page.
88
3. Run the game via the mod manager.
99

10-
If you have issues with ModmManagers head to one of these discords;
10+
If you have issues with Mod Managers head to one of these discords;
1111

12-
* **Thunderstore/R2ModMan Support Discord:** [Here](https://discord.gg/Fbz54kQAxg)
12+
* **Thunderstore Support Discord:** [Here](https://discord.gg/Fbz54kQAxg)
13+
* **R2ModMan Support Discord:** [Here](https://discord.gg/R85wjqa4WN)
1314
* **Gale Mod Manager Support Discord:** [Here](https://discord.gg/sfuWXRfeTt)
1415

1516
### Installing Manually
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!**
17-
2. Move the contents of the 'BepInExPack_Inscryption' folder into the game folder (where the game executable is).
17+
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!**
18+
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`).
1819
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.
1920
4. Install [MonoModLoader](https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/) and extract the contents into a folder.
20-
5. Move the contents of the 'patchers' folder into 'BepInEx/patchers' (If any of the mentioned BepInEx folders don't exist, just create them).
21+
5. Move the contents of the `patchers` folder into `BepInEx/patchers` (If any of the mentioned BepInEx folders don't exist, just create them).
2122
6. Install [Inscryption API](https://inscryption.thunderstore.io/package/API_dev/API/) and extract the contents into a folder.
22-
7. Move the contents of the 'plugins' folder into 'BepInEx/plugins' and the contents of the 'monomod' folder into the 'BepInEx/monomod' folder.
23+
7. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder.
2324
8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
24-
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;
25+
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;
26+
2527
```
2628
BepInEx // These go within the BepInEx root folder
2729
|-- config
@@ -38,16 +40,47 @@ README.md |-- These can be ignored but if you want to keep them put th
3840
CHANGELOG.md |--
3941
icon.png --|
4042
```
43+
44+
10. Run the game once more and everything should be correct and working.
45+
46+
### Installing Manually (XBOX Game-Pass)
47+
1. Install [BepInEx](<https://github.com/BepInEx/BepInEx/releases/tag/v5.4.21>) by pressing `BepInEx_x64_5.4.21.0.zip` and extract the contents into a folder.
48+
2. Move the contents into the game folder (where the game executable is; usually found here: `C:\XboxGames\D30AC640-4EC1-4D15-96F3-384052F09699\Content`).
49+
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. (psst. Enable Logging in `BepInEx/config`)
50+
4. Install [MonoModLoader](<https://inscryption.thunderstore.io/package/BepInEx/MonoMod_Loader_Inscryption/>) and extract the contents into a folder.
51+
5. Move the contents of the `patchers` folder into `BepInEx/patchers` (If any of the mentioned BepInEx folders don't exist, just create them).
52+
6. Install [Inscryption API](<https://inscryption.thunderstore.io/package/API_dev/API/>) and extract the contents into a folder.
53+
7. Move the contents of the `plugins` folder into `BepInEx/plugins` and the contents of the `monomod` folder into the `BepInEx/monomod` folder.
54+
8. Run the game again. If everything runs correctly, a message will appear in the console telling you that the API was loaded.
55+
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;
56+
57+
```
58+
BepInEx // These go within the BepInEx root folder
59+
|-- config
60+
|-- patchers
61+
|-- plugins
62+
|-- monomod
63+
|-- core
64+
plugins // Files within go into the created plugin subfolder that was created for the mod
65+
|-- Art
66+
|-- Scripts
67+
|-- MyMod.dll
68+
manifest.json --|
69+
README.md |-- These can be ignored but if you want to keep them put them in the plugin subfolder
70+
CHANGELOG.md |--
71+
icon.png --|
72+
```
73+
4174
10. Run the game once more and everything should be correct and working.
4275

4376
### Installing on the Steam Deck
44-
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.
45-
2. Download the mods you plan on using and their dependencies..
77+
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.
78+
2. Download the mods you plan on using and their dependencies.
4679
3. Go to the setting of the profile you are using for the mods and click `Browse Profile Folder`.
4780
4. Copy the BepInEx folder, then go to Steam and open Inscryption's Properties menu
4881
5. Go to `Installed Files` click `Browse` to open the folder containing Inscryption's local files; paste the BepInEx folder there.
4982
6. Enter Gaming Mode and check 'Force the use of a specific Steam Play compatibility tool' in the Properties menu under `Compatibility`.
50-
7. Go to the launch parameters and enter `WINEDLLOVERRIDES=“winhttp.dll=n,b” %command%`.
83+
7. Go to the launch parameters and enter `WINEDLLOVERRIDES="winhttp.dll=n,b" %command%`.
5184
8. Open Inscryption. If everything was done correctly, you should see a console appear on your screen.
5285

5386
### Mac & Linux

‎thunderstore.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ namespace = "API_dev"
66
name = "API"
77
versionNumber = "2.15.2"
88
description = "The de-facto standard core API for all Inscryption mods. This lets you create new cards, abilities, challenges, map nodes, starter decks, and more."
9-
websiteUrl = "https://github.com/ScottWilson0903/InscryptionAPI"
9+
websiteUrl = "https://github.com/InscryptionModding/InscryptionAPI/"
1010
containsNsfwContent = false
1111

1212
[package.dependencies]

0 commit comments

Comments
 (0)