Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Steamopollys/Steamodded

A Balatro ModLoader
https://github.com/Steamopollys/Steamodded

Last synced: about 1 month ago
JSON representation

A Balatro ModLoader

Awesome Lists containing this project

README

        

# Steamodded - A Balatro ModLoader

## Introduction

Steamodded is a mod loader and injector for the game Balatro. Much like the [LÖVE2D engine](https://love2d.org/wiki/Main_Page) itself, it is built using [Lua](https://www.lua.org/). It is made with modularity and extensibility in mind, providing a large selection of APIs and other features to facilitate bringing your ideas to life.

## Installation

### How to Install Steamodded

Please refer to the [Installation Instructions](https://github.com/Steamopollys/Steamodded/wiki/01.-Getting-started) in the Steamodded guide. While it is possible to use the injector for versions 0.9.8 and below, this method is no longer recommended and is deprecated starting in version 1.0, which is currently in Alpha.

### How to install the Alpha

To use the 1.0.0 pre-release version, install Steamodded [using Git](https://github.com/Steamopollys/Steamodded/wiki/01.-Getting-started#using-the-command-line-requires-git) and check out the main branch. Alternatively, [download](https://github.com/Steamopollys/Steamodded/archive/refs/heads/main.zip) the source code directly instead of the release and proceed with steps 3-6 of the manual [Installation Instructions](https://github.com/Steamopollys/Steamodded/wiki/01.-Getting-started)

## How to Install a Mod

- Navigate to your Mods directory (see the installation instructions).
- Put the mod into that directory. (The mod can be a single file if there is only one file provided, or it can be a whole folder.)
- Launch the game and enjoy!

## Features

Documentation for this project is currently incomplete. Old documentation for version 0.9.8 can be found on unnumbered [Wiki](https://github.com/Steamopollys/Steamodded/wiki) pages. Documentation for version 1.0 is still being assembled on the **numbered** pages; it's not yet complete. Any information found there is subject to change until the full release of version 1.0.0.

## Contributing

This project is open for contribution; feel free to open a pull request. If you are adding new features, providing documentation is highly appreciated.

## License

This project is licensed under the GNU General Public License. This ensures that the software is free to use, modify, and distribute. For more details, click [here](https://github.com/Steamopollys/Steamodded/actions?tab=GPL-3.0-1-ov-file)