Skip to content

metadata.mdx

Latest commit

 

History

History
145 lines (100 loc) · 7.75 KB

metadata.mdx

File metadata and controls

145 lines (100 loc) · 7.75 KB

Server Metadata

Each server must have a metadata.json, this file should follow the schema found in the root of this repository metadata.schema.json.

An example can also be found in the root, metadata.example.json. This contains all the fields that are required for your server's metadata 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-80 characters and in English. The Lunar Client translation team is responsible for translating this to server other supported languages.

Addresses

The addresses array in each server object is actually an array of IP suffixes. This should not include the subdomain for the server.

✅ Correct ❌ Incorrect
example.com play.example.com
hypixel.net play.hypixel.net
lunar.gg eu.lunar.gg

The primaryAddress in each server object is 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. This can (and should) include the subdomain for the server.

Game Types

Game types help identify the style of games that your server will offer to player. The following are games you may include: PvP, PvE, HCF, Factions, Minigames, Skyblock, Parkour, UHC, Hardcore, Survival, Open World, Prison, Creative, Roleplay, Adventure, and Pixelmon.

You can select up to 3 game types, choose the game types that represent your server the best.

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 #.

Minecraft Versions

The minecraftVersions field must be an array of client versions allowed on your Minecraft server. (ie. 1.18.1, 1.19.2); The primaryMinecraftVersion field must be a subversion of a major version included in the minecraftVersions array.

The versions you include must be versions that are directly offered in Lunar Client, which can be found in the version selector of the Lunar Client Launcher.

Optional Fields

While these fields are not required, they are highly recommended. Enriched servers are more likely to be utilized when being displayed.

Languages

You can define both languages (a list of all the languages your server supports) and a primaryLanguage (the main language your server operates in) which your server supports. These languages can be selected from the following:

  • en
  • es-EN
  • it
  • tr
  • ar
  • zh-CN
  • nl
  • fr
  • de
  • el
  • ja
  • ko
  • lt
  • no
  • pl
  • pt-PT
  • pt-BR
  • sv-SE

Regions

You can define both regions (a list of all the regions your server supports) and a primaryRegion (the main region your server operates out of) which your server supports. These regions can be selected from the following:

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

Server Links (Website, Store, Wiki, Etc.)

Include the following fields to link to your server's ecosystem.

Note: Each field must be a valid URL starting with https://.

Field Description ✅ Example
website A link to your server's main website. https://www.lunar.gg/
store A link to your server's store. https://www.lunar.gg/store
wiki A link to your server's wiki. https://www.lunar.gg/wiki
merch A link to your server's merch. https://www.lunar.gg/merch

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:

Field Expected Format Example
twitter Only Username (No @, No URL) LunarClient
discord Full Invite URL https://discord.com/invite/LunarClient
youtube Channel Name (Include @, No URL) @LunarClient
instagram Only Username (No @, No URL) LunarClient
twitch Only Username (No @, No URL) LunarClient
telegram Only Username (No @, No URL) LunarClient
reddit Only Username (No @, No URL) LunarClient
tiktok Profile Handle (Include @, No URL) @lunarclient
facebook Only Username (No @, No URL) LunarClientOfficial

Voting Links

You can provide any voting links that you would like to be displayed on your server's page. These should be under the votingLinks key.

Note: These links should be the actual listing of the server, rather than the voting tab of said listing.

Example:

❌ Incorrect ✅ Correct
https://minecraftservers.org/vote/467177 https://minecraftservers.org/server/467177

Compliance Links

You can provide important legal and community links under the compliance key.

Note: These URLs must be valid URLs and begin with https://. You do not need to include all fields, you may provide only the ones you have.

Field Description ✅ Example
privacyPolicy A link to your server's privacy policy. https://www.lunar.gg/privacy
termsOfService A link to your server's terms of service. https://www.lunar.gg/terms
rules A link to your server's rules. https://www.lunar.gg/rules
support A link to your server's support page. https://www.lunar.gg/support

Crossplay

If your server supports crossplay (allowing Minecraft: Bedrock Edition players to join), include the boolean crossplay set to true.