Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/UwUDev/balamod
Modloader/Injector/Decompiler that supports ingame code injection for Balatro (Linux/Windows/Mac)
https://github.com/UwUDev/balamod
balamod balatro mod modding modloader
Last synced: about 1 month ago
JSON representation
Modloader/Injector/Decompiler that supports ingame code injection for Balatro (Linux/Windows/Mac)
- Host: GitHub
- URL: https://github.com/UwUDev/balamod
- Owner: balamod
- Created: 2023-12-14T22:36:28.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-08-21T15:12:37.000Z (4 months ago)
- Last Synced: 2024-11-04T07:19:01.823Z (about 2 months ago)
- Topics: balamod, balatro, mod, modding, modloader
- Language: Rust
- Homepage: https://balamod.github.io
- Size: 430 KB
- Stars: 94
- Watchers: 6
- Forks: 19
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-balatro - Balamod - 模组加载器，注入器和反编译器，支持注入游戏内部代码。 by [@UwUDev](https://github.com/UwUDev) (模组加载器)
README
# Balamod
Mod loader, Injector and Decompiler that supports **in-game code injection for Balatro**
[](https://discord.gg/p7DeW7pSzA)
# Summary
- [Balamod](#balamod)
- [Summary](#summary)
- [Easy Install](#easy-install)
- [How to Install Mods](#how-to-install-mods)
- [CLI Usage](#cli-usage)
- [Example of usages](#example-of-usages)
- [Modding](#modding)
- [How to Use Code Injection](#how-to-use-code-injection)
- [How to find the function names, where to inject code, etc...](#how-to-find-the-function-names-where-to-inject-code-etc)
# Easy Install
> [!IMPORTANT]
> **Balamod** currently don't work on macOS i86, but it will work on ARM64 aka M1/M2/M3.
Balamod has now a [GUI installer](https://github.com/balamod/balamod-gui/releases/latest)
## How to Install Mods
Yon can directly install mods from the in game mod menu or just put your mods in the `mods` folder
- **Windows**: `C:\Users\\AppData\Roaming\Balatro` aka `%APPDATA%\Balatro`
- **macOS**: `~/Library/Application Support/Balatro`
- **Linux**: `~/.local/share/Steam/steamapps/compatdata/2379780/pfx/drive_c/users/steamuser/AppData/Roaming/Balatro`
## CLI Usage
Initially, Balamod searches for all Balatro installations.
If a single installation is found, it becomes the default.
For multiple installations, a prompt will allow you to select one.
In case no installation is detected, you will be prompted to specify one using the `-b` flag.
> [!WARNING]
> Since balamod is now fully external, the usage of -x should not be used anymore.
### Example of usages
- Basic Help
```bash
./balamod --help
```
- Full Auto-Injection of the Mod Loader
```bash
./balamod -a
```
- Injecting a File into the Game
```bash
./balamod -x -i -o
```
- Example to patch an asset file
```bash
./balamod -x -i balatro.png -o ressources/textures/x2/balatro.png
```
- Decompiling the game
```bash
./balamod -d
```
or to decompile it into multiple folders,
```bash
./balamod -d -o MyCustomFolder
```
If you want to inject game code, you will need to compress it with -c
Example to inject a Lua file:
```bash
./balamod -x -c -i Balatro.lua -o DAT1.jkr
```
## Modding
Documentation moved to [balamod.github.io](https://balamod.github.io/modding-basics.html)
For a complete example see [example-mod](https://github.com/balamod/example-mod) which shows events, api, injection and a github action for release
## How to Use Code Injection
Before the game starts, Balamod will retrieve all the code and store it in a map where one file equals to one key. It allows Balamod to know the current state of the game code, and to overwrite parts of it already loaded by the engine.
To use it, you will need 3 elements:
- The Lua file where you want to inject your code,
- The function name,
- The part of the code you want to replace.
The `inject` function takes 4 parameters which are the 3 elements seen above and the new code as 4th parameter. In the mod, it replaces the part that manages the number of cards to be activated very simply like that:
```lua
local to_replace = 'amount = amount or 1' -- old code
local replacement = 'amount = ' .. planet_multiplicator_strength -- new code
local fun_name = "level_up_hand"
local file_name = "functions/common_events.lua"
inject(file_name, fun_name, to_replace, replacement)
```
## How to find the function names, where to inject code, etc...
You can use the `./balamod -d` command to decompile the game and take a look at the code.