30 lines
1.4 KiB
Markdown
30 lines
1.4 KiB
Markdown
# Steamodded - A Balatro ModLoader
|
|
|
|
## Introduction
|
|
|
|
Steamodded is a mod loader and injector for the game Balatro. Much like the [LÖVE framework](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
|
|
|
|
Click [here](https://github.com/Steamopollys/Steamodded/wiki).
|
|
|
|
## 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. A collection of documentation pages and guides that are currently available can be found [here](https://github.com/Steamopollys/Steamodded/wiki).
|
|
|
|
## 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)
|