API Overview

Unique Items API does nothing on its own, it must be installed alongside other mods that use what the API provides in order for anything to happen. This API provides modders the tools to easily create "Unique Item" mods as seen on the workshop in various forms, having the sprite of something change based on the character you're playing as. The most popular example of this is the mod "Unique Birthrights", respriting the Birthright collectible to hint at what the item does for the character of the first player only.

The Unique Items API currently provides four different types of objects that can be made "Unique":

• Collectibles (When on pedestals or when held above a character when collecting it)
• Familiars
• Knives (Mom's Knife, Bone Club, Spirit Sword, etc, essentially all melee weapons).
• Effects (A bunch of miscellaneous stuff. Any effects related to an item, you'd probably want to link to an item)

To refer at all types at once, they will be referred to as "Unique Objects" from here on and in further pages.

Any amount of characters, vanilla or modded, can be assigned a sprite for any Unique Object. They can be further customized thanks to support through Mod Config Menu. It will list every available Unique Object and all the characters that object supports. You can disable a character for that Unique Object, or even swap through different mods that use the same Unique Object. There's also an option to change all character's options at once.

The API will constantly check to update your sprite. It will automatically update if your PlayerType changes, if settings in the Mod Config Menu are adjusted, or once every 30 frames. As will be explained in further pages of this wiki, many functions that should cover any customization you need. If anything is missing, be sure to request it!