Skip to content

Commit

Permalink
Update plugins.json JSON schema
Browse files Browse the repository at this point in the history
  • Loading branch information
JannisX11 committed Mar 18, 2024
1 parent 2134951 commit 539fd55
Showing 1 changed file with 46 additions and 7 deletions.
53 changes: 46 additions & 7 deletions schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,64 @@
"type": "string"
},
"icon": {
"type": "string"
"type": "string",
"description": "The plugin icon. Icons can be either PNG files with a resolution of 48x48, or they can be SVG files."
},
"author": {
"type": "string"
"type": "string",
"description": "Name of the author or authors"
},
"description": {
"type": "string"
"type": "string",
"description": "Short plugin description"
},
"about": {
"type": "string"
"type": "string",
"description": "Plugin about text. Markdown is supported. For longer about pages, a separate about.md file is recommended."
},
"tags": {
"type": "array",
"description": "Plugin tags. Up to 3 tags are allowed",
"items": {
"type": "string"
}
},
"version": {
"type": "string"
"type": "string",
"description": "Plugin version"
},
"variant": {
"type": "string"
"type": "string",
"description": "Supported Blockbench variant",
"enum": ["desktop", "web", "both"]
},
"min_version": {
"type": "string"
"type": "string",
"description": "Minimum required Blockbench version. Versions 4.7.x and below use the legacy repository structure, where the plugin file is directly stored in the plugins directory."
},
"deprecation_note": {
"type": "string",
"description": "Reason for plugin deprecation. Used alongside the 'Deprecated' tag"
},
"website": {
"type": "string",
"description": "URL to website of the plugin, if applicable"
},
"repository": {
"type": "string",
"description": "URL to Git repository of the plugin, if applicable"
},
"bug_tracker": {
"type": "string",
"description": "URL to the bug tracker of the plugin, if applicable. If unspecified, links to this repository."
},
"await_loading": {
"type": "boolean",
"description": "When set to true, Blockbench waits for this plugin to finish loading before opening double-clicked files etc. This is useful for plugins that add their own file formats that need to be considered when opening files."
},
"creation_date": {
"type": "string",
"description": "Date of the original release of the plugin, as YYYY/MM/DD"
}
}
}
Expand Down

0 comments on commit 539fd55

Please sign in to comment.