NLauncher.PluginSDK 0.2.0

NLauncher Plugin SDK

SDK for developing plugins for NLauncher, a Minecraft launcher.

Installation

dotnet add package NLauncher.PluginSDK

Quick Start

1. Create a new Class Library project targeting .NET 8.0
2. Add the NLauncher.PluginSDK package
3. Implement IPlugin:

using NLauncher.PluginSDK.Interfaces;
using NLauncher.PluginSDK.Models;

public class MyPlugin : IPlugin
{
    private IPluginHost? _host;

    public PluginInfo Info => new()
    {
        Id = "my-plugin",
        Name = "My Plugin",
        Description = "Does something cool",
        Version = "1.0.0",
        Author = "Your Name"
    };

    public PluginState State { get; private set; } = PluginState.Unloaded;

    public Task LoadAsync(IPluginHost host)
    {
        _host = host;
        _host.Logger.Info("My plugin loaded!");
        
        // Register UI elements, subscribe to events, etc.
        
        State = PluginState.Loaded;
        return Task.CompletedTask;
    }

    public Task UnloadAsync()
    {
        State = PluginState.Unloaded;
        return Task.CompletedTask;
    }

    public Task EnableAsync()
    {
        State = PluginState.Enabled;
        return Task.CompletedTask;
    }

    public Task DisableAsync()
    {
        State = PluginState.Disabled;
        return Task.CompletedTask;
    }

    public void Dispose() { }
}

4. Create a plugin.json manifest:

{
  "id": "my-plugin",
  "name": "My Plugin",
  "version": "1.0.0",
  "description": "Does something cool",
  "author": "Your Name",
  "repository": "https://github.com/YourName/MyPlugin",
  "minLauncherVersion": "0.2.0",
  "entryPoint": "MyPlugin.dll",
  "mainClass": "MyPlugin.MyPlugin"
}

Note: The repository field is required. All plugins must provide a public GitHub repository URL for security review.

Features

IPluginHost Services

• Logger - Log messages to NLauncher's log
• Events - Subscribe to launcher events (instance selected, game launched, etc.)
• InstanceService - Access Minecraft instances
• DialogService - Show dialogs to users
• FileSystem - Safe file operations
• CurrentTheme - Access current UI theme colors

UI Registration

// Add a tab to instance panel
_host.RegisterInstanceTab(new TabRegistration
{
    Id = "my-tab",
    Title = "My Tab",
    ViewFactory = () => new MyTabView(),
    ViewModelFactory = () => new MyTabViewModel(_host)
});

// Add to main tabs
_host.RegisterMainTab(...);

// Add settings section
_host.RegisterSettingsSection(...);

Events

_host.Events.InstanceSelected.Subscribe(args => {
    _host.Logger.Info($"Instance selected: {args.Instance.Name}");
});

_host.Events.GameLaunched.Subscribe(args => {
    // Game started
});

_host.Events.ThemeChanged.Subscribe(args => {
    // Update UI colors
});

Documentation

Full documentation: https://github.com/Nyfaria/NLauncher

License

MIT