Code Monkey home page Code Monkey logo

inscryptionapi's Introduction

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

inscryptionapi's People

Contributors

ingohhacks avatar julian-perge avatar madh95 avatar scottwilson0903 avatar windows10ce avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.