RMMZPluginMetadata

Type: object

RPG Maker MZ plugin metadata

 No Additional Properties

root target
Type: const
Specific value: "MZ"

root description
Type: string or object

A short description of what the plugin does

root description default
Type: string

Text for the default language

Each additional property must conform to the following schema

root description additionalProperties
Type: string

Text for an specific language

root author
Type: string

Name or nickname of the author of the plugin

root url
Type: stringFormat: uri

An URL where the plugin can be found. Useful for updates

root languages
Type: array of string

List of languages the metadata for this plugin supports

Each item of this array must be:

root languages languages items
Type: string

root help
Type: string or object

Plugin help, describes usage and explains features in more detail

Same definition as description

root base
Type: array of string

List of base plugins that this plugin depends on

Each item of this array must be:

root base base items
Type: string

root before
Type: array of string

List of plugins this plugin should come before on the plugin manager

Each item of this array must be:

root before before items
Type: string

root after
Type: array of string

List of plugins this plugin should come after on the plugin manager

Each item of this array must be:

root after after items
Type: string

root params
Type: array

Plugin parameter definitions

Each item of this array must be:

root params parameter
Type: object

A plugin parameter

root params Param allOf ParamBase
Type: object

root params Param allOf ParamBase name
Type: string

Parameter name, used internally by the plugin

root params Param allOf ParamBase description
Type: string or object

Parameter description, will be shown in the editor

Same definition as description

root params Param allOf ParamBase children
Type: array

List of child parameters

Each item of this array must be:

root params Param allOf ParamBase children parameter
Type: object

A plugin parameter

Same definition as Param

root params Param allOf ParamBase default
Type: object

Default value for this parameter

root params Param allOf ParamBase type
Type: object

Parameter type

root params Param allOf ParamBase text
Type: string or object

Text to be shown in the editor for this parameter

Same definition as description
root params Param allOf item 1

root params Param allOf item 1 anyOf BasicParam
Type: object

root params Param allOf item 1 anyOf BasicParam type
Type: enum (of string)

Must be one of:

  • "text"
  • "note"
  • "file"
  • "actor"
  • "class"
  • "skill"
  • "item"
  • "weapon"
  • "armor"
  • "enemy"
  • "troop"
  • "state"
  • "tileset"
  • "common_event"
  • "switch"
  • "variable"
root params Param allOf item 1 anyOf NumberParam
Type: object

root params Param allOf item 1 anyOf NumberParam type
Type: const
Specific value: "number"

root params Param allOf item 1 anyOf NumberParam min
Type: number

Minimum value

root params Param allOf item 1 anyOf NumberParam max
Type: number

Maximum value

root params Param allOf item 1 anyOf NumberParam decimals
Type: number

Floating point precision. If ommited, the number must be an integer.
root params Param allOf item 1 anyOf FileParam
Type: object

root params Param allOf item 1 anyOf FileParam type
Type: const
Specific value: "file"

root params Param allOf item 1 anyOf FileParam dir
Type: stringFormat: uri-reference

Base directory for the file picker

root params Param allOf item 1 anyOf FileParam require
Type: boolean

Whether to include the file on deployment
root params Param allOf item 1 anyOf AnimationParam
Type: object

root params Param allOf item 1 anyOf AnimationParam type
Type: const
Specific value: "animation"

root params Param allOf item 1 anyOf AnimationParam require
Type: boolean

Whether to include the file on deployment
root params Param allOf item 1 anyOf BooleanParam
Type: object

root params Param allOf item 1 anyOf BooleanParam type
Type: const
Specific value: "boolean"

root params Param allOf item 1 anyOf BooleanParam on
Type: string or object

Label for the true option

Same definition as description

root params Param allOf item 1 anyOf BooleanParam off
Type: string or object

Label for the false option

Same definition as description
root params Param allOf item 1 anyOf SelectParam
Type: object

root params Param allOf item 1 anyOf SelectParam type
Type: const
Specific value: "select"

root params Param allOf item 1 anyOf SelectParam options
Type: array

Each item of this array must be:

root params Param allOf item 1 anyOf SelectParam options options items
Type: string or object
No Additional Properties

root params Param allOf item 1 anyOf SelectParam options options items text
Type: string or object

Name of the option to be shown in the editor

Same definition as description

root params Param allOf item 1 anyOf SelectParam options options items value
Type: string

Option value to be used internally by the plugin
root params Param allOf item 1 anyOf ComboParam
Type: object

root params Param allOf item 1 anyOf ComboParam type
Type: const
Specific value: "combo"

root params Param allOf item 1 anyOf ComboParam options
Type: array

Each item of this array must be:

root params Param allOf item 1 anyOf ComboParam options localizedText
Type: string or object
Same definition as description
root params Param allOf item 1 anyOf item 7

root params Param allOf item 1 anyOf StructParam
Type: object
Same definition as StructType

root commands
Type: array

Plugin command definitions

Each item of this array must be:

root commands command
Type: object
No Additional Properties

root commands Command name
Type: string

Command name to be used internally be the plugin

root commands Command text
Type: string or object

Command label to be shown in the editor

Same definition as description

root commands Command description
Type: string or object

Command description to be shown in the editor

Same definition as description

root commands Command args
Type: array

Each item of this array must be:

root commands Command args args items

root structs
Type: array

Plugin struct definitions

Each item of this array must be:

root structs struct
Type: object
No Additional Properties

root structs Struct name
Type: string

root structs Struct params
Type: array

Each item of this array must be:

root structs Struct params parameter
Type: object

A plugin parameter

Same definition as Param