Compare commits

..
Author SHA1 Message Date
alwayscompiling a602347d09 Removing TODOs. 2022-07-09 13:57:48 -04:00
alwayscompiling 03ed723f5c Add input verification in verification_view.py. 2022-07-09 13:53:23 -04:00
alwayscompiling 18db48a55e Sending to verification view. 2022-07-09 11:43:49 -04:00
alwayscompiling 7854be890f Entire submission process works somehow. 2022-07-09 11:24:29 -04:00
alwayscompiling 6a7207d710 Slight organization changes. Decided to use new message for score input. 2022-07-07 22:57:38 -04:00
alwayscompiling f9800677cc Got response of dropdown. 2022-07-06 22:16:22 -04:00
alwayscompiling 3d16fe81e5 First dropdown works. 2022-07-06 21:37:46 -04:00
alwayscompiling c4261fc7f4 Changed where submission views live. 2022-07-06 21:05:04 -04:00
alwayscompiling d0428afb3f Add example config, ignore working config. 2022-07-06 20:39:59 -04:00
alwayscompiling a92f790a5f Adding new boss. 2022-07-04 10:15:01 -04:00
alwayscompiling 22d368f0a8 Adding submission button for all highscore messages. 2022-07-04 10:13:16 -04:00
alwayscompiling 84cf3781ee Adding map to track message id to boss. 2022-07-03 23:01:24 -04:00
alwayscompiling 8a20c1f50a Solved message deletion. 2022-07-03 22:34:16 -04:00
alwayscompiling a8aad570d3 Add logging message for admins, trying to move message with buttons. 2022-07-03 17:29:39 -04:00
alwayscompiling 02ba90134e Removing some local variables. 2022-07-03 17:13:23 -04:00
alwayscompiling 0834634cde Verification button working. 2022-07-03 17:11:06 -04:00
alwayscompiling 445c77b012 Renamed utils folder because import shenanigans with module with same name. 2022-07-03 16:51:54 -04:00
alwayscompiling b3af09f1c6 Changed utils to data_storage where I didn't need to. 2022-07-03 16:39:43 -04:00
alwayscompiling dc0fd694d3 Fix circular dependencies after refractor. 2022-07-03 16:38:22 -04:00
alwayscompiling 6d41baef98 Adding missed utils refactor. 2022-07-03 16:32:51 -04:00
alwayscompiling f29e459b2e Refractor utils to one file. 2022-07-03 16:12:15 -04:00
alwayscompiling 35aa1f34f4 Merge branch 'score-verification' of github.com:alwayscompiling/pvm-highscores into score-verification 2022-07-03 16:09:26 -04:00
alwayscompiling c046fa2c45 Using asserts for error catching. 2022-07-03 13:33:13 -04:00
alwayscompiling ffeb8119f7 Verification message is sent. 2022-07-03 11:46:07 -04:00
alwayscompiling a94ccdc425 Adding verification channel register command. 2022-07-03 11:21:06 -04:00
alwayscompiling 04faff3bdb Adding verification channel register command. 2022-07-03 11:20:08 -04:00
alwayscompiling cfde28ad4b Removing errors in help_command.py. 2022-07-03 10:47:06 -04:00
alwayscompiling f23cd71647 Editing information that would be posted from help command. 2022-07-03 10:35:08 -04:00
alwayscompiling 75fdef6388 Adding premade help command. 2022-07-03 10:29:18 -04:00
17 changed files with 601 additions and 168 deletions
+2
View File
@@ -132,3 +132,5 @@ nextcord.log
# data file for bot # data file for bot
highscores_data.json highscores_data.json
highscores_message_map.json
highscores_config.json
+26
View File
@@ -0,0 +1,26 @@
"""
Help command
"""
from nextcord.ext import commands
from .help_command import NewHelpCommand
class HelpCog(commands.Cog):
"""Help Command"""
def __init__(self, bot: commands.Bot):
self.bot = bot
self._original_help_command = bot.help_command
bot.help_command = NewHelpCommand()
bot.help_command.cog = self
def cog_unload(self):
self.bot.help_command = self._original_help_command
# setup functions for bot
def setup(bot: commands.Bot):
"""Adds function to bot"""
bot.add_cog(HelpCog(bot))
+84
View File
@@ -0,0 +1,84 @@
"""
Help command. Copied from discord-bot-template.
"""
import nextcord
from nextcord.embeds import EmptyEmbed
from nextcord.ext import commands
import config # pylint: disable=import-error
class NewHelpCommand(commands.MinimalHelpCommand):
"""Custom help command override using embeds"""
COLOUR = nextcord.Colour.blurple()
def get_ending_note(self):
"""Returns note to display at the bottom"""
invoked_with = self.invoked_with
return f"Use {config.BOT_PREFIX}{invoked_with} [command] for more info on a command."
def get_command_signature(self, command: commands.core.Command):
"""Retrieves the signature portion of the help page."""
return f"{command.qualified_name} {command.signature}"
async def send_bot_help(self, mapping: dict):
"""implements bot command help page"""
embed = nextcord.Embed(title="Bot Commands", colour=self.COLOUR)
avatar = self.context.bot.user.avatar
avatar_url = avatar.url if avatar else EmptyEmbed
embed.set_author(name=self.context.bot.user.name, icon_url=avatar_url)
description = self.context.bot.description
if description:
embed.description = description
for cog, commands in mapping.items(): # pylint: disable=redefined-outer-name
name = "No Category" if cog is None else cog.qualified_name
filtered = await self.filter_commands(commands, sort=True)
if filtered:
# \u2002 = middle dot
value = "\u2002".join(f"{config.BOT_PREFIX}{c.name}" for c in filtered)
if cog and cog.description:
value = f"{cog.description}\n{value}"
embed.add_field(name=name, value=value)
embed.set_footer(text=self.get_ending_note())
await self.get_destination().send(embed=embed)
async def send_cog_help(self, cog: commands.Cog):
"""implements cog help page"""
embed = nextcord.Embed(title=f"{cog.qualified_name} Commands", colour=self.COLOUR)
if cog.description:
embed.description = cog.description
filtered = await self.filter_commands(cog.get_commands(), sort=True)
for command in filtered:
embed.add_field(
name=self.get_command_signature(command),
value=command.short_doc or "...",
inline=False,
)
embed.set_footer(text=self.get_ending_note())
await self.get_destination().send(embed=embed)
async def send_group_help(self, group: commands.Group):
"""implements group help page and command help page"""
embed = nextcord.Embed(title=group.qualified_name, colour=self.COLOUR)
if group.help:
embed.description = group.help
if isinstance(group, commands.Group):
filtered = await self.filter_commands(group.commands, sort=True)
for command in filtered:
embed.add_field(
name=self.get_command_signature(command),
value=command.short_doc or "...",
inline=False,
)
embed.set_footer(text=self.get_ending_note())
await self.get_destination().send(embed=embed)
# Use the same function as group help for command help
send_command_help = send_group_help # type: ignore
+21 -17
View File
@@ -3,14 +3,17 @@ Bot command to post the highscores
""" """
from nextcord.ext import commands from nextcord.ext import commands
import nextcord
from cogs.submission.submission_views import SubmissionButton # pylint: disable=import-error
from highscores import highscores_config # pylint: disable=import-error from highscores import highscores_config # pylint: disable=import-error
from highscores import highscores_data # pylint: disable=import-error from highscores import highscores_data # pylint: disable=import-error
from utils import data_storage # pylint: disable=import-error from utilities.data_storage import save_highscores_data # pylint: disable=import-error
from utils import highscore_message # pylint: disable=import-error from utilities.utils import send_highscore_message # pylint: disable=import-error
class PostHighscores(commands.Cog, name="Post Highscores"): class PostHighscores(commands.Cog, name="Post Highscores"):
"""Actions of bot command""" """Posts Highscores."""
def __init__(self, bot: commands.Bot): def __init__(self, bot: commands.Bot):
self.bot = bot self.bot = bot
@@ -18,29 +21,30 @@ class PostHighscores(commands.Cog, name="Post Highscores"):
@commands.command(name="post-scores") @commands.command(name="post-scores")
async def post_highscores(self, ctx: commands.Context): async def post_highscores(self, ctx: commands.Context):
""" """
A command which posts the highscore in the designated channel. Sends warning if no channel A command which posts the highscore in the designated channel.
has been registered. Sends warning if no channel has been registered.
Usage: Usage:
``` ```
?post-scores ?post-scores
``` ```
""" """
channel_id = highscores_data["channel_id"] highscore_channel_id = highscores_data["highscore_channel_id"]
print(f"Printing out highscores information in channel {channel_id}") print(f"Printing out highscores information in channel {highscore_channel_id}")
channel = self.bot.get_channel(channel_id) channel = self.bot.get_channel(highscore_channel_id)
if channel is None:
response = 'Registered Highscores channel does not exist or was never registered. \
Register with "?register" command.'
await ctx.send(response)
return
for boss in highscores_config["bosses"]:
await highscore_message.send_highscore_message(channel, boss["boss"])
data_storage.save_highscores_data(highscores_data) error_response = 'Registered Highscores channel does not exist or was never registered. \n\
Register with "?register" command.'
assert channel is not None, await ctx.send(error_response)
for boss in highscores_config["bosses"]:
message: nextcord.Message = await send_highscore_message(channel, boss["boss"])
await message.edit(view=SubmissionButton())
save_highscores_data(highscores_data)
# This function will be called when this extension is loaded. # This function will be called when this extension is loaded.
# It is necessary to add these functions to the bot. # It is necessary to add these functions to the bot.
def setup(bot: commands.Bot): def setup(bot: commands.Bot):
"""Adds functon to bot""" """Adds function to bot"""
bot.add_cog(PostHighscores(bot)) bot.add_cog(PostHighscores(bot))
+9 -9
View File
@@ -4,32 +4,32 @@ Bot command to register the highscores channel
from nextcord.ext import commands from nextcord.ext import commands
from highscores import highscores_data # pylint: disable=import-error from highscores import highscores_data # pylint: disable=import-error
from utils import data_storage # pylint: disable=import-error from utilities.data_storage import save_highscores_data # pylint: disable=import-error
class RegisterHighscoreChannel(commands.Cog, name="Register HighScore Channel"): class RegisterHighscoreChannel(commands.Cog, name="Register HighScore Channel"):
"""Actions of bot command""" """Registers Highscore channel"""
def __init__(self, bot: commands.Bot): def __init__(self, bot: commands.Bot):
self.bot = bot self.bot = bot
@commands.command(name="register") @commands.command(name="register-highscore")
async def register_highscores(self, ctx: commands.Context): async def register_highscores(self, ctx: commands.Context):
"""A command which registers the channel command is sent in as channel to post highscores in """A command which registers current channel as channel to post highscores in.
Usage: Usage:
``` ```
?register (in channel to post highscores in) ?register-highscore (in channel to post highscores in)
``` ```
""" """
print(f"Registering {ctx.channel.id}.") print(f"Registering {ctx.channel.id} for highscores.")
# respond to the message # respond to the message
await ctx.send(f"Registered <#{ctx.channel.id}> as channel to post highscores in.") await ctx.send(f"Registered <#{ctx.channel.id}> as channel to post highscores in.")
highscores_data["channel_id"] = ctx.channel.id highscores_data["highscore_channel_id"] = ctx.channel.id
data_storage.save_highscores_data(highscores_data) save_highscores_data(highscores_data)
# This function will be called when this extension is loaded. # This function will be called when this extension is loaded.
# It is necessary to add these functions to the bot. # It is necessary to add these functions to the bot.
def setup(bot: commands.Bot): def setup(bot: commands.Bot):
"""Adds functon to bot""" """Adds function to bot"""
bot.add_cog(RegisterHighscoreChannel(bot)) bot.add_cog(RegisterHighscoreChannel(bot))
@@ -0,0 +1,35 @@
"""
Bot command to register the verification channel
"""
from nextcord.ext import commands
from highscores import highscores_data # pylint: disable=import-error
from utilities.data_storage import save_highscores_data # pylint: disable=import-error
class RegisterVerificationChannel(commands.Cog, name="Register Verify Channel"):
"""Registers Verification channel"""
def __init__(self, bot: commands.Bot):
self.bot = bot
@commands.command(name="register-verify")
async def register_highscores(self, ctx: commands.Context):
"""A command which registers current channel as channel to post verifications in.
Usage:
```
?register-verify (in channel to post highscores in)
```
"""
print(f"Registering {ctx.channel.id} for verification.")
# respond to the message
await ctx.send(f"Registered <#{ctx.channel.id}> as channel to post verifications in.")
highscores_data["verification_channel_id"] = ctx.channel.id
save_highscores_data(highscores_data)
# This function will be called when this extension is loaded.
# It is necessary to add these functions to the bot.
def setup(bot: commands.Bot):
"""Adds function to bot"""
bot.add_cog(RegisterVerificationChannel(bot))
+28 -10
View File
@@ -3,31 +3,49 @@ Bot command to submit a score
""" """
from nextcord.ext import commands from nextcord.ext import commands
from utils import highscore_manage # pylint: disable=import-error from highscores import highscores_data # pylint: disable=import-error
from utilities.utils import submit_score # pylint: disable=import-error
# from utils import highscore_manage # pylint: disable=import-error from .verification_view import VerificationView
class RegisterHighscoreChannel(commands.Cog, name="Score"): class Score(commands.Cog, name="Score"):
"""Actions of bot command""" """Submits a score."""
def __init__(self, bot: commands.Bot): def __init__(self, bot: commands.Bot):
self.bot = bot self.bot = bot
@commands.Cog.listener()
async def on_ready(self):
"""Called when the cog is loaded"""
self.bot.add_view(VerificationView())
@commands.command(name="score") @commands.command(name="score")
async def score(self, ctx: commands.Context, boss_name: str, category: str, score: str): async def score(self, ctx: commands.Context, boss_name: str, category: str, score: str):
"""A command which calls a function to submit the score to highscores. Gathers required """A command which calls a function to submit the score to highscores.
information from command and passes on. Gathers required information from command and passes on.
Usage: Usage:
``` ```
?score "Boss Name" "Category" "score" ?score "Boss Name" "Category" "score"
``` ```
""" """
await highscore_manage.submit_score(self, ctx, boss_name, category, score) verification_channel_id = highscores_data["verification_channel_id"]
channel = self.bot.get_channel(verification_channel_id)
error_response = "Registered Verification channel does not exist or was never registered. \
Contact server admins."
assert channel is not None, await ctx.send(error_response)
verification_string = f"{ctx.author.display_name}:{boss_name}:{category}:{score}"
await channel.send(
content=verification_string,
files=[await attch.to_file() for attch in ctx.message.attachments],
view=VerificationView(),
)
# This function will be called when this extension is loaded. # This function will be called when this extension is loaded.
# It is necessary to add these functions to the bot. # It is necessary to add these functions to the bot.
def setup(bot: commands.Bot): def setup(bot: commands.Bot):
"""Adds functon to bot""" """Adds function to bot"""
bot.add_cog(RegisterHighscoreChannel(bot)) bot.add_cog(Score(bot))
+36
View File
@@ -0,0 +1,36 @@
"""View for verification buttons"""
import nextcord
from utilities.utils import submit_score # pylint: disable=import-error
class VerificationView(nextcord.ui.View):
"""Defines views for verifying score submissions"""
def __init__(self):
super().__init__(timeout=None)
@nextcord.ui.button(label="Approve", style=nextcord.ButtonStyle.green, custom_id="approve")
async def approve_button(
self, button: nextcord.ui.Button, interaction: nextcord.Interaction
): # pylint: disable=unused-argument
"""Button for approving score submission."""
content = interaction.message.content.split(":")
user = content[0]
boss_name = content[1]
category = content[2]
score = content[3]
await submit_score(interaction, user, boss_name, category, score)
await interaction.message.delete()
await interaction.channel.send(
f"Approved: {boss_name} {category} {user} {score}",
files=[await attch.to_file() for attch in interaction.message.attachments],
)
@nextcord.ui.button(label="Deny", style=nextcord.ButtonStyle.red, custom_id="deny")
async def deny_button(
self, button: nextcord.ui.Button, interaction: nextcord.Interaction
): # pylint: disable=unused-argument
"""Button for denying score submission."""
await interaction.message.delete()
+26
View File
@@ -0,0 +1,26 @@
"""
Cog for creating submission process.
"""
from nextcord.ext import commands
from .submission_views import SubmissionButton
class SubmissionCog(commands.Cog, name="Submission Cog"):
"""Constructs submission method."""
def __init__(self, bot: commands.Bot):
self.bot = bot
@commands.Cog.listener()
async def on_ready(self):
"""Called when cog is loaded"""
self.bot.add_view(SubmissionButton(self.bot))
# This function will be called when this extension is loaded.
# It is necessary to add these functions to the bot.
def setup(bot: commands.Bot):
"""Adds function to bot"""
bot.add_cog(SubmissionCog(bot))
+129
View File
@@ -0,0 +1,129 @@
"""Views used for submission process."""
from typing import Optional
import nextcord
from nextcord.ext import commands
from utilities.data_storage import open_message_map # pylint: disable=import-error
from highscores import highscores_data # pylint: disable=import-error
from .verification_view import VerificationView
class SubmissionButton(nextcord.ui.View):
"""Defines view for score submission button."""
def __init__(self, bot: commands.Bot):
super().__init__(timeout=None)
self._bot = bot
@nextcord.ui.button(label="Submit", style=nextcord.ButtonStyle.primary, custom_id="submit")
async def submit_button(
self, button: nextcord.ui.Button, interaction: nextcord.Interaction
): # pylint: disable=unused-argument
"""Button for score submission."""
highscores_message_map = open_message_map()
boss_name = highscores_message_map[str(interaction.message.id)]
embed = nextcord.Embed(title="Highscores Submission")
embed.add_field(name="Boss", value=boss_name, inline=False)
embed.add_field(name="User", value=interaction.user.display_name, inline=False)
submission_message = await interaction.channel.send( # TODO change channel
f"<@{interaction.user.id}>",
view=SubmissionDropdownView(
self._bot, interaction, await self._category_select_options(boss_name)
),
embed=embed,
)
def wait_check(check_message: nextcord.Message):
return (
interaction.user.id == check_message.author.id
and interaction.channel == check_message.channel
)
proof_message = await self._bot.wait_for("message", check=wait_check)
embed = submission_message.embeds[0]
embed.add_field(name="Score", value=proof_message.content, inline=False)
await submission_message.edit(
files=[await attch.to_file() for attch in proof_message.attachments], embed=embed
)
await proof_message.delete()
async def _category_select_options(self, boss_name: str) -> "list[nextcord.SelectOption]":
options: list[nextcord.SelectOption] = [] # pylint: disable=unsubscriptable-object
boss_dict = highscores_data[boss_name]
for category in boss_dict["categories"].items():
options.append(nextcord.SelectOption(label=category[0]))
return options
class SubmissionDropdown(nextcord.ui.Select):
"""Defines dropdown menu for submission"""
def __init__(
self,
bot: commands.Bot,
options: "list[nextcord.SelectOption]",
):
super().__init__(
placeholder="Choose submission category.", min_values=1, max_values=1, options=options
)
self._bot = bot
async def callback(self, interaction: nextcord.Interaction):
embed = interaction.message.embeds[0]
embed.add_field(name="Category", value=self.values[0], inline=False)
await interaction.message.edit(
embed=embed, # TODO solve ordering issue. currently have to choose category after score submission.
)
class SubmissionDropdownView(nextcord.ui.View):
"""Defines submission dropdown process view"""
def __init__(
self,
bot: commands.Bot,
prev_interaction: nextcord.Interaction,
options: "list[nextcord.SelectOption]",
*,
timeout: Optional[float] = 180,
):
super().__init__(timeout=timeout)
self.add_item(SubmissionDropdown(bot, options))
self._prev_interaction = prev_interaction
self.bot = bot
async def interaction_check(self, interaction: nextcord.Interaction) -> bool:
return self._prev_interaction.user == interaction.user
@nextcord.ui.button(
label="Submit Score", style=nextcord.ButtonStyle.green, custom_id="submit-score"
)
async def submit_button(
self, button: nextcord.ui.Button, interaction: nextcord.Interaction
): # pylint: disable=unused-argument
"""Defines button to submit a user's score."""
verification_channel_id = highscores_data["verification_channel_id"]
channel = self.bot.get_channel(verification_channel_id)
error_response = "Registered Verification channel does not exist or was never registered. \
Contact server admins."
assert channel is not None, await channel.send(error_response)
await channel.send(
files=[await attch.to_file() for attch in interaction.message.attachments],
view=VerificationView(),
embed=interaction.message.embeds[0],
)
await interaction.message.edit(content=f"<@{interaction.user.id}> Submitted!", view=None)
@nextcord.ui.button(
label="Cancel", style=nextcord.ButtonStyle.red, custom_id="cancel-submission"
)
async def cancel_button(
self, button: nextcord.ui.Button, interaction: nextcord.Interaction
): # pylint: disable=unused-argument
"""Deletes message to cancel interaction."""
await interaction.message.delete()
+42
View File
@@ -0,0 +1,42 @@
"""View for verification buttons"""
import nextcord
from utilities.utils import submit_score # pylint: disable=import-error
class VerificationView(nextcord.ui.View):
"""Defines views for verifying score submissions"""
def __init__(self):
super().__init__(timeout=None)
@nextcord.ui.button(label="Approve", style=nextcord.ButtonStyle.green, custom_id="approve")
async def approve_button(
self, button: nextcord.ui.Button, interaction: nextcord.Interaction
): # pylint: disable=unused-argument
"""Button for approving score submission."""
content = interaction.message.embeds[0].to_dict()
for field in content["fields"]:
if field["name"] == "Boss":
boss_name = field["value"]
elif field["name"] == "Category":
category = field["value"]
elif field["name"] == "Score":
score = field["value"]
elif field["name"] == "User":
user = field["value"]
try:
await submit_score(interaction, user, boss_name, category, score)
await interaction.message.edit("Approved.", view=None)
except UnboundLocalError:
await interaction.send("Instruct user to submit with all fields.")
await interaction.message.edit(view=None)
@nextcord.ui.button(label="Deny", style=nextcord.ButtonStyle.red, custom_id="deny")
async def deny_button(
self, button: nextcord.ui.Button, interaction: nextcord.Interaction
): # pylint: disable=unused-argument
"""Button for denying score submission."""
await interaction.message.delete()
@@ -179,6 +179,10 @@
{ {
"boss": "Yakamaru", "boss": "Yakamaru",
"hardmode": false "hardmode": false
},
{
"boss": "Zamorak, Lord of Chaos",
"hardmode": true
} }
], ],
"categories": { "categories": {
+7 -4
View File
@@ -9,7 +9,9 @@ import nextcord
from nextcord.ext import commands from nextcord.ext import commands
import config import config
from utils import data_storage from utilities.data_storage import open_highscores_config
from utilities.data_storage import open_highscores_data
from utilities.data_storage import open_message_map
logger = logging.getLogger("nextcord") logger = logging.getLogger("nextcord")
logger.setLevel(logging.DEBUG) logger.setLevel(logging.DEBUG)
@@ -18,8 +20,9 @@ handler.setFormatter(logging.Formatter("%(asctime)s:%(levelname)s:%(name)s: %(me
logger.addHandler(handler) logger.addHandler(handler)
highscores_config = data_storage.open_highscores_config() highscores_config = open_highscores_config()
highscores_data = data_storage.open_highscores_data() highscores_data = open_highscores_data()
highscores_message_map = open_message_map()
def main(): def main():
@@ -29,7 +32,7 @@ def main():
intents = nextcord.Intents.default() intents = nextcord.Intents.default()
# Required in order to read messages (eg. prefix commands) # Required in order to read messages (eg. prefix commands)
intents.message_content = True intents.message_content = True # pylint: disable=assigning-non-slot
# To enable the guilds priveleged intent: # To enable the guilds priveleged intent:
# intents.guilds = True # intents.guilds = True
@@ -1,12 +1,21 @@
""" """Functions for retreiving and storing highscores data and configurations."""
Contains functions for saving and loading highscore data and configs.
"""
import json
import os import os
import json
HIGHSCORES_CONFIG_FILE = "highscores_config.json" HIGHSCORES_CONFIG_FILE = "highscores_config.json"
HIGHSCORES_DATA_FILE = "highscores_data.json" HIGHSCORES_DATA_FILE = "highscores_data.json"
HIGHSCORES_MESSAGE_MAP_FILE = "highscores_message_map.json"
def open_highscores_config():
"""
Opens the highscores config file and returns.
@return: dict of highscores config.
"""
# Load bot config
with open(HIGHSCORES_CONFIG_FILE, encoding="utf-8", mode="r") as file:
return json.load(file)
def open_highscores_data(): def open_highscores_data():
@@ -19,7 +28,7 @@ def open_highscores_data():
data = json.load(file) data = json.load(file)
else: else:
# create the json object # create the json object
data = {"channel_id": -1} data = {"highscore_channel_id": -1, "verification_channel_id": -1}
config = open_highscores_config() config = open_highscores_config()
for boss in config["bosses"]: for boss in config["bosses"]:
data[boss["boss"]] = {"message_id": 0} data[boss["boss"]] = {"message_id": 0}
@@ -34,14 +43,18 @@ def open_highscores_data():
return data return data
def open_highscores_config(): def open_message_map():
""" """
Opens the highscores config file and returns. Opens a highscore_message_map.json file if one exists. Otherwise returns empty dict.
@return: dict of highscores config. @return: dict message_map of message to boss.
""" """
# Load bot config if os.path.exists(HIGHSCORES_MESSAGE_MAP_FILE):
with open(HIGHSCORES_CONFIG_FILE, encoding="utf-8", mode="r") as file: with open(HIGHSCORES_MESSAGE_MAP_FILE, encoding="utf-8", mode="r") as file:
return json.load(file) message_map = json.load(file)
else:
# create the json object
message_map = {}
return message_map
def save_highscores_data(data): def save_highscores_data(data):
@@ -51,3 +64,12 @@ def save_highscores_data(data):
""" """
with open(HIGHSCORES_DATA_FILE, encoding="utf-8", mode="w") as file: with open(HIGHSCORES_DATA_FILE, encoding="utf-8", mode="w") as file:
file.write(json.dumps(data, indent=4)) file.write(json.dumps(data, indent=4))
def save_message_map(message_map):
"""
Saves the highscores message mao data dict into a json file.
@param map: dict map of message to boss.
"""
with open(HIGHSCORES_MESSAGE_MAP_FILE, encoding="utf-8", mode="w") as file:
file.write(json.dumps(message_map, indent=4))
+118
View File
@@ -0,0 +1,118 @@
"""
Contains various utlity functions for highscores bot
"""
import nextcord
from highscores import highscores_config # pylint: disable=import-error
from highscores import highscores_data # pylint: disable=import-error
from highscores import highscores_message_map # pylint: disable=import-error
from utilities.data_storage import save_highscores_data # pylint: disable=import-error
from utilities.data_storage import save_message_map # pylint: disable=import-error
def format_highscore_message(boss_name: str):
"""
returns a formatted string for a boss's highscore
@param boss: the dictionary object for the boss
@return the formatted string
"""
ret_string = f"**{boss_name}**\n```"
boss_data = highscores_data[boss_name]
# Gather all categories and add to string
for key, value in boss_data["categories"].items():
ret_string += f"{key}".ljust(30, " ")
ret_string += "\n"
highscore_size = highscores_config["highscore_size"]
# list rankings in a single line. Start with first place for each category and then continue
for i in range(highscore_size):
for key, value in boss_data["categories"].items():
if len(value) > i:
score = value[i]
ret_string += f"{i+1}: {score[0]} - {score[1]}".ljust(30, " ")
else:
ret_string += f"{i+1}: submit your score".ljust(30, " ")
ret_string += "\n"
return ret_string + "```"
async def send_highscore_message(channel, boss_name: str) -> nextcord.Message:
"""
Function takes care of checking if a message exists for a boss, then
creating and sending/editing the message
@param channel: the channel to send the message in/search for message id
@param boss: the boss to send the message about
"""
highscore_string = format_highscore_message(boss_name)
message_id = highscores_data[boss_name]["message_id"]
try:
message: nextcord.Message = await channel.fetch_message(message_id)
await message.edit(content=highscore_string)
except nextcord.NotFound:
# message doesn't exist.
message: nextcord.Message = await channel.send(highscore_string)
message_id = message.id
highscores_data[boss_name]["message_id"] = message_id
# save message -> boss_name in message_map
highscores_message_map[str(message_id)] = boss_name
save_message_map(highscores_message_map)
return message
async def submit_score(
interaction: nextcord.Interaction, user: str, boss_name: str, category: str, score: str
):
"""
Adds a score to the high scores and sorts. Removes a score if larger than size limit.
@param boss: the boss to add score to
@param category: the category to add score to
@param user: user who submitted score
@param score: score (int) to add
"""
# TODO update user submission to not have dupe users
# create score tuple for either time or int
# define sort index
if highscores_config["categories"][category]["is_time_record"]:
minutes = score.split(":")[0]
seconds = score.split(":")[1]
score_seconds = int(minutes) * 60 + int(seconds)
score_tuple = (user, score, score_seconds)
sort_index = 2
else:
score_tuple = (user, int(score))
sort_index = 1
scores = highscores_data[boss_name]["categories"][category]
scores.append(score_tuple)
# sort scores.
scores.sort(
key=lambda x: x[sort_index],
reverse=not highscores_config["categories"][category]["ascending"],
)
# enforce highscore size
while len(scores) > highscores_config["highscore_size"]:
scores.pop()
highscores_data[boss_name]["categories"][category] = scores
# edit message
highscore_channel_id = highscores_data["highscore_channel_id"]
print(f"Editting message {highscore_channel_id}")
channel = interaction.guild.get_channel(highscore_channel_id)
error_response = 'Registered Highscores channel does not exist or was never registered. \
Register with "?register" command.'
assert channel is not None, await interaction.send(error_response)
await send_highscore_message(channel, boss_name)
# save data
save_highscores_data(highscores_data)
-60
View File
@@ -1,60 +0,0 @@
"""
Contains various functions for managing the highscores data
"""
from nextcord.ext import commands
from highscores import highscores_config # pylint: disable=import-error
from highscores import highscores_data # pylint: disable=import-error
from utils import highscore_message # pylint: disable=import-error
from utils import data_storage # pylint: disable=import-error
async def submit_score(self, ctx: commands.Context, boss_name: str, category: str, score: str):
"""
Adds a score to the high scores and sorts. Removes a score if larger than size limit.
@param boss: the boss to add score to
@param category: the category to add score to
@param user: user who submitted score
@param score: score (int) to add
"""
# TODO update user submission to not have dupe users
# create score tuple for either time or int
# define sort index
if highscores_config["categories"][category]["is_time_record"]:
score_list = score.split(":")
minutes = score_list[0]
seconds = score_list[1]
score_seconds = int(minutes) * 60 + int(seconds)
score_tuple = (ctx.author.display_name, score, score_seconds)
sort_index = 2
else:
score_tuple = (ctx.author.display_name, int(score))
sort_index = 1
scores = highscores_data[boss_name]["categories"][category]
scores.append(score_tuple)
# sort scores.
ascending = highscores_config["categories"][category]["ascending"]
scores.sort(key=lambda x: x[sort_index], reverse=not ascending)
# enforce highscore size
while len(scores) > highscores_config["highscore_size"]:
scores.pop()
highscores_data[boss_name]["categories"][category] = scores
# edit message
channel_id = highscores_data["channel_id"]
print(f"Editting message {channel_id}")
channel = self.bot.get_channel(channel_id)
if channel is None:
response = 'Registered Highscores channel does not exist or was never registered. \
Register with "?register" command.'
await ctx.send(response)
return
await highscore_message.send_highscore_message(channel, boss_name)
# save data
data_storage.save_highscores_data(highscores_data)
-56
View File
@@ -1,56 +0,0 @@
"""
Contains various functions for sending/editing the highscore messages.
"""
import nextcord
from highscores import highscores_config # pylint: disable=import-error
from highscores import highscores_data # pylint: disable=import-error
def format_highscore_message(boss_name: str):
"""
returns a formatted string for a boss's highscore
@param boss: the dictionary object for the boss
@return the formatted string
"""
ret_string = f"**{boss_name}**\n```"
boss_data = highscores_data[boss_name]
# Gather all categories and add to string
for key, value in boss_data["categories"].items():
ret_string += f"{key}".ljust(30, " ")
ret_string += "\n"
highscore_size = highscores_config["highscore_size"]
# list rankings in a single line. Start with first place for each category and then continue
for i in range(highscore_size):
for key, value in boss_data["categories"].items():
if len(value) > i:
score = value[i]
ret_string += f"{i+1}: {score[0]} - {score[1]}".ljust(30, " ")
else:
ret_string += f"{i+1}: submit your score".ljust(30, " ")
ret_string += "\n"
return ret_string + "```"
async def send_highscore_message(channel, boss_name: str):
"""
Function takes care of checking if a message exists for a boss, then
creating and sending/editing the message
@param channel: the channel to send the message in/search for message id
@param boss: the boss to send the message about
"""
highscore_string = format_highscore_message(boss_name)
message_id = highscores_data[boss_name]["message_id"]
try:
message = await channel.fetch_message(message_id)
await message.edit(content=highscore_string)
except nextcord.NotFound:
# message doesn't exist.
message = await channel.send(highscore_string)
message_id = message.id
highscores_data[boss_name]["message_id"] = message_id