Skip to main content

Write your own Plugin

warning

Writing a plugin for OneWareStudio can be considered experimental, as not all the API is 100% done yet. Future updates can break your plugin. Documentation is incomplete and looking at the source code is nessesary. A good understanding of C# and Avalonia is recommended. If you just want to add your own hardware support, you can do it without using C#

Prerequisites​

  • NET 8.0 SDK
  • C# Code Editor (JetBrains Rider recommended)
  • Latest Version of OneWare Studio

Install the official templates (NET 8)​

dotnet install -g OneWare.Templates

Create a new Plugin​

The following command can create an extension from a template for you. You can replace OneWare.MyExtension with your Extension name. To make integration with github pipelines easier, you can add -G YOUR_GITHUB_NAME using your GitHub name.

dotnet new oneware.extension -o OneWare.MyExtension

Run and Debug the Plugin​

Open the created template .sln file with Rider. Once fully loaded, you can create a new run configuration in the edit Configurations menu. You can use add Configuration and add a new configuration with the .NET Executable type.

Rider Run Configuration

There you can set the path to your OneWareStudio Executable. The Runtime arguments should be --modules ./, which means that you are pointing the module to be loaded to your working directory. For this to work you finally need to set the working directory to your plugin folder and adding (/bin/Debug/net8.0) so that the working directory is the folder where your plugin gets compiled to.

If it works you can press on Run and should see that your plugin is loaded. This also allows debugging your plugin directly in Rider.

Using VSCode​

Coming soon!

Plugin entry point​

The entry point for your extension will be a module.cs, which derives from IModule. In this file you can register types for dependency injection or add your own settings, toolchains, simulators, UI-Elements and much more.

public class TestExtensionModule : IModule
{       
    public void RegisterTypes(IContainerRegistry containerRegistry)
    {
        //Register types for dependency injection
    }

    public void OnInitialized(IContainerProvider containerProvider)
    {
        //Register settings, toolchains, Add UI Elements ...
    }
}

API Documentation​

The API is not ready yet, same goes for the documention. If you still want to experiment with OneWareStudio Plugins, it is recommended to look at the source code of OneWare Studio or see other official examples: