Modding: Difference between revisions

Latest revision as of 15:27, 11 September 2025

Modding is a functionality 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 creating mods for basic generalized information about creating mods. There also exists a few modding tutorials that cover the basics of modding and navigating the decompilation of Resonite.

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.

@@ Line 1: / Line 1: @@
-'''Mods''' (or '''modding''') is a functionality based on top of the [[Plugins|plugin system]], that allows you to make modifications to the Resonite client by modifying the game's code client side or on [[Headless_Server_Software|headlesses]].
+<languages/>
+'''Modding''' is a functionality 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.
-: '''''You May Use Mods!'''''
+== Modding support and policies ==
-== Information ==
+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.
-=== Limitations ===
+The act of modding itself is not against the [https://resonite.com/policies/TermsOfService.html 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 [https://resonite.com/policies/ModAndPlugin.html mod and plugin policy].
-Contrary to some beliefs, mods cannot add or remove things in the [[Core_Concepts|Data Model]]. Only [[Plugins]] are able to add data model items.
+== Limitations ==
-Mods allow you to create new functionality to existing functionality, and are ways of adding missing functionality, adding funny joke functions, or allow you to do things other users can't.
+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:
-{{Note|Making mods that are harmful or go against resonite's [https://resonite.com/policies/ Terms of Service] will be acted accordingly by moderation. Do not make or use mods like these.|danger}}
+* 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
-Mods can do but not limited to:
+== Getting started ==
-* Add support for controllers/headsets
-* Add support for facial trackers/eye trackers
-* Add new tools
-* Add protections like anti knockback and gravity changes
-* Add support for new file formats
-=== Additional resources ===
+For users wishing to install mods, see [[installing mods]].
-A list of community audited mods can be found on [https://github.com/resonite-modding-group/resonite-mod-manifest the mod manifest].
+For developers wishing to create mods, see [[creating mods]] for basic generalized information about creating mods. There also exists a few [[:Category:modding tutorials|modding tutorials]] that cover the basics of modding and navigating the decompilation of Resonite.
-Additional mods, installation help, and debugging assistance can be found on the [https://discord.gg/ZMRyQ8bryN Modding Discord].
+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 [https://discord.gg/ZMRyQ8bryN FrooxEngine Modding Discord]. As a reminder, do not seek official support for issues that are caused by mods.
+[[Category:Modding]]