diff --git a/README.md b/README.md index 0794a448..5e9ea1a4 100644 --- a/README.md +++ b/README.md @@ -31,24 +31,53 @@ To begin, we'll go over how to install BepInEx, the framework all Inscryption mo ### 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/) 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/package/download/BepInEx/BepInExPack_Inscryption/5.4.1902/) page. +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 ModmManagers head to one of these discords; +If you have issues with Mod Managers head to one of these discords; -* **Thunderstore/R2ModMan Support Discord:** [Here](https://discord.gg/Fbz54kQAxg) +* **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.1902/) 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). +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!** +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). +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. +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; +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 --| +README.md |-- These can be ignored but if you want to keep them put them in the plugin subfolder +CHANGELOG.md |-- +icon.png --| +``` +10. Run the game once more and everything should be correct and working. + +### Installing Manually (XBOX Game-Pass) +1. Install [BepInEx]() by pressing `BepInEx_x64_5.4.21.0.zip` and extract the contents into a folder. +2. Move the contents into the game folder (where the game executable is; usually found here: `C:\XboxGames\D30AC640-4EC1-4D15-96F3-384052F09699\Content`). +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`) +4. Install [MonoModLoader]() 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]() 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 @@ -68,13 +97,13 @@ icon.png --| 10. 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.. +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%`. +7. Go to the launch parameters and enter `WINEDLLOVERRIDES="winhttp.dll=n,b" %command%`. 8. Open Inscryption. If everything was done correctly, you should see a console appear on your screen. ### Mac & Linux @@ -234,4 +263,4 @@ Contributors and builders of API 2.0: - WhistleWind - Windows10CE - Keks307 -- ThinCreator3483 \ No newline at end of file +- ThinCreator3483 diff --git a/docs/wiki/getting_started.md b/docs/wiki/getting_started.md index 4d08e674..9ffa71e7 100644 --- a/docs/wiki/getting_started.md +++ b/docs/wiki/getting_started.md @@ -4,24 +4,26 @@ To begin, we'll go over how to install BepInEx, the framework all Inscryption mo ### 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/) 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/package/download/BepInEx/BepInExPack_Inscryption/5.4.1902/) page. +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 ModmManagers head to one of these discords; +If you have issues with Mod Managers head to one of these discords; -* **Thunderstore/R2ModMan Support Discord:** [Here](https://discord.gg/Fbz54kQAxg) +* **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.1902/) 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). +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!** +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). +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. +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; +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 @@ -38,16 +40,47 @@ README.md |-- These can be ignored but if you want to keep them put th CHANGELOG.md |-- icon.png --| ``` + +10. Run the game once more and everything should be correct and working. + +### Installing Manually (XBOX Game-Pass) +1. Install [BepInEx]() by pressing `BepInEx_x64_5.4.21.0.zip` and extract the contents into a folder. +2. Move the contents into the game folder (where the game executable is; usually found here: `C:\XboxGames\D30AC640-4EC1-4D15-96F3-384052F09699\Content`). +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`) +4. Install [MonoModLoader]() 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]() 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 --| +README.md |-- These can be ignored but if you want to keep them put them in the plugin subfolder +CHANGELOG.md |-- +icon.png --| +``` + 10. 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.. +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%`. +7. Go to the launch parameters and enter `WINEDLLOVERRIDES="winhttp.dll=n,b" %command%`. 8. Open Inscryption. If everything was done correctly, you should see a console appear on your screen. ### Mac & Linux diff --git a/thunderstore.toml b/thunderstore.toml index 021028f9..7daa74f9 100644 --- a/thunderstore.toml +++ b/thunderstore.toml @@ -6,7 +6,7 @@ namespace = "API_dev" name = "API" versionNumber = "2.15.2" 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." -websiteUrl = "https://github.com/ScottWilson0903/InscryptionAPI" +websiteUrl = "https://github.com/InscryptionModding/InscryptionAPI/" containsNsfwContent = false [package.dependencies]