Tutorial:Plugin creation

This page may be too technical for most readers to understand. Please help improve it to make it understandable to non-experts, without removing the technical details.

Plugins are used to add more Components and ProtoFlux nodes to Resonite by programming them using C#. They are not to be confused with Mods which do not add things into the Data Model.

This page is about writing plugins and should not be confused with the Plugin overview page.

Please see the plugin guidelines before getting started, to familiarize yourself on what is and is not allowed.

Getting started

You will need to know the basics of the C# Programming Language to write plugins.

1. Download Visual Studio Community edition, which allows for easier programming and compilation of plugins. However, you can use your favourite code editor as long as you know how to compile C# into a .dll
   • During installation, ensure to select .NET desktop development which will give you the .NET Framework development tools, which are required to compile the plugin
2. Create a new project using the Class Library template (please ensure it is the C# option). Guidelines follow:
   1. The project name should be the name of your plugin, same with the solution name. It is recommended to not check the box for Place solution and project in the same directory, as you may have multiple parts to your plugin, such as a ProtoFlux Binding generator.
   2. Select the default framework, we'll be manually editing this later.
3. Add references to the following libraries by right clicking on Dependencies, clicking Add Project Reference and then Browse.
   1. FrooxEngine.dll - Found in Resonite/FrooxEngine.dll
   2. Elements.Core.dll - Found in Resonite/Elements.Core.dll
4. Change the referenced framework to net9.0. To do this:
   1. Double click on your project name, this will be under your solution
   2. Change the line <TargetFramework>whatever_you_selected_earlier</TargetFramework> to <TargetFramework>net9.0</TargetFramework> and save the file
5. Change Your Assembly Info file to tell FrooxEngine what type of plugin you are making.
   1. Create a folder inside your project called Properties
   2. Create a file called AssemblyInfo.cs which contains the line [assembly: DataModelAssembly(t)], where t is a DataModelAssemblyType.

You're now ready to start writing plugins!

Templates

ProtoFlux-Ready

• https://github.com/Custom-Extension-Works/PluginTemplate

Guides

Components

• Creating custom Components

ProtoFlux

• An introduction to creating custom ProtoFlux nodes
• Calls and Continuations in ProtoFlux
• Creating ProtoFlux Globals
• Creating a ProtoFlux Binding

Misc

• Creating settings

Object Reference

This section is in a state of significant expansion or restructuring. You are welcome to assist in its construction by editing it as well.
Reason: Doesn't list all types relevant for writing plugins.

Basic Types

Object	Description
Components	A custom component
DataModelAssemblyType	The type of assembly you are making. Used in your AssemblyInfo.cs file.
ExternalDataModelType
ProtoFlux Binding	The binding for a ProtoFlux Node. Without this, a node cannot be loaded into Resonite.

TODO

ProtoFlux Node Types

Object	Description
ActionBreakableFlowNode
ActionFlowNode
ActionNode	A node which runs when called using an impulse
AsyncActionBreakableFlowNode	Async variant of ActionBreakableFlowNode
AsyncActionFlowNode	Async variant of ActionFlowNode
AsyncActionNode	Async variant of ActionNode
ObjectFunctionNode	A ProtoFlux Node which returns a singular object
ValueFunctionNode	A ProtoFlux Node which returns a singular value
VoidNode	A ProtoFlux Node which doesn't use return to give an output. Used for nodes with multiple outputs.

TODO

Variable types relevant for Components

Type	Description
Sync<T>	A synced Value or Enum
SyncList<T>
SyncRef<T>	A synced Reference (object)

TODO

Variable types relevant for ProtoFlux Nodes

Type	Description

TODO

See also

• Creating custom types in C#