Skip to content

A simple and efficient Discord bot that fetches real-time player counts and map info for your game servers using the SourceQuery and REST APIs. Keep your community informed about server status and engage with your players seamlessly.

License

Notifications You must be signed in to change notification settings

DarklandServers/GameStatus-Bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation



GameStatus Bot 🎮


GameStatus-Bot simplifies server monitoring with real-time player counts, maximum limits, and in-game maps. It uses either the BattleMetrics or Gamedig APIs, making it a versatile tool for gamers and admins. Level up your gameplay with GameStatus-Bot! 🚀🎮

You can run it on windows, macOS, linux or docker, see the installation section for more info.

  • gamedig (All games)
  • battlemetrics.com (All games)
  • Bot update status every 1-3 minutes
  • Display Map (Supported games)
  • Join Server (Supported games)

Configuration 📒

On the first launch, GameStatus-Bot auto-generates the configuration file, streamlining the setup process for users.

Location: src/config/config.json

Default configuration

Single Server Configuration

{
  "maxServers": 5, //Max amount of servers that can be running
  "updateInterval": 3, //How often to update the status
  "statusPrefix": "Players", // Custom status prefix, leave blank to default to Playing
  "statusSpacer": "|", //Spacer for between the player count and current map

  "SERVERS": [
    {
      "RUNNING": false, //Enable or disable the bot from running
      "serverName": "", //Server name to know what server bot is for
      "botToken": "", //Discord bot token
      "apiType": 1, //Api choice 1 = Battlemetrics, 2 = GameDig
      "apiUrl": "", //Battlemetric url (https://api.battlemetrics.com/servers/YOUR_SERVER_ID)
      "serverIp": "",
      "serverPort": "",
      "queueMessage": "currently waiting in queue.", //Message to display after queue number. (Only available using battlemetrics)
      "gameType": "garrysmod", //Rember the game type
      "showMap": false, //Show the map in status (Only available using gamedig)
      "mapPrefix": "fw", //Remove map prefix if used or leave blank to default
      "debug": false
    }
  ]
}

Multiple Server Configuration

{
  "maxServers": 5,
  "updateInterval": 3,
  "statusPrefix": "Players",
  "statusSpacer": "|",
  "mapPrefix": "fw",

  "SERVERS": [
    {
      "RUNNING": false,
      "serverName": "",
      "botToken": "",
      "apiType": 1,
      "apiUrl": "",
      "serverIp": "",
      "serverPort": "",
      "queueMessage": "currently waiting in queue.",
      "gameType": "garrysmod",
      "showMap": false,
      "mapPrefix": "fw", //Remove map prefix if used or leave blank to default
      "debug": false
    },
    {
      "RUNNING": false,
      "serverName": "",
      "botToken": "",
      "apiType": 1,
      "apiUrl": "",
      "serverIp": "",
      "serverPort": "",
      "queueMessage": "currently waiting in queue.",
      "gameType": "garrysmod",
      "showMap": false,
      "mapPrefix": "fw", //Remove map prefix if used or leave blank to default
      "debug": false
    }
  ]
}

Discord Setup 🤖

Installation 🔨

About

A simple and efficient Discord bot that fetches real-time player counts and map info for your game servers using the SourceQuery and REST APIs. Keep your community informed about server status and engage with your players seamlessly.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published