 | spaar's Mod Loader |
This is the documentation for spaar's Mod Loader. spaar's Mod Loader is currently the only mod loader available for the game Besiege.
This documentation is aimed primarily at mod developers looking to use the APIs provided by the mod loader.
The documentation is still a work-in-progress, anybody who wants to contribute or request more documentation on a specific topic is welcome to do so at the GitHub repository of the mod loader.
Getting StartedTo get started writing mods you can look at the Mod class. Every mod need exactly one class extending the Mod and overwriting its abstract members.
In practice this means you will need to specify at least a name, a display name, an author, a version and methods to be called when your mod is loaded and unloaded. Please look at the documentation for all members of Mod when writing a mod and overwrite each as necessary, even if there are default values specified.
Apart from that, all classes in spaar.ModLoader provide some kind of API for mods and spaar.ModLoader.UI provides methods for making your GUI fit in.