Overhaul Bot and utilize Discord Embed by kphoenix137 · Pull Request #20 · diasurgical/devilutionx-gamelist

kphoenix137 · 2023-10-02T19:52:31Z

Adds embeds, as well as overhauling the whole python end of the bot.

Features:

Split files for maintainability
config.json
- Can be modified by set bot owners using new commands!
- Doesn't require restart to apply changes
More console logging
- Helps with debugging and displays useful information
- More data using the Debug setting in config
Detects the backend application (./devilutionx-gamelist) based on OS used
Improved error handling
Multiple attempts at refreshing games in case a refresh fails to avoid marking games as closed incorrectly
Automatic graphic for game type
- You can add a graphic with the 4 digit code for a game type as a PNG to the images directory to automatically have that graphic display in the embed for the respective game type

discord_bot.py

StephenCWills

I really like how this is looking now. Here are a few more suggestions for cleaning things up a bit.

bot.py

commands.py

game_manager.py

bot.py

StephenCWills · 2025-03-16T03:27:08Z

Come to think of it, it might be tough to resolve those conflicts with discord_bot.py now that you've demolished it.

Add "Game Closed" to replace game id Remove Players and Options as inline Update game icons Modify game title based on 4 letter code Update missing game ids Handle undefined difficulty and game speed Change unknown to custom for tick rate Overhaul Revert to DevilutionX Game List channel Update bot.py Co-authored-by: Stephen C. Wills <[email protected]> Update bot.py Co-authored-by: Stephen C. Wills <[email protected]> Update commands.py Co-authored-by: Stephen C. Wills <[email protected]> Update game_manager.py Co-authored-by: Stephen C. Wills <[email protected]> Update bot.py Co-authored-by: Stephen C. Wills <[email protected]> Update bot.py Co-authored-by: Stephen C. Wills <[email protected]> Pass config as param Avoid using outdated config Fix mistake Delete discord_bot.py Rename bot.py Return types Appease mypy Change code to British More British

AJenbo · 2025-03-16T05:31:33Z

Split files for maintainability

I'll have to change my setup ... but i should have done so a long time ago

discord_bot.py

AJenbo · 2025-03-16T05:40:33Z

Need to update this line to not lower code quality: https://github.com/diasurgical/devilutionx-gamelist/blob/main/.github/workflows/mypy.yml#L23

kphoenix137 · 2025-03-16T06:50:52Z

Need to update this line to not lower code quality: https://github.com/diasurgical/devilutionx-gamelist/blob/main/.github/workflows/mypy.yml#L23

Not sure what you mean

StephenCWills

I tried going through the commits that you rebased over to see if anything got lost. Most of it was either incorporated, re-implemented, or inconsequential. But I did notice a couple things.

game_manager.py

discord_bot.py

No longer available to admins, only bot owner(s).

Requested changes have been addressed

ephphatha · 2025-03-21T11:22:58Z

utils.py

+def censor_bad_words(name: str) -> str:
+    """Replaces banned words in a player's name with asterisks."""
+    name_upper = name.upper()
+    for bad_word in BANNED_WORDS:
+        if bad_word in name_upper:
+            masked_word = "*" * len(bad_word)  # Replace with asterisks
+            pattern = re.compile(
+                re.escape(bad_word), re.IGNORECASE
+            )  # Case-insensitive match
+            name = pattern.sub(masked_word, name)  # Replace in original case
+    return name


This allows people to infer what words the banlist contains, it's not currently part of the repo I assume by design.

It's also possible to have overlapping banned words, e.g. if "potato" and "tomato" are banned, the name "potatomato" will be censored as either "******mato" or "pota******" depending on the order of the banlist with this code (because you're searching in name_upper but performing the substitution in name).

... it's not currently part of the repo I assume by design.

If I were to guess, the main reason is so that AJenbo can add words ad-hoc when he feels he needs to, without having to open a PR here or commit changes to the repo.

Good points about overlapping words and being able to infer, though. Perhaps we should just censor the whole name and solve both issues?

ephphatha · 2025-03-21T11:26:54Z

utils.py

+def debug_print(
+    *args: Any, sep: str = " ", end: str = "\n", file: Any = None, flush: bool = False
+) -> None:
+    """Prints messages only if debug mode is enabled."""
+    if CONFIG.get("debug", False):
+        print(*args, sep=sep, end=end, file=file, flush=flush)


