SGStats

SGStats is a Discord scraper bot specifically made for the Smithtainment gaming network. It is partially hard-coded to get information about their game servers and forums.

Along with the Discord bot, this Node.js application also runs a server which serves pages with the changelog and some redirect links directly to the Steam game servers. You can check the live version of the bot with the updated changelog on Glitch.com.

Scraped data

Some of the data gathered for the network members includes:

gametracker.com data and generated images
Steam user basic information through Steam Web API
Smithtainment Forums specific posts
Smithtaiment server info through Smithtainment Status API v2

These data are gathered through commands in a Discord server channel, to see which commands are available and what each one does, use the help command to the bot.

Installing

Before runnning the bot, install its dependencies and set up the enviroment variables

Dependencies

npm i

Environment Variables

Create a .env file in the project's root. These variables are needed throughout the code:

# Server
BASEURI=                       # The url of the server (Ex: http://localhost)
PORT=                          # The server port (Ex: 80)

# Bot
PREFIX=                        # The prefix character for commands (Ex: !!)
TOKEN=                         # The Discord bot app token
STEAMWEBAPI_KEY=               # The Steam Web API key
SMITHTAINMENT_API_KEY=         # The Smithtainment API v2 key
DEBUG_CHANNEL=                 # The Discord channel to send startup and specific error messages
FORUMS_CHECK_MESSAGE_CHANNEL=  # The Discord server channel to send the forums sections logs
FORUMS_CHECK_LOGGING=          # true or false, toggles logging at bot/commands/forums.js

# Scripts
GLITCH_NO_SLEEP=               # true or false, toggles noSleep script for Glitch.com

Running

node main.js

Gametracker servers

Some commands scrap, format and send Gametracker server information to the users. The information needed to access a specific server data on Gamertracker is stored in a JSON file located at bot/data/servers.json. This makes it easier to add and remove servers the bot can target, without having to modify the commands themselves.

Here's how add a new server to the file:

{
    "classic": {
        "name": "Classic PropHunt",
        "ip": "185.249.196.141:27515",
        "gamertrackerID": "6055306",
        "supportedBySmithtainmentAPI": true
    }
}

Object key (Ex: classic): The single word abbreviation for the server, used in commands names and parameters.
name: The name of the server, used in embed messages.
ip: The ip + port of the server, used to build the target server URLs.
gamertrackerID: The server ID generated by Gamertracker, used to build graph images URLs.
supportedBySmithtainmentAPI: True if server is supported by the Smithtainemnt API. Only available on Smithtainment Gaming servers.

Commands

Server commands

join: Generates a link to quickly join a server.
map: Shows a graph of the most used maps in a server over the last day, week or month.
online: Shows a list of the server's online players and their time played since the last join. Also shows a graph of the server's population through the day.
online2: Shows a list of the server's online players. Uses Smithtainment Status API v2.
population: Shows a graph of the population of a server over the last day, week or month.
rank: Shows a graph of the server rank over the last day, week or month.
server: Shows current display name, status, ip and online player count/slots of a server.

Player commands`

leaderboard: Shows a leaderboard around a player displaying total score, time played or score/min.
playerh: Shows a graph of the minutes played each day on a server over the last day, week or month.
players: Shows a graph of the score earned on a server over the last day, week or month.
stats: Shows the leaderboard rank, total score, time played and score/min of a player on a server.

Other commands