Skip to main content

Interface IPluginManifest

Public interface for the base plugin manifest.

Assembly: Dalamud.dll
View Source
Declaration
public interface IPluginManifest

Properties

InternalName

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

View Source
Declaration
string InternalName { get; }

Name

Gets the public name of the plugin.

View Source
Declaration
string Name { get; }

Punchline

Gets a punchline of the plugins functions.

View Source
Declaration
string? Punchline { get; }

Author

Gets the author/s of the plugin.

View Source
Declaration
string Author { get; }

CanUnloadAsync

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

View Source
Declaration
bool CanUnloadAsync { get; }

AssemblyVersion

Gets the assembly version of the plugin.

View Source
Declaration
Version AssemblyVersion { get; }

TestingAssemblyVersion

Gets the assembly version of the plugin's testing variant.

View Source
Declaration
Version? TestingAssemblyVersion { get; }

Dip17Channel

Gets the DIP17 channel name.

View Source
Declaration
string? Dip17Channel { get; }

LastUpdate

Gets the last time this plugin was updated.

View Source
Declaration
long LastUpdate { get; }

Changelog

Gets a changelog, null if none exists.

View Source
Declaration
string? Changelog { get; }

Tags

Gets a list of tags that apply to this plugin.

View Source
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.

View Source
Declaration
int DalamudApiLevel { get; }

TestingDalamudApiLevel

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

View Source
Declaration
int? TestingDalamudApiLevel { get; }

DownloadCount

Gets the number of downloads this plugin has.

View Source
Declaration
long DownloadCount { get; }

SupportsProfiles

Gets a value indicating whether the plugin supports profiles.

View Source
Declaration
bool SupportsProfiles { get; }

RepoUrl

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

View Source
Declaration
string? RepoUrl { get; }

Description

Gets a description of the plugins functions.

View Source
Declaration
string? Description { get; }

FeedbackMessage

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

View Source
Declaration
string? FeedbackMessage { get; }

IsTestingExclusive

Gets a value indicating whether the plugin is only available for testing.

View Source
Declaration
bool IsTestingExclusive { get; }

ImageUrls

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

View Source
Declaration
List<string>? ImageUrls { get; }

IconUrl

Gets an URL for the plugin's icon.

View Source
Declaration
string? IconUrl { get; }