PocketMine plugin.yml

PocketMine plugin manifest file

Type object
File match plugin.yml
Schema URL https://catalog.lintel.tools/schemas/schemastore/pocketmine-plugin-yml/latest.json
Source https://www.schemastore.org/pocketmine-plugin.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

api string[] | string required

The PocketMine API version(s) supported by the plugin. The array should be minimized such that no two API versions.

main string required

The fully-qualified name of the main class that extends PluginBase

pattern=([A-Za-z_]\w+\\)*([A-Za-z_]\w+)
name string required

Name of the plugin

pattern=^[A-Za-z0-9 _.-]+$
version string required

Plugin version

author string

The author name

authors string[]

The author names, will be appended to author if both are present

commands Record<string, object>

The commands to be registered automatically. The keys are command name. Commands can also be dynamically registered with the server CommandMap.

depend string[] | string

Plugin(s) in depend must be present and will be loaded BEFORE this plugin.

description string

The detailed description of the plugin

extensions string[] | object | string

Extension(s) required to load this plugin. Can be one extension name, a list of extension names or a mapping of extension name to version constraints.

load string

The point of loading the plugin, defaults to POSTWORLD

Values: "POSTWORLD" "STARTUP"
loadbefore string[] | string

Plugin(s) in loadbefore will be loaded AFTER this plugin if they are present.

mcpe-protocols integer[] | integer

The MCPE protocol versions supported by the plugin. If supported,

permissions Record<string, object>
prefix string

The plugin prefix used in the logger, defaults to plugin name

softdepend string[] | string

Plugin(s) in softdepend will be loaded BEFORE this plugin if they are present, but nothing special happens if they are not present.

website string

The plugin's website

format=iri

Definitions

PermissionChildren Record<string, object>
VersionConstraint string

The name of the extension, or a mapping of the extension to the required version constraint.