Skip to main content

Plugin Development Quick Start

This guide covers the shortest path from a .NET project to an installed FolderRewind 1.8 plugin.

:::info Prerequisites

  • Visual Studio 2022 or JetBrains Rider
  • .NET 10 SDK
  • FolderRewind installed (Downloads) :::

Choose interfaces​

Every plugin implements IFolderRewindPlugin. Add only the optional interfaces you need:

InterfacePurpose
IFolderRewindBackupFilterProviderPer-backup include/exclude rules
IFolderRewindBackupScopeProviderConfigurable scopes such as selected Minecraft regions
IFolderRewindBackupPreparationProviderTrigger and consistency context before backup
IFolderRewindFolderDetailsProviderRead-only folder detail sections
IFolderRewindRestoreInterceptorHandle or block restore before side effects
IFolderRewindConfigAugmenterSuggest discovered folders for existing configs
IFolderRewindParameterizedKnotLinkCommandHandlerParameterized KnotLink v2 commands
IFolderRewindKnotLinkCapabilityProviderDiscoverable KnotLink command/signal manifest
IFolderRewindHotkeyProviderGlobal or in-app hotkeys

Interfaces introduced in 1.8 require "MinHostVersion": "1.8.0".

Create the project​

dotnet new classlib -n MyFirstPlugin -f net10.0-windows10.0.19041.0

Reference the FolderRewind assembly from the actual build output:

<Reference Include="FolderRewind">
  <HintPath>..\..\FolderRewind\FolderRewind\bin\Release\net10.0-windows10.0.19041.0\FolderRewind.dll</HintPath>
</Reference>

The application uses .NET 10 with Windows App SDK 2.3.1. Use the target framework from the current project file rather than copying an old path.

Add manifest.json​

{
  "Id": "com.example.myfirstplugin",
  "Name": "MyFirstPlugin",
  "Version": "1.0.0",
  "Author": "YourName",
  "Description": "My first FolderRewind plugin",
  "EntryAssembly": "MyFirstPlugin.dll",
  "EntryType": "MyFirstPlugin.MyPlugin",
  "MinHostVersion": "1.8.0"
}

Implement the core lifecycle​

using FolderRewind.Models;
using FolderRewind.Services.Plugins;

public sealed class MyPlugin : IFolderRewindPlugin
{
    public PluginInstallManifest Manifest { get; } = new()
    {
        Id = "com.example.myfirstplugin",
        Name = "MyFirstPlugin",
        Version = "1.0.0",
        Author = "YourName",
        Description = "My first FolderRewind plugin",
        EntryAssembly = "MyFirstPlugin.dll",
        EntryType = "MyFirstPlugin.MyPlugin",
        MinHostVersion = "1.8.0"
    };

    public IReadOnlyList<PluginSettingDefinition> GetSettingsDefinitions()
        => Array.Empty<PluginSettingDefinition>();

    public void Initialize(IReadOnlyDictionary<string, string> settingsValues) { }

    public string? OnBeforeBackupFolder(
        BackupConfig config, ManagedFolder folder,
        IReadOnlyDictionary<string, string> settingsValues) => null;

    public void OnAfterBackupFolder(
        BackupConfig config, ManagedFolder folder, bool success,
        string? generatedArchiveFileName,
        IReadOnlyDictionary<string, string> settingsValues) { }

    public IReadOnlyList<ManagedFolder> TryDiscoverManagedFolders(
        string selectedRootPath,
        IReadOnlyDictionary<string, string> settingsValues)
        => Array.Empty<ManagedFolder>();
}

The remaining core methods have default implementations. Add extension interfaces only after deciding which Host behavior the plugin owns.

Package and test​

The ZIP must contain a top-level plugin directory:

MyFirstPlugin.zip
└─ MyFirstPlugin/
   ├─ manifest.json
   ├─ MyFirstPlugin.dll
   └─ dependencies/

Install it from Settings → Plugin Management → Local Install, restart if requested, and verify the manifest, minimum Host version, settings, and one backup/restore test.

Next steps​