forked from JannisX11/blockbench-plugins
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathplugins.schema.json
More file actions
118 lines (118 loc) · 4.52 KB
/
Copy pathplugins.schema.json
File metadata and controls
118 lines (118 loc) · 4.52 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "plugins.schema",
"title": "plugins.json",
"description": "List of all plugins and their store metadata",
"type": "object",
"additionalProperties": {
"type": "object",
"required": ["title", "author", "version", "icon"],
"properties": {
"title": {
"type": "string",
"description": "Name of the plugin"
},
"author": {
"type": "string",
"description": "Author or authors"
},
"icon": {
"type": "string",
"pattern": "^[a-zA-Z0-9._-]+$",
"description": "Icon, either an icon resolvable string, or icon.png / icon.svg in the new repo format"
},
"description": {
"type": "string",
"description": "Short plugin description"
},
"tags": {
"type": "array",
"items": {"type": "string"},
"description": "Tags to help categorize the plugin",
"maxItems": 3
},
"version": {
"type": "string",
"description": "Semver version string"
},
"min_version": {
"type": "string",
"description": "Minimum required Blockbench version to run this plugin"
},
"variant": {
"type": "string",
"enum": ["both", "desktop", "web"],
"description": "Specify if Blockbench can run only on desktop, only in the web app, or on both"
},
"creation_date": {
"type": "string",
"description": "Date of when the plugin was first released. As YYYY/MM/DD",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"new_repository_format": {
"type": "boolean",
"deprecated": true,
"description": "Instruct the plugin to use the new repository format, see README.md. This field was only used in the transition period, instead the behavior is now based on a min_version of 4.8.0 or higher."
},
"has_changelog": {
"type": "boolean",
"description": "Whether the plugin has a changelog.json file, specifying changes in past updates."
},
"await_loading": {
"type": "boolean",
"description": "Set to true if you need the plugin to finish loading when starting Blockbench before loading files"
},
"contributes": {
"type": "object",
"properties": {
"formats": {
"type": "array",
"items": {"type": "string"}
}
}
},
"website": {
"type": "string",
"description": "Link to the plugins website",
"pattern": "^https://.+"
},
"repository": {
"type": "string",
"description": "Link to the repository that contains the source for the plugin",
"pattern": "^https://.+"
},
"bug_tracker": {
"type": "string",
"description": "Link to where users can report issues with the plugin",
"pattern": "^https://.+"
},
"contributors": {
"type": "array",
"items": {"type": "string"},
"description": "List of people who have contributed to the plugin but are not the main author(s)"
},
"deprecation_note": {
"type": "string",
"description": "Used in combination with a \"Deprecated\" tag. Explains why the plugin is deprecated and what to do or use instead."
}
},
"defaultSnippets": [
{
"label": "Basic plugin",
"description": "A new plugin example",
"body": {
"title": "My Plugin",
"author": "Benchbot",
"description": "",
"icon": "icon.png",
"version": "1.0.0",
"min_version": "4.10.0",
"variant": "both"
}
}
]
},
"propertyNames": {
"pattern": "^[a-z0-9_]{3,64}$"
}
}