index.json
Generated by tools/store.py index. Never hand-edited. Caps: 1 MiB, 500 plugins, 50 versions per plugin.
Generated from schema/index-1.schema.json (JSON Schema). The validator, tools/store.py, applies the same rules.
Top level
Section titled “Top level”| Property | Type | Required | Default | Description |
|---|---|---|---|---|
indexVersion |
integer | yes | Must be 1. |
|
serial |
integer | yes | Minimum 0. | |
plugins |
object[] | yes | At most 500 items. See plugins[]. |
No other properties are allowed.
plugins[]
Section titled “plugins[]”| Property | Type | Required | Default | Description |
|---|---|---|---|---|
id |
string | yes | Pattern: ^[a-z0-9](?:[a-z0-9_-]{0,62}[a-z0-9])?$. |
|
name |
string | yes | 1 to 80 characters. | |
authors |
string[] | yes | At least 1 item. | |
description |
string | yes | 1 to 400 characters. | |
homepage |
string | |||
licence |
string | yes | ||
categories |
string[] | yes | 1 to 3 items. | |
gameBuilds |
string[] | yes | At least 1 item. | |
screenshots |
object[] | yes | At most 6 items. See plugins[].screenshots[]. |
|
versions |
object[] | yes | 1 to 50 items. | |
imports |
object[] | 1 to 4 items. |
No other properties are allowed.
plugins[].screenshots[]
Section titled “plugins[].screenshots[]”| Property | Type | Required | Default | Description |
|---|---|---|---|---|
path |
string | yes | ||
sha256 |
string | yes | Pattern: ^[0-9a-f]{64}$. |
|
size |
integer | yes | Minimum 1. | |
caption |
string | At most 120 characters. |
No other properties are allowed.