BonkersLib
This is a library for Megabonk to provide a stable API and reusable services.
About this mod Author’s original text
BonkersLib
BonkersLib is a core shared library for BepInEx mod development targeting the game "Megabonk".
Its primary purpose is to provide a stable API and reusable services to interact with the game's code. It is used as a dependency by other mods, such as MegaBonkPlusMod.
🛠️ Core Services
This library abstracts away game-specific code into several easy-to-use services, including:
- PlayerService: For accessing and manipulating player data.
- WorldService: For interacting with the game world and objects.
- GameStateService: For retrieving and tracking the overall game state.
(And other helpers for managing inventory, items, etc.)*
🚀 Installation (For End-Users)
If you are a user of a mod that requires BonkersLib:
Ensure BepInExPack_IL2CPP (Version 6) is installed for your game.
- Compile this project or download the latest release.
- Place the BonkersLib.dll into your BepInEx/plugins folder, alongside the mod that needs it.
- Start the game once to allow the mod to generate its configuration files.
🧑💻 Usage (For Developers)
If you are developing a mod that builds on this library:
- Add BonkersLib.dll as a reference in your C# project.
- Ensure your mod declares BonkersLib.dll as a dependency (e.g., via BepInEx attributes).
- Access the provided services (e.g., BonkersAPI.PlayerService).
🤝 Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
📄 License
MIT LICENSE
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide.
Install these first, or the mod will not work: