-
Notifications
You must be signed in to change notification settings - Fork 193
Your First Mod
Casimir Eisenach edited this page Feb 9, 2025
·
13 revisions
This page is designed to help you find what is needed when first making a mod. If you are just looking on more clarifcation 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.
- Checkout the Mod Metadata page for how to get your mod detected by Steamodded.
- Checkout 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 familarize 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.loveinsideBalatro.appand rename it toBalatro.zip, then extractBalatro.zip. A handful of vanilla jokers have been reimplemented in a Steamodded example mod for reference. - It can also be useful to look at code from other mod creators.
- Steamodded has some Example Mods.
- The best place to find other mods is in the official Balatro Discord.
- Lovely is a tool that lets you patch the balatro source code, and since it's necessary for Steamodded, Steamodded mods can take advantage of it too. See Lovely's patch documentation.
Note
The SMODS wiki has a new home now! Check it out at https://docs.smods.dev
Game Objects
- API Documentation
- SMODS.Achievement
- SMODS.Atlas
- SMODS.Attribute
- SMODS.Blind
- SMODS.CanvasSprite
- SMODS.Center
- SMODS.Challenge
- SMODS.DeckSkin
- SMODS.DrawStep
- SMODS.DynaTextEffect
- SMODS.Font
- SMODS.Gradient
- SMODS.https
- SMODS.JimboQuip
- SMODS.Keybind
- SMODS.Language
- SMODS.ObjectType and SMODS.ConsumableType
- SMODS.PokerHand
- SMODS.Rank and SMODS.Suit
- SMODS.Rarity
- SMODS.Scoring_Parameter and SMODS.Scoring_Calculation
- SMODS.Seal
- SMODS.Shader and SMODS.ScreenShader
- SMODS.Sound
- SMODS.Stake
- SMODS.Sticker
- SMODS.Tag
Guides
- Your First Mod
- Mod Metadata
- The Mod Object
- Calculate Functions
- Perma-bonuses
- Object Weights
- Logging
- Event Manager
- Localization
- Text Styling
- UI Structure
- Utility Functions
- All About
G - Internal Documentation
Release Notes
Found an issue, or want to add something? Submit a PR to the Wiki repo.