ItemsAPI
A library that provides item creation tools for Mimesis
About this mod Author’s original text
Items API
A library that provides item creation tools for Mimesis.
How to use
This is an API for mod developers, so this mod does not do anything by itself.
It helps creators add new items to the game.
Developer Guide
A complete guide with tutorials is currently a WIP.
Until then, here is a short guide on how to use the API:
- Export the Unity project using AssetRipper and open it in Unity 6.0 (6000.0.59f2)
- Create your item's prefab using another item as a reference (search for prefab_miscellnary_ for examples)
- Assign your item (and its icon) to a new AssetBundle and build it
- Create a MelonLoader mod project
- Add ItemsAPI.dll as a project dependency (keep ItemsAPI.xml in the same directory to access the documentation)
- Load your AssetBundle during OnInitializeMelon
- Register it in ItemsAPI using ItemBuilder.RegisterAssetBundle
- Create a new MiscItemDescriptor or ConsumableItemDescriptor instance with:
- a unique object ID,
- the prefab asset name from your bundle,
- and the display name of the item
- Configure the other properties (price, weight, spawn rate, etc.)
- Register your new item with ItemBuilder.RegisterItem
- Enjoy your new item!
FAQ
➡️ I'm not a mod developer. Do I need to install this mod anyway?
Only if you want to use mods that add new items to the game using this library.
➡️ Do I need the mod if I'm not hosting the game?
Yes, both the host and all clients need the mod for it to work.
➡️ I can't see the items / I don't see the same items as my friends.
You are probably missing an item mod.
The game can start even if you do not have the same item mods as the host, but the item tables will be out of sync.
Make sure you have the same mods as the host and check the logs at startup. The API logs the number of registered items.
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide.
Install these first, or the mod will not work: