LegendAPI is a framework for other mods to help integrate their content with the game in a way compatible with both other mods and with vanilla systems other than the one being directly modified.
The contents of the release should be extracted into the plugins folder under your BepInEx installation,
This project requires a valid installation of both BepInEx (version 4.5.* or later) and also of HookGenPatcher
After cloning the repo,place the necessary library files in a folder named libs one level above the repo,afterwards run dotnet build.
##Basic Usage (by Module)
The core idea behind using LegendAPI as a mod developer is that you write your content as if it was a part of the main game and then provide LegendAPI with info regarding it so that it can do the necessary modifications for the game to accept it.
There are various modules that facilitate this.
Unless stated otherwise all Info fields can be expected to have sane default values.
An Item is implmented by first writing a class inheriting from either any other item or the vanilla Item class,after doing so the following details can be provided to LegendAPI:
ItemInfo {
Item item; //An instance of your item
string name; //The name of your item.
int tier; //The 'tier' that your item is in,this determines internal values such as rarity and base price.
global::TextManager.ItemInfo text; //The user facing text your item has,made up of it's internal-id,a display name and a description.
string group; //The internal-id of any group items that this item might belong to.
Sprite icon; // The inventory & world sprite for your item.
int priceMultiplier; //The direct price multiplier of your item,set to 0 to make it free.
Func<bool> unlockCondition; //A function that takes nothing and returns a bool,this delegate will be called to decide whether the item is eligible for sale at the Plaza's Item Shop. It can either check another condition or return false for fully custom unlocks.
}
This data can then be passed to the API by calling LegendAPI.Items.Register(),any items that this one can combine into should be registered using LegendAPI.Items.RegisterRecipe().
This module is compatible with Replace Mode Registering,which means that providing an ItemInfo matching to an existing (vanilla or modded) item will allow you to change it's values.
An Outfit is made by creating a new instance of the vanilla Outfit class. However,to make use of LegendAPI's outfit related functionality requires that the outfit's modList field contains an entry of LegendAPI.Outfits.CustomModType,it can also include other OutfitStatMods without issue.
Afterwards,the following info can be filled out:
OutfitInfo {
Outfit outfit; //The outfit instance you created,note the requirement of a CustomModType entry mentioned above.
string name; //The display name of the outfit.
Func<bool> unlockCondition; //A function that takes nothing and returns a bool,provided that the outfit isn't unlocked by default(a field in the Outfit class),this delegate will be called to decide whether the player has earned the outfit.
Action<Player, bool, bool> customMod; //The Custom Modifier,this is the workhorse that weaves your custom outfit effects into being,this delegate takes,in order,the player in question,whether the effect is being turned on or off and if it's being called due to a change in outfits or otherwise.
Func<bool, string> customDesc; //The display description of the outfit's abilities,it is provided as a delegate to take advantage of live shifts in values,the input of the delegate refers to whether it's being displayed in a context where providing stat numbers is appropriate
}
This data can then be passed to the the API by calling LegendAPI.Outfits.Register().
This module is compatible with Replace Mode Registering,which means that providing and OutfitInfo matching to an existing (vanilla or modded) outfit will allow you to change it's values.
This module allows you to provide the following data to slot in new element types into the games systems:
ElementInfo {
string name; //The Internal *and* External name of the element.
Color color; //The color that represent the element
List<ElementType> weakTo; //Elements that this one performs weakly against.
bool isSubElement; //Whether this element is a subset of another,primary,element. It should be noted that the game expects all damage to be dealt in the form of a primary element.
string impactAudioID; //The internal id for this element's sound effect.
Type statusEffectType; //The C# Type of a status effect that can be inflicted by this element,leave empty if no such exists.
string statusEffectChanceString; //Provided that a statusEffectType exists,this will be the key that will be added to attacks to represent it,can be left empty to use a default value.
Type elementalBurstType; //The C# Type of this element's 'burst'.This is an explosion or blast that will be used by many effects in the game,can be left empty if such compatibility is not desired.
Func<Vector2,System.Collections.IEnumerator> spawnDisaster; //The Delegate that gets called to represent this element in the Catastrophic Codex,it is treated as a coroutine that takes a position to spawn the effect at,can be left empty if such compatibility is not desired.
Sprite icon; //The sprite used to represent your element.
Sprite iconInk; //The sprite used to represent your element when not selected.
}
After providing this data to the API by calling LegendAPI.Elements.Register(),it will return an ElementType representing the new element,
this value should be saved by the mod plugin and can later be used in anywhere a vanilla ElementType can.
This module is NOT compatible with Replace Mode Registering,trying to register the same element twice will give you copies.
This module allows you to provide the following data to add new soundtrack replacements to the game:
BGMInfo{
string name; //The Internal name of the Soundtrack
BGMTrackType fallback; //Another Soundtrack,vanilla or modded,for this replacer to fallback to when it is missing a requested song.
Dictionary<string,AudioClip> soundtrack; //The actual audio that will be played for a given song name/id.
string message; //The line of dialogue Melody will provide the player in regards to this soundtack.
string messageConfirm; //The confirmation option for the above.
string messageCancel; //The rejection option for the above.
Sprite albumIndicatorSprite; //The replacement sprite for Melody's indicator ribbon.
float volumeMultiplier; //A flat multiplier on the volume of all songs played from this soundtrack
}
After providing this data to the API by calling LegendAPI.Music.Register() it will return a BGMTrackType representing the new soundtrack,
however,keeping this value around is not necessary unless one intends to manually queue up music,as all soundtracks will be automatically added to Melody's rotation ingame.
This module is NOT compatible with Replace Mode Registering,trying to register the same soundtrack twice will give you copies.
This is the generic module for any extra functionality that LegendAPI might make use of or expose,check here for stuff that might be useful to you!
Current Functionality Includes(but may not be limited to):\
SetExtraAttackInfo() which will let you attack arbitrary pieces of data to attacks.GetExtraAttackInfo() for making use of the above.1.3.0
1.2.1
1.2.0