Skip to content

Commit 205f7fd

Browse files
Feat: More Fields (#1190)
* feat: add `compliance` and `presentationVideo` fields * feat: add `modpack` field
1 parent 58720cd commit 205f7fd

File tree

6 files changed

+79
-2
lines changed

6 files changed

+79
-2
lines changed

Diff for: .github/pull_request_template.md

+6
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
- [ ] `regions`: a list of regions where you have servers located that service your players _(ex. `["NA", "EU", "AS"]`)_
2626
- [ ] `gameTypes`: a list of games that describe the content on your server, must be a max of 3 listed _(ez. `["PVP", "UHC", "HCF"]`)_
2727
- [ ] `crossplay`: whether the server has support for Bedrock Edition players (through proxies such as [GeyserMC](https://geysermc.org/))
28+
- [ ] (optional) `presentationVideo`: YouTube video ID (in slug) to server trailer / introduction _(ex. `7EV4cPuJvXE`)_
2829
- [ ] (optional) `website`: url of server website, must include URL schema (http:// or https://) _(ex. `https://www.your-server.com`)_
2930
- [ ] (optional) `store`: url of server store, must include URL schema (http:// or https://) _(ex. `https://store.your-server.com`)_
3031

@@ -40,6 +41,11 @@
4041
- [ ] (optional) `tiktok`: username of tiktok account _(ex. MyServer)_
4142
- [ ] (optional) `facebook`: slug of facebook page _(ex. MyServer)_
4243

44+
### Compliance
45+
- [ ] (optional) `privacyPolicy`: url to your Privacy Policy _(ex. https://www.lunar.gg/privacy)_
46+
- [ ] (optional) `termsOfService`: url to your Terms of Service _(ex. https://www.lunar.gg/terms)_
47+
- [ ] (optional) `rules`: url to your Rules _(ex. https://www.lunar.gg/rules)_
48+
4349
### Media:
4450

4551
#### Logo

Diff for: metadata.example.json

+6
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@
3232
],
3333
"website": "https://www.lunar.gg",
3434
"store": "https://store.lunar.gg",
35+
"compliance": {
36+
"privacyPolicy": "https://www.lunar.gg/privacy",
37+
"termsOfService": "https://www.lunar.gg/terms",
38+
"rules": "https://www.lunar.gg/rules"
39+
},
40+
"presentationVideo": "7EV4cPuJvXE",
3541
"socials": {
3642
"twitter": "LunarNetwork",
3743
"telegram": "lunarnetwork",

Diff for: metadata.schema.json

+53
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,59 @@
8585
"store": {
8686
"$ref": "#/definitions/WebAddress"
8787
},
88+
"compliance": {
89+
"type": "object",
90+
"additionalProperties": false,
91+
"properties": {
92+
"privacyPolicy": {
93+
"$ref": "#/definitions/WebAddress"
94+
},
95+
"termsOfService": {
96+
"$ref": "#/definitions/WebAddress"
97+
},
98+
"rules": {
99+
"$ref": "#/definitions/WebAddress"
100+
}
101+
}
102+
},
103+
"presentationVideo": {
104+
"type": "string"
105+
},
106+
"modpack": {
107+
"type": "object",
108+
"additionalProperties": false,
109+
"properties": {
110+
"id": {
111+
"type": "string",
112+
"description": "The Modrinth Modpack ID."
113+
},
114+
"recommendedVersion": {
115+
"type": "string",
116+
"description": "The recommended Modrinth Modpack version. If blank, will use latest version."
117+
},
118+
"recommendedReleaseChannel": {
119+
"type": "string",
120+
"description": "If blank, will use 'Release' release channel."
121+
},
122+
"recommendedLoader": {
123+
"type": "string",
124+
"description": "If blank, will use 'Fabric' loader or the next available loader if Fabric is not available."
125+
},
126+
"promptBeforeGameJoin": {
127+
"type": "boolean",
128+
"default": true,
129+
"description": "If true, the user will be prompted to install the recommended mods/modpack before joining the server in-game."
130+
},
131+
"promptBeforeLauncherJoin": {
132+
"type": "boolean",
133+
"default": true,
134+
"description": "If true, the user will be prompted to install the recommended mods/modpack before joining the server from the Launcher."
135+
}
136+
},
137+
"required": [
138+
"id"
139+
]
140+
},
88141
"socials": {
89142
"type": "object",
90143
"additionalProperties": false,

Diff for: servers/hoplite/metadata.json

+5
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,10 @@
3131
"twitter": "hoplitenetwork",
3232
"discord": "https://discord.com/invite/hoplitenetwork",
3333
"youtube": "UCX3dkuHYteQRdAUlhmu8qaQ"
34+
},
35+
"modpack": {
36+
"id": "oVn5uNcU",
37+
"promptBeforeGameJoin": true,
38+
"promptBeforeLauncherJoin": true
3439
}
3540
}

Diff for: servers/hypixel/metadata.json

+7-1
Original file line numberDiff line numberDiff line change
@@ -43,5 +43,11 @@
4343
"reddit": "hypixel",
4444
"tiktok": "hypixel",
4545
"facebook": "Hypixel"
46-
}
46+
},
47+
"compliance": {
48+
"privacyPolicy": "https://hypixel.net/privacy",
49+
"termsOfService": "https://hypixel.net/terms",
50+
"rules": "https://hypixel.net/rules"
51+
},
52+
"presentationVideo": "bkWHyz1MmaQ"
4753
}

Diff for: servers/pokefind/metadata.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
22
"id": "pokefind",
33
"name": "PokeFind",
4-
"store": "https://play.pokefind.co/",
4+
"website": "https://www.pokefind.co/",
5+
"store": "https://store.pokefind.co/",
56
"addresses": [
67
"pokefind.co"
78
],

0 commit comments

Comments
 (0)