SpecialAPI-KayceesModModifierAPI icon

KayceesModModifierAPI

KayceesModModifierAPI is a BepInEx plugin that allows for easy creation of custom starter decks and challenges for Kaycee's Mod.

Last updated 4 years ago
Total downloads 2268
Total rating 0 
Categories Act I
Dependency string SpecialAPI-KayceesModModifierAPI-1.0.0
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

KayceesModModifierAPI

KayceesModModifierAPI is a BepInEx plugin that allows for easy creation of custom starter decks and challenges for Kaycee's Mod. To use KayceesModModifierAPI in your mod, just add it as a reference in your project. Custom deck creation example:

KayceeModModifier.AddStarterDeckOption("test" /*name for code purpose, doesn't appear anywhere in game*/, textureForDeckIcon, new List<string> { "Urayuli", "Urayuli", "Urayuli" }, levelRequiredForDeckUnlock /*0 if you want it to always be unlocked*/, extraUnlockConditions /*optional*/);

extraUnlockConditions is a list of KayceeModUnlockCondition (custom delegate that takes an int (the current challenge level) and returns a bool (true if the condition is satisfied)). If extraUnlockConditions is included and isn't an empty list, the deck will only be unlocked if both the required challenge level is met AND all of the extra unlock conditions are satisfied. Custom challenge creation example:

NewChallenge test = new NewChallenge("Challenge Name" /*both for code and game purposes*/, challengePointsGivenForActivation, "Challenge Description Here.", challengeIcon, activatedEyesIcon, typeof(ChallengeHandler), levelRequiredForChallengeUnlock, numAppearancesInChallengeSelectScreen /*defaults to 1*/, extraUnlockConditions);

ChallengeHandler should be a type that inherits from ChallengeBehaviour. It is very similar to BoonAPI's BoonBehaviour so for a fuller guide go there. numAppearancesInChallengeSelectScreen is how much the challenge appears in the challenge select screen. It defaults to 1 if you don't include it, but you can set it to something over 1 if you want it to appear multiple times in the challenge select screen (similarly to the More Difficult challenge appearing twice). You can also set it to 0 or lower if you don't want it appearing at all (for some reason).

Installation

To use KayceesModModifierAPI, put KayceesModModifierAPI.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 obviously only works for Kaycee's Mod beta.