m cleanup useless comments |
this page was forgotten in the type update |
||
| (7 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
< | <languages/> | ||
{{Note|<translate><!--T:1--> If you use plugins other players will not be able to join sessions you host, unless they have the same plugins as you.</translate>|danger}} | |||
<translate><!--T:2--> 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.</translate> | |||
<translate><!--T:3--> A plugin is a compiled Assembly / DLL written in C# that can be loaded into Resonite at runtime.</translate> | |||
== Plugin | == <translate><!--T:4--> Plugin Guidelines</translate> == | ||
<translate><!--T:5--> When creating a Plugin please keep the following in mind:</translate> | |||
* <translate><!--T:6--> Plugins must not enable players, including yourself to bypass [[Guidelines]].</translate> | |||
** <translate><!--T:7--> This includes: Asset Theft, Harassment etc.</translate> | |||
* <translate><!--T:8--> Plugins should follow the general principle of "Do No Harm"</translate> | |||
== | == <translate><!--T:9--> Plugin Limitations</translate> == | ||
<translate><!--T:10--> Plugins are limited in several ways right now:</translate> | |||
# <translate><!--T:11--> '''If you use plugins you will not be able to join other players, unless they have the same plugins.'''</translate> | |||
# | # <translate><!--T:12--> There is no built-in distribution system. You are in charge of distribution</translate> | ||
# | # <translate><!--T:13--> Plugins may break in between builds of Resonite and therefore require frequent updates.</translate> | ||
# | |||
== <translate><!--T:14--> Writing a Plugin</translate> == | |||
<translate>Please see the article on [[How_To_Create_Plugins|creating plugins]] for an in depth guide.</translate> | |||
<translate><!--T:23--> Double check the links/resources section below for additional resources.</translate> | |||
== <translate><!--T:24--> Using / Testing a Plugin</translate> == | |||
<translate><!--T:25--> When running Resonite with a plugin you must use [[Command Line Arguments]].</translate> | |||
<translate><!--T:26--> The Command Line Argument <code>-LoadAssembly <path></code> will load additional Assemblies / DLLs when used to launch Resonite.</translate> | |||
== Resources / Links == | == <translate><!--T:27--> Plugin Recommendations</translate> == <!--T:12--> | ||
=== Open Source Plugins === | <translate><!--T:28--> 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:</translate> | ||
Feel free to add any open source Resonite plugins here! | * <translate><!--T:29--> Integration of Third Party Hardware or Devices - You can potentially use WebSockets or HTTP for this, but if not a plugin may be needed</translate> | ||
* <translate><!--T:30--> Research / Science Applications - If your scenario requires some advanced integration with a science/educational background one may be needed</translate> | |||
* <translate><!--T:31--> Automation - If you need to automate a process within Resonite such as batch processing of assets or data</translate> | |||
== <translate><!--T:32--> Resources / Links</translate> == | |||
=== <translate><!--T:33--> Open Source Plugins</translate> === | |||
<translate><!--T:34--> Feel free to add any open source Resonite plugins here!</translate> | |||
* [https://github.com/Xlinka/Project-Obsidian Project Obsidian] | * [https://github.com/Xlinka/Project-Obsidian Project Obsidian] | ||
* [https://github.com/resonite-modding-group/ResoniteModLoader ResoniteModLoader] | * [https://github.com/resonite-modding-group/ResoniteModLoader ResoniteModLoader] | ||
[[Category:Features]] | |||
Latest revision as of 23:00, 15 August 2024
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
Please see the article on creating plugins for an in depth guide.
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!