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

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

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

The plugin's initial class file.

pattern=^(?!org\.bukkit\.)([a-zA-Z_$][a-zA-Z0-9_$]*\.)*[a-zA-Z_$][a-zA-Z0-9_$]*$
version string | number required

A plugin revision identifier.

description string

Human readable plugin summary.

author string

The plugin author.

authors string[]

The plugin contributors.

website string

The URL to the plugin's site

format=uri
prefix string

The token to prefix plugin log entries.

database boolean

Set to true if this plugin uses a database.

Default: false
load string

The phase of server-startup this plugin will load during.

Default: "POSTWORLD"
Values: "STARTUP" "POSTWORLD"
depend plugin-name[]

Other required plugins.

softdepend plugin-name[]

Other plugins that add functionality.

loadbefore plugin-name[]

A list of plugins should be loaded after this plugin.

commands Record<string, object>

The commands the plugin will register

permissions Record<string, permission>

The permissions the plugin will register

default-permission string | boolean
Default: "op"
Values: true false "op" "not op"
awareness string[]

The concepts that the plugin acknowledges.

api-version string | number

Gives the API version which this plugin is designed to support.

Examples: "1.13", "1.14", "1.15", "1.16"
libraries string[]

A list of libraries the server should download and supply to the plugin when loading it.

Definitions

plugin-name string
command object

Optional command attributes.

description string

A user-friendly description for a command.

aliases string | array

Alternate command names a user may use instead.

permission string

The permission required to use the command.

permission-message string

A no-permission message.

Examples: "You do not have <permission>"
usage string

A short description of how to use this command.

permission

Optional permission attributes.

description string

A short description of what this permission allows.

Default: "op"
Values: true false "op" "not op"
children Record<string, permission>

Allows other permissions to be set as a relation to the parent permission.

default-permission string | boolean