Skip to content

Your-First-Mod.md

Latest commit

 

History

History
23 lines (20 loc) · 2.37 KB

Your-First-Mod.md

File metadata and controls

23 lines (20 loc) · 2.37 KB

Making 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.

First Steps

Useful resources

  • It can be useful to look at code from other mod creators.
    • You can find example implementations of the vanilla Jokers using Steamodded here (Work In Progress)
    • The best place to find more mods is in the official Balatro Discord.
    • Steamodded has some Example Mods.

Steamodded documentation

  • 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.

Other resources

  • 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 inside Balatro.app and rename it to Balatro.zip, then extract Balatro.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.

Development Tips

  • To quickly restart the game after making mod changes, press and hold M or press Alt + F5.
  • Data can be saved by adding it to G.GAME.