You are viewing a potentially older version of this package. View all versions.
Thunderstore-lovely-0.6.0 icon

lovely

Lovely is a runtime lua injector for LÖVE 2d

By Thunderstore
https://github.com/ethangreen-dev/lovely-injector
Date uploaded a month ago
Version 0.6.0
Download link Thunderstore-lovely-0.6.0.zip
Downloads 12360
Dependency string Thunderstore-lovely-0.6.0

README

Lovely is a runtime lua injector for LÖVE 2d

Lovely is a lua injector which embeds code into a LÖVE 2d game at runtime. Unlike executable patchers, mods can be installed, updated, and removed over and over again without requiring a partial or total game reinstallation. This is accomplished through in-process lua API detouring and an easy to use (and distribute) patch system.

Manual Installation

  1. Download the latest release.
  2. Open the .zip archive, copy dwmapi.dll into the game directory. You can navigate to the location by right-clicking the game in Steam, hovering "Manage", and selecting "Browse local files".
  3. Install one or more mods into %AppData%/Balatro/Mods.
  4. Run the game.

Important: Mods with Lovely patch files (lovely.toml or in lovely/*.toml) must be installed into their own directory within %AppData%/Balatro/Mods. No exceptions!

Patches

Note that the patch format is unstable and prone to change until Lovely is out of early development.

Patch files define where and how code injection occurs within the game process. For example, this is a patch for the modloader Steamodded:

[manifest]
version = "1.0.0"
dump_lua = true
priority = 0

# Define a var substitution rule. This searches for lines that begin with ${{lovely:var_name}} (var_name from this example, it can really be anything) 
# and replaces each match with the provided value.
# This example would transform print("${lovely:var_name}") to print("Hello world!").
# USEFUL: For when you want to reduce the complexity of repetitive injections, eg. embedding release version numbers in multiple locations.
[vars]
var_name = "Hello world!"

# Inject one or more lines of code before, after, or at (replacing) a line which matches the provided pattern.
# USEFUL: For when you need to add / modify a small amount of code to setup initialization routines, etc.
[[patches]]
[patches.pattern]
target = "game.lua"
pattern = "self.SPEEDFACTOR = 1"
position = "after"
payload = '''
initSteamodded()
print('${{lovely:var_name}}')
'''
match_indent = true
overwrite = false

# Append or prepend the contents of one or more files onto the target.
# USEFUL: For when you *only* care about getting your code into the game, nothing else. This does NOT inject it as a new module.
[[patches]]
[patches.copy]
target = "main.lua"
position = "append"
sources = [
    "core/core.lua",
    "core/deck.lua",
    "core/joker.lua",
    "core/sprite.lua",
    "debug/debug.lua",
    "loader/loader.lua",
]

# Inject a new module into the game *before* a target file it loaded.
# USEFUL: For when you want to silo your code into a separate require-able module OR inject a "global" dependency before game / mod code begins execution.
[[patches]]
[patches.module]
source = "nativefs.lua"
before = "main.lua"
name = "nativefs"

Patch variants

This file contains two patch definitions - a pattern patch, which (currently) changes a single line at a position offset to some pattern match, and a copy patch, which reads one or more input lua files and either appends or prepends them onto the target. The former is used when you need to surgically embed code at specific locations in the target (very useful for modloader init routines), and the latter is designed for use when you need to bulk inject position-independent code into the game.

Patch files

Patch files are loaded from mod directories inside of %AppData%/Balatro/Mods. Lovely will load any patch files present within Mods/ModName/lovely/ or load a single patch from %AppData/Balatro/Mods/ModName/lovely.toml. If multiple patches are loaded they will be injected into the game in the order in which they are found.

Paths defined within the patch are rooted by the mod's directory. For example, core/deck.lua is resolved to %AppData%/Balatro/Steamodded/core/deck.lua.

Patch targets

Each patch definition has a single patch target. These targets are the relative paths of source files when dumped from the game with a tool like 7zip. For example, one can target a top-level file like main.lua, or one in a subdirectory like engine/event.lua.

Patch debugging

Lovely dumps patched lua source files to %AppData%/Balatro/Mods/lovely/dump.

Not yet implemented

  • manifest.priority
  • manifest.dump_lua
  • manifest.version

CHANGELOG

v0.6.0

What's Changed

New Contributors

Full Changelog: https://github.com/ethangreen-dev/lovely-injector/compare/v0.4.0...v0.6.0

v0.4.0

What's Changed

New Contributors

Full Changelog: https://github.com/ethangreen-dev/lovely-injector/compare/v0.3.1...v0.4.0

v0.3.1

  • [9f1c346] Implement native print override This fixes missed output from Lua print calls

  • [436fcc7] Implement lua module injection. This allows modules to be injected and require-ed. Initially implemented for nativefs.

  • [436fcc7] Add Lovely metadata injection. This makes it possible for a Lua caller to query information about the Lovely environment.

  • [7ceeace] Add LOVELY_INTEGRITY global const to patched source files. This has been implemented to enable runtime integrity checking for Ankh.

  • [ffeb76f] Fix missing target name check in PatternPatch.

About

Contact Us Privacy Policy Thunderstore Wiki

Developers

API Docs GitHub Repo Package Format Docs Markdown Preview Manifest Validator

Thunderstore 2024