Modding: Difference between revisions

Revision as of 20:19, 10 September 2025

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.

@@ Line 1: / Line 1: @@
-'''Mods''' (or '''modding''') are a functionality based on top of the [[Plugins|plugin system]], that allows you to make modifications to the Resonite client to patch various issues or add functionalities in a limited manner.
+<languages/>
+'''Modding''' is a functionality based on top of the [[Plugins|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.
-{{Note| While using and creating mods is totally fine, 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}}
+== 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:
-Mods can do but not limited to:
+* Add installation UI and functionality for existing systems in Resonite
-* Add support for controllers/headsets
+* Automate/perform usually cumbersome/impossible actions
-* Add support for facial trackers/eye trackers
+* Patch existing functions for new or different behavior. This can encompass many things, such as:
-* Add new tools
+** Adding support for new file formats
-* Add protections like anti knockback and gravity changes
+** Adding support for new headsets/controllers or face/eye tracking
-* Add support for new file formats
+** Creating safety systems that exist outside of the [[world]] and thus can not be messed with by other users
-=== Additional resources ===
+== Getting started ==
-A list of community audited mods can be found on [https://github.com/resonite-modding-group/resonite-mod-manifest the mod manifest].
+For users wishing to install mods, see [[/Installing mods]].
-Additional mods, installation help, and debugging assistance can be found on the [https://discord.gg/ZMRyQ8bryN Modding Discord].
+For developers wishing to create mods, see the pages about [[/Creating mods]].
-=== Why aren't some features implemented by mods in the base game? ===
+For information about the mod manifest, which is used as a consistent API for mod releases and authors, see the [[/Mod manifest]] page.
-Cyro wrote a good answer to this question<ref>OutFlow on GitHub - README: https://github.com/BlueCyro/Outflow?tab=readme-ov-file#why-isnt-this-in-the-game-by-default</ref>:
+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.
-<blockquote>
+[[Category:Modding]]
-I get this question a lot about some of my mods, so I want to go a little bit into detail about why it seems like modders can do all of these amazing things when the YDMS Team can't.
-''Mods do not care.''
-What I mean by this, is that they don't care about the philosophy behind why something is built. Imagine you have an office building and you want to run a long network cable to the other side. If you own the building, you can contract a bunch of workers to carefully route the wires in such a way that is out of the way, and is easily accessible if they need to run more networking to other areas of the building. As a mod-maker, you don't own this building. You can't hire a bunch of workers so what you end up doing is either routing a bunch of cables all over the place where people can trip. You use far more cabling than you need, drill holes in the walls to get it to the next room, or completely tear them down to get the cable where you want it to go. Imagine taking a bulldozer to your bedroom to connect to a router located in your kitchen.
-All this is to say that just because a mod can do it, doesn't mean it's the way it should be done. Modding isn't bad (it's actually really good for a platform's longevity it turns out), but it's not the way a game should be developed officially. The YDMS Team work very hard at giving us a stable foundation to base our wacky inventions off of.
-You can either use a bulldozer, or recognize why a wall is there in the first place.
-</blockquote>