https://github.com/Numbuh214/EnhanceAPI
Allows for the easy addition of custom enhancements
https://github.com/Numbuh214/EnhanceAPI
Last synced: 12 days ago
JSON representation
Allows for the easy addition of custom enhancements
- Host: GitHub
- URL: https://github.com/Numbuh214/EnhanceAPI
- Owner: Numbuh214
- Created: 2024-04-20T08:41:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-05T02:25:03.000Z (12 months ago)
- Last Synced: 2024-08-02T00:22:46.505Z (9 months ago)
- Language: Lua
- Size: 64.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-balatro - EnhanceAPI - Allows for the easy addition of custom enhancements. by [@Numbuh214](https://github.com/Numbuh214) (Mods (Require [**Steamodded**](https://github.com/Steamopollys/Steamodded)) / API)
README
# Installation / Usage
1.) After installing Steamodded (via Lovely or the old installer), download and extract this Lua file into its own folder in the Mods folder (%AppData/Roaming/Balatro/Mods).
2.) In your own mod, define your Enhancement in the `INIT` function using this format:
```
{
name = "Sample Enhancement",
slug = "m_sample",
sprite = "m_sample",
pos = {x=0,y=0},
effect = "Sample Enhancement",
label = "Sample Enhancement",
playing_card = true,
display_face = true,
config = {},
loc_txt =
{
"Describe your enhancement {C:attention}here{}",
"as you would {C:attention}anything{} else"
}
}
```
3.) Call the function `newEnhancement(table)` in order to insert your Enhancement into the custom table.
4.) Define a sprite, in the same manner as you would for anything else.
And that's your custom Enhancement added to the game! You'll have to create your own logic and such, depending on what you want the enhancement to actually *do*... but I know you'll do great things now that it's easy to get started!