Removing TODOs.

.gitignore

@@ -131,4 +131,6 @@ dmypy.json
 nextcord.log
 
 # data file for bot
-highscores_data.json
+highscores_data.json
+highscores_message_map.json
+highscores_config.json

cogs/help/__init__.py

@@ -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))

cogs/help/help_command.py

@@ -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

cogs/post_highscores/__init__.py

@@ -3,52 +3,48 @@ Bot command to post the highscores
 """
 
 from nextcord.ext import commands
-import highscores  # pylint: disable=import-error
-from utils import data_storage  # pylint: disable=import-error
-from utils import message_formatter  # pylint: disable=import-error
+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_data  # pylint: disable=import-error
+from utilities.data_storage import save_highscores_data  # pylint: disable=import-error
+from utilities.utils import send_highscore_message  # pylint: disable=import-error
 
 
 class PostHighscores(commands.Cog, name="Post Highscores"):
-    """Actions of bot command"""
+    """Posts Highscores."""
 
     def __init__(self, bot: commands.Bot):
         self.bot = bot
 
     @commands.command(name="post-scores")
     async def post_highscores(self, ctx: commands.Context):
-        """A command which posts the highscore in the designated channel. Sends warning if no channel has been registered.
+        """
+        A command which posts the highscore in the designated channel.
+        Sends warning if no channel has been registered.
         Usage:
         ```
         ?post-scores
         ```
         """
-        # temporarily sending config data...
-        channel_id = highscores.highscores_data["channel_id"]
-        if (channel_id != -1):
-            print(
-                f"Printing out highscores information in channel {channel_id}")
-            channel = self.bot.get_channel(channel_id)
-            for boss in highscores.highscores_config["bosses"]:
-                highscore_string = message_formatter.format_boss_highscore(
-                    boss)
-                message = await channel.send(highscore_string)
-                message_id = message.id
+        highscore_channel_id = highscores_data["highscore_channel_id"]
+        print(f"Printing out highscores information in channel {highscore_channel_id}")
+        channel = self.bot.get_channel(highscore_channel_id)
 
-                # check if there is a dict for the boss in the highscores data
-                if not boss["boss"] in highscores.highscores_data:
-                    highscores.highscores_data[boss["boss"]] = {}
+        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)
 
-                highscores.highscores_data[boss["boss"]
-                                           ]["message_id"] = message_id
-        else:
-            response = "Highscores channel is not registered. Register with \"?register\" command."
-            await ctx.send(response)
+        for boss in highscores_config["bosses"]:
+            message: nextcord.Message = await send_highscore_message(channel, boss["boss"])
+            await message.edit(view=SubmissionButton())
 
-        data_storage.save_highscores_data(highscores.highscores_data)
+        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 functon to bot"""
+    """Adds function to bot"""
     bot.add_cog(PostHighscores(bot))

cogs/register_highscore_channel/__init__.py

@@ -3,33 +3,33 @@ Bot command to register the highscores channel
 """
 
 from nextcord.ext import commands
-import highscores  # pylint: disable=import-error
-from utils import data_storage  # pylint: disable=import-error
+from highscores import highscores_data  # pylint: disable=import-error
+from utilities.data_storage import save_highscores_data  # pylint: disable=import-error
 
 
 class RegisterHighscoreChannel(commands.Cog, name="Register HighScore Channel"):
-    """Actions of bot command"""
+    """Registers Highscore channel"""
 
     def __init__(self, bot: commands.Bot):
         self.bot = bot
 
-    @commands.command(name="register")
+    @commands.command(name="register-highscore")
     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:
         ```
-        ?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
         await ctx.send(f"Registered <#{ctx.channel.id}> as channel to post highscores in.")
-        highscores.highscores_data["channel_id"] = ctx.channel.id
-        data_storage.save_highscores_data(highscores.highscores_data)
+        highscores_data["highscore_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 functon to bot"""
+    """Adds function to bot"""
     bot.add_cog(RegisterHighscoreChannel(bot))

cogs/register_verification_channel/__init__.py

@@ -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))

cogs/score/__init__.py

@@ -0,0 +1,51 @@
+"""
+Bot command to submit a score
+"""
+
+from nextcord.ext import commands
+from highscores import highscores_data  # pylint: disable=import-error
+from utilities.utils import submit_score  # pylint: disable=import-error
+from .verification_view import VerificationView
+
+
+class Score(commands.Cog, name="Score"):
+    """Submits a score."""
+
+    def __init__(self, bot: commands.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")
+    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 information from command and passes on.
+        Usage:
+        ```
+        ?score "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.
+# It is necessary to add these functions to the bot.
+def setup(bot: commands.Bot):
+    """Adds function to bot"""
+    bot.add_cog(Score(bot))

