Skip to content
This repository has been archived by the owner on Oct 21, 2022. It is now read-only.

servers.json

Patrix87 edited this page Oct 20, 2021 · 6 revisions

Use Visual Studio Code or Notepad++ to edit to avoid errors. autofill fields are optional.

servers.JSON

Field Type Requirements Notes
comment string optional Informations displayed in the error messages on the console, also usefull to read through servers.json
type string mandatory gamedigquery , sourcequery , ut3query or fake
game string mandatory For gamedigquery see https://github.com/gamedig/node-gamedig
address string mandatory Relative server address.
port int mandatory Server Port.
channel int mandatory Discord channel id.
message_id int autofill id of the message to update.
image_url string optional URL of the Thumbnail image URL https://static.wikia.nocookie.net/minecraft_gamepedia/images/9/93/Grass_Block_JE7_BE6.png
custom string optional Additionnal information message showed at the bottom of the server embed
steam_id int optional Steam App ID of the game the server is running for. Not the steam id of the dedicated server.
direct_join bool optionnal Set the link to directly join the server instead of just launching the game. Steam_id must be set.
color string optional RGB color code : #5b8731
country bool or string optional autofill Show the country field, set to false, to disable
title string optional Title of the Embed message.
public_address string optional Diplayed address with port.
locked bool optional Will show the locked icon or unlocked icon.
password string optional Server Password.
map string optional Overwrite Map Name. set to false to remove field.
maxplayers int optional Maximum number of players, overwrite auto-detection if defined.
hostname string optional replaces the value of hostname.

Template:

[
    {
        "comment": "Informations displayed in the error messages on the console, also usefull to read through servers.json",
        "type": "[string][mandatory] GamedigQuery or SourceQuery or UT3Query or Fake.",
        "game": "[string][mandatory] See https://github.com/gamedig/node-gamedig",
        "address": "[string][mandatory] Relative server address.",
        "port": "[int][mandatory] Server Port.",
        "channel": "[int][mandatory] Discord channel id.",
        "message_id": "[int][optional][autofill] id of the message to update.",
        "image_url": "[string][optional] URL of the Thumbnail image URL https://static.wikia.nocookie.net/minecraft_gamepedia/images/9/93/Grass_Block_JE7_BE6.png",
        "custom": "[string][optional] Additionnal information message showed at the bottom of the server embed",
        "steam_id": "[int][optional] Steam App ID of the game the server is running for. Not the steam id of the dedicated server.",
        "direct_join": "[bool][optional] Set the link to directly join the server instead of just launching the game. Steam_id must be set.",
        "color": "[string][optional] RGB color code : #5b8731",
        "country": "[bool]or[string][optional][autofill] Show the country field, set to false, to disable",
        "title": "[string][optional] Title of the Embed message.",
        "public_address": "[string][optional] Diplayed address with port.",
        "locked": "[bool][optional] Will show the locked icon or unlocked icon.",
        "password": "[string][optional] Server Password.",
        "map": "[string][optional] Overwrite Map Name. set to false to remove field.",
        "maxplayers": "[int][optional] Maximum number of players, overwrite auto-detection if defined.",
        "hostname": "[string][optional] replaces the value of hostname."
    }
]

Example:

[
    {
        "comment": "7 Days to Die | In the Server channel",
        "type": "GamedigQuery",
        "game": "7d2d",
        "address": "7d2d.domain.ca",
        "port": 25000,
        "channel": 745044509741321321,
        "image_url": "https://github.com/patrix87/DiscordLogGSM/blob/master/images/7dtd.png?raw=true",
        "custom": "Visit <#875131864359321321> via <#46560149126321321>.",
        "steam_id": 251570,
        "direct_join": true,
        "country": "CA",
        "color": "#bf0b01",
        "title": "7 Days to Die",
        "public_address": "7d2d.domain.ca:25000",
        "locked": true,
        "maxplayers": 32,
        "hostname": "My 7 Days To Die Server"
    },
    {
        "comment": "7 Days to Die | In the 7 Days to die channel",
        "type": "GamedigQuery",
        "game": "7d2d",
        "address": "7d2d.domain.ca",
        "port": 25000,
        "channel": 745044509951123123,
        "image_url": "https://github.com/patrix87/DiscordLogGSM/blob/master/images/7dtd.png?raw=true",
        "custom": "**PVE SERVER** Join vocal when playing",
        "steam_id": 251570,
        "direct_join": true,
        "country": "CA",
        "color": "#bf0b01",
        "title": "7 Days to Die",
        "public_address": "7d2d.domain.ca:25000",
        "locked": true,
        "password": "serverpassword",
        "maxplayers": 32,
        "hostname": "My 7 Days To Die Server"
    },
    {
        "comment": "ARK | Ark Channel",
        "type": "GamedigQuery",
        "game": "arkse",
        "address": "ark.domain.ca",
        "port": 27016,
        "channel": 745044509741547522,
        "image_url": "https://github.com/patrix87/DiscordLogGSM/blob/master/images/ark.png?raw=true",
        "custom": "Visit <#343135886478123123> via <#465601491261654654>.",
        "steam_id": 346110,
        "direct_join": false,
        "country": false,
        "color": "#b6ccda",
        "title": "ARK : Survival Evolved",
        "public_address": "ark.domain.ca",
        "locked": false,
        "map": false,
        "hostname": "My ARK Server"
    }
]