metadata.schema.json

{
    "type": "object",
    "additionalProperties": false,
    "required": [
        "id",
        "name",
        "addresses",
        "primaryAddress",
        "minecraftVersions",
        "primaryMinecraftVersion",
        "gameTypes",
        "primaryColor",
        "secondaryColor"
    ],
    "properties": {
        "id": {
            "type": "string",
            "pattern": "^[a-z0-9_.-]+$"
        },
        "name": {
            "type": "string"
        },
        "description": {
            "type": "string",
            "minLength": 16,
            "maxLength": 80
        },
        "addresses": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "$ref": "#/definitions/ServerAddress"
            }
        },
        "primaryAddress": {
            "$ref": "#/definitions/ServerAddress"
        },
        "minecraftVersions": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "$ref": "#/definitions/MinecraftVersion"
            }
        },
        "primaryMinecraftVersion": {
            "$ref": "#/definitions/MinecraftSubversion"
        },
        "primaryColor": {
            "$ref": "#/definitions/RGBColor"
        },
        "secondaryColor": {
            "$ref": "#/definitions/RGBColor"
        },
        "primaryLanguage": {
            "$ref": "#/definitions/Language"
        },
        "languages": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "$ref": "#/definitions/Language"
            }
        },
        "primaryRegion": {
            "$ref": "#/definitions/Region"
        },
        "regions": {
            "type": "array",
            "uniqueItems": true,
            "items": {
                "$ref": "#/definitions/Region"
            }
        },
        "gameTypes": {
            "type": "array",
            "uniqueItems": true,
            "maxItems": 3,
            "items": {
                "$ref": "#/definitions/GameType"
            }
        },
        "website": {
            "$ref": "#/definitions/WebAddress"
        },
        "wiki": {
            "$ref": "#/definitions/WebAddress"
        },
        "store": {
            "$ref": "#/definitions/WebAddress"
        },
        "merch": {
            "$ref": "#/definitions/WebAddress"
        },
        "votingLinks": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/WebAddress"
            }
        },
        "compliance": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "privacyPolicy": {
                    "$ref": "#/definitions/WebAddress"
                },
                "termsOfService": {
                    "$ref": "#/definitions/WebAddress"
                },
                "rules": {
                    "$ref": "#/definitions/WebAddress"
                },
                "support": {
                    "$ref": "#/definitions/WebAddress"
                }
            }
        },
        "presentationVideo": {
            "type": "string"
        },
        "modpack": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "id": {
                    "type": "string",
                    "description": "The Modrinth Modpack ID."
                },
                "recommendedVersion": {
                    "type": "string",
                    "description": "The recommended Modrinth Modpack version. If blank, will use latest version."
                },
                "recommendedReleaseChannel": {
                    "type": "string",
                    "description": "If blank, will use 'Release' release channel."
                },
                "recommendedLoader": {
                    "type": "string",
                    "description": "If blank, will use 'Fabric' loader or the next available loader if Fabric is not available."
                },
                "promptBeforeGameJoin": {
                    "type": "boolean",
                    "default": true,
                    "description": "If true, the user will be prompted to install the recommended mods/modpack before joining the server in-game."
                },
                "promptBeforeLauncherJoin": {
                    "type": "boolean",
                    "default": true,
                    "description": "If true, the user will be prompted to install the recommended mods/modpack before joining the server from the Launcher."
                }
            },
            "required": [
                "id"
            ]
        },
        "socials": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "twitter": {
                    "type": "string"
                },
                "discord": {
                    "$ref": "#/definitions/DiscordLink"
                },
                "youtube": {
                    "type": "string"
                },
                "instagram": {
                    "type": "string"
                },
                "twitch": {
                    "type": "string"
                },
                "telegram": {
                    "type": "string"
                },
                "reddit": {
                    "type": "string"
                },
                "tiktok": {
                    "type": "string"
                },
                "facebook": {
                    "type": "string"
                }
            }
        },
        "crossplay": {
            "type": "boolean"
        },
        "tebexStore": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "background": {
                    "$ref": "#/definitions/TebexStoreBackground"
                }
            }
        }
    },
    "definitions": {
        "WebAddress": {
            "format": "uri",
            "pattern": "^https?://"
        },
        "ServerAddress": {
            "type": "string",
            "pattern": "^[a-z0-9_.-]+$"
        },
        "DiscordLink": {
            "type": "string",
            "pattern": "(?i)^https?://(?:www\\.)?(?:discord\\.gg(?:/invite)?/[a-zA-Z0-9-]+|discord\\.com/invite/[a-zA-Z0-9-]+)/?$"
        },
        "MinecraftVersion": {
            "type": "string",
            "enum": [
                "1.7.*",
                "1.8.*",
                "1.12.*",
                "1.16.*",
                "1.17.*",
                "1.18.*",
                "1.19.*",
                "1.20.*",
                "1.21.*",
                "1.7.10",
                "1.8.9",
                "1.12.2",
                "1.16.5",
                "1.17.1",
                "1.18.1",
                "1.18.2",
                "1.19",
                "1.19.2",
                "1.19.3",
                "1.19.4",
                "1.20",
                "1.20.1",
                "1.20.2",
                "1.20.3",
                "1.20.4",
                "1.20.5",
                "1.20.6",
                "1.21",
                "1.21.1"
            ]
        },
        "MinecraftSubversion": {
            "type": "string",
            "enum": [
                "1.7.10",
                "1.8.9",
                "1.12.2",
                "1.16.5",
                "1.17.1",
                "1.18.1",
                "1.18.2",
                "1.19",
                "1.19.2",
                "1.19.3",
                "1.19.4",
                "1.20",
                "1.20.1",
                "1.20.2",
                "1.20.3",
                "1.20.4",
                "1.20.5",
                "1.20.6",
                "1.21"
            ]
        },
        "Region": {
            "type": "string",
            "enum": [
                "AF",
                "AS",
                "EU",
                "NA",
                "OC",
                "SA"
            ]
        },
        "Language": {
            "type": "string",
            "enum": [
                "en",
                "es-EN",
                "it",
                "tr",
                "ar",
                "zh-CN",
                "nl",
                "fr",
                "de",
                "el",
                "ja",
                "ko",
                "lt",
                "no",
                "pl",
                "pt-PT",
                "pt-BR",
                "sv-SE"
            ]
        },
        "RGBColor": {
            "type": "string",
            "pattern": "^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$"
        },
        "GameType": {
            "type": "string",
            "enum": [
                "PvP",
                "PvE",
                "HCF",
                "Factions",
                "Minigames",
                "Skyblock",
                "Parkour",
                "UHC",
                "Hardcore",
                "Survival",
                "Open World",
                "Prison",
                "Creative",
                "Roleplay",
                "Adventure"
            ]
        },
        "TebexStoreBackground": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "lowerColor": {
                    "$ref": "#/definitions/RGBColor"
                },
                "upperColor": {
                    "$ref": "#/definitions/RGBColor"
                }
            }
        }
    }
}