You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/adding-servers/metadata.mdx
+46-18Lines changed: 46 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,8 +22,8 @@ Below is a table of the basic fields that are required for your server's metadat
22
22
23
23
The `addresses` array in each server object is actually an array of IP suffixes. **This should not include the subdomain for the server**.
24
24
25
-
| ✅ Correct | ❌ Incorrect |
26
-
|-------------|------------------|
25
+
| ✅ Correct | ❌ Incorrect |
26
+
|---------------|--------------------|
27
27
|`example.com`|`play.example.com`|
28
28
|`hypixel.net`|`play.hypixel.net`|
29
29
|`lunar.gg`|`eu.lunar.gg`|
@@ -32,24 +32,24 @@ The `primaryAddress` in each server object is for users to connect to your serve
32
32
33
33
### Game Types
34
34
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`.
36
36
37
37
You can select up to `3` game types, choose the game types that represent your server the best.
38
38
39
39
### Colors
40
40
41
41
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 `#`.
42
42
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
-
47
43
### Minecraft Versions
48
44
49
45
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.
50
46
51
47
**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.**
52
48
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
+
53
53
### Languages
54
54
55
55
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
86
86
| OC | Oceania |
87
87
| SA | South America |
88
88
89
-
### Website/Store/Merch/Wiki
89
+
### Server Links (Website, Store, Wiki, Etc.)
90
90
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://`.
|`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`|
92
101
93
102
### Socials
94
103
95
104
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:
0 commit comments