Skip to content

Latest commit

 

History

History
134 lines (121 loc) · 10.4 KB

Manifest.md

File metadata and controls

134 lines (121 loc) · 10.4 KB
Raw

Manifest.json

Available keys

Important: All provided values are just examples. Do not copy them, instead use your own ones!

Key Description Example value
server_name* Short server name (must match the directory name!) "laby"
nice_name* Nice server name "LabyMod"
direct_ip* Direct Minecraft server ip "play.labymod.net"
server_wildcards Wildcards the user can use ["%.laby.net", "%.labymod.net"]
supported_languages Supported languages on your server - Format: ISO 639-1 ["de", "en"]
social.web Website URL "https://labymod.net"
social.web_shop Shop URL "https://labymod.net/shop"
social.web_support Support page URL, e.g. faq page "https://labymod.net/support"
social.twitter Twitter username "LabyMod"
social.tiktok TikTok username "LabyMod"
social.facebook Facebook username "LabyMod"
social.instagram Instagram username "LabyMod"
social.discord Discord invite URL "https://discord.gg/labymod" or "https://discord.gg/Wbg7rArky7" (Read more)
social.youtube YouTube channel URL "https://www.youtube.com/channel/UCSamgE1KYvC7qZn56T0J2yg"
social.teamspeak TeamSpeak server address "ts.labymod.net"
gamemodes Gamemodes gamemode object
chat Chat chat object
discord.server_id Discord server id 260471731809026048
discord.rename_to_minecraft_name Boolean whether the user should be renamed when joining false (true only allowed for server partners)
brand.primary Primary brand color "#008FE8"
brand.background Background-color "#0A56A5"
brand.text Text color (must fit with the background color) "#FFFFFF"
location.city Server location: City "Berlin"
location.country Server location: Country "Germany"
location.country_code Server location: Country code - Format: ISO 3166-1 alpha-2 (upper-case) "DE"
yt_trailer YouTube trailer embed ID "vNF-ztQGnUo"
user_stats User stats url "https://laby.net/@{userName}" or "https://laby.net/@{uuid}"
command_delay Delay of commands in ms when joining on the server and automatically executing a command 3000
  • Required values are: server_name, nice_name & direct_ip

Chat object

Key Description Example value
message_formats Regex for chat messages sent by players see below 
[
  "^§[a-f0-9](?<level>\\d+)(| §[a-f0-9](?<rank>\\S+)) §e(?<sender>[a-zA-Z0-9_]{2,16}) §f(?<message>.*)$"
]

Gamemode object

Key Description Example value
name* Gamemode nice name "JumpWorld"
color* Brand color "#ADD8E6"
url Gamemode description url / website related to the gamemode "https://www.timolia.de/games#jumpworld"
command e.g. quickjoin-command "/quickjoin jumpworld"
versions Restrict supported Minecraft versions for the gamemode "1.17<1.19.1", "1.8<*"
  • Required values are: name & color

Discord URL

We only support direct discord invite links, such as https://discord.gg/Wbg7rArky7 or https://discord.gg/labymod. Links like https://labymod.net/dc are only supported for partner servers.
Why? Links directly from Discord can be validated well by us for up-to-dateness.

Example manifest.json file

{
  "server_name": "laby",
  "nice_name": "LabyMod",
  "direct_ip": "play.laby.net",
  "server_wildcards": [
    "%.laby.net"
  ],
  "supported_languages": [
     "en",
     "de"
  ],
  "social": {
    "web": "https://labymod.net",
    "web_shop": "https://labymod.net/shop",
    "web_support": "https://labymod.net/support",
    "twitter": "LabyMod",
    "tiktok": "LabyMod",
    "facebook": "LabyMod",
    "instagram": "LabyMod",
    "discord": "https://discord.gg/labymod",
    "youtube": "https://www.youtube.com/channel/UCSamgE1KYvC7qZn56T0J2yg",
    "teamspeak": "ts.labymod.net"
  },
  "gamemodes": {
    "jumpworld": {
      "name": "JumpWorld", 
      "color": "#FFA500",
      "url": "https://www.timolia.de/games#jumpworld",
      "command": "/quickjoin jumpworld16",
      "versions": "1.17<*"
    },
    "dna": {
      "name": "DNA",
      "color": "#ADD8E6",
      "url": "https://www.timolia.de/games#dna",
      "command": "/quickjoin dna",
      "versions": "1.8<*"
    }
  },
  "chat": {
    "message_formats": [
      "^§[a-f0-9](?<level>\\d+)( \\||§8 \\|) §[a-f0-9](?<sender>[a-zA-Z0-9_]{2,16})§r§7: §f(?<message>.*)$"
    ]
  },
  "discord": {
    "server_id": 260471731809026048,
    "rename_to_minecraft_name": false
  },
  "brand": {
     "primary": "#008FE8",
     "background": "#0A56A5",
     "text": "#FFFFFF"
  }, 
  "location": {
     "city": "Walldorf",
     "country": "Germany",
     "country_code": "DE"
  },
  "yt_trailer": "8asFIRe2HSw",
  "user_stats": "https://laby.net/@{userName}",
  "command_delay": 3000
}