-
Notifications
You must be signed in to change notification settings - Fork 78
Home
Welcome to the Steamodded wiki! The following pages form an assembly of documentation and guides for Steamodded.
Skip ahead to step 2 if you are not using any anti-virus software.
Steamodded relies on a runtime code injector in order to modify the game. Because it functions similarly to a Trojan, it is often incorrectly flagged as malware by anti-virus systems. Rest assured that Lovely is not malicious in any way. It is fully open source, so you can convince yourself that it works exactly as promised and does nothing else. You can even build it yourself if you're still unsure. In order to get Lovely running properly, you will have to whitelist Balatro's installation folder in whatever anti-virus software you may be using. You may also need to temporarily disable real-time protection to avoid having files deleted while moving them around.
Differences may occur if you're using different software.
- Navigate to the game's directory by right-clicking the game in Steam, hovering "Manage", and selecting "Browse local files". Copy the file path of this directory.
- Open Windows Security and navigate to
Virus & threat protection > Manage settings
. - Disable
Real-time protection
. - Scroll down to
Add or remove exclusions
and confirm if prompted. - Add a folder exclusion. When an explorer window opens, paste the path you copied in step 1 into the address bar and confirm.
Now you're ready to install the Lovely injector. Please follow the installation instructions for your operating system here, then return to this page and continue with Step 3. If your browser is blocking your download, use Firefox instead.
If you previously installed Steamodded without Lovely, you must first remove that installation by verifying your game files on Steam: Library > Balatro > Properties > Installed Files > Verify integrity of game files
.
This method requires no further tools. If you know what Git is, skip ahead to Method (3b).
- Click here to download the latest source code. (No up-to-date releases exist as of now. This guide will be updated when they do.)
Important
We recently reworked some stuff in the latest commits that has caused incompatibility with lots of mods. Regular users probably want to download the old-calc version instead of the main one. Mod dev's should use the main commit to update their mods.
When following steps with this build, the folders will be named smods-old-calc
instead of smods-main
.
- Extract the download zip file.
- In your file explorer, navigate to Balatro's save directory: Windows:
%AppData%/Balatro
; Mac:~/Library/Application Support/Balatro
; Linux (WINE/Proton):~/.local/share/Steam/steamapps/compatdata/2379780/pfx/drive_c/users/steamuser/AppData/Roaming/Balatro
.
Important
On Windows systems, just paste %AppData%/Balatro
into the explorer path bar or the run dialog to open the folder. %AppData%
has special meaning and you do not need to manually replace it.
Click me for Example Video
Screencast_20241231_162107.webm
Note
On Linux systems with a snap installation of Steam, the save directory is slightly different: ~/snap/steam/common/.local/share/Steam/steamapps/compatdata/2379780/pfx/drive_c/users/steamuser/AppData/Roaming/Balatro
- Create a folder named
Mods
if it doesn't already exist. Open yourMods
folder. - Inside the extracted zip file, you should find a directory named
smods-main
. Move this interior folder into yourMods
folder. Ensure there is more than a single folder inside. - To update Steamodded later, delete the
smods-main
folder and repeat steps 1-5.
This method requires Git. If you have completed Method (3a), please skip this step. Your installation is complete.
-
Navigate to Balatro's save directory: Windows:
cd %AppData%/Balatro
; Mac:cd ~/Library/Application Support/Balatro
; Linux (WINE/Proton):cd ~/.local/share/Steam/steamapps/compatdata/2379780/pfx/drive_c/users/steamuser/AppData/Roaming/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
.
Game Objects
- API Documentation
- SMODS.Achievement
- SMODS.Atlas
- SMODS.Blind
- SMODS.Center
- SMODS.Challenge
- SMODS.DeckSkin
- SMODS.Keybind
- SMODS.Language
- SMODS.ObjectType
- SMODS.PokerHand
- SMODS.Rarity
- SMODS.Seal
- SMODS.Sound
- SMODS.Stake
- SMODS.Sticker
- SMODS.Suit and SMODS.Rank
- SMODS.Tag
Guides
- Your First Mod
- Mod Metadata
- Joker Calculation
- Calculate Functions
- Logging
- Event Manager
- Localization
- Mod functions
- UI Structure
- Utility Functions
Found an issue, or want to add something? Submit a PR to the Wiki repo.