API_dev-API icon

API

This plugin is a BepInEx plugin made for Inscryption as an API. It can currently create custom cards and abilities and inject them into the data pool, or modify existing cards in the card pool.

Last updated a month ago
Total downloads 17346
Total rating 13 
Categories Libraries
Dependency string API_dev-API-1.13.0
Dependants 97 other mods depend on this mod

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

API

Inscryption API made by Cyantist

This plugin is a BepInEx plugin made for Inscryption as an API. It can currently:

  • Create custom cards and inject them into the card pool
  • Modify existing cards in the card pool
  • Create custom card backgrounds
  • Create custom abilities and inject them into the ability pool
  • Reference abilities between mods
  • Create custom regions and encounters
  • Create talking cards and add dialogues
  • Enable energy

Installation (automated)

This is the recommended way to install the API on the game.

Installation (manual)

To install this plugin first you need to install BepInEx as a mod loader for Inscryption. A guide to do this can be found here. Inscryption needs the 86x (32 bit) mono version.

To install Inscryption API you simply need to copy API.dll from releases to Inscryption/BepInEx/plugins.

An example Mod utilising this plugin can be found here.

Debugging

The easiest way to check if the plugin is working properly or to debug an error is to enable the console. This can be done by changing

[Logging.Console]
\## Enables showing a console for log output.
\# Setting type: Boolean
\# Default value: false
Enabled = false

to

[Logging.Console]
\## Enables showing a console for log output.
\# Setting type: Boolean
\# Default value: false
Enabled = true

in Inscryption/BepInEx/Config/BepInEx/cfg


If you want help debugging you can find me on the Inscryption Modding Discord or on Daniel Mullins Discord as Cyantist.

Development

At the moment I am working on:

  • Adding comments
  • Documentation
  • Custom special abilities

The next planned features for this plugin are:

  • Extending the loader to handle and load custom abilities, boons and items.

Contribution

How can you help?

Use the plugin and report bugs you find! Lots of traits won't be designed to work well together and may cause bugs or crashes. At the very least we can document this. Ideally we can create generic patches for them.

But really, I want to help develop this mod

Great! I'm more than happy to accept help. Either make a pull request or come join us over in the Inscryption Modding Discord.

Can I donate?

Donations are totally not needed, this is a passion project before anything else. If you do still want to donate though, you can buy me a coffee on ko-fi.

Contributors

  • divisionbyz0rro
  • IngoH
  • JamesVeug
  • julian-perge
  • Windows10CE

Available versions

Please note that the install buttons only work if you have compatible client software installed, such as the Thunderstore Mod Manager. Otherwise use the zip download links instead.

Upload date Version number Downloads Download link  
2021-12-14 1.13.0 8012 Version 1.13.0 Install
2021-11-21 1.12.1 6232 Version 1.12.1 Install
2021-11-21 1.12.0 225 Version 1.12.0 Install
2021-11-12 1.11.0 1813 Version 1.11.0 Install
2021-11-11 1.10.1 389 Version 1.10.1 Install
2021-11-11 1.10.0 43 Version 1.10.0 Install
2021-11-11 1.9.1 60 Version 1.9.1 Install
2021-11-11 1.9.0 25 Version 1.9.0 Install
2021-11-8 1.8.2 270 Version 1.8.2 Install
2021-11-7 1.8.1 58 Version 1.8.1 Install
2021-11-7 1.8.0 30 Version 1.8.0 Install
2021-11-7 1.7.2 26 Version 1.7.2 Install
2021-11-6 1.7.1 32 Version 1.7.1 Install
2021-11-6 1.7.0 36 Version 1.7.0 Install
2021-11-5 1.6.0 35 Version 1.6.0 Install
2021-11-4 1.5.3 26 Version 1.5.3 Install
2021-11-4 1.5.2 34 Version 1.5.2 Install