Skip to content

Latest commit

 

History

History
156 lines (136 loc) · 7.12 KB

README.md

File metadata and controls

156 lines (136 loc) · 7.12 KB
Raw

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:

Use the help command to see how this data is displayed. See Screenshots.

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
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
FORUMS_CHECK_ADMIN_ID=         # Discord ID (numbers only) of user that can use the forums command

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 GameTracker is stored in a JSON file located at bot/data/servers.json.

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

{
    "classic": {
        "name": "Classic PropHunt",
        "ip": "185.249.196.141:27515",
        "supportedByGameTracker": true,
        "gametrackerID": "6022841",
        "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.
  • supportedByGameTracker: True if server is tracked on GameTracker.
  • gametrackerID: The server ID generated by GameTracker, concatenated in graph images URLs.
  • supportedBySmithtainmentAPI: True if server is supported by the Smithtainment API. Only available on Smithtainment Gaming servers.

Smithtainment forums checking

This bot scraps the Smithtainment network forums periodically to check for new recent posts on specific threads. If a new thread is found, Steam/GameTracker data from that post is retrieved if available, and a notification message about the thread is sent in a Discord channel.

The thread can be associated with a server tracked by GameTracker. The configuration file for this feature is located in the bot/data/forumsSections.json file.

Format example:

[
    {
        "name": "Appeals Section",
        "rolesToPing": [ 
            "@here", "<@&421555402533975564>"
        ],
        "sections": [
            {
                "name": "Garry's Mod Ban Appeal",
                "fid": "443",
                "color": "RED"
            },
            {
                "name": "Garry's Mod Warn Appeal",
                "fid": "445",
                "color": "ORANGE"
            },
            {
                "name": "Discord Ban Appeal",
                "fid": "302",
                "color": "DARK_BLUE"
            }
        ]
    }
]
  • name: Alias for the group of forums thread sections.
    • name can be replaced by a serverKey key, where the value is a server key present in the server.json file.
  • rolesToPing: Array of strings containing roles or text to be sent before the me.
  • sections: Array of objects representing a forums section.
    • name: Alias for the forums section.
    • fid: ID of the forums section, can be found in the URL.
    • color A ColorResolvable used in the messages for this forums section.

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. Uses Smithtainment Status API v2.
  • online2: 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.
  • 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

  • steaminfo: Shows some information from steam of a steam user.

Screenshots

Click to see some screenshots of the above commands

Changelog

The changelog page is served by the bot and can be found at server/public/index.html.

Acknowledgments

Thank you Aryan#6666 for helping me get started on Discord bot development.