Blockbench Reference Docs
    Preparing search index...

    Interface PluginOptions

    interface PluginOptions {
        about?: string;
        author: string;
        await_loading?: boolean;
        bug_tracker?: string;
        contributes?: { formats: string[] };
        contributors?: string[];
        creation_date?: string;
        deprecation_note?: string;
        description: string;
        disabled?: boolean;
        has_changelog?: boolean;
        icon: string;
        max_version?: string;
        min_version?: string;
        new_repository_format?: boolean;
        repository?: string;
        tags?: [string, string?, string?];
        title: string;
        variant: "both" | "desktop" | "web";
        version?: string;
        website?: string;
        oninstall?(): void;
        onload?(): void;
        onuninstall?(): void;
        onunload?(): void;
    }
    Index

    Properties

    about? author await_loading? bug_tracker? contributes? contributors? creation_date? deprecation_note? description disabled? has_changelog? icon max_version? min_version? new_repository_format? repository? tags? title variant version? website?

    Methods

    oninstall? onload? onuninstall? onunload?

    Properties

    about?: string

    The about text appears when the user unfolds the plugin in the plugin browser. It can contain additional information and usage instructions

    author: string
    await_loading?: boolean

    Set to true if the plugin must finish loading before a project is opened, i. e. because it adds a format

    bug_tracker?: string
    contributes?: { formats: string[] }

    Can be used to specify which features a plugin adds. This allows Blockbench to be aware of and suggest even plugins that are not installed.

    contributors?: string[]
    creation_date?: string
    deprecation_note?: string

    In combination with a "Deprecated" tag, this can be used to provide context on why a plugin is deprecated

    description: string

    Description text in the plugin browser

    disabled?: boolean
    has_changelog?: boolean
    icon: string
    max_version?: string

    Maximum Blockbench version in which the plugin can be installed

    min_version?: string

    Minimum Blockbench version in which the plugin can be installed

    new_repository_format?: boolean

    Use the new repository format where plugin, iron, and about are stored in a separate folder

    repository?: string
    tags?: [string, string?, string?]

    Plugin tags that will show up in the plugin store. You can provide up to 3 tags.

    title: string
    variant: "both" | "desktop" | "web"

    Where the plugin can be installed. Desktop refers to the electron app, web refers to the web app and PWA

    version?: string

    The version of the plugin.

    website?: string

    Methods

    • Runs when the user manually installs the plugin

      Returns void

    • Runs when the plugin loads

      Returns void

    • Runs when the user manually uninstalls the plugin

      Returns void

    • Runs when the plugin unloads

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods