SliderPuzzlesAPI-SliderPuzzlesAPI icon

SliderPuzzlesAPI

An API for Inscryption that allows you to add more Slider Puzzles to the GBC section of the game in the cabin. Puzzle Examples Provided in the `Examples` Folder.

Last updated 4 months ago
Total downloads 365
Total rating 2 
Categories Tweaks Libraries Misc Act II
Dependency string SliderPuzzlesAPI-SliderPuzzlesAPI-2.0.2
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack_Inscryption-5.4.1701 icon
BepInEx-BepInExPack_Inscryption

BepInEx pack for Inscryption. Preconfigured and ready to use.

Preferred version: 5.4.1701

README

InscryptionMoreSliderPuzzles

A mod for Inscryption that adds more slider puzzles to the GBC section of the game in the cabin.

This mod is mainly a proof of concept to show that replacing puzzles in the GBC section of the game works. Some things might not work as expected, such as certain sigils not displaying correctly or certain sigils, not working in slider puzzles. This mod does not fix these things, this mod plans to have a parch to fix the Stat icons not showing up within sliderpuzzles however.

Details

This mod changes the slider puzzle in the cabin in the GBC section of the game. That puzzle will be replaced by a list of puzzles, defined in the plugin folders. When you solve a puzzle, you will be rewarded as normal, but the cabinet will remain closed, and you can solve the next puzzle. If there are no more puzzles to solve, because you've solved all puzzles defined, the cabinet will become open, making the puzzles inaccessible.

Usage

In order to use this mod, you must have BepInEx installed. This mod does not depend on any other mods.

Install from GitHub

You need to find the required files (MoreSliderPuzzles.dll and a folder containing the puzzles) and unpack them in the BepInEx\plugins folder.

Installing with a Mod Manager

This is the recommended way to install BepInEx to the game.

  1. Download and install Thunderstore Mod Manager or r2modman.
  2. Click the Install with Mod Manager button on the top of BepInEx's page.
  3. Run the game via the mod manager.

Installing Manually

  1. Install BepInEx 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).
  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.

Installing on the Steam Deck:

  1. Download r2modman on the Steam Deck’s Desktop Mode and open it from its download using its AppImage file
  2. Go to the setting of the profile you have for the mods and click Browse Profile Folder.
  3. Copy the BepInEx folder then go to Steam, and browse Inscryption's local files; paste the folder there
  4. Enter Gaming Mode and open Inscryption. If everything was done correctly, you should see a console appear on your screen.

Define Custom Puzzles

Your puzzles must be defined in the same folder with MoreSliderPuzzles.dll, or in any subfolder of the Plugins folder. The extension must be .pdef. If the extension is prefixed with _example it wont be loaded in.

A .pdef file contains 4 lines, with each line containing 4 entries, separated by |. For each entry, you may leave it empty (for an empty space), or an ID representing the card. The ID of the card can be prepended by !. If so, the tile is locked. Each entry can be padded by whitespaces, and empty lines will be ignored.

An ID is defined as the in code name, it does not require the GUID to be present, If it is present an error will pop up telling you which ID failed to load.

The puzzles will be Randomized, if you wish to configure this there is a config available.

See the example puzzles for more details.

Contributers:

  • RageLeague - Made The Original Mod
  • Creator - Porting
  • WhistleWind - StatIcon Patch

Want to contribute? Open a PR at: https://github.com/SaxbyMod/InscryptionMoreSliderPuzzlesMiniUpdate