Modding is a functionality based on top of the plugin system that allows one to make modifications to the Resonite client for various purposes. Common uses for modding are to patch around current bugs, add customization to existing aspects of Resonite, or enable functionality not easily provided by Resonite itself.
Modding support and policies
Modding is not officially supported by the Resonite team. They will not officially assist in creating or debugging mods, and bug reports providing log files with mods will have a higher chance to be dismissed.
The act of modding itself is not against the terms of service of Resonite. However, functionality enabled by mods can be utilized to break the terms of service, as with everything that grants power. Mods made specifically to bypass security restrictions or mess with non-consenting users are not allowed. For more information on the exact modding policy for users and developers, refer to the mod and plugin policy.
Limitations
Unlike generic plugins, mods are unable to add, remove, or change things in the data model. In a rough sense, mods can only really be used to:
- Add installation UI and functionality for existing systems in Resonite
- Automate/perform usually cumbersome/impossible actions
- Patch existing functions for new or different behavior. This can encompass many things, such as:
- Adding support for new file formats
- Adding support for new headsets/controllers or face/eye tracking
- Creating safety systems that exist outside of the world and thus can not be messed with by other users
Getting started
For users wishing to install mods, see /Installing mods.
For developers wishing to create mods, see the pages about /Creating mods.
For information about the mod manifest, which is used as a consistent API for mod releases and authors, see the /Mod manifest page.
Real-time discussion and support about using and developing mods can be found on the FrooxEngine Modding Discord. As a reminder, do not seek official support for issues that are caused by mods.