Metadata
Learn how to add metadata to your server mappings
Each server must have a metadata.json, this file should follow the schema found in the metadata.schema.json file.
An example can also be found in the metadata.example.json file.
Required Fields
These fields are required for your server to be accepted.
Basic
Below is a table of the basic fields that are required for your server's metadata file, and a brief description of what they are.
| Field | Description |
|---|---|
id | This is the ID for the server, discussed in the overview, this must match the name of your server's folder. |
name | This is the name for your server. |
description | This is the description for your server. It must be between 16-40 characters. |
Addresses
The addresses array in each server object is actually an array of IP suffixes (This should not include the subdomain for the server).
For example, "addresses": ["goldenpvp.net", "other.domain"] will match goldenpvp.net, na.goldenpvp.net, play.other.domain, and so on.
The primaryAddress field is where you can include the desired subdomain (na.goldenpvp.net, play.goldenpvp.net) for users to connect to your server on and is required to be resolvable. This primary address will be used to ensure that the server remains online and active.
Minecraft Versions
The minecraftVersions field must be an array of client versions allowed on your Minecraft server. (ie. 1.7.10, 1.8.9); The primaryMinecraftVersion field must be a subversion of a major version included in the minecraftVersions array.
The versions you include must at least include versions that are directly offered in CheatBreaker, which can be found in the version selector of the CheatBreaker Launcher. However, we also support intended versions:
1.9.*1.10.*1.11.*1.12.*1.16.*1.17.*1.18.*1.19.*1.20.*1.21.*
We only allow intended versions as long as your list contains at least one version supported from our services.
If your server supports all of the subversions within a major version, you can list the version in minecraftVersions as 1.7.*, but you will still need to specify the specific subversion in the primaryMinecraftVersion as this is the specific version that the client uses to Launch you into the game for Quick Connecting.
Game Types
Game types help identify the style of games that your server will offer to player.
The following are games you may include:
PvPPvEHCFFactionsMinigamesSkyblockParkourUHCHardcoreSurvivalOpen WorldPrisonCreativeRoleplayAdventure
You can add up to 3 unique types on the gameTypes field in your metadata.json.
Colors
Each server must have a primaryColor and secondaryColor. These colors should represent the brand of your server. These colors must be in hexadecimal format, and must be prefixed with a #.
Regions
Each server must have both a primaryRegion and regions your server supports defined.
Below is a table of the regions that are supported:
| Region Code | Name |
|---|---|
AF | Africa |
AS | Asia |
EU | Europe |
NA | North America |
OC | Oceania |
SA | South America |
Languages
Each server must have both a primaryLanguage and languages your server supports defined.
Below are the languages that are supported:
enes-ENittrarzh-CNnlfrdeeljakoltnoplpt-PTpt-BRsv-SE
Optional Fields
While these fields are not required, they are highly recommended.
Enriched servers are more likely to be utilized when being displayed.
Links
The URLs to your server's website and/or store. These should be a valid URLs including their protocols (e.g. https://).
Socials
You can provide any social media links that you would like to be displayed on your server's page. These links will be displayed alongside your server. These should be under the socials key.
We support the following socials:
twitterdiscordyoutubeinstagramtwitchtelegramreddittiktokfacebook