Skip to content

Commit 7be7264

Browse files
Update Documentation (#3702)
1 parent f22cfee commit 7be7264

File tree

1 file changed

+46
-18
lines changed

1 file changed

+46
-18
lines changed

docs/adding-servers/metadata.mdx

Lines changed: 46 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Below is a table of the basic fields that are required for your server's metadat
2222

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

25-
| ✅ Correct | ❌ Incorrect |
26-
| ------------- | ------------------ |
25+
| ✅ Correct | ❌ Incorrect |
26+
|---------------|--------------------|
2727
| `example.com` | `play.example.com` |
2828
| `hypixel.net` | `play.hypixel.net` |
2929
| `lunar.gg` | `eu.lunar.gg` |
@@ -32,24 +32,24 @@ The `primaryAddress` in each server object is for users to connect to your serve
3232

3333
### Game Types
3434

35-
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`, and `Adventure`.
35+
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`.
3636

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

3939
### Colors
4040

4141
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 `#`.
4242

43-
## Optional Fields
44-
45-
> While these fields are not required, they are highly recommended. Enriched servers are more likely to be utilized when being displayed.
46-
4743
### Minecraft Versions
4844

4945
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.
5046

5147
**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.**
5248

49+
## Optional Fields
50+
51+
> While these fields are not required, they are highly recommended. Enriched servers are more likely to be utilized when being displayed.
52+
5353
### Languages
5454

5555
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:
@@ -86,23 +86,34 @@ You can define both `regions` (a list of all the regions your server supports) a
8686
| OC | Oceania |
8787
| SA | South America |
8888

89-
### Website/Store/Merch/Wiki
89+
### Server Links (Website, Store, Wiki, Etc.)
9090

91-
The URLs to your server's website, store, wiki, and/or merch. These should be a valid URLs including their protocols (e.g. `https://`).
91+
Include the following fields to link to your server's ecosystem.
92+
93+
> Note: Each field must be a valid URL starting with `https://`.
94+
95+
| Field | Description | ✅ Example |
96+
|-----------|---------------------------------------|------------------------------|
97+
| `website` | A link to your server's main website. | `https://www.lunar.gg/` |
98+
| `store` | A link to your server's store. | `https://www.lunar.gg/store` |
99+
| `wiki` | A link to your server's wiki. | `https://www.lunar.gg/wiki` |
100+
| `merch` | A link to your server's merch. | `https://www.lunar.gg/merch` |
92101

93102
### Socials
94103

95104
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:
96105

97-
- `twitter`
98-
- `discord`
99-
- `youtube`
100-
- `instagram`
101-
- `twitch`
102-
- `telegram`
103-
- `reddit`
104-
- `tiktok`
105-
- `facebook`
106+
| Field | Expected Format | Example |
107+
|-------------|------------------------------------|------------------------------------------|
108+
| `twitter` | Only Username (No @, No URL) | `LunarClient` |
109+
| `discord` | Full Invite URL | `https://discord.com/invite/LunarClient` |
110+
| `youtube` | Channel Name (Include @, No URL) | `@LunarClient` |
111+
| `instagram` | Only Username (No @, No URL) | `LunarClient` |
112+
| `twitch` | Only Username (No @, No URL) | `LunarClient` |
113+
| `telegram` | Only Username (No @, No URL) | `LunarClient` |
114+
| `reddit` | Only Username (No @, No URL) | `LunarClient` |
115+
| `tiktok` | Profile Handle (Include @, No URL) | `@lunarclient` |
116+
| `facebook` | Only Username (No @, No URL) | `LunarClientOfficial` |
106117

107118
### Voting Links
108119

@@ -115,3 +126,20 @@ Example:
115126
| ❌ Incorrect | ✅ Correct |
116127
| ------------------------------------------ | -------------------------------------------- |
117128
| `https://minecraftservers.org/vote/467177` | `https://minecraftservers.org/server/467177` |
129+
130+
### Compliance Links
131+
132+
You can provide important legal and community links under the `compliance` key.
133+
134+
> 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.
135+
136+
| Field | Description | ✅ Example |
137+
|------------------|-------------------------------------------|--------------------------------|
138+
| `privacyPolicy` | A link to your server's privacy policy. | `https://www.lunar.gg/privacy` |
139+
| `termsOfService` | A link to your server's terms of service. | `https://www.lunar.gg/terms` |
140+
| `rules` | A link to your server's rules. | `https://www.lunar.gg/rules` |
141+
| `support` | A link to your server's support page. | `https://www.lunar.gg/support` |
142+
143+
### Crossplay
144+
145+
If your server supports crossplay _(allowing **Minecraft: Bedrock Edition** players to join)_, include the boolean `crossplay` set to `true`.

0 commit comments

Comments
 (0)