CiCisMods-CiCisTrinketAndBindingFramework icon

CiCisTrinketAndBindingFramework

Library mod for White Knuckle. Lets other mods register custom Trinkets and Bindings that appear in the run-start picker. Required by CiCi's Climbing Axes 1.1.0+ and CiCi's Pioneer's Shotgun 0.2.13+.

Last updated 2 hours ago
Total downloads 24
Total rating 0 
Categories Tools Libraries
Dependency string CiCisMods-CiCisTrinketAndBindingFramework-1.0.0
Dependants 1 other package depends on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2305 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2305

README

CiCi's Trinket & Binding Framework

A library mod for White Knuckle. Provides a public API that other mods can call to register custom Trinkets (run-start modifiers, optional) and Bindings (run-start modifiers with stronger effects, optional) so they show up in the trinket/binding picker on Fresh Game start.

This mod does nothing by itself. It's a dependency for other mods.

For players

Just install it. You'll only need it if a mod you use lists this as a dependency — Thunderstore Mod Manager will install it automatically in that case.

For modders

using TrinketAndBindingFramework;

[BepInDependency(TrinketAndBindingFramework.Plugin.GUID)]
public class MyMod : BaseUnityPlugin
{
    private void Awake()
    {
        TrinketRegistry.Register(
            id: "yourmod_my_trinket",
            displayName: "My Trinket",
            description: "...",
            icon: yourSprite,
            isBinding: false,
            itemsToGrantFactory: () => new List<Item_Object> { yourItemTemplate }
        );
    }
}

See the source of CiCi's Climbing Axes or CiCi's Pioneer's Shotgun for working examples.

Compatibility

  • White Knuckle (current build)
  • BepInEx 5.x