-
Notifications
You must be signed in to change notification settings - Fork 144
Your First Mod
This page is designed to help you find what is needed when first making a mod. If you are just looking on more clarification on something specific, you should check the sidebar to see if it's covered, or ask in the Balatro Discord.
If you haven't already, Install Steamodded. Method A is recommended due to easier updating and being on the latest dev branch.
This method requires Git. If you do not have git, skip to method B.
- Install lovely according to the instructions.
- Navigate to Balatro's save directory:
cd %AppData%/Balatro
- Paste the following lines:
mkdir Mods
cd Mods
git clone https://github.com/Steamodded/smods.git
- To update Steamodded later, navigate back to the
smods
directory and rungit pull
.
If you have completed Method A, please skip this step. Your installation is complete.
Follow the manual installation instructions on how to install smods as a user at the home page.
A list of resources that might be useful when developing your own mod.
It can be useful to look at code from other mod creators.
- You can find example implementations of the vanilla game objects using Steamodded here
- The best place to find more mods is in the official Balatro Discord.
- Steamodded has some Example Mods.
- Check out the Mod Metadata page for how to get your mod detected by Steamodded.
- Check out the API Documentation page for information on the basics of Steamodded's api.
- For adding content, check the Game Objects part of the sidebar, which lists every object SMODS can create.
- The Lua Reference Manual and Programming in Lua are very useful resources to familiarize yourself with Lua (the game's programming language).
- Often, something you want to do has already been implemented in the base game. Familiarizing yourself with the game's code is an important step to learn Balatro modding. To get Balatro's source code, extract the game's executable file with 7-zip. For Mac, find
Balatro.love
insideBalatro.app
and rename it toBalatro.zip
, then extractBalatro.zip
. A handful of vanilla jokers have been reimplemented in a Steamodded example mod for reference. - Lovely is a tool that lets you patch Balatro's source code. Steamodded mods can take advantage of it too. See Lovely's patch documentation.
- To quickly restart the game after making mod changes, press and hold
M
or pressAlt + F5
. - Data can be saved by adding it to
G.GAME
.
Game Objects
- API Documentation
- SMODS.Achievement
- SMODS.Atlas
- SMODS.Blind
- SMODS.Center
- SMODS.Challenge
- SMODS.DeckSkin
- SMODS.DrawStep
- SMODS.Gradient
- SMODS.https
- SMODS.Keybind
- SMODS.Language
- SMODS.ObjectType
- SMODS.PokerHand
- SMODS.Rank and SMODS.Suit
- SMODS.Rarity
- SMODS.Seal
- SMODS.Sound
- SMODS.Stake
- SMODS.Sticker
- SMODS.Tag
Guides
- Your First Mod
- Mod Metadata
- Calculate Functions
- Perma-bonuses
- Logging
- Event Manager
- Localization
- Text Styling
- Mod functions
- UI Structure
- Utility Functions
Found an issue, or want to add something? Submit a PR to the Wiki repo.