aboutsummaryrefslogtreecommitdiff
path: root/starboard
diff options
context:
space:
mode:
authorArjun Satarkar <me@arjunsatarkar.net>2024-03-20 03:07:54 +0000
committerArjun Satarkar <me@arjunsatarkar.net>2024-03-20 03:07:54 +0000
commit16aeaa50db79e3c17194128a93d22370bf5daa33 (patch)
treecbcef052ca3afb49274513446514438fa1ed1604 /starboard
parent92a0d3eb4fd919ff9ed33b81d379ccb77af43026 (diff)
downloadaps-cogs-16aeaa50db79e3c17194128a93d22370bf5daa33.tar
aps-cogs-16aeaa50db79e3c17194128a93d22370bf5daa33.tar.gz
aps-cogs-16aeaa50db79e3c17194128a93d22370bf5daa33.zip
markov: avoid float division in uint_to_bytes
It seems as though the float division could cause an issue where the actual value should be an integer but the float representation is slightly higher than that, causing the addition of an extra unnecessary byte. Although this works fine as long as the same function is used, it could cause problems if seemingly inconsequential details change. I switch to using divmod and checking for the presence of a remainder. This should ensure use of the exact minimum required number of bytes in the blob.
Diffstat (limited to 'starboard')
-rw-r--r--starboard/__init__.py5
-rw-r--r--starboard/info.json5
-rw-r--r--starboard/starboard.py143
3 files changed, 153 insertions, 0 deletions
diff --git a/starboard/__init__.py b/starboard/__init__.py
new file mode 100644
index 0000000..eeb3d75
--- /dev/null
+++ b/starboard/__init__.py
@@ -0,0 +1,5 @@
+from .starboard import Starboard
+
+
+async def setup(bot):
+ await bot.add_cog(Starboard(bot))
diff --git a/starboard/info.json b/starboard/info.json
new file mode 100644
index 0000000..af11ade
--- /dev/null
+++ b/starboard/info.json
@@ -0,0 +1,5 @@
+{
+ "author": ["Arjun Satarkar"],
+ "description": "Create starboards in your server.",
+ "short": "Create starboards in your server."
+}
diff --git a/starboard/starboard.py b/starboard/starboard.py
new file mode 100644
index 0000000..751c7c3
--- /dev/null
+++ b/starboard/starboard.py
@@ -0,0 +1,143 @@
+import asyncio
+import discord
+import redbot.core
+from redbot.core import Config
+from redbot.core import commands
+
+
+class Starboard(commands.Cog):
+ def __init__(self, bot):
+ self.bot = bot
+ self.config = Config.get_conf(
+ self, identifier="551742410770612234|31374c1f-a5e9-470a-8fed-1137e980f27a"
+ )
+ self.config.register_guild(starboards={})
+
+ def emoji_as_sendable_text(self, emoji: discord.Emoji | discord.PartialEmoji | str):
+ if isinstance(emoji, str):
+ return emoji
+ if emoji.animated:
+ return f"<a:{emoji.name}:{emoji.id}>"
+ else:
+ return f"<:{emoji.name}:{emoji.id}>"
+
+ @commands.group()
+ async def starboard(self, _ctx):
+ pass
+
+ @starboard.command()
+ @commands.admin_or_permissions(manage_guild=True)
+ async def add(self, ctx, name: str, channel: discord.TextChannel, threshold: int):
+ if threshold < 1:
+ await ctx.reply("Error: threshold must be 1 or higher.")
+ return
+ async with self.config.guild(ctx.guild).starboards() as starboards:
+ if name in starboards:
+ await ctx.reply(
+ "Error: a starboard with that name already exists (see `starboard list`)."
+ )
+ return
+ starboards[name] = {
+ "channel_id": channel.id,
+ "threshold": threshold,
+ "allow_all_reactions": False,
+ "reactions": {
+ "unicode": {},
+ "custom": {},
+ },
+ }
+
+ wait_message_id = (
+ await ctx.reply(
+ f"Creating starboard ``{name}`` posting to {channel.mention} requiring {threshold} reactions."
+ "\nReact to this message with all reactions you want the bot to consider for this starboard,"
+ " then send DONE, or else type ANY to check for all reactions. If you don't react, ⭐ will"
+ " be chosen by default.",
+ allowed_mentions=discord.AllowedMentions.none(),
+ )
+ ).id
+
+ try:
+ done_message = await self.bot.wait_for(
+ "message",
+ check=lambda m: m.content.lower() in ["done", "any"],
+ timeout=120,
+ )
+ except asyncio.TimeoutError:
+ await ctx.send(
+ f"Error: timed out; cancelling creation of starboard ``{name}``.",
+ allowed_mentions=discord.AllowedMentions.none(),
+ )
+ del starboards[name]
+ return
+
+ # Accumulated to easily post the confirmation message
+ emoji_text_list = []
+ match done_message.content.lower():
+ case "done":
+ reactions = (
+ await ctx.channel.fetch_message(wait_message_id)
+ ).reactions
+ if not reactions:
+ starboards[name]["reactions"]["unicode"]["⭐"] = 1
+ emoji_text_list.append("⭐")
+ else:
+ for reaction in reactions:
+ emoji = reaction.emoji
+ if isinstance(emoji, str):
+ starboards[name]["reactions"]["unicode"][emoji] = 1
+ else:
+ starboards[name]["reactions"]["custom"][emoji.id] = 1
+ emoji_text_list.append(self.emoji_as_sendable_text(emoji))
+ case "any":
+ starboards[name]["allow_all_reactions"] = True
+
+ confirmation_text = f"Created starboard ``{name}`` posting to {channel.mention} and requiring {threshold}"
+ if not emoji_text_list:
+ confirmation_text += " of any emoji."
+ else:
+ confirmation_text += f" reactions of {redbot.core.utils.chat_formatting.humanize_list(emoji_text_list, style='or')}."
+ await ctx.send(
+ confirmation_text, allowed_mentions=discord.AllowedMentions.none()
+ )
+
+ @starboard.command()
+ @commands.admin_or_permissions(manage_guild=True)
+ async def remove(self, ctx, name: str):
+ async with self.config.guild(ctx.guild).starboards() as starboards:
+ try:
+ del starboards[name]
+ except KeyError:
+ await ctx.reply(
+ "Error: no starboard found with that name (see `starboard list`)."
+ )
+ else:
+ await ctx.reply("Removed that starboard.")
+
+ @starboard.command()
+ async def list(self, ctx):
+ starboards = await self.config.guild(ctx.guild).starboards()
+ list_text = "Name, Channel, Threshold, Reactions"
+ for name in starboards:
+ starboard = starboards[name]
+ list_text += (
+ f"\n* ``{name}``, {ctx.guild.get_channel(starboard['channel_id']).mention},"
+ f" {starboard['threshold']}, "
+ )
+ if starboard["allow_all_reactions"]:
+ list_text += "*any*"
+ else:
+ emoji_list = []
+ for emoji in starboard["reactions"]["custom"]:
+ emoji_list.append(
+ self.emoji_as_sendable_text(self.bot.get_emoji(int(emoji)))
+ )
+ for emoji in starboard["reactions"]["unicode"]:
+ emoji_list.append(emoji)
+ list_text += redbot.core.utils.chat_formatting.humanize_list(emoji_list)
+ pages = [
+ *redbot.core.utils.chat_formatting.pagify(
+ discord.utils.escape_mentions(list_text)
+ )
+ ]
+ await redbot.core.utils.menus.menu(ctx, pages)