Add RML link |
m cleanup useless comments |
||
| Line 1: | Line 1: | ||
<span style="font-size:2em;">If you use plugins you will not be able to join other players, unless they have the same plugins as you.</span> | <span style="font-size:2em;">If you use plugins you will not be able to join other players, unless they have the same plugins as you.</span> | ||
Programming within / while playing Resonite right now requires [[ProtoFlux]], but that isn't the only option. Resonite has a Plugin system which you can use. | Programming within / while playing Resonite right now requires [[ProtoFlux]], but that isn't the only option. Resonite has a Plugin system which you can use. | ||
A plugin is a compiled Assembly / DLL written in C# that can be loaded into Resonite at runtime. | A plugin is a compiled Assembly / DLL written in C# that can be loaded into Resonite at runtime. | ||
== Plugin Guidelines == | == Plugin Guidelines == | ||
When creating a Plugin please keep the following in mind: | When creating a Plugin please keep the following in mind: | ||
* Plugins must not enable players, including yourself to bypass [[Guidelines]]. | * Plugins must not enable players, including yourself to bypass [[Guidelines]]. | ||
| Line 14: | Line 11: | ||
* Plugins should follow the general principle of "Do No Harm" | * Plugins should follow the general principle of "Do No Harm" | ||
== Plugin Limitations == | == Plugin Limitations == | ||
Plugins are limited in several ways right now: | Plugins are limited in several ways right now: | ||
# '''If you use plugins you will not be able to join other players, unless they have the same plugins.''' | # '''If you use plugins you will not be able to join other players, unless they have the same plugins.''' | ||
| Line 20: | Line 17: | ||
# Plugins may break in between builds of Resonite and therefore require frequent updates. | # Plugins may break in between builds of Resonite and therefore require frequent updates. | ||
== Writing a Plugin == | == Writing a Plugin == | ||
To get started writing a plugin follow these steps: | To get started writing a plugin follow these steps: | ||
# Download [https://visualstudio.microsoft.com/vs/community/ Visual Studio Community edition]. | # Download [https://visualstudio.microsoft.com/vs/community/ Visual Studio Community edition]. | ||
| Line 30: | Line 27: | ||
# Start writing! | # Start writing! | ||
Double check the links/resources section below for additional resources. | Double check the links/resources section below for additional resources. | ||
== Using / Testing a Plugin == | == Using / Testing a Plugin == | ||
When running Resonite with a plugin you must use [[Command Line Arguments]]. | When running Resonite with a plugin you must use [[Command Line Arguments]]. | ||
The Command Line Argument <code>-LoadAssembly <path></code> will load additional Assemblies / DLLs when used to launch Resonite. | The Command Line Argument <code>-LoadAssembly <path></code> will load additional Assemblies / DLLs when used to launch Resonite. | ||
| Line 44: | Line 40: | ||
* Automation - If you need to automate a process within Resonite such as batch processing of assets or data | * Automation - If you need to automate a process within Resonite such as batch processing of assets or data | ||
== Resources / Links == | == Resources / Links == | ||
=== Open Source Plugins === | === Open Source Plugins === | ||
Feel free to add any open source Resonite plugins here! | Feel free to add any open source Resonite plugins here! | ||
Revision as of 21:42, 13 January 2024
If you use plugins you will not be able to join other players, unless they have the same plugins as you.
Programming within / while playing Resonite right now requires ProtoFlux, but that isn't the only option. Resonite has a Plugin system which you can use.
A plugin is a compiled Assembly / DLL written in C# that can be loaded into Resonite at runtime.
Plugin Guidelines
When creating a Plugin please keep the following in mind:
- Plugins must not enable players, including yourself to bypass Guidelines.
- This includes: Asset Theft, Harassment etc.
- Plugins should follow the general principle of "Do No Harm"
Plugin Limitations
Plugins are limited in several ways right now:
- If you use plugins you will not be able to join other players, unless they have the same plugins.
- There is no built-in distribution system. You are in charge of distribution
- Plugins may break in between builds of Resonite and therefore require frequent updates.
Writing a Plugin
To get started writing a plugin follow these steps:
- Download Visual Studio Community edition.
- During installation, check of the .NET desktop development workload which will give you the >NET Framework 4-4.6 development tools
- Create a new Library project
- Add references to some Resonite libraries from the installation folder:
- FrooxEngine.dll - Found in Resonite/Resonite_Data/Managed/FrooxEngine.dll
- Elements.Core.dll - Found in Resonite/Resonite_Data/Managed/Elements.Core.dll
- Start writing!
Double check the links/resources section below for additional resources.
Using / Testing a Plugin
When running Resonite with a plugin you must use Command Line Arguments.
The Command Line Argument -LoadAssembly <path> will load additional Assemblies / DLLs when used to launch Resonite.
Plugin Recommendations
Firstly, double check, if you 'need a plugin. Most common scenarios can be done within Resonite using ProtoFlux or Components. These items might seem scary for newer users but their possibilities are quite endless. Common things that might need plugins include:
- Integration of Third Party Hardware or Devices - You can potentially use WebSockets or HTTP for this, but if not a plugin may be needed
- Research / Science Applications - If your scenario requires some advanced integration with a science/educational background one may be needed
- Automation - If you need to automate a process within Resonite such as batch processing of assets or data
Resources / Links
Open Source Plugins
Feel free to add any open source Resonite plugins here!