Creating an addon - SkEditorTeam/SkEditor GitHub Wiki

[!NOTE] This guide is written for Visual Studio, but you can use any IDE that supports .NET development like Rider or Visual Studio Code.

Creating a project

1. To begin, you need to have Visual Studio ready for .NET development.
2. Click on the "Create new project" button and select "Class library" for .NET.
3. Give your project a name and click "Next".
4. In the next window, make sure to select .NET 8.0
5. Lastly, click the "Create" button to finish.

Adding SkEditor API from Nuget

1. Right click the project in Solution Explorer and click Manage Nuget Packages.
2. Search for SkEditor and install it.

You can also use the .NET CLI: dotnet add package SkEditor

Writing the Code

Now you're set to write some code. Start by ensuring your main class inherits from IAddon from the SkEditor.API namespace. Then, implement all of the required interface fields and methods.

Here's an example class for reference:

using SkEditor.API;

namespace SkEditorTestAddon;

public class TestAddon : IAddon
{
    public string Name => "TestAddon";

    public string Identifier => "TestAddon";

    public string Version => "1.0.0";

    public string? Description => "A test addon for SkEditor";

    public Version GetMinimalSkEditorVersion() => new(2, 8, 0);

    public void OnEnable()
    {
        SkEditorAPI.Windows.ShowMessage("Enabled!", "TestAddon enabled!");
    }
}

Using the Addon

To use your addon:

1. Select your release configuration: when you're ready to release your addon, you should change the configuration to Release at the top of Visual Studio.
2. Right click the project in Solution Explorer and click Pack.
3. Copy YourAddonName.dll from YourProjectName\bin\Release\net8.0 or similar folder.
4. And paste it into %appdata%\SkEditor\Addons