SoulFire TypeScript SDK 2.10.3
    Preparing search index...
    ServerPlugin: Message<"soulfire.v1.ServerPlugin"> & {
        author: string;
        description: string;
        id: string;
        license: string;
        version: string;
        website: string;
    }

    Metadata about a registered server plugin. Plugins extend SoulFire functionality by adding new settings, commands, and bot behaviors. This information is displayed in the client UI. Returned as part of InstanceInfo and ServerInfoResponse.

    Type Declaration

    • author: string

      The author or organization that created the plugin. Typically a name or organization identifier.

      from field: string author = 4;

    • description: string

      A brief description of what the plugin does. Shown in plugin lists and information panels.

      from field: string description = 3;

    • id: string

      The unique plugin identifier. Should be a lowercase, hyphenated string (e.g., "auto-reconnect", "chat-control"). Used to reference the plugin in owning_plugin_id fields.

      from field: string id = 1;

    • license: string

      The software license under which the plugin is distributed. Examples: "MIT", "Apache-2.0", "GPL-3.0".

      from field: string license = 5;

    • version: string

      The semantic version of the plugin (e.g., "1.0.0", "2.1.3-beta"). Follows semver conventions for compatibility tracking.

      from field: string version = 2;

    • website: string

      URL to the plugin's website, documentation, or repository. Allows users to find more information or report issues.

      from field: string website = 6;

    from message soulfire.v1.ServerPlugin