You are viewing a potentially older version of this package. View all versions.
SpecialAPI-BoonAPI-1.0.0 icon

BoonAPI

BoonAPI is a BepInEx plugin that allows for easy creation of custom boons.

Date uploaded 4 years ago
Version 1.0.0
Download link SpecialAPI-BoonAPI-1.0.0.zip
Downloads 277
Dependency string SpecialAPI-BoonAPI-1.0.0

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

BoonAPI

BoonAPI is a BepInEx plugin that allows for easy creation of custom boons. To use BoonAPI in your mod, just add it as a reference in your project. Custom boon creation example:

NewBoon exampleBoon = new NewBoon("Boon's Rulebook Name Here", typeof(ExampleBoonHandler), "Boon's Description Here", boonRulebookIcon, boonCardArt, trueIfStacks, trueIfAppearsAsLeshyTrialReward, trueIfAppearsInRulebook);
ExampleBoonHandler.boo = exampleBoon.boon.type;

ExampleBoonHandler here would be a class that inherits from BoonBehavior that handles how the boon affects card battles. You can override any method that would normally be overridable in any TriggerReceivers like AbilityBehaviours or SpecialCardBehaviours (but in BoonBehavior the RespondsToSomething methods are named RespondToSomething instead). To add your boon you can do RunState.Run.playerDeck.AddBoon(savedBoonType) (this is why the last line (ExampleBoonHandler.boo = exampleBoon.boon.type) is there, to save the boon's type). To remove the boon do the same but RemoveBoon or RemoveAllBoonsOfType instead of AddBoon.

Installation

To use BoonAPI, put BoonAPI.dll inside of your BepInEx plugins folder. It also probably works for Thunderstore Mod Manager or r2modman but I don't know for sure (I don't use them)

NOTE: This mod was developed for Kaycee's Mod beta but it should work for the normal game.