Bukkit plugin.yml

Minecraft Bukkit plugin description files

plugin.yml

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your plugin.yml and it validates in your browser — nothing is uploaded.

Validate a plugin.yml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`name`required	`string`	—
`main`required	`string`	The plugin's initial class file.
`version`required	`string \| number`	A plugin revision identifier.
`description`	`string`	Human readable plugin summary.
`author`	`string`	The plugin author.
`authors`	`array<string>`	The plugin contributors.
`website`	`string`	The URL to the plugin's site
`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"` one of: `"STARTUP", "POSTWORLD"`
`depend`	`array`	Other required plugins.
`softdepend`	`array`	Other plugins that add functionality.
`loadbefore`	`array`	A list of plugins should be loaded after this plugin.
`commands`	`object`	The commands the plugin will register
`permissions`	`object`	The permissions the plugin will register
`default-permission`	`string \| boolean`	— default: `"op"` one of: `true, false, "op", "not op"`
`awareness`	`array<string>`	The concepts that the plugin acknowledges.
`api-version`	`string \| number`	Gives the API version which this plugin is designed to support.
`libraries`	`array<string>`	A list of libraries the server should download and supply to the plugin when loading it.

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
Has 2 place(s) where keywords sit beside $ref. Under draft-07 those keywords are silently ignored by every conforming validator — first at #/definitions/permission/properties/children/additionalProperties.
27 properties, 100% carrying a description, max nesting depth 7.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$ref`	JSON Schema Core, draft 2020-12	§8.2.3.1 — Direct References with "$ref"
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`examples`	JSON Schema Validation, draft 2020-12	§9.5 — "examples"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`pattern`	JSON Schema Validation, draft 2020-12	§6.3.3 — "pattern"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`required`	JSON Schema Validation, draft 2020-12	§6.5.3 — "required"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"
`format: "uri"`	RFC 3986 (STD 66)	§3 — Syntax Components

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas