Plugin Interface

var name = pluginInterface.InternalName;
// "MyPlugin"

var manifest = pluginInterface.Manifest;
var author = manifest.Author;
var version = manifest.AssemblyVersion;
var description = manifest.Description;

var reason = pluginInterface.Reason;

if (reason.HasFlag(PluginLoadReason.Boot))
{
    // First load on game start
}
else if (reason.HasFlag(PluginLoadReason.Update))
{
    // Plugin was just updated
}

if (pluginInterface.IsDev)
{
    // Enable debug features
}

if (pluginInterface.IsTesting)
{
    // Running beta version
}

var repo = pluginInterface.SourceRepository;

var loadTime = pluginInterface.LoadTime;

var loadTimeUtc = pluginInterface.LoadTimeUTC;

var elapsed = pluginInterface.LoadTimeDelta;
Console.WriteLine($"Plugin has been running for {elapsed.TotalMinutes:F2} minutes");

var assetDir = pluginInterface.DalamudAssetDirectory;
var iconPath = Path.Combine(assetDir.FullName, "UIRes", "icon.png");

var dllPath = pluginInterface.AssemblyLocation;
var pluginDir = dllPath.Directory;

var configDir = pluginInterface.ConfigDirectory;
var customFile = Path.Combine(configDir.FullName, "custom.json");

var configFile = pluginInterface.ConfigFile;
// Typically: %AppData%/XIVLauncher/pluginConfig/MyPlugin/MyPlugin.json

var uiBuilder = pluginInterface.UiBuilder;

// Register draw handler
uiBuilder.Draw += DrawUI;

// Register config UI handler
uiBuilder.OpenConfigUi += () => configWindow.IsOpen = true;

// Access fonts
var defaultFont = uiBuilder.DefaultFontHandle;
var iconFont = uiBuilder.IconFontHandle;

if (pluginInterface.IsDevMenuOpen)
{
    // Show debug information
}

if (pluginInterface.IsDebugging)
{
    // Enable additional logging
}

var lang = pluginInterface.UiLanguage;
// "en", "ja", "de", "fr"

var greeting = lang switch
{
    "ja" => "こんにちは",
    "de" => "Hallo",
    "fr" => "Bonjour",
    _ => "Hello"
};

if (pluginInterface.IsAutoUpdateComplete)
{
    // All plugins have finished updating
}

var sanitizer = pluginInterface.Sanitizer;
var clean = sanitizer.Sanitize("Text with <special> chars");

var chatType = pluginInterface.GeneralChatType;

foreach (var plugin in pluginInterface.InstalledPlugins)
{
    Console.WriteLine($"{plugin.Name} - {plugin.IsLoaded}");
}

pluginInterface.LanguageChanged += OnLanguageChanged;

private void OnLanguageChanged(string langCode)
{
    // Reload localization
    LoadTranslations(langCode);
}

// Don't forget to unsubscribe in Dispose!
pluginInterface.LanguageChanged -= OnLanguageChanged;

pluginInterface.ActivePluginsChanged += OnActivePluginsChanged;

private void OnActivePluginsChanged(IActivePluginsChangedEventArgs args)
{
    // Handle plugin state changes
}

// Unsubscribe in Dispose
pluginInterface.ActivePluginsChanged -= OnActivePluginsChanged;

public class MyConfig : IPluginConfiguration
{
    public int Version { get; set; } = 1;
    public bool Enabled { get; set; } = true;
}

var config = new MyConfig();
pluginInterface.SavePluginConfig(config);

var config = pluginInterface.GetPluginConfig() as MyConfig ?? new MyConfig();

var dir = pluginInterface.GetPluginConfigDirectory();
// %AppData%/XIVLauncher/pluginConfig/MyPlugin

var locDir = pluginInterface.GetPluginLocDirectory();
// %AppData%/XIVLauncher/pluginConfig/MyPlugin/loc

var langFile = Path.Combine(locDir, $"{langCode}.json");

// Open to all plugins
pluginInterface.OpenPluginInstallerTo();

// Open with search
pluginInterface.OpenPluginInstallerTo(
    PluginInstallerOpenKind.AllPlugins,
    "crafting");

// Open to installed plugins
pluginInterface.OpenPluginInstallerTo(
    PluginInstallerOpenKind.InstalledPlugins);

// Open to general settings
pluginInterface.OpenDalamudSettingsTo();

// Open with search
pluginInterface.OpenDalamudSettingsTo(
    SettingsOpenKind.General,
    "auto update");

pluginInterface.OpenDeveloperMenu();

// Get plugin from assembly
var assembly = typeof(SomeType).Assembly;
var plugin = pluginInterface.GetPlugin(assembly);

// Get plugin from context
var context = AssemblyLoadContext.GetLoadContext(assembly);
var plugin2 = pluginInterface.GetPlugin(context);

if (plugin != null)
{
    Console.WriteLine($"Belongs to: {plugin.Name}");
}

var version = pluginInterface.GetDalamudVersion();
Console.WriteLine($"Dalamud version: {version.Version}");

var sharedData = pluginInterface.GetOrCreateData(
    "MySharedData",
    () => new MyDataClass());

if (pluginInterface.TryGetData<MyDataClass>("MySharedData", out var data))
{
    // Data exists, use it
}

var data = pluginInterface.GetData<MyDataClass>("MySharedData");

pluginInterface.RelinquishData("MySharedData");

public class MyService
{
    public MyService(IChatGui chatGui, ICommandManager commands)
    {
        // Dependencies are injected
    }
}

var service = pluginInterface.Create<MyService>();

// With scoped objects
var service2 = pluginInterface.Create<MyService>(customDependency);

var service = await pluginInterface.CreateAsync<MyService>();

public class MyClass
{
    [PluginService] public IChatGui ChatGui { get; set; } = null!;
}

var obj = new MyClass();
pluginInterface.Inject(obj);
// obj.ChatGui is now injected

var obj = new MyClass();
await pluginInterface.InjectAsync(obj);