cogs/score/verification_view.py

@@ -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()

cogs/submission/__init__.py

@@ -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))

cogs/submission/submission_views.py

@@ -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()

cogs/submission/verification_view.py

@@ -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()

example_config/runescape_bosses.json

@@ -2,201 +2,205 @@
     "bosses": [
         {
             "boss": "The Ambassador",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Araxxi",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "Arch-Glacor",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Astellarn",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "The Barrows Brothers",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "The Barrows: Rise of the Six",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "Beastmaster Durzag",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "Black Stone Dragon",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Chaos Elemental",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "Commander Zilyana",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Corporeal Beast",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "Crassian Leviathan",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Croesus",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "Dagannoth Kings",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "General Graardor",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Giant Mole",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Gregorovic",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Har-Aken",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "Helwyr",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Kalphite King",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "Kalphite Queen",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "Kerapac",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "King Black Dragon",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "Kree'arra",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "K'ril Tsutsaroth",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Legiones",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "The Magister",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "Masuta the Ascended",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Nex",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "Nex - Angel of Death",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "Queen Black Dragon",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "Raksha",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Rex Matriarchs",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "The Sanctum Guardian",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Seiryu the Azure Serpent",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Solak",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "Taraket the Necromancer",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Telos",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "The Twin Furies",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "TzKal-Zuk",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "TzTok-Jad",
-            "hardmode": "false"
+            "hardmode": false
         },
         {
             "boss": "Verak Lith",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Vindicta & Gorvek",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Vorago",
-            "hardmode": "true"
+            "hardmode": true
         },
         {
             "boss": "Yakamaru",
-            "hardmode": "false"
+            "hardmode": false
+        },
+        {
+            "boss": "Zamorak, Lord of Chaos",
+            "hardmode": true
         }
     ],
