Interface IPluginManifest

Public interface for the base plugin manifest.

Assembly: Dalamud.dll

Declaration

public interface IPluginManifest

Properties

InternalName

Gets the internal name of the plugin, which should match the assembly name of the plugin.

Declaration

string InternalName { get; }

Name

Gets the public name of the plugin.

Declaration

string Name { get; }

Punchline

Gets a punchline of the plugins functions.

Declaration

string? Punchline { get; }

Author

Gets the author/s of the plugin.

Declaration

string Author { get; }

CanUnloadAsync

Gets a value indicating whether the plugin can be unloaded asynchronously.

Declaration

bool CanUnloadAsync { get; }

AssemblyVersion

Gets the assembly version of the plugin.

Declaration

Version AssemblyVersion { get; }

MinimumDalamudVersion

Gets the minimum Dalamud assembly version this plugin requires.

Declaration

Version? MinimumDalamudVersion { get; }

Dip17Channel

Gets the DIP17 channel name.

Declaration

string? Dip17Channel { get; }

LastUpdate

Gets the last time this plugin was updated.

Declaration

long LastUpdate { get; }

Changelog

Gets a changelog, null if none exists.

Declaration

string? Changelog { get; }

Tags

Gets a list of tags that apply to this plugin.

Declaration

List<string>? Tags { get; }

DalamudApiLevel

Gets the API level of this plugin. For the current API level, please see Dalamud.Plugin.Internal.PluginManager.DalamudApiLevel for the currently used API level.

Declaration

int DalamudApiLevel { get; }

DownloadCount

Gets the number of downloads this plugin has.

Declaration

long DownloadCount { get; }

SupportsProfiles

Gets a value indicating whether the plugin supports profiles.

Declaration

bool SupportsProfiles { get; }

RepoUrl

Gets an URL to the website or source code of the plugin.

Declaration

string? RepoUrl { get; }

Description

Gets a description of the plugins functions.

Declaration

string? Description { get; }

FeedbackMessage

Gets a message that is shown to users when sending feedback.

Declaration

string? FeedbackMessage { get; }

ImageUrls

Gets a list of screenshot image URLs to show in the plugin installer.

Declaration

List<string>? ImageUrls { get; }

IconUrl

Gets an URL for the plugin's icon.

Declaration

string? IconUrl { get; }

TestingAssemblyVersion

Declaration

Version? TestingAssemblyVersion { get; }

TestingDalamudApiLevel

Declaration

int? TestingDalamudApiLevel { get; }

IsTestingExclusive

Declaration

bool IsTestingExclusive { get; }

IsAvailableForTesting

Declaration

bool IsAvailableForTesting { get; }