github ethangreen-dev/lovely-injector v0.9.0

11 hours ago

Hello! Just wanted to take this moment to thank everyone in this amazing community for their ingenuity and creativity and wonderful drive. It's really rare for a game to persist for as long as Balatro and I'm so proud that I have been able to be a part of it for the past (almost) two years.

I can't even begin to explain how thankful I am to have the incredible @WilsontheWolf and @cg-223. They have taken care of so much work between now and v0.8.0 and I am so lucky to have them as maintainers. They deserve so much appreciation for keeping up the pressure and making this release happen.

And remember to thank the hardworking people that make the mods, they keep this community alive.

You are obligated to try these mods out: (and legally obligated to try out every mod you see elsewhere, too)

Entropy, Tangents, Matador, LobotomyCorp, Amulet, Hatchet, Gros Balatro, Stocking Stuffer, MrBones, Insignia, MyDreamJournal, Balatro Plus, Arrow, TooManyJokers, Multiverse, 45DegreeRotatedBeatblock, Basslatro, Joyous Spring, Incognito, Galdur, Hyperfixation, Hot Potato, UltraViolet, Qualatro, Corrupted Nether, Fusion Jokers, Fortlatro, 1 in 10000 Chance for Withered Foxy Jumpscare Every Second, BeatblockPlus, Beattools, Scruffy Plays Pikmen, Lovely Mobile Maker Revo's Vault Dilatro, Aikoyori's Shenanigans

Install guide

OS Download
Windows lovely-x86_64-pc-windows-msvc.zip
Mac (Arm) lovely-aarch64-apple-darwin.tar.gz
Mac (x86) lovely-x86_64-apple-darwin.tar.gz
Linux lovely-x86_64-unknown-linux-gnu.tar.gz

Mobile Mods!!!!

@WilsontheWolf has created https://lmm.shorty.systems, it lets you mod Balatro on mobile with lovely by porting the Steam version of the game. Try it out.

Important

BREAKING CHANGES:

  • Module patches with load_now = true that fail to load or execute now properly propagate errors instead of failing silently.
  • On Linux native, the mod directory has changed from ~/.config/<game>/Mods to ~/.local/share/<game>/Mods to follow XDG standards. You'll need to move your mods to the new location.

Contributors

Big thanks to the following contributors:

  • @cg223 for multiple targets support, copy patch payloads, nested folder loading, and runtime API additions
  • @WilsontheWolf for the runtime API (reload_patches, variable store), load_now error handling, Linux directory fix, and luaL_loadbuffer hook, and lots more
  • @kasimeka for fixing the --vanilla segfault on Unix and adding Nix support
  • @SpomJ for improving Linux installation documentation
  • @hliuson for release workflow improvements

Notable Changes

Important

Most mods WILL NOT WORK AS ZIPS until modloaders have added support. NO EXCEPTIONS!

Zip mods

TL;DR: Mods can now be distributed as zip files.

Lovely can now load mods packaged as zips. Packaging is simple, just drop your mod files into the archive into either the top-level or into a folder, both are valid.

mod.zip
  lovely.toml
  ...

works the same as

mod.zip
  mod/
    lovely.toml
    ...

Recursive patch loading

TL;DR: Patch files are loaded recursively, clean your lovely dirs.

Patch files inside the lovely/ directory are loaded recursively from subdirectories.

For example:

tangents/
    lovely/
      questionable_feature.toml
      features/
        real_feature.toml
        content.toml
      tweaks/
        balanced.toml

Multiple targets per patch

TL;DR: Pattern, regex, and copy patches can target multiple files.

Patch away with reckless abandon:

[[patches]]
[patches.pattern]
target = ["main.lua", "game.lua", "init.lua"]
pattern = "old_code"
payload = "new_code"

Copy patch payloads

TL;DR: Copy patch payload field

Copy patches now have an optional payload field that lets you inject code without the fuss of a separate file:

[[patches]]
[patches.copy]
target = "main.lua"
position = "append"
payload = """
-- Inline code here
print("Injected!")
"""

Runtime API additions

TL;DR: New Lua APIs for runtime patch manipulation.

The lovely module now exposes several new functions for runtime control:

  • lovely.reload_patches() - Reload all patches from disk without restarting. This does not reapply patches, you need a restart for that.
  • lovely.apply_patches(buffer_name, buffer_content) - Apply patches to arbitrary buffers at runtime. You can patch shaders with this! And whatever you want, really.
  • lovely.set_var(key, value) - Store a var in the store.
  • lovely.get_var(key) - Retrieve a var from the store.
  • lovely.remove_var(key) - Remove and return a var from the store.

Example usage:

-- Store configuration
lovely.set_var("is_tangents_questionable", "true")

-- Retrieve it later
if lovely.get_var("is_tangents_questionable") == "true" then
	panic!("What?")
end

-- Apply patches to a dynamically loaded buffer
local patched = lovely.apply_patches("buffer_name", buffer)

-- Force a patch reload (not a restart)
lovely.reload_patches()

Module patches now apply Lovely patches

TL;DR: You can patch injected modules.

Injected modules can now be patch targets! =[lovely modname "filename"]

Bug Fixes

  • Fixed hardcoded game names in Linux launch scripts (run_lovely_linux.sh)
  • Fixed segfault when running with --vanilla flag on Unix
  • Fixed double-panic behavior on Windows
  • Fixed panic when obtaining extension from extensionless files
  • Fixed incorrect mod directory on Linux (#325)

What's Changed

New Contributors

Full Changelog: v0.8.0...v0.9.0

Don't miss a new lovely-injector release

NewReleases is sending notifications on new releases.