The Binding of Isaac: Rebirth

The Binding of Isaac: Rebirth

Not enough ratings
Custom Consumable API [OBSOLETE]
   
Award
Favorite
Favorited
Unfavorite
Tags: Lua, Pills, Cards
File Size
Posted
Updated
1.130 MB
Nov 24, 2019 @ 1:30am
Nov 28, 2019 @ 1:43pm
13 Change Notes ( view )

Subscribe to download
Custom Consumable API [OBSOLETE]

In 3 collections by AgentCucco
AgentCucco's Serious mods
40 items
AgentCucco's Utility Mods
7 items
Cuccommissions
28 items
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.
Popular Discussions View All (3)
0
Nov 29, 2019 @ 4:59pm
PINNED: Incompatible Mods
AgentCucco
12 Comments
Steel, my beloved Jun 27, 2021 @ 9:55am 
Well that's good at least.
AgentCucco  [author] Jun 26, 2021 @ 11:33pm 
Not really, repentance made this api obsolete, all of the functionality this api offered is now officially supported.
Steel, my beloved Jun 26, 2021 @ 11:06pm 
That sucks that this will likely never be updated.
AgentCucco  [author] Dec 13, 2020 @ 7:24am 
If anyone's aiming towards posting a mod on the workshop that requires this API, please don't. This tool is broken for all intents and purposes, it doesn't integrate well with the game or other mods, has little to no support from the rest of the community, and is also a bit outdated.

I'll be likely never updating this mod again, or at least not to a degree where I would recommend using it in real mods. Any mods I've posted that requires this tool will soon become independent from it.

If you wanna use this API for your own wackies, by all means go ahead. But avoid publishing any mods that require it.
AgentCucco  [author] Jan 7, 2020 @ 11:05am 
:winter2019happybulb:
Elya Draganesti Jan 7, 2020 @ 6:12am 
Always love mods like this, you're doing great job for everyone who is moding! ♥ And also for players like me which can use new mods ^^
AgentCucco  [author] Nov 29, 2019 @ 4:54pm 
I could given someone provided the sprite for me, I don't have access to antibirth sprites.
Badsy the Edgecat Nov 29, 2019 @ 4:17pm 
do you think you could add the sprite for the custom runes that Antibirth added?
AgentCucco  [author] Nov 28, 2019 @ 3:08am 
Well, just in case someone didn't read the patchnotes, the overhaul is already live, make sure to update your mod!
AgentCucco  [author] Nov 26, 2019 @ 2:08pm 
ATTENTION

The Custom Rune API is going to get an overhaul soon. I'm working towards implementing support for custom cards and pills too.
This disclaimer is for the people who already download the mod. A lot is bound to change, so if you are working on new runes with this API, I'll highly recommend you to hold them off until after the update is up, then update your code.
Regards!