discord-gamestatus/discord-gamestatus

View the status of your game server in discord using embeds

discord-gamestatus

A open-source discord bot that actively monitors your game server and updates a discord message with the current status.

• Invite link
• Command documentation
• Self-hosting documentation (WIP)
• Terms of usage (for public bot)
• Privacy policy (for public bot)

Changelog

See CHANGELOG

Contributing

If you would like to request a new feature, report a bug, or even fix or improve our code we welcome your contribution. Open an issue to make a request, or a PR to submit your code for review.

Before contributing please read CONTRIBUTING

LICENSE

Licensed under GPL-3.0

discord-gamestatus's Issues

Setup tutorial

Create a setup guide (maybe video)

Error when using discord protocol

The query function errors when trying to fetch an image for discord servers.

Error running command status
TypeError: this.guilds.get is not a function
   at Client.discord (/home/discord-bots/discord-gamestatus/src/query.js:35:29)
   at Client.query (/home/discord-bots/discord-gamestatus/src/query.js:99:37)
   at async Update.send (/home/discord-bots/discord-gamestatus/src/structs/Update/UpdateSend.js:32:17)
   at async Object.call (/home/discord-bots/discord-gamestatus/src/commands/status.js:43:15)
   at async Client.<anonymous> (/home/discord-bots/discord-gamestatus/src/index.js:118:9)

Find replacement for discord.js-light

