
BonkersLib
This is a library for Megabonk to provide a stable API and reusable services.Details
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.dllinto yourBepInEx/pluginsfolder, 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.dllas a reference in your C# project. - Ensure your mod declares
BonkersLib.dllas 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.