Custom Consumable API

If you liked this item, please rate it up on Steam Workshop page.

Author: AgentCucco

Last revision: 28 Nov, 2019 at 20:43 UTC

File size: 1.08 MB

On Steam Workshop

Description:
Features:

This mod’s focus is to make it easier on people who want to add new consumables to the game.

With this API all it takes is the standard procedure for sprites and a couple lines of code, and the mod will handle the rest!

Rune/Card Utilities:

Dynamic rune/card pool: Automatically adds your consumable to its respective pool, with a proper chance of appearing based off the total amount of cards or runes.
Easy giantbook animations: All you need to do is have your sprite in the designated root, add a simple line of code and the API will take charge of rendering it when the rune is used.
Automated consumable texturing: This mod automates the process of changing your consumable’s animation to that one of a rune or cardl, all you need to do is specify the cardback you want.
Optional sound implementation: While creating your new consumable you can choose to add a sound effect for it, alongside a specific volume and pitch for it.

– This mod adds several new rune types! Double point, spiky, and a rune shard. You can use these rune types on your mod to have it differ from the bland pointy and chunky ones. Alternatively you can also use the black rune sprite.

Pill Utilities:

Dynamic pill pool: Automatically adds your pill to a new custom pill pool. This is so it’s guaranteed you get at least a few modded pills during each run.
Automatic pill coloring: New pills added into the game will automatically get asigned a default color for them without any effort on your side!
Great customization: While creating your brand new custom pill, you can choose to make it either a positive, negative or neutral pill, plus a few extra types.

General:

Straighforward documentation: You can find easy to follow documentation in the documentation.lua file, inside of this mod’s folder.
Pools customization: You can customize how the pools operate by modifying the MOD CONFIG settings inside of the main.lua.

Unfortunately this mod does not support new rune types or cardbacks, but if you have one in mind and have the sprites, feel free to send them to me so I can add them in.

This mod also does not add new pill colors, since those are pretty incompatible to make

Here’s an example mod I made using this API: https://steamcommunity.com/sharedfiles/filedetails/?id=1922723188
Here’s the documentation for the mod: https://steamcommunity.com/workshop/filedetails/discussion/1919865250/1742268227703736235/

Credits:
AgentCucco: Coding the API.
???: Double point rune.
Ilias: Rune shard.
Hox: Spiky rune.