-    "categories": [
-        {
-            "category": "Kill Count",
+    "categories": {
+        "Kill Count": {
             "hardmode": true,
-            "ascending": false
+            "ascending": false,
+            "is_time_record": false
         },
-        {
-            "category": "Kill Time",
+        "Kill Time": {
             "hardmode": true,
-            "ascending": true
+            "ascending": true,
+            "is_time_record": true
         },
-        {
-            "category": "Spooned Log",
+        "Spooned Log": {
             "hardmode": false,
-            "ascending": true
+            "ascending": true,
+            "is_time_record": false
         }
-    ],
+    },
     "highscore_size": 3
 }

highscores.py

@@ -2,7 +2,6 @@
 main file for pvm-highscores bot
 """
 
-import json
 import logging
 import os
 
@@ -10,19 +9,20 @@ import nextcord
 from nextcord.ext import commands
 
 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)
-handler = logging.FileHandler(
-    filename='nextcord.log', encoding='utf-8', mode='w')
-handler.setFormatter(logging.Formatter(
-    '%(asctime)s:%(levelname)s:%(name)s: %(message)s'))
+handler = logging.FileHandler(filename="nextcord.log", encoding="utf-8", mode="w")
+handler.setFormatter(logging.Formatter("%(asctime)s:%(levelname)s:%(name)s: %(message)s"))
 logger.addHandler(handler)
 
 
-highscores_config = data_storage.open_highscores_config()
-highscores_data = data_storage.open_highscores_data()
+highscores_config = open_highscores_config()
+highscores_data = open_highscores_data()
+highscores_message_map = open_message_map()
 
 
 def main():
@@ -32,7 +32,7 @@ def main():
     intents = nextcord.Intents.default()
 
     # 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:
     # intents.guilds = True

utilities/data_storage.py

@@ -0,0 +1,75 @@
+"""Functions for retreiving and storing highscores data and configurations."""
+
+import os
+import json
+
+HIGHSCORES_CONFIG_FILE = "highscores_config.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():
+    """
+    Opens a highscores_data.json file if one exists, otherwise creates a skeleton of the data.
+    @return: dict of highscores data.
+    """
+    if os.path.exists(HIGHSCORES_DATA_FILE):
+        with open(HIGHSCORES_DATA_FILE, encoding="utf-8", mode="r") as file:
+            data = json.load(file)
+    else:
+        # create the json object
+        data = {"highscore_channel_id": -1, "verification_channel_id": -1}
+        config = open_highscores_config()
+        for boss in config["bosses"]:
+            data[boss["boss"]] = {"message_id": 0}
+            boss_categories = {}
+            for key, value in config["categories"].items():
+                rank_list = []
+                boss_categories[key] = rank_list
+                if boss["hardmode"] and value["hardmode"]:
+                    rank_list = []
+                    boss_categories["Hardmode " + key] = rank_list
+            data[boss["boss"]]["categories"] = boss_categories
+    return data
+
+
+def open_message_map():
+    """
+    Opens a highscore_message_map.json file if one exists. Otherwise returns empty dict.
+    @return: dict message_map of message to boss.
+    """
+    if os.path.exists(HIGHSCORES_MESSAGE_MAP_FILE):
+        with open(HIGHSCORES_MESSAGE_MAP_FILE, encoding="utf-8", mode="r") as file:
+            message_map = json.load(file)
+    else:
+        # create the json object
+        message_map = {}
+    return message_map
+
+
+def save_highscores_data(data):
+    """
+    Saves the highscores data dict into a json file.
+    @param data: dict of highscores data.
+    """
+    with open(HIGHSCORES_DATA_FILE, encoding="utf-8", mode="w") as file:
+        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))

utilities/utils.py

@@ -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)

utils/data_storage.py

@@ -1,43 +0,0 @@
-"""
-Contains functions for saving and loading highscore data and configs.
-"""
-
-import json
-import os
-
-HIGHSCORES_CONFIG_FILE = "highscores_config.json"
-HIGHSCORES_DATA_FILE = "highscores_data.json"
-
-
-def open_highscores_data():
-    """
-    Opens a highscores_data.json file if one exists, otherwise creates a skeleton of the data.
-    @return: dict of highscores data.
-    """
-    if (os.path.exists(HIGHSCORES_DATA_FILE)):
-        with open(HIGHSCORES_DATA_FILE, encoding='utf-8', mode="r") as file:
-            data = json.load(file)
-    else:
-        # create the json object
-        data = {}
-
-    return data
-
-
-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 save_highscores_data(data):
-    """
-    Saves the highscores data dict into a json file.
-    @param: dict of highscores data.
-    """
-    with open(HIGHSCORES_DATA_FILE, encoding='utf-8', mode='w') as file:
-        file.write(json.dumps(data, indent=4))

utils/message_formatter.py

@@ -1,45 +0,0 @@
-"""
-Contains various function to format the highscore messages
-"""
-
-import highscores  # pylint: disable=import-error
-
-
-def format_boss_highscore(boss):
-    """
-    returns a formattedd string for a boss's highscore
-    @param the dictionary object for the boss
-    @return the formatted string
-    """
-    boss_name = boss["boss"]
-    ret_string = f"**{boss_name}**\n"
-
-    # Gather all categories and add to string
-    for category in highscores.highscores_config["categories"]:
-        category_name = category["category"]
-        ret_string += f"{category_name}\t\t"
-    ret_string += "\n"
-
-    highscore_size = highscores.highscores_config["highscore_size"]
-
-    # list rankings
-    for i in range(highscore_size):
-        for category in highscores.highscores_config["categories"]:
-            ret_string += f"{i+1}: (name here)\t\t"
-        ret_string += "\n"
-
-    # if boss is hardmode, repeat above for hardmode applicable categories
-    if boss["hardmode"]:
-        for category in highscores.highscores_config["categories"]:
-            if category["hardmode"]:
-                category_name = category["category"]
-                ret_string += f"{category_name}\t\t"
-
-        ret_string += "\n"
-
-        for i in range(highscore_size):
-            for category in highscores.highscores_config["categories"]:
-                if category["hardmode"]:
-                    ret_string += f"{i+1}: (name here)\t\t"
-            ret_string += "\n"
-    return ret_string