Extension file format

Start with an example

YAML and JSON use the same schema. Define a plugin, a stable extension ID and one or more named actions. Each action can contain fields and command templates. The example gives a buyer in-game money through EssentialsX; install the matching plugin before using it.

schemaVersion: 1
id: essentials-economy
name: EssentialsX Economy
version: 1.0.0
plugin: EssentialsX
actions:
  - id: deposit
    name: Give money
    fields:
      - id: amount
        label: Amount
        type: number
        default: "100"
        min: 1
    commands:
      - eco give {username} {amount}
    runAs: console
    requireOnline: false

Definition and action properties

The definition requires schemaVersion: 1, id, name, version, plugin and actions. description is optional. Extension IDs use lowercase letters, digits and hyphens, begin with a letter, and can be at most 40 characters. Keep an ID stable when sharing updates.

Each action requires id, name and commands. description and fields are optional. runAs can be console (the default) or player. requireOnline defaults to false; player actions always wait for the player.

A field needs id, label and type. Optional properties are description, placeholder and default. Defaults and select option values must be strings, even for number fields. Every field is required when configuring a package action.

Field types

Placeholders and limits

Use {username} for the buyer. Other placeholders must match a declared field ID exactly, such as {amount}. The username ID is reserved. Unknown properties, undeclared placeholders, control characters, YAML aliases and custom tags are rejected. There is no executable validation code or script support.

Commands must be single lines without leading slashes. Field values cannot contain braces or control characters. Craftly validates the selected action against your store’s enabled definition when saving the package.