robbmanes / seeding-reward-bot

Seeding reward bot for Glow's Battlegrounds Community

seeding-reward-bot

Discord Bot for encouraging and rewarding seeding for select games.

Proudly used in:

• Glow's Battlegrounds Community.

Setup

This section talks about how to deploy the bot to your Discord server.

Creating the Bot via Discord Developer Portal

The official instructions for creating a Discord Bot are located on the discord.py home page.

This bot requires no Privileged Gateway Intents.

Currently no permissions are required for the bot to operate as only slash commands are used.

seeding-reward-bot's Issues

Open to Public Consumption

Hello, I'm just wondering if this repository is open for anyone to utilize or is it just for Glow?

[FEAT] Check if certain users are online and notify in channel

Is your feature request related to a problem? Please describe.
Part of the community application process involves playing with applicants. Currently, users who are also members have no good way to know when applicants are online.

Describe the solution you'd like
Allow for a list of users/applicants to be monitored, and when they get online alert in a dedicated channel.

[FEAT] Gift VIP to other users

Is your feature request related to a problem? Please describe.
Sometimes you want to give VIP to other users acquired through seeding. There should be a command to allow for this.

Describe the solution you'd like
Some command, like /hll gift, etc, should allow you to do this.

/hll register does not perform steamid input validation

Describe the bug
It is possible, as there is no input validation for the steam ID input, to break /hll register if an improper steam64id format is input. This input needs sanitization and checking.

Additional context
Discussed in further detail here: #14 (comment)

Daily RCON data backups

Title is self explanatory.

[FEAT] Providing testing framework

Is your feature request related to a problem? Please describe.
Currently, testing is non-existent, which leads to bugs being caught in production.

Describe the solution you'd like
Using a pythonic method (pytest, tox, etc), creating testing scaffolding for unit and e2e tests.

Incorrect returm when value is "true"

https://github.com/glows-battlegrounds/GlowBot/blame/adf82ff6643b3f49ef683eb4cacd608ea49df404/glowbot/hll_rcon_client.py#L315

[FEAT] Top Seeders / Top Killers (DISCORD)

GlowBot to post in a Discord channel the Top Seeders and Top Killers (individual channels)

[FEAT] Prompt users in discord to use seeder VIP hours

Is your feature request related to a problem? Please describe.
To encourage usage of VIP earned through seeding, provide an optional mechanism to allow for users to be notified at a certain threshold.

Describe the solution you'd like
Some optional/timer based thing - more discussion needed

[FEAT] Implement performance-based VIP at match end

Is your feature request related to a problem? Please describe.
In order to boost retention, high-performing players should be rewarded in a way that should enable them to continue playing on Glow's at peak times.

Describe the solution you'd like
High performing users should be rewarded with free VIP to use after certain thresholds have been met, calculated at match end.

Example VIP reward scenarios could be:

• Top killer on each team (min. 30 kills)
• Anyone with more than 70 kills
• Squad leaders with 40 kills and 1200 support
• Tank Crews with 1000 CE and 40 kills
• Commanders with over 4000 support

[ISSUE] Figure out why Workers stop working/recording within a few hours.

In the previous games tab in RCON, the previous games will randomly stop updating until the Workers tab is toggled in the RCON page.

Once the Workers toggle is flipped off, then back on, the previous games will quickly update.

http://glows.gg:8015/#/gamescoreboard/29508

Workers toggle is on Setting page at the bottom right.

[FEAT] Output seeder status to a channel

Is your feature request related to a problem? Please describe.
Currently seeding status has to be manually pinged out in discord channels. It would be ideal if messages could be updated regarding the current seeding status.

Describe the solution you'd like
Either a static channel with a message, or repeated/reoccurring (configurable) messages to the channel of the user's choice.

[FEAT] Add Discord Presence Updates for HLL Server Status

Is your feature request related to a problem? Please describe.

• Currently, GlowBot does not leverage any presence updates that indicate server presence. It would be useful to get a player count, seeding status, etc.

Describe the solution you'd like

• Status updates to the GlowBot presence, including:
  • Server player count
  • Seeding Status
  • Multi-server support

`update_seeders` fails with boolean ValueError exception when parsing player lists from RCON

Describe the bug
During update_seeders we're having tracebacks due to a boolean somehow being returned as a key of a dict it seems:

Traceback (most recent call last):
  File "/root/.cache/pypoetry/virtualenvs/glowbot-Yr1L9Y8C-py3.11/lib/python3.11/site-packages/discord/ext/tasks/__init__.py", line 198, in _loop
    raise exc
  File "/root/.cache/pypoetry/virtualenvs/glowbot-Yr1L9Y8C-py3.11/lib/python3.11/site-packages/discord/ext/tasks/__init__.py", line 169, in _loop
    await self.coro(*args, **kwargs)
  File "/root/GlowBot/glowbot/tasks.py", line 69, in update_seeders
    player_list = result[rcon_server_url]

This causes incorrect seeding times as the update_seeders method bails.

To Reproduce
Only happens during seeders, and only when certain players are present, although I am not sure what the criteria is.

Expected behavior
Obviously a string for the RCON name should be returned here, never a bool, and I am unsure how we're getting here. Looking into it.

[FEAT] Manage AFK seeders to ensure fair team balance

Is your feature request related to a problem? Please describe.
While seeding, AFK players are acceptable and desired. However, as the server approaches seeding limits, it is possible (and likely) that one team will have significantly more AFK/non-squad members than the other, leading to a lack of balance between the two teams regarding the amount of active players. This leads to one team being very quickly steamrolled due to pure active player count issues causing maps to flip more often and causing player retention issues.

Describe the solution you'd like
Glowbot should be able to manage AFK players interactively by:

• Ensuring players not in a squad are considered as AFK.
• Moving non-squad players between teams to balance them.
• Removing non-squad players from teams (putting them back to the team selection screen).

[FEAT] Prompt users when seeding is ended

Is your feature request related to a problem? Please describe.
When users exceed the 20v20 limit of seeding, it is not immediately clear when a server is seeding still or is considered "live" and seeding rules are removed. This leads to confusion as all players are not uniformly informed of when seeding rules are in effect or not.

Describe the solution you'd like
Glowbot should be able to send a mass message when seeding rules are clearly enabled or not based on active player count.