Any reason you went back to basic print() output instead of using the existing logging config? You could still let people choose logging level via the config file (with the more widely used trace/debug/info/warning/error levels instead of just debug/warning)

ephphatha · 2025-03-21T11:29:18Z

utils.py

+def sanitize_player_name(name: str) -> str:
+    """Removes forbidden characters from a player's name."""
+    return re.sub(FORBIDDEN_CHARS, "", name)  # Strip invalid characters


I believe the choice to hide games with an invalid player name was deliberate as it's assumed players with these names are malicious. Any players which have a name containing one of these characters have set it using external tools. Vanilla Diablo/DevilutionX don't allow inputting these characters in a name. This is also missing the filtering/validation the current code applies to ensure that no ASCII control characters or multibyte sequences are present in a players name.

ephphatha · 2025-03-21T11:47:47Z

discord_bot.py

+# Run Bot
+with open("./discord_bot_token", "r") as file:
+    token = file.readline().strip()


The discord token used by the bot is currently part of the config file discord_bot.json. Renaming the config file to config.json is fine imo but I'd rather see the token remain as a config option instead of a bare file. If you'd rather split secret and non-secret options a convention used by other programs is to have config.json and config.private.json, where the latter is excluded from source control. E.g. in the current main branch discord_bot.json is listed in .gitignore and discord_bot.json.template provides an example of the expected structure. You could even put channel id in there since that's closely related to the auth token and not really of any use to other people.

ephphatha · 2025-03-21T11:54:28Z

utils.py

+    players = ", ".join(
+        censor_bad_words(sanitize_player_name(player)) for player in game["players"]
+    )


It appears you've dropped the code that escapes discord formatting characters in player names. This will cause players with valid names (e.g. "M`din") to trigger discord's markdown parser and cause odd formatting to get applied to the embed message.

StephenCWills reviewed Oct 4, 2023

View reviewed changes

discord_bot.py Outdated Show resolved Hide resolved

StephenCWills reviewed Oct 4, 2023

View reviewed changes

discord_bot.py Outdated Show resolved Hide resolved

StephenCWills reviewed Oct 4, 2023

View reviewed changes

discord_bot.py Outdated Show resolved Hide resolved

kphoenix137 requested a review from StephenCWills March 16, 2025 02:01

kphoenix137 changed the title ~~Change Plain Text to Embed~~ Overhaul Bot and utilize Discord Embed Mar 16, 2025

StephenCWills requested changes Mar 16, 2025

View reviewed changes

kphoenix137 requested a review from StephenCWills March 16, 2025 04:24

kphoenix137 force-pushed the embeds branch 2 times, most recently from 9577cff to 125cefb Compare March 16, 2025 04:48

kphoenix137 force-pushed the embeds branch from 0ad4f26 to 4d43125 Compare March 16, 2025 05:29

AJenbo reviewed Mar 16, 2025

View reviewed changes

discord_bot.py Show resolved Hide resolved

Add time to embed

b27fa16

StephenCWills previously requested changes Mar 16, 2025

View reviewed changes

game_manager.py Outdated Show resolved Hide resolved

discord_bot.py Show resolved Hide resolved

kphoenix137 added 9 commits March 16, 2025 13:56

Censor Player Names, Proc timeout

10c5c71

Global config

a5515da

Appease mypy

b92cae8

Apply PEP8 Formatting Rules

fa338b2

Fix debug_print

94594e0

Fix debug_print

1eec612

Implement debug_print

fb11b64

Fix missing config options

e86f671

Add more commands

a0cfdb0

No longer available to admins, only bot owner(s).

kphoenix137 mentioned this pull request Mar 16, 2025

Statistics #32

Open

kphoenix137 requested a review from AJenbo March 17, 2025 03:07

ephphatha requested changes Mar 21, 2025

View reviewed changes

Conversation

kphoenix137 commented Oct 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

StephenCWills left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

StephenCWills commented Mar 16, 2025

Uh oh!

AJenbo commented Mar 16, 2025

Uh oh!

Uh oh!

AJenbo commented Mar 16, 2025

Uh oh!

kphoenix137 commented Mar 16, 2025

Uh oh!

StephenCWills left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ephphatha Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

StephenCWills Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

ephphatha Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

ephphatha Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

ephphatha Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

ephphatha Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kphoenix137 commented Oct 2, 2023 •

edited

Loading