discord.js-light is no longer being maintained (timotejroiko/discord.js-light#95) and will not be updated to discord.js v14.

While a lot of the caching functionality is now included in discord.js itself I do not believe that the forge methods are, it might be possible to port just the forge methods into the bot itself or their own library, or it might be better to just maintain discord.js-light ourselves.

More research needed.

Add ability to move statuses between channels

This avoids people having to reconfigure the whole status message when they want to change the channel it is in.

Validate image URLs

Non-valid image URLs cause updates to fail

Limit lengths on embed fields

Limit the length on embed fields before sending.
https://discord.com/developers/docs/resources/channel#embed-limits

Statusrefresh bug

TypeError: Cannot read properties of undefined (reading 'split')
statusrefresh.js:26:36

Add discord slash commands

Must move to discord slash commands before the messages intent is banned

Remove on error not actually removing statuses

When encountering errors such as 10003 during an update the bot is failing to remove statuses from the database.

Gamelist doesn't work well with interactions

The gamelist command can only show one embed when used with slash commands, also specifying a short query like 2 will cause the command to fail because the resulting embed is too large.

Changes to statuses being lost/statuses being deleted

Probably due to incomplete shutdown, needs more investigating.

Unit testing

Add some unit tests to validate code quality and prevent regression

Giving error 'Sorry an error occured, please try again later' after using !statusrefresh

Hi, i updated statusmod image then tried to refresh, then i got this error.. Any idea? (The bot perm and channel perm have 'can send embed files' permission.)

Unable to delete statuses with null properties

Casting values to text in postgres queries makes selecting statuses with null properties not work.

Add debian packages

Create packages for debian so native setup is simpler

https://github.com/discord-gamestatus/discord-gamestatus-pkg

Address statuses by full ID instead of channel ID

Because of JSON format statuses are currently only addressed by channelID, this is inefficient when using SQL. Should convert functions to mainly use full ID.

Create site for documentation

Slash command for statusmod doesnt allow rich formatting

Text entry for statusmod slash command ignores rich formatting in description (e.g. newline).

Activateguild should remove existing activation

Running activateguild should clear the oldactivation first to save having to use the command twice.

Some of the status messages aren't updated

Statuses on the first tick don't get updated.

Give format strings access to raw query info

Allow format specifiers to access the raw query info, this will allow descriptions/titles to include game/protocol specific data.

Queries for fivem servers don't work

Fivem server statuses always show as offline.

Docs: Add build instructions to README

What would you like to be added?

Add instructions for building and running the bot to the README.

Any extra information

No response

Self-host

Self-Hosted

Add schemas to docker initialize scripts

The postgres image we use supports automatically initializing the database by mounting initialization scripts in /docker-entrypoint-init-db.d/ (https://github.com/docker-library/docs/blob/master/postgres/README.md#initialization-scripts). By doing so setup can skip the steps of running schemas.

Using this method we would need to consider whether this actually runs the scripts in the correct order as this is required.

Add contribution guidelines

Make it easy for people to contribute by adding contribution guidelines, and an overview of the code structure.

Statusremove command error

Statusremove throws an error and doesn't function correctly when being called via the slash command.

Error running interaction statusremove
 TypeError [COMMAND_INTERACTION_OPTION_TYPE]: Option "channel" is of type: CHANNEL; expected STRING.
    at CommandInteractionOptionResolver._getTypedOption (/home/node/node_modules/discord.js/src/structures/CommandInteractionOptionResolver.js:98:13)
    at CommandInteractionOptionResolver.getString (/home/node/node_modules/discord.js/src/structures/CommandInteractionOptionResolver.js:159:25)
    at Object.call (/home/node/dist/commands/statusremove.js:68:53)
    at Client.onInteraction (/home/node/dist/index.js:213:27)
    at Client.<anonymous> (/home/node/node_modules/@douile/bot-utilities/lib/index.js:38:28)
    at Client.emit (node:events:527:28)
    at InteractionCreateAction.InteractionCreate [as handle] (/home/node/node_modules/discord.js-light/actions.js:412:5)
    at Object.INTERACTION_CREATE (/home/node/node_modules/discord.js-light/handlers.js:262:36)
    at WebSocketManager.Client.ws.handlePacket (/home/node/node_modules/discord.js-light/client.js:47:29)
    at WebSocketShard.onPacket (/home/node/node_modules/discord.js/src/client/websocket/WebSocketShard.js:482:22) {
  [Symbol(code)]: 'COMMAND_INTERACTION_OPTION_TYPE'

Re-implement JSON support

Re-add support for JSON saves.

Add docker documentation

offlineImage not working

The offlineImage property is not respected and the default image is still shown while the server is online.

Add localization support

Make the bot translatable

Rust rewrite

Rewrite entire bot in rust using the serenity library for much improved resource efficiency.

This will involve some re-architecture.

• The bot client will no longer connect to the scheduler: status updates now exclusively use HTTP API endpoints meaning they do not need an active gateway connection.
  • A seperate updater program will run that connects to scheduler and just sends updates
  • This program will be built with sharding in mind, hence need to add way to easily distribute bot configuration between them (rewrite scheduler protocol)
  • Possibly swap out JSON for more efficient machine parsable format
  • Possibly add TLS support for scheduler
  • This depends on https://github.com/gamedig/rust-gamedig to be ready (it mostly is)
• Bot client will be reduced to most basic functionality: recieve slash command, update database, generate message.
  • Database updates will be optimised by creating specific queries for each specific use case instead of updating each status as its own unit.
  • Hopefully take advantage of new discord features like buttons and modals
• Database changes
  • db is central point of reference for all components therefore it might be the best place to store the bot configuration
  • statuses table could be optimised, better indexes, remove data for functionality thats not really used
    • player change list (stores entire response json)
    • last server title (stores entire response json)
  • if changing database schema should add unit tests to confirm that migration will work

Other tasks

• create a component diagram of this architecture
• get docs up to scratch, especially for slash commands as regular commands are being removed
• support internationalization out the gate
• performance metrics so benefit of rewrite can be measured

Add right click command for statusremove

Add better management for active statuses

• Allow moving statuses between channels
• Allow changing the IP/gametype of a status

Multiple updates in single embed

Add the ability to have multiple updates in a single embed, probably one server update per field.

Auto-build docker and publish to docker hub (or alternative)

Add CI to build dockerfiles (on release) and publish them so self-build is not required.

Statuses can get re-added to database after deletion

After deleting a status with statusremove it may get re-added to the database by the auto-updater. This is caused by the status-save in auto-update if a new message is sent.

Reduce memory footprint

The bot currently uses ~500mb per shard, this can probably be greatly reduced by not caching stuff we don't need, using partials etc.

Activateguild mode should not be optional

The slash command option for activateguild should not be optional.

Add local IP denylist

Add the ability to prevent the bot from querying IPs in set ranges.

Improve community info

Improve open-sourness

Add:

• Contributing.md (contributing guidelines)
• Issue templates

Improve:

• Setup/build tutorial

https://github.com/Douile/discord-gamestatus/community

Prune servers offline for a certain period

What would you like to be added?

Store the last online time for servers and automatically remove those that have not been online for a set amount of time.

Any extra information

No response

Self-host

Public

Pass tick number from scheduler to the updater

I've set new dots for my status which first seemed to work but after the next status update the changes were reverted. Every other setting I changed until then worked fine.

Add slash command setup to docker

Add option to automatically enable slash commands to the docker image

Add privacy policy and terms of use

Move tick management to database

By managing the ticks (which statuses are updated when) in the database we can save memory footprint as not all the statuses will need to be loaded in memory. It will also make it possible to shard and spread the updates across shards.

Requirements:

• New database table that stores (tick_id, status_id)
• Some kind of manager in db that assigns statuses to ticks
• Rework update code to fetch from database

Dead statuses don't get removed

After logging removing {status} for {code} status messages do not get removed from the database, perhaps regression of #9

How does one actually start the bot?

Instructions in doing so on Windows are not entirely clear. I have my bot running through the developer portal but do not know how to activate this script. Thanks.

how to use this bot

Hi I have followed the instructions but still showing error :) pls help
`/root/discord-gamestatus/src/limits.js:19
onError ||= debugLog;
^^^

SyntaxError: Unexpected token '||='
at wrapSafe (internal/modules/cjs/loader.js:988:16)
at Module._compile (internal/modules/cjs/loader.js:1036:27)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:1101:10)
at Module.load (internal/modules/cjs/loader.js:937:32)
at Function.Module._load (internal/modules/cjs/loader.js:778:12)
at Module.require (internal/modules/cjs/loader.js:961:19)
at require (internal/modules/cjs/helpers.js:92:18)
at Object. (/root/discord-gamestatus/src/structs/UpdateCache.js:26:23)
at Module._compile (internal/modules/cjs/loader.js:1072:14)
at Object.Module._extensions..js (internal/modules/cjs/loader.js:1101:10)`

Remove defaults from Dockerfile.bot CMD

Having arguments prevents configuration being set via environment variables

Maintenance mode

Allow admins to turn on/off "maintenance mode" where a temporary (customizable) warning is added to the status message.