Metadata

A metadata.json file is required for every server in the mappings. This file contains information about the server such as the server name, IP address, supported Minecraft versions, game modes, and more. Below is an example of what a metadata.json file should look like.

Properties to Include

Required

Property	Description	Type
`id`	Unique ID for your server (reference)	string
`name`	Name of your server, can include spaces and uppercase letters	string
`addresses`	List of addresses to connect to your server	string[]
`primaryAddress`	The main address to connect to your server	string
`port`	Port to the server, usually 25565 unless specified	number
`versions`	String of Minecraft versions that are supported	string[]
`primaryVersion`	Primary versions players connect to your server on	string
`tags`	List of string of what the server offers	string[]
`regions`	List of regions the server supports/is located in (reference)	string[]
`primaryRegion`	The main region the server is targeted at (reference)	string
`crossplay`	Boolean indicating whether the server supports both Bedrock and Java editions of the game	boolean
`primaryColor`	Primary colour that depicts the server (hexadecimal)	string
`secondaryColor`	Secondary colour that depicts the server (hexadecimal)	string

Optional Fields

Additianally, you can include some optional properties to further describe your server.

Property	Description	Type
`website`	Link to the server's website	string
`wiki`	Link to the wiki page related to the server	string
`store`	Link to the server's store page	string
`privacyPolicy`	Full link to the server's privacy policy	string
`tos`	Link to your servers Terms Of Service	string
`rules`	URL linking to your servers ruleset	string
`support`	Link to where users can get support	string

Adding Socials

When adding socials they should be contained in an object named socials, this object can contain the following properties. Please note that these are all optional.

Property	Description	Type
`twitter`	Twitter handle to the server's account	string
`discord`	Full Discord invite link	string
`youtube`	YouTube handle or slug	string
`instagram`	Handle for the server's instagram account	string
`twitch`	Servers Twitch handle	string
`telegram`	Server's telegram username	string
`reddit`	Server's reddit subreddit prefixed with `r/`	string
`tiktok`	TikTok handle for the server's TikTok	string
`facebook`	Server's Facebook username	string

Regions

Regions should short and concise, use the following table to help you find the appropriate region(s) for your server.

Region Code	Continent
AF	Africa
AS	Asia
EU	Europe
NA	North America
OC	Oceania
SA	South America

Additional Help

If you need any additional help with crafting your metadata.json reference our example-metadata.json (opens in a new tab) file:

metadata.json

{
    "id": "ExampleServer",
    "name": "Example Server",
    "addresses": ["mc.example.com"],
    "primaryAddress": "mc.example.com",
    "port": 25565,
    "versions": ["1.8", "1.16.5", "1.17"],
    "primaryVersion": "1.16.5",
    "tags": ["minigames", "pvp", "survival"],
    "primaryRegion": "NA",
    "regions": ["NA", "EU", "AS"],
    "crossplay": true,
    "primaryColor": "#00FFFF",
    "secondaryColor": "#FF0000",
    "website": "https://www.example.com",
    "wiki": "https://wiki.example.com",
    "store": "https://store.example.com",
    "socials": {
        "twitter": "MyServer",
        "discord": "https://discord.gg/example",
        "youtube": "MyServerChannel",
        "instagram": "MyServerOfficial",
        "twitch": "MyServerStreams",
        "telegram": "MyServerGroup",
        "reddit": "r/MyServerSubreddit",
        "tiktok": "MyServerTikTok",
        "facebook": "MyServerPage"
    },
    "privacyPolicy": "https://www.example.com/privacy",
    "tos": "https://www.example.com/tos",
    "rules": "https://www.example.com/rules",
    "support": "https://www.example.com/support"
}

Overview Logo