base

LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 Jamie
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

README.md

@@ -1,3 +1,9 @@
 # Ava Cogs
 
 ## This repository is being built for our fork of Red-DiscordBot
+
+Credits will be below:
+[Aikaterna's Cogs](https://github.com/aikaterna/aikaterna-cogs)
+[Preda's Cogs](https://github.com/PredaaA/predacogs)
+[Flare's Pokecord-Red](https://github.com/flaree/pokecord-red)
+[HollowStrawberry's Crab Cogs](https://github.com/hollowstrawberry/crab-cogs)

audioslash/__init__.py

@@ -0,0 +1,7 @@
+from .audioslash import AudioSlash
+from redbot.core.utils import get_end_user_data_statement
+
+__red_end_user_data_statement__ = get_end_user_data_statement(__file__)
+
+async def setup(bot):
+    await bot.add_cog(AudioSlash(bot))

audioslash/audioslash.py

@@ -0,0 +1,446 @@
+import os
+import re
+import logging
+import asyncio
+import discord
+from copy import copy
+from typing import Optional
+from yt_dlp import YoutubeDL
+from yt_dlp.utils import YoutubeDLError
+from redbot.core import commands, app_commands
+from redbot.core.bot import Red, Config
+from redbot.core.commands import Cog
+from redbot.cogs.audio.core import Audio
+from redbot.cogs.audio.utils import PlaylistScope
+from redbot.cogs.audio.converters import PlaylistConverter, ScopeParser
+from redbot.cogs.audio.apis.playlist_interface import get_all_playlist
+
+log = logging.getLogger("red.crab-cogs.audioslash")
+
+LANGUAGE = "en"
+EXTRACT_CONFIG = {
+    "extract_flat": True,
+    "outtmpl": "%(title).85s.mp3",
+    "extractor_args": {"youtube": {"lang": [LANGUAGE]}},
+}
+DOWNLOAD_CONFIG = {
+    "extract_audio": True,
+    "format": "bestaudio",
+    "outtmpl": "%(title).85s.mp3",
+    "extractor_args": {"youtube": {"lang": [LANGUAGE]}},
+}
+DOWNLOAD_FOLDER = "backup"
+YOUTUBE_LINK_PATTERN = re.compile(r"(https?://)?(www\.)?(youtube.com/watch\?v=|youtu.be/)([\w\-]+)")
+MAX_VIDEO_LENGTH = 600
+
+MAX_OPTIONS = 25
+MAX_OPTION_SIZE = 100
+
+async def extract_info(ydl: YoutubeDL, url: str) -> dict:
+    return await asyncio.to_thread(ydl.extract_info, url, False)  # noqa
+
+async def download_video(ydl: YoutubeDL, url: str) -> dict:
+    return await asyncio.to_thread(ydl.extract_info, url)  # noqa
+
+def format_youtube(res: dict) -> str:
+    if res.get("duration", None):
+        m, s = divmod(int(res['duration']), 60)
+        name = f"({m}:{s:02d}) {res['title']}"
+    else:
+        name = f"(🔴LIVE) {res['title']}"
+    
+    author = f" — {res['channel']}"
+    if len(author) > MAX_OPTION_SIZE // 2:
+        author = author[:MAX_OPTION_SIZE//2 - 3] + "..."
+    
+    if len(name) + len(author) > MAX_OPTION_SIZE:
+        return name[:MAX_OPTION_SIZE - len(author) - 3] + "..." + author
+    else:
+        return name + author
+
+
+class AudioSlash(Cog):
+    """Audio cog commands in the form of slash commands, with YouTube and playlist autocomplete."""
+
+    def __init__(self, bot: Red, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.bot = bot
+        self.config = Config.get_conf(self, identifier=77241349)
+        self.config.register_guild(**{"backup_mode": False})
+
+    async def get_audio_cog(self, inter: discord.Interaction) -> Optional[Audio]:
+        cog: Optional[Audio] = self.bot.get_cog("Audio")
+        if cog:
+            return cog
+        await inter.response.send_message("Audio cog not loaded! Contact the bot owner for more information.", ephemeral=True)
+
+    async def get_context(self, inter: discord.Interaction, cog: Audio) -> commands.Context:
+        ctx: commands.Context = await self.bot.get_context(inter)  # noqa
+        ctx.command.cog = cog
+        return ctx
+
+    async def can_run_command(self, ctx: commands.Context, command_name: str) -> bool:
+        prefix = await self.bot.get_prefix(ctx.message)
+        prefix = prefix[0] if isinstance(prefix, list) else prefix
+        fake_message = copy(ctx.message)
+        fake_message.content = prefix + command_name
+        command = ctx.bot.get_command(command_name)
+        fake_context: commands.Context = await ctx.bot.get_context(fake_message)  # noqa
+        try:
+            can = await command.can_run(fake_context, check_all_parents=True, change_permission_state=False)
+        except commands.CommandError:
+            can = False
+        if not can:
+            await ctx.send("You do not have permission to do this.", ephemeral=True)
+        return can
+
+
+    @app_commands.command()
+    @app_commands.guild_only
+    @app_commands.describe(search="Type here to get suggestions, or send anything to get a best match.",
+                           when="You can choose when this track will play in the queue.")
+    @app_commands.choices(when=[app_commands.Choice(name="Add to the end of the queue.", value="end"),
+                                app_commands.Choice(name="Play after the current song.", value="next"),
+                                app_commands.Choice(name="Start playing immediately.", value="now")])
+    async def play(self, inter: discord.Interaction, search: str, when: Optional[str]):
+        """Search a YouTube video to play in voicechat."""
+        if not (audio := await self.get_audio_cog(inter)):
+            return
+        ctx = await self.get_context(inter, audio)
+        search = search.strip()
+
+        if await self.config.guild(ctx.guild).backup_mode():
+            if not audio.local_folder_current_path:
+                await ctx.send("Connect bot to a voice channel first")
+                return
+                
+            if not search.startswith(DOWNLOAD_FOLDER + "/"):
+                if match := YOUTUBE_LINK_PATTERN.match(search):
+                    search = match.group(0)
+                else:
+                    search = "ytsearch1:" + search
+    
+                (audio.local_folder_current_path / DOWNLOAD_FOLDER).mkdir(parents=True, exist_ok=True)
+                ydl = YoutubeDL(EXTRACT_CONFIG)
+                video_info = await extract_info(ydl, search)
+                if video_info.get("entries", None):
+                    video_info = video_info["entries"][0]
+        
+                if "duration" not in video_info or video_info["duration"] > MAX_VIDEO_LENGTH:
+                    await ctx.send("Video too long or invalid!")
+                    return
+        
+                filename = ydl.prepare_filename(video_info)
+                if not os.path.exists(filename):
+                    await ctx.send(f"Downloading `{filename}` ...")
+                    ydl = YoutubeDL(DOWNLOAD_CONFIG)
+                    os.chdir(audio.local_folder_current_path / DOWNLOAD_FOLDER)
+                    await download_video(ydl, search)
+                    
+                search = DOWNLOAD_FOLDER + "/" + filename
+                
+        if when in ("next", "now"):
+            if not await self.can_run_command(ctx, "bumpplay"):
+                return
+            await audio.command_bumpplay(ctx, when == "now", query=search)
+        else:
+            if not await self.can_run_command(ctx, "play"):
+                return
+            await audio.command_play(ctx, query=search)
+
+
+    @app_commands.command()
+    @app_commands.guild_only
+    async def pause(self, inter: discord.Interaction):
+        """Pauses or resumes the music in voicechat."""
+        if not (audio := await self.get_audio_cog(inter)):
+            return
+        ctx = await self.get_context(inter, audio)
+        if not await self.can_run_command(ctx, "pause"):
+            return
+        await audio.command_pause(ctx)
+
+    @app_commands.command()
+    @app_commands.guild_only
+    async def stop(self, inter: discord.Interaction):
+        """Stops playing any music entirely."""
+        if not (audio := await self.get_audio_cog(inter)):
+            return
+        ctx = await self.get_context(inter, audio)
+        if not await self.can_run_command(ctx, "stop"):
+            return
+        await audio.command_stop(ctx)
+
+    @app_commands.command()
+    @app_commands.guild_only
+    @app_commands.describe(position="Will skip to this track in the queue.")
+    async def skip(self, inter: discord.Interaction, position: Optional[app_commands.Range[int, 1, 1000]]):
+        """Skips a number of tracks in the music queue."""
+        if not (audio := await self.get_audio_cog(inter)):
+            return
+        ctx = await self.get_context(inter, audio)
+        if not await self.can_run_command(ctx, "skip"):
+            return
+        await audio.command_skip(ctx, position)
+
+    @app_commands.command()
+    @app_commands.guild_only
+    async def queue(self, inter: discord.Interaction):
+        """Show what's currently playing."""
+        if not (audio := await self.get_audio_cog(inter)):
+            return
+        ctx = await self.get_context(inter, audio)
+        if not await self.can_run_command(ctx, "queue"):
+            return
+        await audio.command_queue(ctx)
+
+    toggle = [app_commands.Choice(name="Enabled", value="1"),
+              app_commands.Choice(name="Disabled", value="0")]
+
+    @app_commands.command()
+    @app_commands.guild_only
+    @app_commands.describe(volume="New volume value between 1 and 150.")
+    async def volume(self, inter: discord.Interaction, volume: app_commands.Range[int, 1, 150]):
+        """Sets the music volume in voicechat."""
+        if not (audio := await self.get_audio_cog(inter)):
+            return
+        ctx = await self.get_context(inter, audio)
+        if not await self.can_run_command(ctx, "volume"):
+            return
+        await audio.command_volume(ctx, volume)
+
+    @app_commands.command()
+    @app_commands.guild_only
+    @app_commands.describe(toggle="Enable or disable track shuffling.")
+    @app_commands.choices(toggle=toggle)
+    async def shuffle(self, inter: discord.Interaction, toggle: str):
+        """Sets whether the playlist should be shuffled."""
+        if not (audio := await self.get_audio_cog(inter)):
+            return
+        ctx = await self.get_context(inter, audio)
+        value = bool(int(toggle))
+        if value != await audio.config.guild(ctx.guild).shuffle():
+            if not await self.can_run_command(ctx, "shuffle"):
+                return
+            await audio.command_shuffle(ctx)
+        else:
+            embed = discord.Embed(title="Setting Unchanged", description="Shuffle tracks: " + ("Enabled" if value else "Disabled"))
+            await audio.send_embed_msg(ctx, embed=embed)
+
+    @app_commands.command()
+    @app_commands.guild_only
+    @app_commands.describe(toggle="Enable or disable track repeating.")
+    @app_commands.choices(toggle=toggle)
+    async def repeat(self, inter: discord.Interaction, toggle: str):
+        """Sets whether the playlist should repeat."""
+        if not (audio := await self.get_audio_cog(inter)):
+            return
+        ctx = await self.get_context(inter, audio)
+        value = bool(int(toggle))
+        if value != await audio.config.guild(ctx.guild).repeat():
+            if not await self.can_run_command(ctx, "repeat"):
+                return
+            await audio.command_repeat(ctx)
+        else:
+            embed = discord.Embed(title="Setting Unchanged", description="Repeat tracks: " + ("Enabled" if value else "Disabled"))
+            await audio.send_embed_msg(ctx, embed=embed)
+
+
+    playlist = app_commands.Group(name="playlist", description="Playlist commands", guild_only=True)
+
+    playlist_scopes = [app_commands.Choice(name="Personal", value="USERPLAYLIST"),
+                       app_commands.Choice(name="Server", value="GUILDPLAYLIST"),
+                       app_commands.Choice(name="Global", value="GLOBALPLAYLIST")]
+
+    @staticmethod
+    def get_scope_data(scope: str, ctx: commands.Context) -> ScopeParser:
+        return [scope, ctx.author, ctx.guild, False]  # noqa
+
+    @playlist.command(name="play")
+    @app_commands.describe(playlist="The name of the playlist.",
+                           shuffle="Whether to shuffle the playlist before sending it.")
+    async def playlist_play(self, inter: discord.Interaction, playlist: str, shuffle: Optional[bool]):
+        """Starts an existing playlist in voicechat."""
+        if not (audio := await self.get_audio_cog(inter)):
+            return
+        ctx = await self.get_context(inter, audio)
+        if not await self.can_run_command(ctx, "playlist play"):
+            return       
+        enabled = False
+        if shuffle is not None and shuffle != await audio.config.guild(ctx.guild).shuffle():
+            dj_enabled = audio._dj_status_cache.setdefault(ctx.guild.id, await audio.config.guild(ctx.guild).dj_enabled())
+            can_skip = await audio._can_instaskip(ctx, ctx.author)
+            if not dj_enabled or can_skip and await self.can_run_command(ctx, "shuffle"):
+                await audio.config.guild(ctx.guild).shuffle.set(shuffle)
+                enabled = shuffle
+        match = await PlaylistConverter().convert(ctx, playlist)
+        await audio.command_playlist_start(ctx, match)
+        if enabled:
+            await audio.config.guild(ctx.guild).shuffle.set(False)
+
+    @playlist.command(name="create")
+    @app_commands.describe(name="The name of the new playlist. Cannot contain spaces.",
+                           make_from_queue="This will fill the playlist with the current queue.",
+                           scope="Who this playlist will belong to. You need permissions for Server and Global.")
+    @app_commands.choices(scope=playlist_scopes)
+    async def playlist_create(self, inter: discord.Interaction, name: str, make_from_queue: Optional[bool], scope: Optional[str]):
+        """Creates a new playlist."""
+        if not (audio := await self.get_audio_cog(inter)):
+            return
+        name = name.replace(" ", "-")
+        ctx = await self.get_context(inter, audio)
+        if make_from_queue:
+            if not await self.can_run_command(ctx, "playlist queue"):
+                return
+            await audio.command_playlist_queue(ctx, name, scope_data=self.get_scope_data(scope, ctx))
+        else:
+            if not await self.can_run_command(ctx, "playlist create"):
+                return
+            await audio.command_playlist_create(ctx, name, scope_data=self.get_scope_data(scope, ctx))
+
+    @playlist.command(name="add")
+    @app_commands.describe(playlist="The name of the playlist.",
+                           track="The track to add to the playlist.",
+                           scope="You may specify who this playlist belongs to.")
+    @app_commands.choices(scope=playlist_scopes)
+    async def playlist_add(self, inter: discord.Interaction, playlist: str, track: str, scope: Optional[str]):
+        """Adds a track to an existing playlist."""
+        if not (audio := await self.get_audio_cog(inter)):
+            return
+        ctx = await self.get_context(inter, audio)
+        match = await PlaylistConverter().convert(ctx, playlist)
+        if not await self.can_run_command(ctx, "playlist append"):
+            return
+        await audio.command_playlist_append(ctx, match, track, scope_data=self.get_scope_data(scope, ctx))
+
+    @playlist.command(name="remove")
+    @app_commands.describe(playlist="The name of the playlist.",
+                           track="The link to the track to remove from the playlist.",
+                           scope="You may specify who this playlist belongs to.")
+    @app_commands.choices(scope=playlist_scopes)
+    async def playlist_remove(self, inter: discord.Interaction, playlist: str, track: str, scope: Optional[str]):
+        """Removes a track from an existing playlist."""
+        if not (audio := await self.get_audio_cog(inter)):
+            return
+        ctx = await self.get_context(inter, audio)
+        match = await PlaylistConverter().convert(ctx, playlist)
+        if not await self.can_run_command(ctx, "playlist remove"):
+            return
+        await audio.command_playlist_remove(ctx, match, track, scope_data=self.get_scope_data(scope, ctx))
+
+    @playlist.command(name="info")
+    @app_commands.describe(playlist="The name of the playlist to show.",
+                           scope="You may specify who this playlist belongs to.")
+    @app_commands.choices(scope=playlist_scopes)
+    async def playlist_info(self, inter: discord.Interaction, playlist: str, scope: Optional[str]):
+        """Show information about a playlist."""
+        if not (audio := await self.get_audio_cog(inter)):
+            return
+        ctx = await self.get_context(inter, audio)
+        match = await PlaylistConverter().convert(ctx, playlist)
+        if not await self.can_run_command(ctx, "playlist info"):
+            return
+        await audio.command_playlist_info(ctx, match, scope_data=self.get_scope_data(scope, ctx))
+
+    @playlist.command(name="delete")
+    @app_commands.describe(playlist="The name of the playlist to delete.",
+                           scope="You may specify who this playlist belongs to.")
+    @app_commands.choices(scope=playlist_scopes)
+    async def playlist_delete(self, inter: discord.Interaction, playlist: str, scope: Optional[str]):
+        """Deletes a playlist entirely."""
+        if not (audio := await self.get_audio_cog(inter)):
+            return
+        ctx = await self.get_context(inter, audio)
+        match = await PlaylistConverter().convert(ctx, playlist)
+        if not await self.can_run_command(ctx, "playlist delete"):
+            return
+        await audio.command_playlist_delete(ctx, match, scope_data=self.get_scope_data(scope, ctx))
+
+
+    @play.autocomplete("search")
+    @playlist_add.autocomplete("track")
+    async def youtube_autocomplete(self, inter: discord.Interaction, current: str):
+        try:
+            return await self._youtube_autocomplete(inter, current)
+        except Exception:  # noqa, reason: user-facing error
+            log.exception("YouTube autocomplete", stack_info=True)
+            return [app_commands.Choice(name="Autocomplete error. Please contact the bot owner.", value=".")]
+
+    async def _youtube_autocomplete(self, inter: discord.Interaction, current: str):
+        lst = []
+
+        if await self.config.guild(inter.guild).backup_mode():
+            audio = await self.get_audio_cog(inter)
+            if not audio or not audio.local_folder_current_path:
+                return lst
+            folder = (audio.local_folder_current_path / DOWNLOAD_FOLDER)
+            folder.mkdir(parents=True, exist_ok=True)
+            files = [app_commands.Choice(name=filename, value=f"{DOWNLOAD_FOLDER}/{filename}"[:MAX_OPTION_SIZE]) for
+                     filename in os.listdir(folder)]
+            if current:
+                lst += [file for file in files if file.name.lower().startswith(current.lower())]
+                lst += [file for file in files if
+                        current.lower() in file.name.lower() and not file.name.lower().startswith(current.lower())]
+            else:
+                lst += files
+
+        if not current or len(current) < 3 or len(lst) >= MAX_OPTIONS:
+            return lst[:MAX_OPTIONS]
+
+        try:
+            ydl = YoutubeDL(EXTRACT_CONFIG)
+            results = await extract_info(ydl, f"ytsearch{MAX_OPTIONS - len(lst)}:{current}")
+            lst += [app_commands.Choice(name=format_youtube(res), value=res["url"]) for res in results["entries"]]
+        except YoutubeDLError:
+            log.exception("Retrieving youtube results", stack_info=True)
+
+        return lst[:MAX_OPTIONS]
+
+
+    @playlist_play.autocomplete("playlist")
+    @playlist_add.autocomplete("playlist")
+    @playlist_remove.autocomplete("playlist")
+    @playlist_info.autocomplete("playlist")
+    @playlist_delete.autocomplete("playlist")
+    async def playlist_autocomplete(self, inter: discord.Interaction, current: str):
+        try:
+            return await self._playlist_autocomplete(inter, current)
+        except Exception:  # noqa, reason: user-facing error
+            log.exception("Playlist autocomplete")
+            return [app_commands.Choice(name="Autocomplete error. Please contact the bot owner.", value=".")]
+
+    async def _playlist_autocomplete(self, inter: discord.Interaction, current: str):
+        audio: Optional[Audio] = self.bot.get_cog("Audio")
+        if not audio or not audio.playlist_api:
+            return []
+
+        global_matches = await get_all_playlist(
+            PlaylistScope.GLOBAL.value, self.bot, audio.playlist_api, inter.guild, inter.user
+        )
+        guild_matches = await get_all_playlist(
+            PlaylistScope.GUILD.value, self.bot, audio.playlist_api, inter.guild, inter.user
+        )
+        user_matches = await get_all_playlist(
+            PlaylistScope.USER.value, self.bot, audio.playlist_api, inter.guild, inter.user
+        )
+        playlists = [*user_matches, *guild_matches, *global_matches]
+
+        if current:
+            results = [pl.name for pl in playlists if pl.name.lower().startswith(current.lower())]
+            results += [pl.name for pl in playlists if
+                        current.lower() in pl.name.lower() and not pl.name.lower().startswith(current.lower())]
+        else:
+            results = [pl.name for pl in playlists]
+
+        return [app_commands.Choice(name=pl, value=pl) for pl in results][:MAX_OPTIONS]
+
+
+    @commands.command(name="audioslashbackupmode", hidden=True)
+    @commands.is_owner()
+    async def audioslashbackupmode(self, ctx: commands.Context, value: Optional[bool]):
+        """Not intended for public use. If audio stopped working, enabling this will download YouTube tracks locally."""
+        if value is None:
+            value = await self.config.guild(ctx.guild).backup_mode()
+        else:
+            await self.config.guild(ctx.guild).backup_mode.set(value)
+        await ctx.reply(f"Backup mode: `{value}`", mention_author=False)

audioslash/info.json

@@ -0,0 +1,12 @@
+{
+    "author": ["hollowstrawberry"],
+    "min_bot_version": "3.5.0",
+    "description": "Audio cog commands in the form of slash commands, with YouTube and playlist autocomplete. Uses up ~10 slash commands out of the available 100.",
+    "hidden": false,
+    "install_msg": "🎵 __**AudioSlash**__ ```Cog installed. Instructions:\n1. Load it with [p]load audioslash\n2. There are ~10 slash commands in this cog. You may enable them all with [p]slash enablecog audioslash\n3. Sync slash commands with [p]slash sync\n4. You may need to restart Discord to see the new commands.```",
+    "required_cogs": {},
+    "requirements": ["yt-dlp"],
+    "short": "Audio cog commands in the form of slash commands, with YouTube and playlist autocomplete.",
+    "end_user_data_statement": "This cog does not store user data.",
+    "tags": ["crab", "voice", "audio", "music", "slash"]
+}

away/__init__.py

@@ -0,0 +1,16 @@
+from .away import Away
+
+__red_end_user_data_statement__ = (
+    "This cog stores data provided by users "
+    "for the express purpose of redisplaying. "
+    "It does not store user data which was not "
+    "provided through a command. "
+    "Users may remove their own content "
+    "without making a data removal request. "
+    "This cog does not support data requests, "
+    "but will respect deletion requests."
+)
+
+
+async def setup(bot):
+    await bot.add_cog(Away(bot))

away/away.py

@@ -0,0 +1,686 @@
+import discord
+from redbot.core import Config, commands, checks
+from typing import Optional, Literal
+import re
+from datetime import datetime
+
+IMAGE_LINKS = re.compile(r"(http[s]?:\/\/[^\"\']*\.(?:png|jpg|jpeg|gif|png))")
+
+
+class Away(commands.Cog):
+    """Le away cog"""
+
+    default_global_settings = {"ign_servers": []}
+    default_guild_settings = {"TEXT_ONLY": False, "BLACKLISTED_MEMBERS": []}
+    default_user_settings = {
+        "MESSAGE": False,
+        "IDLE_MESSAGE": False,
+        "DND_MESSAGE": False,
+        "OFFLINE_MESSAGE": False,
+        "GAME_MESSAGE": {},
+        "STREAMING_MESSAGE": False,
+        "LISTENING_MESSAGE": False
+    }
+
+    async def red_delete_data_for_user(
+        self, *, requester: Literal["discord", "owner", "user", "user_strict"], user_id: int,
+    ):
+        await self.config.user_from_id(user_id).clear()
+
+    def __init__(self, bot):
+        self.bot = bot
+        self.config = Config.get_conf(self, 8423491260, force_registration=True)
+        self.config.register_global(**self.default_global_settings)
+        self.config.register_guild(**self.default_guild_settings)
+        self.config.register_user(**self.default_user_settings)
+
+    def _draw_play(self, song):
+        song_start_time = song.start
+        total_time = song.duration
+        current_time = discord.utils.utcnow()
+        elapsed_time = current_time - song_start_time
+        sections = 12
+        loc_time = round((elapsed_time / total_time) * sections)  # 10 sections
+
+        bar_char = "\N{BOX DRAWINGS HEAVY HORIZONTAL}"
+        seek_char = "\N{RADIO BUTTON}"
+        play_char = "\N{BLACK RIGHT-POINTING TRIANGLE}"
+        msg = "\n" + play_char + " "
+
+        for i in range(sections):
+            if i == loc_time:
+                msg += seek_char
+            else:
+                msg += bar_char
+
+        dt_elapsed_time = datetime.utcfromtimestamp(elapsed_time.total_seconds())
+        dt_total_time = datetime.utcfromtimestamp(total_time.total_seconds())
+
+        if dt_total_time.hour >= 1: #If song is an hour or over long
+            total_time = dt_total_time.strftime(f"{dt_total_time.hour}:%M:%S")
+            if dt_elapsed_time.hour == 0: #If time elapsed has not been over an hour
+                elapsed_time = dt_elapsed_time.strftime(f"{dt_elapsed_time.minute}:%S")
+            else:
+                elapsed_time = dt_elapsed_time.strftime(f"{dt_elapsed_time.hour}:%M:%S")
+        else:
+            elapsed_time = dt_elapsed_time.strftime(f"{dt_elapsed_time.minute}:%S")
+            total_time = dt_total_time.strftime(f"{dt_total_time.minute}:%S")
+
+        msg += " `{}`/`{}`".format(elapsed_time, total_time)
+        return msg
+
+    async def make_embed_message(self, author, message, state=None):
+        """
+            Makes the embed reply
+        """
+        avatar = author.display_avatar  # This will return default avatar if no avatar is present
+        color = author.color
+        if message:
+            link = IMAGE_LINKS.search(message)
+            if link:
+                message = message.replace(link.group(0), " ")
+        if state == "away":
+            em = discord.Embed(description=message, color=color)
+            em.set_author(name=f"{author.display_name} is currently away", icon_url=avatar)
+        elif state == "idle":
+            em = discord.Embed(description=message, color=color)
+            em.set_author(name=f"{author.display_name} is currently idle", icon_url=avatar)
+        elif state == "dnd":
+            em = discord.Embed(description=message, color=color)
+            em.set_author(name=f"{author.display_name} is currently do not disturb", icon_url=avatar)
+        elif state == "offline":
+            em = discord.Embed(description=message, color=color)
+            em.set_author(name=f"{author.display_name} is currently offline", icon_url=avatar)
+        elif state == "gaming":
+            em = discord.Embed(description=message, color=color)
+            em.set_author(
+                name=f"{author.display_name} is currently playing {author.activity.name}", icon_url=avatar,
+            )
+            em.title = getattr(author.activity, "details", None)
+            thumbnail = getattr(author.activity, "large_image_url", None)
+            if thumbnail:
+                em.set_thumbnail(url=thumbnail)
+        elif state == "gamingcustom":
+            status = [c for c in author.activities if c.type == discord.ActivityType.playing]
+            em = discord.Embed(description=message, color=color)
+            em.set_author(
+                name=f"{author.display_name} is currently playing {status[0].name}", icon_url=avatar,
+            )
+            em.title = getattr(status[0], "details", None)
+            thumbnail = getattr(status[0], "large_image_url", None)
+            if thumbnail:
+                em.set_thumbnail(url=thumbnail)
+        elif state == "listening":
+            em = discord.Embed(color=author.activity.color)
+            url = f"https://open.spotify.com/track/{author.activity.track_id}"
+            artist_title = f"{author.activity.title} by " + ", ".join(
+                a for a in author.activity.artists
+            )
+            limit = 256 - (
+                len(author.display_name) + 27
+            )  # incase we go over the max allowable size
+            em.set_author(
+                name=f"{author.display_name} is currently listening to",
+                icon_url=avatar,
+                url=url,
+            )
+            em.description = (
+                f"{message}\n "
+                f"[{artist_title}]({url})\n"
+                f"{self._draw_play(author.activity)}"
+            )
+
+            em.set_thumbnail(url=author.activity.album_cover_url)
+        elif state == "listeningcustom":
+            activity = [c for c in author.activities if c.type == discord.ActivityType.listening]
+            em = discord.Embed(color=activity[0].color)
+            url = f"https://open.spotify.com/track/{activity[0].track_id}"
+            artist_title = f"{activity[0].title} by " + ", ".join(a for a in activity[0].artists)
+            limit = 256 - (len(author.display_name) + 27)
+            em.set_author(
+                name=f"{author.display_name} is currently listening to",
+                icon_url=avatar,
+                url=url
+            )
+            em.description = (
+                f"{message}\n "
+                f"[{artist_title}]({url})\n"
+                f"{self._draw_play(activity[0])}"
+            )
+            em.set_thumbnail(url=activity[0].album_cover_url)
+        elif state == "streaming":
+            color = int("6441A4", 16)
+            em = discord.Embed(color=color)
+            em.description = message + "\n" + author.activity.url
+            em.title = getattr(author.activity, "details", None)
+            em.set_author(
+                name=f"{author.display_name} is currently streaming {author.activity.name}", icon_url=avatar,
+            )
+        elif state == "streamingcustom":
+            activity = [c for c in author.activities if c.type == discord.ActivityType.streaming]
+            color = int("6441A4", 16)
+            em = discord.Embed(color=color)
+            em.description = message + "\n" + activity[0].url
+            em.title = getattr(author.activity, "details", None)
+            em.set_author(
+                name=f"{author.display_name} is currently streaming {activity[0].name}", icon_url=avatar,
+            )
+        else:
+            em = discord.Embed(color=color)
+            em.set_author(name="{} is currently away".format(author.display_name), icon_url=avatar)
+        if link and state not in ["listening", "listeningcustom", "gaming"]:
+            em.set_image(url=link.group(0))
+        return em
+
+    async def find_user_mention(self, message):
+        """
+            Replaces user mentions with their username
+        """
+        for word in message.split():
+            match = re.search(r"<@!?([0-9]+)>", word)
+            if match:
+                user = await self.bot.fetch_user(int(match.group(1)))
+                message = re.sub(match.re, "@" + user.name, message)
+        return message
+
+    async def make_text_message(self, author, message, state=None):
+        """
+            Makes the message to display if embeds aren't available
+        """
+        message = await self.find_user_mention(message)
+
+        if state == "away":
+            msg = f"{author.display_name} is currently away"
+        elif state == "idle":
+            msg = f"{author.display_name} is currently idle"
+        elif state == "dnd":
+            msg = f"{author.display_name} is currently do not disturb"
+        elif state == "offline":
+            msg = f"{author.display_name} is currently offline"
+        elif state == "gaming":
+            msg = f"{author.display_name} is currently playing {author.activity.name}"
+        elif state == "gamingcustom":
+            status = [c for c in author.activities if c.type == discord.ActivityType.playing]
+            msg = f"{author.display_name} is currently playing {status[0].name}"
+        elif state == "listening":
+            artist_title = f"{author.activity.title} by " + ", ".join(a for a in author.activity.artists)
+            currently_playing = self._draw_play(author.activity)
+            msg = f"{author.display_name} is currently listening to {artist_title}\n{currently_playing}"
+        elif state == "listeningcustom":
+            status = [c for c in author.activities if c.type == discord.ActivityType.listening]
+            artist_title = f"{status[0].title} by " + ", ".join(a for a in status[0].artists)
+            currently_playing = self._draw_play(status[0])
+            msg = f"{author.display_name} is currently listening to {artist_title}\n{currently_playing}"
+        elif state == "streaming":
+            msg = f"{author.display_name} is currently streaming at {author.activity.url}"
+        elif state == "streamingcustom":
+            status = [c for c in author.activities if c.type == discord.ActivityType.streaming]
+            msg = f"{author.display_name} is currently streaming at {status[0].url}"
+        else:
+            msg = f"{author.display_name} is currently away"
+
+        if message != " " and state != "listeningcustom":
+            msg += f" and has set the following message: `{message}`"
+        elif message != " " and state == "listeningcustom":
+            msg += f"\n\nCustom message: `{message}`"
+
+        return msg
+
+    async def is_mod_or_admin(self, member: discord.Member):
+        guild = member.guild
+        if member == guild.owner:
+            return True
+        if await self.bot.is_owner(member):
+            return True
+        if await self.bot.is_admin(member):
+            return True
+        if await self.bot.is_mod(member):
+            return True
+        return False
+
+    @commands.Cog.listener()
+    async def on_message_without_command(self, message: discord.Message):
+        guild = message.guild
+        if not guild or not message.mentions or message.author.bot:
+            return
+        if not message.channel.permissions_for(guild.me).send_messages:
+            return
+
+        blocked_guilds = await self.config.ign_servers()
+        guild_config = await self.config.guild(guild).all()
+        for author in message.mentions:
+            if (guild.id in blocked_guilds and not await self.is_mod_or_admin(author)) or author.id in guild_config["BLACKLISTED_MEMBERS"]:
+                continue
+            user_data = await self.config.user(author).all()
+            embed_links = message.channel.permissions_for(guild.me).embed_links
+
+            away_msg = user_data["MESSAGE"]
+            # Convert possible `delete_after` of < 5s of before PR#212
+            if isinstance(away_msg, list) and away_msg[1] is not None and away_msg[1] < 5:
+                await self.config.user(author).MESSAGE.set((away_msg[0], 5))
+                away_msg = away_msg[0], 5
+            if away_msg:
+                if type(away_msg) in [tuple, list]:
+                    # This is just to keep backwards compatibility
+                    away_msg, delete_after = away_msg
+                else:
+                    delete_after = None
+                if embed_links and not guild_config["TEXT_ONLY"]:
+                    em = await self.make_embed_message(author, away_msg, "away")
+                    await message.channel.send(embed=em, delete_after=delete_after)
+                elif (embed_links and guild_config["TEXT_ONLY"]) or not embed_links:
+                    msg = await self.make_text_message(author, away_msg, "away")
+                    await message.channel.send(msg, delete_after=delete_after)
+                continue
+            idle_msg = user_data["IDLE_MESSAGE"]
+            # Convert possible `delete_after` of < 5s of before PR#212
+            if isinstance(idle_msg, list) and idle_msg[1] is not None and idle_msg[1] < 5:
+                await self.config.user(author).IDLE_MESSAGE.set((idle_msg[0], 5))
+                idle_msg = idle_msg[0], 5
+            if idle_msg and author.status == discord.Status.idle:
+                if type(idle_msg) in [tuple, list]:
+                    idle_msg, delete_after = idle_msg
+                else:
+                    delete_after = None
+                if embed_links and not guild_config["TEXT_ONLY"]:
+                    em = await self.make_embed_message(author, idle_msg, "idle")
+                    await message.channel.send(embed=em, delete_after=delete_after)
+                elif (embed_links and guild_config["TEXT_ONLY"]) or not embed_links:
+                    msg = await self.make_text_message(author, idle_msg, "idle")
+                    await message.channel.send(msg, delete_after=delete_after)
+                continue
+            dnd_msg = user_data["DND_MESSAGE"]
+            # Convert possible `delete_after` of < 5s of before PR#212
+            if isinstance(dnd_msg, list) and dnd_msg[1] is not None and dnd_msg[1] < 5:
+                await self.config.user(author).DND_MESSAGE.set((dnd_msg[0], 5))
+                dnd_msg = dnd_msg[0], 5
+            if dnd_msg and author.status == discord.Status.dnd:
+                if type(dnd_msg) in [tuple, list]:
+                    dnd_msg, delete_after = dnd_msg
+                else:
+                    delete_after = None
+                if embed_links and not guild_config["TEXT_ONLY"]:
+                    em = await self.make_embed_message(author, dnd_msg, "dnd")
+                    await message.channel.send(embed=em, delete_after=delete_after)
+                elif (embed_links and guild_config["TEXT_ONLY"]) or not embed_links:
+                    msg = await self.make_text_message(author, dnd_msg, "dnd")
+                    await message.channel.send(msg, delete_after=delete_after)
+                continue
+            offline_msg = user_data["OFFLINE_MESSAGE"]
+            # Convert possible `delete_after` of < 5s of before PR#212
+            if isinstance(offline_msg, list) and offline_msg[1] is not None and offline_msg[1] < 5:
+                await self.config.user(author).OFFLINE_MESSAGE.set((offline_msg[0], 5))
+                offline_msg = offline_msg[0], 5
+            if offline_msg and author.status == discord.Status.offline:
+                if type(offline_msg) in [tuple, list]:
+                    offline_msg, delete_after = offline_msg
+                else:
+                    delete_after = None
+                if embed_links and not guild_config["TEXT_ONLY"]:
+                    em = await self.make_embed_message(author, offline_msg, "offline")
+                    await message.channel.send(embed=em, delete_after=delete_after)
+                elif (embed_links and guild_config["TEXT_ONLY"]) or not embed_links:
+                    msg = await self.make_text_message(author, offline_msg, "offline")
+                    await message.channel.send(msg, delete_after=delete_after)
+                continue
+            streaming_msg = user_data["STREAMING_MESSAGE"]
+            # Convert possible `delete_after` of < 5s of before PR#212
+            if isinstance(streaming_msg, list) and streaming_msg[1] is not None and streaming_msg[1] < 5:
+                await self.config.user(author).STREAMING_MESSAGE.set((streaming_msg[0], 5))
+                streaming_msg = streaming_msg[0], 5
+            if streaming_msg and type(author.activity) is discord.Streaming:
+                streaming_msg, delete_after = streaming_msg
+                if embed_links and not guild_config["TEXT_ONLY"]:
+                    em = await self.make_embed_message(author, streaming_msg, "streaming")
+                    await message.channel.send(embed=em, delete_after=delete_after)
+                elif (embed_links and guild_config["TEXT_ONLY"]) or not embed_links:
+                    msg = await self.make_text_message(author, streaming_msg, "streaming")
+                    await message.channel.send(msg, delete_after=delete_after)
+                continue
+            if streaming_msg and type(author.activity) is discord.CustomActivity:
+                stream_status = [c for c in author.activities if c.type == discord.ActivityType.streaming]
+                if not stream_status:
+                    continue
+                streaming_msg, delete_after = streaming_msg
+                if embed_links and not guild_config["TEXT_ONLY"]:
+                    em = await self.make_embed_message(author, streaming_msg, "streamingcustom")
+                    await message.channel.send(embed=em, delete_after=delete_after)
+                elif (embed_links and guild_config["TEXT_ONLY"]) or not embed_links:
+                    msg = await self.make_text_message(author, streaming_msg, "streamingcustom")
+                    await message.channel.send(msg, delete_after=delete_after)
+                continue
+            listening_msg = user_data["LISTENING_MESSAGE"]
+            # Convert possible `delete_after` of < 5s of before PR#212
+            if isinstance(listening_msg, list) and listening_msg[1] is not None and listening_msg[1] < 5:
+                await self.config.user(author).LISTENING_MESSAGE.set((listening_msg[0], 5))
+                listening_msg = listening_msg[0], 5
+            if listening_msg and type(author.activity) is discord.Spotify:
+                listening_msg, delete_after = listening_msg
+                if embed_links and not guild_config["TEXT_ONLY"]:
+                    em = await self.make_embed_message(author, listening_msg, "listening")
+                    await message.channel.send(embed=em, delete_after=delete_after)
+                elif (embed_links and guild_config["TEXT_ONLY"]) or not embed_links:
+                    msg = await self.make_text_message(author, listening_msg, "listening")
+                    await message.channel.send(msg, delete_after=delete_after)
+                continue
+            if listening_msg and type(author.activity) is discord.CustomActivity:
+                listening_status = [c for c in author.activities if c.type == discord.ActivityType.listening]
+                if not listening_status:
+                    continue
+                listening_msg, delete_after = listening_msg
+                if embed_links and not guild_config["TEXT_ONLY"]:
+                    em = await self.make_embed_message(author, listening_msg, "listeningcustom")
+                    await message.channel.send(embed=em, delete_after=delete_after)
+                elif (embed_links and guild_config["TEXT_ONLY"]) or not embed_links:
+                    msg = await self.make_text_message(author, listening_msg, "listeningcustom")
+                    await message.channel.send(msg, delete_after=delete_after)
+                continue
+            gaming_msgs = user_data["GAME_MESSAGE"]
+            # Convert possible `delete_after` of < 5s of before PR#212
+            if isinstance(gaming_msgs, list) and gaming_msgs[1] is not None and gaming_msgs[1] < 5:
+                await self.config.user(author).GAME_MESSAGE.set((gaming_msgs[0], 5))
+                gaming_msgs = gaming_msgs[0], 5
+            if gaming_msgs and type(author.activity) in [discord.Game, discord.Activity]:
+                for game in gaming_msgs:
+                    if game in author.activity.name.lower():
+                        game_msg, delete_after = gaming_msgs[game]
+                        if embed_links and not guild_config["TEXT_ONLY"]:
+                            em = await self.make_embed_message(author, game_msg, "gaming")
+                            await message.channel.send(embed=em, delete_after=delete_after)
+                            break  # Let's not accidentally post more than one
+                        elif (embed_links and guild_config["TEXT_ONLY"]) or not embed_links:
+                            msg = await self.make_text_message(author, game_msg, "gaming")
+                            await message.channel.send(msg, delete_after=delete_after)
+                            break
+            if gaming_msgs and type(author.activity) is discord.CustomActivity:
+                game_status = [c for c in author.activities if c.type == discord.ActivityType.playing]
+                if not game_status:
+                    continue
+                for game in gaming_msgs:
+                    if game in game_status[0].name.lower():
+                        game_msg, delete_after = gaming_msgs[game]
+                        if embed_links and not guild_config["TEXT_ONLY"]:
+                            em = await self.make_embed_message(author, game_msg, "gamingcustom")
+                            await message.channel.send(embed=em, delete_after=delete_after)
+                            break  # Let's not accidentally post more than one
+                        elif (embed_links and guild_config["TEXT_ONLY"]) or not embed_links:
+                            msg = await self.make_text_message(author, game_msg, "gamingcustom")
+                            await message.channel.send(msg, delete_after=delete_after)
+                            break
+
+    @commands.command(name="away")
+    async def away_(self, ctx, delete_after: Optional[int] = None, *, message: str = None):
+        """
+        Tell the bot you're away or back.
+
+        `delete_after` Optional seconds to delete the automatic reply. Must be minimum 5 seconds
+        `message` The custom message to display when you're mentioned
+        """
+        if delete_after is not None and delete_after < 5:
+            return await ctx.send("Please set a time longer than 5 seconds for the `delete_after` argument")
+
+        author = ctx.message.author
+        mess = await self.config.user(author).MESSAGE()
+        if mess:
+            await self.config.user(author).MESSAGE.set(False)
+            msg = "You're now back."
+        else:
+            if message is None:
+                await self.config.user(author).MESSAGE.set((" ", delete_after))
+            else:
+                await self.config.user(author).MESSAGE.set((message, delete_after))
+            msg = "You're now set as away."
+        await ctx.send(msg)
+
+    @commands.command(name="idle")
+    async def idle_(self, ctx, delete_after: Optional[int] = None, *, message: str = None):
+        """
+        Set an automatic reply when you're idle.
+
+        `delete_after` Optional seconds to delete the automatic reply. Must be minimum 5 seconds
+        `message` The custom message to display when you're mentioned
+        """
+        if delete_after is not None and delete_after < 5:
+            return await ctx.send("Please set a time longer than 5 seconds for the `delete_after` argument")
+
+        author = ctx.message.author
+        mess = await self.config.user(author).IDLE_MESSAGE()
+        if mess:
+            await self.config.user(author).IDLE_MESSAGE.set(False)
+            msg = "The bot will no longer reply for you when you're idle."
+        else:
+            if message is None:
+                await self.config.user(author).IDLE_MESSAGE.set((" ", delete_after))
+            else:
+                await self.config.user(author).IDLE_MESSAGE.set((message, delete_after))
+            msg = "The bot will now reply for you when you're idle."
+        await ctx.send(msg)
+
+    @commands.command(name="offline")
+    async def offline_(self, ctx, delete_after: Optional[int] = None, *, message: str = None):
+        """
+        Set an automatic reply when you're offline.
+
+        `delete_after` Optional seconds to delete the automatic reply. Must be minimum 5 seconds
+        `message` The custom message to display when you're mentioned
+        """
+        if delete_after is not None and delete_after < 5:
+            return await ctx.send("Please set a time longer than 5 seconds for the `delete_after` argument")
+
+        author = ctx.message.author
+        mess = await self.config.user(author).OFFLINE_MESSAGE()
+        if mess:
+            await self.config.user(author).OFFLINE_MESSAGE.set(False)
+            msg = "The bot will no longer reply for you when you're offline."
+        else:
+            if message is None:
+                await self.config.user(author).OFFLINE_MESSAGE.set((" ", delete_after))
+            else:
+                await self.config.user(author).OFFLINE_MESSAGE.set((message, delete_after))
+            msg = "The bot will now reply for you when you're offline."
+        await ctx.send(msg)
+
+    @commands.command(name="dnd", aliases=["donotdisturb"])
+    async def donotdisturb_(self, ctx, delete_after: Optional[int] = None, *, message: str = None):
+        """
+        Set an automatic reply when you're dnd.
+
+        `delete_after` Optional seconds to delete the automatic reply. Must be minimum 5 seconds
+        `message` The custom message to display when you're mentioned
+        """
+        if delete_after is not None and delete_after < 5:
+            return await ctx.send("Please set a time longer than 5 seconds for the `delete_after` argument")
+
+        author = ctx.message.author
+        mess = await self.config.user(author).DND_MESSAGE()
+        if mess:
+            await self.config.user(author).DND_MESSAGE.set(False)
+            msg = "The bot will no longer reply for you when you're set to do not disturb."
+        else:
+            if message is None:
+                await self.config.user(author).DND_MESSAGE.set((" ", delete_after))
+            else:
+                await self.config.user(author).DND_MESSAGE.set((message, delete_after))
+            msg = "The bot will now reply for you when you're set to do not disturb."
+        await ctx.send(msg)
+
+    @commands.command(name="streaming")
+    async def streaming_(self, ctx, delete_after: Optional[int] = None, *, message: str = None):
+        """
+        Set an automatic reply when you're streaming.
+
+        `delete_after` Optional seconds to delete the automatic reply. Must be minimum 5 seconds
+        `message` The custom message to display when you're mentioned
+        """
+        if delete_after is not None and delete_after < 5:
+            return await ctx.send("Please set a time longer than 5 seconds for the `delete_after` argument")
+
+        author = ctx.message.author
+        mess = await self.config.user(author).STREAMING_MESSAGE()
+        if mess:
+            await self.config.user(author).STREAMING_MESSAGE.set(False)
+            msg = "The bot will no longer reply for you when you're mentioned while streaming."
+        else:
+            if message is None:
+                await self.config.user(author).STREAMING_MESSAGE.set((" ", delete_after))
+            else:
+                await self.config.user(author).STREAMING_MESSAGE.set((message, delete_after))
+            msg = "The bot will now reply for you when you're mentioned while streaming."
+        await ctx.send(msg)
+
+    @commands.command(name="listening")
+    async def listening_(self, ctx, delete_after: Optional[int] = None, *, message: str = " "):
+        """
+        Set an automatic reply when you're listening to Spotify.
+
+        `delete_after` Optional seconds to delete the automatic reply. Must be minimum 5 seconds
+        `message` The custom message to display when you're mentioned
+        """
+        if delete_after is not None and delete_after < 5:
+            return await ctx.send("Please set a time longer than 5 seconds for the `delete_after` argument")
+
+        author = ctx.message.author
+        mess = await self.config.user(author).LISTENING_MESSAGE()
+        if mess:
+            await self.config.user(author).LISTENING_MESSAGE.set(False)
+            msg = "The bot will no longer reply for you when you're mentioned while listening to Spotify."
+        else:
+            await self.config.user(author).LISTENING_MESSAGE.set((message, delete_after))
+            msg = "The bot will now reply for you when you're mentioned while listening to Spotify."
+        await ctx.send(msg)
+
+    @commands.command(name="gaming")
+    async def gaming_(self, ctx, game: str, delete_after: Optional[int] = None, *, message: str = None):
+        """
+        Set an automatic reply when you're playing a specified game.
+
+        `game` The game you would like automatic responses for
+        `delete_after` Optional seconds to delete the automatic reply. Must be minimum 5 seconds
+        `message` The custom message to display when you're mentioned
+
+        Use "double quotes" around a game's name if it is more than one word.
+        """
+        if delete_after is not None and delete_after < 5:
+            return await ctx.send("Please set a time longer than 5 seconds for the `delete_after` argument")
+
+        author = ctx.message.author
+        mess = await self.config.user(author).GAME_MESSAGE()
+        if game.lower() in mess:
+            del mess[game.lower()]
+            await self.config.user(author).GAME_MESSAGE.set(mess)
+            msg = f"The bot will no longer reply for you when you're playing {game}."
+        else:
+            if message is None:
+                mess[game.lower()] = (" ", delete_after)
+            else:
+                mess[game.lower()] = (message, delete_after)
+            await self.config.user(author).GAME_MESSAGE.set(mess)
+            msg = f"The bot will now reply for you when you're playing {game}."
+        await ctx.send(msg)
+
+    @commands.command(name="toggleaway")
+    @commands.guild_only()
+    @checks.admin_or_permissions(administrator=True)
+    async def _ignore(self, ctx, member: discord.Member=None):
+        """
+        Toggle away messages on the whole server or a specific guild member.
+
+        Mods, Admins and Bot Owner are immune to this.
+        """
+        guild = ctx.message.guild
+        if member:
+            bl_mems = await self.config.guild(guild).BLACKLISTED_MEMBERS()
+            if member.id not in bl_mems:
+                bl_mems.append(member.id)
+                await self.config.guild(guild).BLACKLISTED_MEMBERS.set(bl_mems)
+                msg = f"Away messages will not appear when {member.display_name} is mentioned in this guild."
+                await ctx.send(msg)
+            elif member.id in bl_mems:
+                bl_mems.remove(member.id)
+                await self.config.guild(guild).BLACKLISTED_MEMBERS.set(bl_mems)
+                msg = f"Away messages will appear when {member.display_name} is mentioned in this guild."
+                await ctx.send(msg)
+            return
+        if guild.id in (await self.config.ign_servers()):
+            guilds = await self.config.ign_servers()
+            guilds.remove(guild.id)
+            await self.config.ign_servers.set(guilds)
+            message = "Not ignoring this guild anymore."
+        else:
+            guilds = await self.config.ign_servers()
+            guilds.append(guild.id)
+            await self.config.ign_servers.set(guilds)
+            message = "Ignoring this guild."
+        await ctx.send(message)
+
+    @commands.command()
+    @commands.guild_only()
+    @checks.admin_or_permissions(administrator=True)
+    async def awaytextonly(self, ctx):
+        """
+        Toggle forcing the guild's away messages to be text only.
+
+        This overrides the embed_links check this cog uses for message sending.
+        """
+        text_only = await self.config.guild(ctx.guild).TEXT_ONLY()
+        if text_only:
+            message = "Away messages will now be embedded or text only based on the bot's permissions for embed links."
+        else:
+            message = (
+                "Away messages are now forced to be text only, regardless of the bot's permissions for embed links."
+            )
+        await self.config.guild(ctx.guild).TEXT_ONLY.set(not text_only)
+        await ctx.send(message)
+
+    @commands.command(name="awaysettings", aliases=["awayset"])
+    async def away_settings(self, ctx):
+        """View your current away settings"""
+        author = ctx.author
+        msg = ""
+        data = {
+            "MESSAGE": "Away",
+            "IDLE_MESSAGE": "Idle",
+            "DND_MESSAGE": "Do not disturb",
+            "OFFLINE_MESSAGE": "Offline",
+            "LISTENING_MESSAGE": "Listening",
+            "STREAMING_MESSAGE": "Streaming",
+        }
+        settings = await self.config.user(author).get_raw()
+        for attr, name in data.items():
+            if type(settings[attr]) in [tuple, list]:
+                # This is just to keep backwards compatibility
+                status_msg, delete_after = settings[attr]
+            else:
+                status_msg = settings[attr]
+                delete_after = None
+            if settings[attr] and len(status_msg) > 20:
+                status_msg = status_msg[:20] + "..."
+            if settings[attr] and len(status_msg) <= 1:
+                status_msg = "True"
+            if delete_after:
+                msg += f"{name}: {status_msg} deleted after {delete_after}s\n"
+            else:
+                msg += f"{name}: {status_msg}\n"
+        if "GAME_MESSAGE" in settings:
+            if not settings["GAME_MESSAGE"]:
+                games = "False"
+            else:
+                games = "True"
+            msg += f"Games: {games}\n"
+            for game in settings["GAME_MESSAGE"]:
+                status_msg, delete_after = settings["GAME_MESSAGE"][game]
+                if len(status_msg) > 20:
+                    status_msg = status_msg[:-20] + "..."
+                if len(status_msg) <= 1:
+                    status_msg = "True"
+                if delete_after:
+                    msg += f"{game}: {status_msg} deleted after {delete_after}s\n"
+                else:
+                    msg += f"{game}: {status_msg}\n"
+
+        if ctx.channel.permissions_for(ctx.me).embed_links:
+            em = discord.Embed(description=msg[:2048], color=author.color)
+            em.set_author(name=f"{author.display_name}'s away settings", icon_url=author.avatar.url)
+            await ctx.send(embed=em)
+        else:
+            await ctx.send(f"{author.display_name} away settings\n" + msg)

away/info.json

@@ -0,0 +1,9 @@
+{
+    "author": ["aikaterna", "Axas", "TrustyJAID"],
+    "description": "Set and unset a user as being away. Originally by Paddo.",
+    "min_bot_version": "3.5.0",
+    "short": "Away message toggle for users",
+    "tags": ["away", "afk"],
+    "type": "COG",
+    "end_user_data_statement": "This cog stores data provided by users for the express purpose of redisplaying. It does not store user data which was not provided through a command. Users may remove their own content without making a data removal request. This cog does not support data requests, but will respect deletion requests."
+}

chatchart/__init__.py

@@ -0,0 +1,7 @@
+from .chatchart import Chatchart
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(Chatchart(bot))

chatchart/chatchart.py

@@ -0,0 +1,366 @@
+#  This cog is influenced heavily by cacobot's stats module:
+#  https://github.com/Orangestar12/cacobot/blob/master/cacobot/stats.py
+#  Big thanks to Redjumpman for changing the beta version from
+#  Imagemagick/cairosvg to matplotlib.
+#  Thanks to violetnyte for suggesting this cog.
+
+import asyncio
+import discord
+import heapq
+from io import BytesIO
+from typing import List, Optional, Tuple, Union
+
+from redbot.core import checks, commands, Config
+
+import matplotlib
+matplotlib.use("agg")
+import matplotlib.pyplot as plt
+plt.switch_backend("agg")
+
+
+class Chatchart(commands.Cog):
+    """Show activity."""
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """ Nothing to delete """
+        return
+
+    def __init__(self, bot):
+        self.bot = bot
+        self.config = Config.get_conf(self, 2766691001, force_registration=True)
+
+        default_guild = {"channel_deny": []}
+        default_global = {"limit": 0}
+
+        self.config.register_guild(**default_guild)
+        self.config.register_global(**default_global)
+
+    @staticmethod
+    def calculate_member_perc(history: List[discord.Message]) -> dict:
+        """Calculate the member count from the message history"""
+        msg_data = {"total_count": 0, "users": {}}
+        for msg in history:
+            # Name formatting
+            if len(msg.author.display_name) >= 20:
+                short_name = "{}...".format(msg.author.display_name[:20]).replace("$", "\\$")
+            else:
+                short_name = msg.author.display_name.replace("$", "\\$").replace("_", "\\_ ").replace("*", "\\*")
+            whole_name = "{}#{}".format(short_name, msg.author.discriminator)
+            if msg.author.bot:
+                pass
+            elif whole_name in msg_data["users"]:
+                msg_data["users"][whole_name]["msgcount"] += 1
+                msg_data["total_count"] += 1
+            else:
+                msg_data["users"][whole_name] = {}
+                msg_data["users"][whole_name]["msgcount"] = 1
+                msg_data["total_count"] += 1
+        return msg_data
+
+    @staticmethod
+    def calculate_top(msg_data: dict) -> Tuple[list, int]:
+        """Calculate the top 20 from the message data package"""
+        for usr in msg_data["users"]:
+            pd = float(msg_data["users"][usr]["msgcount"]) / float(msg_data["total_count"])
+            msg_data["users"][usr]["percent"] = pd * 100
+        top_twenty = heapq.nlargest(
+            20,
+            [
+                (x, msg_data["users"][x][y])
+                for x in msg_data["users"]
+                for y in msg_data["users"][x]
+                if (y == "percent" and msg_data["users"][x][y] > 0)
+            ],
+            key=lambda x: x[1],
+        )
+        others = 100 - sum(x[1] for x in top_twenty)
+        return top_twenty, others
+
+    @staticmethod
+    async def create_chart(top, others, channel_or_guild: Union[discord.Guild, discord.TextChannel]):
+        plt.clf()
+        sizes = [x[1] for x in top]
+        labels = ["{} {:g}%".format(x[0], round(x[1], 1)) for x in top]
+        if len(top) >= 20:
+            sizes = sizes + [others]
+            labels = labels + ["Others {:g}%".format(round(others, 1))]
+        if len(channel_or_guild.name) >= 19:
+            if isinstance(channel_or_guild, discord.Guild):
+                channel_or_guild_name = "{}...".format(channel_or_guild.name[:19])
+            else:
+                channel_or_guild_name = "#{}...".format(channel_or_guild.name[:19])
+        else:
+            channel_or_guild_name = channel_or_guild.name
+        title = plt.title("Stats in {}".format(channel_or_guild_name), color="white")
+        title.set_va("top")
+        title.set_ha("center")
+        plt.gca().axis("equal")
+        colors = [
+            "r",
+            "darkorange",
+            "gold",
+            "y",
+            "olivedrab",
+            "green",
+            "darkcyan",
+            "mediumblue",
+            "darkblue",
+            "blueviolet",
+            "indigo",
+            "orchid",
+            "mediumvioletred",
+            "crimson",
+            "chocolate",
+            "yellow",
+            "limegreen",
+            "forestgreen",
+            "dodgerblue",
+            "slateblue",
+            "gray",
+        ]
+        pie = plt.pie(sizes, colors=colors, startangle=0)
+        plt.legend(
+            pie[0],
+            labels,
+            bbox_to_anchor=(0.7, 0.5),
+            loc="center",
+            fontsize=10,
+            bbox_transform=plt.gcf().transFigure,
+            facecolor="#ffffff",
+        )
+        plt.subplots_adjust(left=0.0, bottom=0.1, right=0.45)
+        image_object = BytesIO()
+        plt.savefig(image_object, format="PNG", facecolor="#36393E")
+        image_object.seek(0)
+        return image_object
+
+    async def fetch_channel_history(
+        self,
+        channel: discord.TextChannel,
+        animation_message: discord.Message,
+        messages: int
+    ) -> List[discord.Message]:
+        """Fetch the history of a channel while displaying an status message with it"""
+        animation_message_deleted = False
+        history = []
+        history_counter = 0
+        async for msg in channel.history(limit=messages):
+            history.append(msg)
+            history_counter += 1
+            await asyncio.sleep(0.005)
+            if history_counter % 250 == 0:
+                new_embed = discord.Embed(
+                    title=f"Fetching messages from #{channel.name}",
+                    description=f"This might take a while...\n{history_counter}/{messages} messages gathered",
+                    colour=await self.bot.get_embed_colour(location=channel),
+                )
+                if channel.permissions_for(channel.guild.me).send_messages:
+                    await channel.typing()
+                if animation_message_deleted is False:
+                    try:
+                        await animation_message.edit(embed=new_embed)
+                    except discord.NotFound:
+                        animation_message_deleted = True
+        return history
+
+    @commands.guild_only()
+    @commands.command()
+    @commands.cooldown(1, 10, commands.BucketType.guild)
+    @commands.max_concurrency(1, commands.BucketType.guild)
+    @commands.bot_has_permissions(attach_files=True)
+    async def chatchart(self, ctx, channel: Optional[discord.TextChannel] = None, messages:int = 5000):
+        """
+        Generates a pie chart, representing the last 5000 messages in the specified channel.
+        """
+        if channel is None:
+            channel = ctx.channel
+
+        # --- Early terminations
+        if channel.permissions_for(ctx.message.author).read_messages is False:
+            return await ctx.send("You're not allowed to access that channel.")
+        if channel.permissions_for(ctx.guild.me).read_messages is False:
+            return await ctx.send("I cannot read the history of that channel.")
+        blacklisted_channels = await self.config.guild(ctx.guild).channel_deny()
+        if channel.id in blacklisted_channels:
+            return await ctx.send(f"I am not allowed to create a chatchart of {channel.mention}.")
+        if messages < 5:
+            return await ctx.send("Don't be silly.")
+
+        message_limit = await self.config.limit()
+        if (message_limit != 0) and (messages > message_limit):
+            messages = message_limit
+
+        embed = discord.Embed(
+            title=f"Fetching messages from #{channel.name}",
+            description="This might take a while...",
+            colour=await self.bot.get_embed_colour(location=channel)
+        )
+        loading_message = await ctx.send(embed=embed)
+        try:
+            history = await self.fetch_channel_history(channel, loading_message, messages)
+        except discord.errors.Forbidden:
+            try:
+                await loading_message.delete()
+            except discord.NotFound:
+                pass
+            return await ctx.send("No permissions to read that channel.")
+
+        msg_data = self.calculate_member_perc(history)
+        # If no members are found.
+        if len(msg_data["users"]) == 0:
+            try:
+                await loading_message.delete()
+            except discord.NotFound:
+                pass
+            return await ctx.send(f"Only bots have sent messages in {channel.mention} or I can't read message history.")
+
+        top_twenty, others = self.calculate_top(msg_data)
+        chart = await self.create_chart(top_twenty, others, channel)
+
+        try:
+            await loading_message.delete()
+        except discord.NotFound:
+            pass
+        await ctx.send(file=discord.File(chart, "chart.png"))
+
+    @checks.mod_or_permissions(manage_guild=True)
+    @commands.guild_only()
+    @commands.command(aliases=["guildchart"])
+    @commands.cooldown(1, 30, commands.BucketType.guild)
+    @commands.max_concurrency(1, commands.BucketType.guild)
+    @commands.bot_has_permissions(attach_files=True)
+    async def serverchart(self, ctx: commands.Context, messages: int = 1000):
+        """
+        Generates a pie chart, representing the last 1000 messages from every allowed channel in the server.
+
+        As example:
+        For each channel that the bot is allowed to scan. It will take the last 1000 messages from each channel.
+        And proceed to build a chart out of that.
+        """
+        if messages < 5:
+            return await ctx.send("Don't be silly.")
+        channel_list = []
+        blacklisted_channels = await self.config.guild(ctx.guild).channel_deny()
+        for channel in ctx.guild.text_channels:
+            channel: discord.TextChannel
+            if channel.id in blacklisted_channels:
+                continue
+            if channel.permissions_for(ctx.message.author).read_messages is False:
+                continue
+            if channel.permissions_for(ctx.guild.me).read_messages is False:
+                continue
+            channel_list.append(channel)
+
+        if len(channel_list) == 0:
+            return await ctx.send("There are no channels to read... This should theoretically never happen.")
+
+        embed = discord.Embed(
+            description="Fetching messages from the entire server this **will** take a while.",
+            colour=await self.bot.get_embed_colour(location=ctx.channel),
+        )
+        global_fetch_message = await ctx.send(embed=embed)
+        global_history = []
+
+        for channel in channel_list:
+            embed = discord.Embed(
+                title=f"Fetching messages from #{channel.name}",
+                description="This might take a while...",
+                colour=await self.bot.get_embed_colour(location=channel)
+            )
+            loading_message = await ctx.send(embed=embed)
+            try:
+                history = await self.fetch_channel_history(channel, loading_message, messages)
+                global_history += history
+                await loading_message.delete()
+            except discord.errors.Forbidden:
+                try:
+                    await loading_message.delete()
+                except discord.NotFound:
+                    continue
+            except discord.NotFound:
+                try:
+                    await loading_message.delete()
+                except discord.NotFound:
+                    continue 
+
+        msg_data = self.calculate_member_perc(global_history)
+        # If no members are found.
+        if len(msg_data["users"]) == 0:
+            try:
+                await global_fetch_message.delete()
+            except discord.NotFound:
+                pass
+            return await ctx.send(f"Only bots have sent messages in this server... Wauw...")
+
+        top_twenty, others = self.calculate_top(msg_data)
+        chart = await self.create_chart(top_twenty, others, ctx.guild)
+
+        try:
+            await global_fetch_message.delete()
+        except discord.NotFound:
+            pass
+        await ctx.send(file=discord.File(chart, "chart.png"))
+
+    @checks.mod_or_permissions(manage_channels=True)
+    @commands.guild_only()
+    @commands.command()
+    async def ccdeny(self, ctx, channel: discord.TextChannel):
+        """Add a channel to deny chatchart use."""
+        channel_list = await self.config.guild(ctx.guild).channel_deny()
+        if channel.id not in channel_list:
+            channel_list.append(channel.id)
+        await self.config.guild(ctx.guild).channel_deny.set(channel_list)
+        await ctx.send(f"{channel.mention} was added to the deny list for chatchart.")
+
+    @checks.mod_or_permissions(manage_channels=True)
+    @commands.guild_only()
+    @commands.command()
+    async def ccdenylist(self, ctx):
+        """List the channels that are denied."""
+        no_channels_msg = "Chatchart is currently allowed everywhere in this server."
+        channel_list = await self.config.guild(ctx.guild).channel_deny()
+        if not channel_list:
+            msg = no_channels_msg
+        else:
+            msg = "Chatchart is not allowed in:\n"
+            remove_list = []
+            for channel in channel_list:
+                channel_obj = self.bot.get_channel(channel)
+                if not channel_obj:
+                    remove_list.append(channel)
+                else:
+                    msg += f"{channel_obj.mention}\n"
+            if remove_list:
+                new_list = [x for x in channel_list if x not in remove_list]
+                await self.config.guild(ctx.guild).channel_deny.set(new_list)
+                if len(remove_list) == len(channel_list):
+                    msg = no_channels_msg
+        await ctx.send(msg)
+
+    @checks.mod_or_permissions(manage_channels=True)
+    @commands.guild_only()
+    @commands.command()
+    async def ccallow(self, ctx, channel: discord.TextChannel):
+        """Remove a channel from the deny list to allow chatchart use."""
+        channel_list = await self.config.guild(ctx.guild).channel_deny()
+        if channel.id in channel_list:
+            channel_list.remove(channel.id)
+        else:
+            return await ctx.send("Channel is not on the deny list.")
+        await self.config.guild(ctx.guild).channel_deny.set(channel_list)
+        await ctx.send(f"{channel.mention} will be allowed for chatchart use.")
+
+    @checks.is_owner()
+    @commands.command()
+    async def cclimit(self, ctx, limit_amount: int = None):
+        """
+        Limit the amount of messages someone can request.
+
+        Use `0` for no limit.
+        """
+        if limit_amount is None:
+            return await ctx.send_help()
+        if limit_amount < 0:
+            return await ctx.send("You need to use a number larger than 0.")
+        await self.config.limit.set(limit_amount)
+        await ctx.send(f"Chatchart is now limited to {limit_amount} messages.")

chatchart/info.json

@@ -0,0 +1,11 @@
+{
+    "author": ["aikaterna", "Redjumpman"],
+    "description": "Generate a pie chart from the last 5000 messages in a channel to see who's been talking the most.",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "Thanks for installing, have fun.",
+    "min_bot_version": "3.5.0",
+    "requirements": ["matplotlib"],
+    "short": "Generate a pie chart from the last 5000 messages",
+    "tags": ["messages", "chart", "count", "activity"],
+    "type": "COG"
+}

dadjokes/__init__.py

@@ -0,0 +1,7 @@
+from .dadjokes import DadJokes
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(DadJokes(bot))

dadjokes/dadjokes.py

@@ -0,0 +1,26 @@
+from redbot.core import commands
+import aiohttp
+
+
+class DadJokes(commands.Cog):
+    """Random dad jokes from icanhazdadjoke.com"""
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """ Nothing to delete """
+        return
+
+    def __init__(self, bot):
+        self.bot = bot
+
+    @commands.command()
+    async def dadjoke(self, ctx):
+        """Gets a random dad joke."""
+        try:
+            async with aiohttp.request("GET", "https://icanhazdadjoke.com/", headers={"Accept": "text/plain"}) as r:
+                if r.status != 200:
+                    return await ctx.send("Oops! Cannot get a dad joke...")
+                result = await r.text(encoding="UTF-8")
+        except aiohttp.ClientConnectionError:
+            return await ctx.send("Oops! Cannot get a dad joke...")
+
+        await ctx.send(f"`{result}`")

dadjokes/info.json

@@ -0,0 +1,10 @@
+{
+    "author": ["UltimatePancake"],
+    "description": "Gets a random dad joke from icanhazdadjoke.com",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "Gets a random dad joke from icanhazdadjoke.com. Thanks for installing.",
+    "min_bot_version": "3.5.0",
+    "short": "Random dad jokes",
+    "tags": ["jokes", "dad", "dadjokes"],
+    "type": "COG"
+}

dictionary/__init__.py

@@ -0,0 +1,7 @@
+from .dictionary import Dictionary
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(Dictionary(bot))

dictionary/dictionary.py

@@ -0,0 +1,185 @@
+import aiohttp
+import discord
+import contextlib
+from bs4 import BeautifulSoup
+import json
+import logging
+import re
+from redbot.core import commands
+from redbot.core.utils.chat_formatting import pagify
+
+
+log = logging.getLogger("red.aikaterna.dictionary")
+
+
+class Dictionary(commands.Cog):
+    """
+    Word, yo
+    Parts of this cog are adapted from the PyDictionary library.
+    """
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """Nothing to delete"""
+        return
+
+    def __init__(self, bot):
+        self.bot = bot
+        self.session = aiohttp.ClientSession()
+
+    def cog_unload(self):
+        self.bot.loop.create_task(self.session.close())
+
+    @commands.command()
+    async def define(self, ctx, *, word: str):
+        """Displays definitions of a given word."""
+        search_msg = await ctx.send("Searching...")
+        search_term = word.split(" ", 1)[0]
+        result = await self._definition(ctx, search_term)
+        str_buffer = ""
+        if not result:
+            with contextlib.suppress(discord.NotFound):
+                await search_msg.delete()
+            await ctx.send("This word is not in the dictionary.")
+            return
+        for key in result:
+            str_buffer += f"\n**{key}**: \n"
+            counter = 1
+            j = False
+            for val in result[key]:
+                if val.startswith("("):
+                    str_buffer += f"{str(counter)}. *{val})* "
+                    counter += 1
+                    j = True
+                else:
+                    if j:
+                        str_buffer += f"{val}\n"
+                        j = False
+                    else:
+                        str_buffer += f"{str(counter)}. {val}\n"
+                        counter += 1
+        with contextlib.suppress(discord.NotFound):
+            await search_msg.delete()
+        for page in pagify(str_buffer, delims=["\n"]):
+            await ctx.send(page)
+
+    async def _definition(self, ctx, word):
+        data = await self._get_soup_object(f"http://wordnetweb.princeton.edu/perl/webwn?s={word}")
+        if not data:
+            return await ctx.send("Error fetching data.")
+        types = data.findAll("h3")
+        length = len(types)
+        lists = data.findAll("ul")
+        out = {}
+        if not lists:
+            return
+        for a in types:
+            reg = str(lists[types.index(a)])
+            meanings = []
+            for x in re.findall(r">\s\((.*?)\)\s<", reg):
+                if "often followed by" in x:
+                    pass
+                elif len(x) > 5 or " " in str(x):
+                    meanings.append(x)
+            name = a.text
+            out[name] = meanings
+        return out
+
+    @commands.command()
+    async def antonym(self, ctx, *, word: str):
+        """Displays antonyms for a given word."""
+        search_term = word.split(" ", 1)[0]
+        result = await self._antonym_or_synonym(ctx, "antonyms", search_term)
+        if not result:
+            await ctx.send("This word is not in the dictionary or nothing was found.")
+            return
+
+        result_text = "*, *".join(result)
+        msg = f"Antonyms for **{search_term}**: *{result_text}*"
+        for page in pagify(msg, delims=["\n"]):
+            await ctx.send(page)
+
+    @commands.command()
+    async def synonym(self, ctx, *, word: str):
+        """Displays synonyms for a given word."""
+        search_term = word.split(" ", 1)[0]
+        result = await self._antonym_or_synonym(ctx, "synonyms", search_term)
+        if not result:
+            await ctx.send("This word is not in the dictionary or nothing was found.")
+            return
+
+        result_text = "*, *".join(result)
+        msg = f"Synonyms for **{search_term}**: *{result_text}*"
+        for page in pagify(msg, delims=["\n"]):
+            await ctx.send(page)
+
+    async def _antonym_or_synonym(self, ctx, lookup_type, word):
+        if lookup_type not in ["antonyms", "synonyms"]:
+            return None
+        data = await self._get_soup_object(f"http://www.thesaurus.com/browse/{word}")
+        if not data:
+            await ctx.send("Error getting information from the website.")
+            return
+
+        script = data.find("script", id="preloaded-state")
+        if script:
+            script_text = script.string
+            script_text = script_text.strip()
+            script_text = script_text.replace("window.__PRELOADED_STATE__ = ", "")
+        else:
+            await ctx.send("Error fetching script from the website.")
+            return
+
+        try:
+            data = json.loads(script_text)
+        except json.decoder.JSONDecodeError:
+            await ctx.send("Error decoding script from the website.")
+            return
+        except Exception as e:
+            log.exception(e, exc_info=e)
+            await ctx.send("Something broke. Check your console for more information.")
+            return
+
+        try:
+            data_prefix = data["thesaurus"]["thesaurusData"]["data"]["slugs"][0]["entries"][0]["partOfSpeechGroups"][0]["shortDefinitions"][0]
+        except KeyError:
+            return None
+
+        if lookup_type == "antonyms":
+            try:
+                antonym_subsection = data_prefix["antonyms"]
+            except KeyError:
+                return None
+            antonyms = []
+            for item in antonym_subsection:
+                try:
+                    antonyms.append(item["targetWord"])
+                except KeyError:
+                    pass
+            if antonyms:
+                return antonyms
+            else:
+                return None
+
+        if lookup_type == "synonyms":
+            try:
+                synonyms_subsection = data_prefix["synonyms"]
+            except KeyError:
+                return None
+            synonyms = []
+            for item in synonyms_subsection:
+                try:
+                    synonyms.append(item["targetWord"])
+                except KeyError:
+                    pass
+            if synonyms:
+                return synonyms
+            else:
+                return None
+
+    async def _get_soup_object(self, url):
+        try:
+            async with self.session.request("GET", url) as response:
+                return BeautifulSoup(await response.text(), "html.parser")
+        except Exception:
+            log.error("Error fetching dictionary.py related webpage", exc_info=True)
+            return None

dictionary/info.json

@@ -0,0 +1,11 @@
+{
+    "author": ["UltimatePancake", "aikaterna"],
+    "description": "Gets definitions, antonyms, or synonyms for given words",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "After loading the cog with `[p]load dictionary`, use [p]help Dictionary to view commands.",
+    "min_bot_version": "3.5.0",
+    "short": "Gets definitions, antonyms, or synonyms for given words",
+    "tags": ["dictionary", "synonym", "antonym"],
+    "requirements": ["beautifulsoup4"],
+    "type": "COG"
+}

embedpeek/__init__.py

@@ -0,0 +1,7 @@
+from .embedpeek import EmbedPeek
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(EmbedPeek(bot))

embedpeek/embedpeek.py

@@ -0,0 +1,89 @@
+import discord
+from redbot.core import commands
+from redbot.core.utils.chat_formatting import box, pagify
+
+
+class EmbedPeek(commands.Cog):
+    """Take a closer look at an embed."""
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """Nothing to delete"""
+        return
+
+    def __init__(self, bot):
+        self.bot = bot
+        self._grave = "\N{GRAVE ACCENT}"
+
+    @commands.command()
+    async def embedpeek(self, ctx, message_link: str):
+        """
+        Take a closer look at an embed.
+
+        On a webhook message or other multi-embed messages, this will only display the first embed.
+        """
+        bad_link_msg = "That doesn't look like a message link, I can't reach that message, or that link does not have an embed."
+        no_guild_msg = "You aren't in that guild."
+        no_channel_msg = "You can't view that channel."
+        no_message_msg = "That message wasn't found."
+
+        if not "discord.com/channels/" in message_link:
+            return await ctx.send(bad_link_msg)
+        ids = message_link.split("/")
+        if len(ids) != 7:
+            return await ctx.send(bad_link_msg)
+
+        guild = self.bot.get_guild(int(ids[4]))
+        channel = self.bot.get_channel(int(ids[5]))
+        try:
+            message = await channel.fetch_message(int(ids[6]))
+        except discord.errors.NotFound:
+            return await ctx.send(no_message_msg)
+
+        if ctx.author not in guild.members:
+            return await ctx.send(no_guild_msg)
+        if not channel.permissions_for(ctx.author).read_messages:
+            return await ctx.send(no_channel_msg)
+
+        components = [guild, channel, message]
+        valid_components = [x for x in components if x != None]
+        if len(valid_components) < 3:
+            return await ctx.send(bad_link_msg)
+
+        try:
+            embed = message.embeds[0]
+        except IndexError:
+            return await ctx.send(bad_link_msg)
+
+        info = embed.to_dict()
+        sorted_info = dict(sorted(info.items()))
+        msg = ""
+
+        for k, v in sorted_info.items():
+            if k == "type":
+                continue
+            msg += f"+ {k}\n"
+            if isinstance(v, str):
+                msg += f"{v.replace(self._grave, '~')}\n\n"
+            elif isinstance(v, list):
+                for i, field in enumerate(v):
+                    msg += f"--- field {i+1} ---\n"
+                    for m, n in field.items():
+                        msg += f"- {str(m).replace(self._grave, '~')}\n"
+                        msg += f"{str(n).replace(self._grave, '~')}\n"
+                    msg += "\n"
+            elif isinstance(v, dict):
+                msg += self._dict_cleaner(v)
+                msg += "\n"
+            else:
+                msg += f"{str(v)}\n\n"
+
+        for page in pagify(msg, delims=f"{'-' * 20}", page_length=1500):
+            await ctx.send(box(page, lang="diff"))
+
+    def _dict_cleaner(self, d: dict):
+        msg = ""
+        for k, v in d.items():
+            k = str(k).replace(self._grave, "~")
+            v = str(v).replace(self._grave, "~")
+            msg += f"- {k}\n{v}\n"
+        return msg

embedpeek/info.json

@@ -0,0 +1,10 @@
+{
+    "author": ["aikaterna"],
+    "description": "Dev tool to display the content of an embed.",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "Thanks for installing.",
+    "min_bot_version": "3.5.0",
+    "short": "Dev tool to display the content of an embed.",
+    "tags": ["embed"],
+    "type": "COG"
+}

emojisteal/__init__.py

@@ -0,0 +1,7 @@
+from .emojisteal import EmojiSteal
+from redbot.core.utils import get_end_user_data_statement
+
+__red_end_user_data_statement__ = get_end_user_data_statement(__file__)
+
+async def setup(bot):
+    await bot.add_cog(EmojiSteal(bot))

emojisteal/emojisteal.py

@@ -0,0 +1,261 @@
+import io
+import re
+import zipfile
+import aiohttp
+import discord
+from typing import Optional, Union, List
+from itertools import zip_longest
+from redbot.core import commands, app_commands
+
+IMAGE_TYPES = (".png", ".jpg", ".jpeg", ".gif", ".webp")
+STICKER_KB = 512
+STICKER_DIM = 320
+STICKER_TIME = 5
+
+MISSING_EMOJIS = "Can't find emojis or stickers in that message."
+MISSING_REFERENCE = "Reply to a message with this command to steal an emoji."
+MESSAGE_FAIL = "I couldn't grab that message, sorry."
+UPLOADED_BY = "Uploaded by"
+STICKER_DESC = "Stolen sticker"
+STICKER_EMOJI = "😶"
+STICKER_FAIL = "❌ Failed to upload sticker"
+STICKER_SUCCESS = "✅ Uploaded sticker"
+STICKER_SLOTS = "⚠ This server doesn't have any more space for stickers!"
+EMOJI_FAIL = "❌ Failed to upload"
+EMOJI_SLOTS = "⚠ This server doesn't have any more space for emojis!"
+INVALID_EMOJI = "Invalid emoji or emoji ID."
+STICKER_TOO_BIG = f"Stickers may only be up to {STICKER_KB} KB and {STICKER_DIM}x{STICKER_DIM} pixels and last up to {STICKER_TIME} seconds."
+STICKER_ATTACHMENT = """\
+>>> For a non-moving sticker, simply use this command and attach a PNG image.
+For a moving sticker, Discord limitations make it very annoying. Follow these steps:
+1. Scale down and optimize your video/gif in <https://ezgif.com>
+2. Convert it to APNG in that same website.
+3. Download it and put it inside a zip file.
+4. Use this command and attach that zip file.
+\n**Important:** """ + STICKER_TOO_BIG
+
+
+class EmojiSteal(commands.Cog):
+    """Steals emojis and stickers sent by other people and optionally uploads them to your own server. Supports context menu commands."""
+
+    def __init__(self, bot):
+        super().__init__()
+        self.bot = bot
+        self.steal_context_menu = app_commands.ContextMenu(name='Steal Emotes', callback=self.steal_app_command)
+        self.steal_upload_context_menu = app_commands.ContextMenu(name='Steal+Upload Emotes', callback=self.steal_upload_app_command)
+        self.bot.tree.add_command(self.steal_context_menu)
+        self.bot.tree.add_command(self.steal_upload_context_menu)
+
+    async def cog_unload(self) -> None:
+        self.bot.tree.remove_command(self.steal_context_menu.name, type=self.steal_context_menu.type)
+        self.bot.tree.remove_command(self.steal_upload_context_menu.name, type=self.steal_upload_context_menu.type)
+
+    @staticmethod
+    def get_emojis(content: str) -> Optional[List[discord.PartialEmoji]]:
+        results = re.findall(r"(<(a?):(\w+):(\d{10,20})>)", content)
+        return [discord.PartialEmoji.from_str(result[0]) for result in results]
+    
+    @staticmethod
+    def available_emoji_slots(guild: discord.Guild, animated: bool) -> int:
+        current_emojis = len([em for em in guild.emojis if em.animated == animated])
+        return guild.emoji_limit - current_emojis
+
+    async def steal_ctx(self, ctx: commands.Context) -> Optional[List[Union[discord.PartialEmoji, discord.StickerItem]]]:
+        reference = ctx.message.reference
+        if not reference:
+            await ctx.send(MISSING_REFERENCE)
+            return None
+        message = await ctx.channel.fetch_message(reference.message_id)
+        if not message:
+            await ctx.send(MESSAGE_FAIL)
+            return None
+        if message.stickers:
+            return message.stickers
+        if not (emojis := self.get_emojis(message.content)):
+            await ctx.send(MISSING_EMOJIS)
+            return None
+        return emojis
+
+
+    @commands.group(name="steal", aliases=["emojisteal"], invoke_without_command=True)
+    async def steal_command(self, ctx: commands.Context):
+        """Steals the emojis and stickers of the message you reply to. Can also upload them with [p]steal upload."""
+        if not (emojis := await self.steal_ctx(ctx)):
+            return
+        response = '\n'.join([emoji.url for emoji in emojis])
+        await ctx.send(response)
+
+
+    # context menu added in __init__
+    async def steal_app_command(self, ctx: discord.Interaction, message: discord.Message):
+        if message.stickers:
+            emojis = message.stickers
+        elif not (emojis := self.get_emojis(message.content)):
+            return await ctx.response.send_message(MISSING_EMOJIS, ephemeral=True)
+
+        response = '\n'.join([emoji.url for emoji in emojis])
+        await ctx.response.send_message(content=response, ephemeral=True)
+
+
+    @steal_command.command(name="upload")
+    @commands.guild_only()
+    @commands.has_permissions(manage_emojis=True)
+    @commands.bot_has_permissions(manage_emojis=True, add_reactions=True)
+    async def steal_upload_command(self, ctx: commands.Context, *names: str):
+        """Steals emojis and stickers you reply to and uploads them to this server."""
+        if not (emojis := await self.steal_ctx(ctx)):
+            return
+        
+        if isinstance(emojis[0], discord.StickerItem):
+            if len(ctx.guild.stickers) >= ctx.guild.sticker_limit:
+                return await ctx.send(STICKER_SLOTS)
+
+            sticker = emojis[0]
+            fp = io.BytesIO()
+
+            try:
+                await sticker.save(fp)
+                await ctx.guild.create_sticker(
+                    name=sticker.name, description=STICKER_DESC, emoji=STICKER_EMOJI, file=discord.File(fp))
+
+            except discord.DiscordException as error:
+                return await ctx.send(f"{STICKER_FAIL}, {type(error).__name__}: {error}")
+
+            return await ctx.send(f"{STICKER_SUCCESS}: {sticker.name}")
+        
+        names = [''.join(re.findall(r"\w+", name)) for name in names]
+        names = [name if len(name) >= 2 else None for name in names]
+        emojis = list(dict.fromkeys(emojis))
+
+        async with aiohttp.ClientSession() as session:
+            for emoji, name in zip_longest(emojis, names):
+                if not self.available_emoji_slots(ctx.guild, emoji.animated):
+                    return await ctx.send(EMOJI_SLOTS)
+                if not emoji:
+                    break
+
+                try:
+                    async with session.get(emoji.url) as resp:
+                        resp.raise_for_status()
+                        image = io.BytesIO(await resp.read()).read()
+                    added = await ctx.guild.create_custom_emoji(name=name or emoji.name, image=image)
+
+                except (aiohttp.ClientError, discord.DiscordException) as error:
+                    return await ctx.send(f"{EMOJI_FAIL} {emoji.name}, {type(error).__name__}: {error}")
+
+                try:
+                    await ctx.message.add_reaction(added)
+                except discord.DiscordException:
+                    pass  # fail silently to not interrupt the loop, ideally there'd be a summary at the end
+
+
+    # context menu added in __init__
+    @app_commands.guild_only()
+    @app_commands.checks.has_permissions(manage_emojis=True)
+    @app_commands.checks.bot_has_permissions(manage_emojis=True)
+    async def steal_upload_app_command(self, ctx: discord.Interaction, message: discord.Message):
+        if message.stickers:
+            emojis: List[Union[discord.PartialEmoji, discord.StickerItem]] = message.stickers
+        elif not (emojis := self.get_emojis(message.content)):
+            return await ctx.response.send_message(MISSING_EMOJIS, ephemeral=True)
+        
+        await ctx.response.defer(thinking=True)
+        
+        if isinstance(emojis[0], discord.StickerItem):
+            if len(ctx.guild.stickers) >= ctx.guild.sticker_limit:
+                return await ctx.edit_original_response(content=STICKER_SLOTS)
+
+            sticker = emojis[0]
+            fp = io.BytesIO()
+
+            try:
+                await sticker.save(fp)
+                await ctx.guild.create_sticker(
+                    name=sticker.name, description=STICKER_DESC, emoji=STICKER_EMOJI, file=discord.File(fp))
+
+            except discord.DiscordException as error:
+                return await ctx.edit_original_response(content=f"{STICKER_FAIL}, {type(error).__name__}: {error}")
+
+            return await ctx.edit_original_response(content=f"{STICKER_SUCCESS}: {sticker.name}")
+
+        added_emojis = []
+        emojis = list(dict.fromkeys(emojis))
+        async with aiohttp.ClientSession() as session:
+            for emoji in emojis:
+                if not self.available_emoji_slots(ctx.guild, emoji.animated):
+                    response = EMOJI_SLOTS
+                    if added_emojis:
+                        response = ' '.join([str(e) for e in added_emojis]) + '\n' + response
+                    return await ctx.edit_original_response(content=response)
+
+                try:
+                    async with session.get(emoji.url) as resp:
+                        resp.raise_for_status()
+                        image = io.BytesIO(await resp.read()).read()
+                    added = await ctx.guild.create_custom_emoji(name=emoji.name, image=image)
+
+                except (aiohttp.ClientError, discord.DiscordException) as error:
+                    response = f"{EMOJI_FAIL} {emoji.name}, {type(error).__name__}: {error}"
+                    if added_emojis:
+                        response = ' '.join([str(e) for e in added_emojis]) + '\n' + response
+                    return await ctx.edit_original_response(content=response)
+
+                added_emojis.append(added)
+        
+        response = ' '.join([str(e) for e in added_emojis])
+        await ctx.edit_original_response(content=response)
+
+
+    @commands.command()
+    async def getemoji(self, ctx: commands.Context, *, emoji: str):
+        """Get the image link for custom emojis or an emoji ID."""
+        emoji = emoji.strip()
+
+        if emoji.isnumeric():
+            emojis = [discord.PartialEmoji(name="e", animated=b, id=int(emoji)) for b in [False, True]]
+        elif not (emojis := self.get_emojis(emoji)):
+            await ctx.send(INVALID_EMOJI)
+            return
+
+        await ctx.send('\n'.join(emoji.url for emoji in emojis))
+
+
+    @commands.command()
+    @commands.has_permissions(manage_emojis=True)
+    @commands.bot_has_permissions(manage_emojis=True)
+    async def uploadsticker(self, ctx: commands.Context, *, name: str = None):
+        """Uploads a sticker to the server, useful for mobile."""
+        if len(ctx.guild.stickers) >= ctx.guild.sticker_limit:
+            return await ctx.send(content=STICKER_SLOTS)
+
+        if not ctx.message.attachments or not ctx.message.attachments[0].filename.endswith((".png", ".zip")):
+            return await ctx.send(STICKER_ATTACHMENT)
+
+        attachment = ctx.message.attachments[0]
+        if attachment.size > STICKER_KB * 1024 or attachment.width and attachment.width > STICKER_DIM or attachment.height and attachment.height > STICKER_DIM:
+            return await ctx.send(STICKER_TOO_BIG)
+
+        await ctx.typing()
+        name = name or attachment.filename.split('.')[0]
+        fp = io.BytesIO()
+
+        try:
+            await attachment.save(fp)
+
+            if attachment.filename.endswith(".zip"):
+                z = zipfile.ZipFile(fp)
+                files = zipfile.ZipFile.namelist(z)
+                file = next(f for f in files if f.endswith(".png"))
+                if not file:
+                    return await ctx.send(STICKER_ATTACHMENT)
+                fp = io.BytesIO(z.read(file))
+
+            sticker = await ctx.guild.create_sticker(
+                name=name, description=f"{UPLOADED_BY} {ctx.author}", emoji=STICKER_EMOJI, file=discord.File(fp))
+
+        except (discord.DiscordException, zipfile.BadZipFile) as error:
+            if "exceed" in str(error):
+                return await ctx.send(STICKER_TOO_BIG)
+            return await ctx.send(f"{STICKER_FAIL}, {type(error).__name__}: {error}")
+
+        return await ctx.send(f"{STICKER_SUCCESS}: {sticker.name}")

emojisteal/info.json

@@ -0,0 +1,12 @@
+{
+    "author": ["hollowstrawberry"],
+    "min_bot_version": "3.5.0",
+    "description": "Steals emojis and stickers sent by other people and optionally uploads them to your own server. Supports context menu commands. Can also upload stickers from mobile.",
+    "hidden": false,
+    "install_msg": "\uD83D\uDE36 __**EmojiSteal**__ ```Cog installed. Instructions:\n1. Load it with [p]load emojisteal\n2. View commands with [p]help EmojiSteal\n3a. Optionally, enable the context menu commands with [p]slash enablecog emojisteal\n  3b. Sync commands with [p]slash sync\n  3c. You may need to restart Discord to see the new commands.```",
+    "required_cogs": {},
+    "requirements": [],
+    "short": "Steals emojis and stickers sent by other people.",
+    "end_user_data_statement": "This cog does not store any user data.",
+    "tags": ["crab", "emoji", "sticker", "steal", "image", "slash", "message", "context", "menu"]
+}

genshin/__init__.py

@@ -0,0 +1,7 @@
+from .genshin import Genshin
+from redbot.core.utils import get_end_user_data_statement
+
+__red_end_user_data_statement__ = get_end_user_data_statement(__file__)
+
+async def setup(bot):
+    await bot.add_cog(Genshin(bot))

genshin/genshin.py

@@ -0,0 +1,149 @@
+import discord
+from random import random, choice
+from redbot.core import commands, Config
+
+BANNERS = {
+    "Hu Tao": {
+        "5starfeatured": ["Hu Tao"],
+        "5star": ["Keqing", "Mona", "Qiqi", "Diluc", "Jean"],
+        "5starweapon": [],
+        "4starfeatured": ["Chongyun", "Xingqiu", "Xiangling"],
+        "4star": [
+            "Xinyan", "Sucrose", "Diona", "Noelle", "Bennett", "Fischl", "Ningguang", "Beidou", "Razor", "Barbara"],
+        "4starweapon": [
+            "Rust", "Sacrificial Bow", "The Stringless", "Favonius Warbow", "Eye of Perception",
+            "Sacrificial Fragments", "The Widsith", "Favonius Codex", "Favonius Lance", "Dragon's Bane",
+            "Rainslasher", "Sacrificial Greatsword", "The Bell", "Favonius Greatsword", "Lions Roar",
+            "Sacrificial Sword", "The Flute", "Favonius Sword"],
+        "3star": [
+            "Slingshot", "Sharpshooter's Oath", "Raven Bow", "Emerald Orb", "Thrilling Tales of Dragon Slayers",
+            "Magic Guide", "Black Tassel", "Debate Club", "Bloodtainted Greatsword", "Ferrous Shadow",
+            "Skyrider Sword", "Harbinger of Dawn", "Cool Steel"]
+    }
+}
+
+FIVESTARS = set(sum([banner["5star"] + banner["5starfeatured"] + banner["5starweapon"] for banner in BANNERS.values()], []))
+FOURSTARS = set(sum([banner["4star"] + banner["4starfeatured"] + banner["4starweapon"] for banner in BANNERS.values()], []))
+PULL_IMG = {
+    "Hu Tao": "https://cdn.discordapp.com/attachments/541768631445618689/818653017892061194/unknown.png"
+}
+WISH_IMG3 = "https://cdn.discordapp.com/attachments/541768631445618689/818649843202916362/unknown.png"
+WISH_IMG4 = "https://media.discordapp.net/attachments/541768631445618689/879785351579832371/wish4.png"
+WISH_IMG5 = "https://cdn.discordapp.com/attachments/541768631445618689/879785356382330901/wish5.png"
+
+
+class Genshin(commands.Cog):
+    """Simulates Genshin Impact gacha pulls."""
+
+    def __init__(self, bot):
+        super().__init__()
+        self.bot = bot
+        self.config = Config.get_conf(self, identifier=6765673686)
+        default_config = {"no4star": 0, "no4starf": 0, "no5star": 0, "no5starf": 0, "inv": {}}
+        self.config.register_user(**default_config)
+        self.banner = BANNERS["Hu Tao"]
+
+    async def red_delete_data_for_user(self, requester: str, user_id: int):
+        await self.config.user_from_id(user_id).clear()
+
+    # Commands
+
+    def pull(self, userdata):
+        roll = random()
+        if userdata["no5starf"] >= 179:  # featured 5 star pity
+            possible = self.banner["5starfeatured"]
+        elif userdata["no5star"] >= 89 or roll < 0.006:  # 5 star
+            if random() > 0.5:
+                possible = self.banner["5starfeatured"]
+            elif random() > 0.5 and self.banner["5starweapon"]:
+                possible = self.banner["5starweapon"]
+            else:
+                possible = self.banner["5star"]
+        elif userdata["no4starf"] >= 19:  # featured 4 star pity
+            possible = self.banner["4starfeatured"]
+        elif userdata["no4star"] >= 9 or roll < 0.051:  # 4 star
+            if random() > 0.5:
+                possible = self.banner["4starfeatured"]
+            elif random() > 0.5 and self.banner["4starweapon"]:
+                possible = self.banner["4starweapon"]
+            else:
+                possible = self.banner["4star"]
+        else:  # 3 star
+            possible = self.banner["3star"]
+
+        result = choice(possible)
+        if result in FOURSTARS:
+            userdata["no4star"] = 0
+            if result in self.banner["4starfeatured"]:
+                userdata["no4starf"] = 0
+            else:
+                userdata["no4starf"] += 1
+            userdata["no5star"] += 1
+            userdata["no5starf"] += 1
+        else:
+            userdata["no4star"] += 1
+            userdata["no4starf"] += 1
+            if result in FIVESTARS:
+                userdata["no5star"] = 0
+                if result in self.banner["5starfeatured"]:
+                    userdata["no5starf"] = 0
+                else:
+                    userdata["no5starf"] += 1
+            else:
+                userdata["no5star"] += 1
+
+        userdata["inv"][result] = userdata["inv"].get(result, 0) + 1
+        return result
+
+    async def pullx(self, user: discord.User, x: int):
+        userdata = await self.config.user(user).get_raw()
+        pulled = []
+        for _ in range(x):
+            pulled.append(self.pull(userdata))
+        await self.config.user(user).set_raw(value=userdata)
+        return pulled
+
+    @classmethod
+    def formatitem(cls, item):
+        return f'{item}{" ⭐⭐⭐⭐⭐" if item in FIVESTARS else ""}{" ⭐⭐⭐⭐" if item in FOURSTARS else ""}'
+
+    @commands.group(aliases=["genshinimpact"], invoke_without_command=True)
+    async def genshin(self, ctx: commands.Context):
+        """Base genshin command. Use me!"""
+        await ctx.send_help()
+
+    @genshin.command(aliases=["pull", "wish", "summon"])
+    async def pull1(self, ctx: commands.Context, *, etc=""):
+        """Makes 1 Genshin Impact wish (Hu Tao banner)"""
+        if etc == '10':
+            return await self.pull10(ctx)
+        pulled = (await self.pullx(ctx.author, 1))[0]
+        embed = discord.Embed(title="Your pull", description=self.formatitem(pulled), color=await ctx.embed_color())
+        embed.set_thumbnail(url=WISH_IMG5 if pulled in FIVESTARS else WISH_IMG4 if pulled in FOURSTARS else WISH_IMG3)
+        embed.set_image(url=PULL_IMG.get(pulled, ""))
+        await ctx.send(embed=embed)
+
+    @genshin.command(aliases=["wish10", "summon10"])
+    async def pull10(self, ctx: commands.Context):
+        """Makes 10 Genshin Impact wishes (Hu Tao banner)"""
+        pulled = await self.pullx(ctx.author, 10)
+        pulledf = "\n".join(self.formatitem(p) for p in pulled)
+        embed = discord.Embed(title="Your pulls", description=f"```md\n{pulledf}```", color=await ctx.embed_color())
+        embed.set_thumbnail(url=WISH_IMG5 if any(p in FIVESTARS for p in pulled) else
+                            WISH_IMG4 if any(p in FOURSTARS for p in pulled) else WISH_IMG3)
+        embed.set_image(url=next((PULL_IMG.get(p) for p in pulled if p in PULL_IMG), ""))
+        await ctx.send(embed=embed)
+
+    @genshin.command(aliases=["inventory"])
+    async def inv(self, ctx: commands.Context):
+        """View your Genshin Impact inventory"""
+        inv = await self.config.user(ctx.author).inv()
+        if not inv:
+            await ctx.send("You haven't pulled anything yet.")
+        else:
+            s = "```md"
+            for key, value in inv.items():
+                if key not in self.banner["3star"]:
+                    s += f'\n{value} x {key}{" ⭐⭐⭐⭐⭐" if key in FIVESTARS else ""}'
+            embed = discord.Embed(title="Your inventory", description=s + "```", color=await ctx.embed_color())
+            await ctx.send(embed=embed)

genshin/info.json

@@ -0,0 +1,12 @@
+{
+    "author": ["hollowstrawberry"],
+    "min_bot_version": "3.5.0",
+    "description": "Simulates Genshin Impact gacha pulls.",
+    "hidden": true,
+    "install_msg": "🌠 __**Genshin**__\n**This cog is for demonstration purposes. It doesn't have the latest banners or characters.**```Cog installed. Instructions:\n1. Load it with [p]load genshin\n2. Check out [p]help genshin```",
+    "required_cogs": {},
+    "requirements": [],
+    "short": "Simulates Genshin Impact gacha pulls.",
+    "end_user_data_statement": "This cog stores user IDs to keep track of your inventory.",
+    "tags": ["crab", "fun", "game", "gacha", "genshin", "impact", "random"]
+}

icyparser/__init__.py

@@ -0,0 +1,7 @@
+from .icyparser import IcyParser
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(IcyParser(bot))

icyparser/icyparser.py

@@ -0,0 +1,333 @@
+import asyncio
+import aiohttp
+from aiohttp.client_proto import ResponseHandler
+from aiohttp.http_parser import HttpResponseParserPy
+import discord
+import functools
+import io
+import lavalink
+import logging
+from pkg_resources import parse_version
+import struct
+import re
+from types import SimpleNamespace
+from typing import List, Pattern, Optional
+
+from redbot.core import commands
+from redbot.core.utils.chat_formatting import pagify
+from redbot.core.utils.menus import menu, DEFAULT_CONTROLS
+
+
+log = logging.getLogger("red.aikaterna.icyparser")
+
+
+HTML_CLEANUP: Pattern = re.compile("<.*?>|&([a-z0-9]+|#[0-9]{1,6}|#x[0-9a-f]{1,6});")
+
+
+# Now utilizing Jack1142's answer for ICY 200 OK -> 200 OK at
+# https://stackoverflow.com/questions/4247248/record-streaming-and-saving-internet-radio-in-python/71890980
+
+
+class ICYHttpResponseParser(HttpResponseParserPy):
+    def parse_message(self, lines):
+        if lines[0].startswith(b"ICY "):
+            lines[0] = b"HTTP/1.0 " + lines[0][4:]
+        return super().parse_message(lines)
+
+
+class ICYResponseHandler(ResponseHandler):
+    def set_response_params(
+        self,
+        *,
+        timer=None,
+        skip_payload=False,
+        read_until_eof=False,
+        auto_decompress=True,
+        read_timeout=None,
+        read_bufsize=2 ** 16,
+        timeout_ceil_threshold=5,
+        max_line_size=8190,
+        max_field_size=8190,
+    ) -> None:
+        # this is a copy of the implementation from here:
+        # https://github.com/aio-libs/aiohttp/blob/v3.8.1/aiohttp/client_proto.py#L137-L165
+        self._skip_payload = skip_payload
+
+        self._read_timeout = read_timeout
+        self._reschedule_timeout()
+
+        self._timeout_ceil_threshold = timeout_ceil_threshold
+
+        self._parser = ICYHttpResponseParser(
+            self,
+            self._loop,
+            read_bufsize,
+            timer=timer,
+            payload_exception=aiohttp.ClientPayloadError,
+            response_with_body=not skip_payload,
+            read_until_eof=read_until_eof,
+            auto_decompress=auto_decompress,
+        )
+
+        if self._tail:
+            data, self._tail = self._tail, b""
+            self.data_received(data)
+
+
+class ICYConnector(aiohttp.TCPConnector):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._factory = functools.partial(ICYResponseHandler, loop=self._loop)
+
+
+class IcyParser(commands.Cog):
+    """Icyparser/Shoutcast stream reader."""
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """Nothing to delete."""
+        return
+
+    def __init__(self, bot):
+        self.bot = bot
+        self.timeout = aiohttp.ClientTimeout(total=20)
+        self.session = session = aiohttp.ClientSession(
+            connector=ICYConnector(), headers={"Icy-MetaData": "1"}, timeout=self.timeout
+        )
+
+    def cog_unload(self):
+        self.bot.loop.create_task(self.session.close())
+
+    @commands.guild_only()
+    @commands.command(aliases=["icynp"])
+    async def icyparser(self, ctx, url=None):
+        """Show Icecast or Shoutcast stream information, if any.
+
+        Supported link formats:
+        \tDirect links to MP3, AAC, or OGG/Opus encoded Icecast or Shoutcast streams
+        \tLinks to PLS, M3U, or M3U8 files that contain said stream types
+        """
+        if not url:
+            audiocog = self.bot.get_cog("Audio")
+            if not audiocog:
+                return await ctx.send(
+                    "The Audio cog is not loaded. Provide a url with this command instead, to read from an online Icecast or Shoutcast stream."
+                )
+
+            if parse_version(lavalink.__version__) <=  parse_version("0.9.0"):
+                try:
+                    player = lavalink.get_player(ctx.guild.id)
+                except KeyError:
+                    return await ctx.send("The bot is not playing any music.")
+            else:
+                try:
+                    player = lavalink.get_player(ctx.guild.id)
+                except lavalink.PlayerNotFound:
+                    return await ctx.send("The bot is not playing any music.")
+            if not player.current:
+                return await ctx.send("The bot is not playing any music.")
+            if not player.current.is_stream:
+                return await ctx.send("The bot is not playing a stream.")
+            async with ctx.typing():
+                radio_obj = await self._icyreader(ctx, player.current.uri)
+        else:
+            async with ctx.typing():
+                radio_obj = await self._icyreader(ctx, url)
+
+        if not radio_obj:
+            return
+
+        embed_menu_list = []
+
+        # Now Playing embed
+        title = radio_obj.title if radio_obj.title is not None else "No stream title available"
+        song = f"**[{title}]({player.current.uri if not url else url})**\n"
+        embed = discord.Embed(colour=await ctx.embed_colour(), title="Now Playing", description=song)
+
+        # Set radio image if scraped or provided by the Icy headers
+        if radio_obj.image:
+            embed.set_thumbnail(url=radio_obj.image)
+        else:
+            icylogo = dict(radio_obj.resp_headers).get("icy-logo", None)
+            if icylogo:
+                embed.set_thumbnail(url=icylogo)
+            else:
+                icyfavicon = dict(radio_obj.resp_headers).get("icy-favicon", None)
+                if icyfavicon:
+                    embed.set_thumbnail(url=icyfavicon)
+
+        # Set radio description if present
+        radio_station_description = dict(radio_obj.resp_headers).get("icy-description", None)
+        if radio_station_description == "Unspecified description":
+            radio_station_description = None
+        if radio_station_description:
+            embed.set_footer(text=radio_station_description)
+
+        embed_menu_list.append(embed)
+
+        # Metadata info embed(s)
+        stream_info_text = ""
+        sorted_radio_obj_dict = dict(sorted(radio_obj.resp_headers))
+        for k, v in sorted_radio_obj_dict.items():
+            v = self._clean_html(v)
+            stream_info_text += f"**{k}**: {v}\n"
+
+        if len(stream_info_text) > 1950:
+            for page in pagify(stream_info_text, delims=["\n"], page_length=1950):
+                info_embed = discord.Embed(
+                    colour=await ctx.embed_colour(), title="Radio Station Metadata", description=page
+                )
+                embed_menu_list.append(info_embed)
+        else:
+            info_embed = discord.Embed(
+                colour=await ctx.embed_colour(), title="Radio Station Metadata", description=stream_info_text
+            )
+            embed_menu_list.append(info_embed)
+
+        await menu(ctx, embed_menu_list, DEFAULT_CONTROLS)
+
+    async def _icyreader(self, ctx: commands.Context, url: Optional[str]) -> Optional[SimpleNamespace]:
+        """
+        Icecast/Shoutcast stream reader.
+        """
+        try:
+            extensions = [".pls", ".m3u", ".m3u8"]
+            if any(url.endswith(x) for x in extensions):
+                async with self.session.get(url) as resp:
+                    lines = []
+                    async for line in resp.content:
+                        lines.append(line)
+
+                    if url.endswith(".pls"):
+                        url = await self._pls_reader(lines)
+                    else:
+                        url = await self._m3u_reader(lines)
+
+                    if url:
+                        await self._icyreader(ctx, url)
+                    else:
+                        await ctx.send("That url didn't seem to contain any valid Icecast or Shoutcast links.")
+                        return
+
+            async with self.session.get(url) as resp:
+                metaint = await self._metaint_read(ctx, resp)
+                if metaint:
+                    radio_obj = await self._metadata_read(int(metaint), resp)
+                    return radio_obj
+
+        except aiohttp.client_exceptions.InvalidURL:
+            await ctx.send(f"{url} is not a valid url.")
+            return None
+        except aiohttp.client_exceptions.ClientConnectorError:
+            await ctx.send("The connection failed.")
+            return None
+        except aiohttp.client_exceptions.ClientPayloadError as e:
+            friendly_msg = "The website closed the connection prematurely or the response was malformed.\n"
+            friendly_msg += f"The error returned was: `{str(e)}`\n"
+            await ctx.send(friendly_msg)
+            return None
+        except asyncio.exceptions.TimeoutError:
+            await ctx.send("The bot timed out while trying to access that url.")
+            return None
+        except aiohttp.client_exceptions.ServerDisconnectedError:
+            await ctx.send("The target server disconnected early without a response.")
+            return None
+        except Exception:
+            log.error(
+                f"Icyparser's _icyreader encountered an error while trying to read a stream at {url}", exc_info=True
+            )
+            return None
+
+    @staticmethod
+    async def _metaint_read(ctx: commands.Context, resp: aiohttp.client_reqrep.ClientResponse) -> Optional[int]:
+        """Fetch the metaint value to know how much of the stream header to read, for metadata."""
+        metaint = resp.headers.get("icy-metaint", None)
+        if not metaint:
+            error_msg = (
+                "The url provided doesn't seem like an Icecast or Shoutcast direct stream link, "
+                "or doesn't contain a supported format stream link: couldn't read the metadata length."
+            )
+            await ctx.send(error_msg)
+            return None
+
+        try:
+            metaint = int(metaint)
+            return metaint
+        except ValueError:
+            return None
+
+    @staticmethod
+    async def _metadata_read(metaint: int, resp: aiohttp.client_reqrep.ClientResponse) -> Optional[SimpleNamespace]:
+        """Read the metadata at the beginning of the stream chunk."""
+        try:
+            for _ in range(5):
+                await resp.content.readexactly(metaint)
+                metadata_length = struct.unpack("B", await resp.content.readexactly(1))[0] * 16
+                metadata = await resp.content.readexactly(metadata_length)
+                m = re.search(br"StreamTitle='([^']*)';", metadata.rstrip(b"\0"))
+                if m:
+                    title = m.group(1)
+                    if len(title) > 0:
+                        title = title.decode("utf-8", errors="replace")
+                    else:
+                        title = None
+                else:
+                    title = None
+
+                image = False
+                t = re.search(br"StreamUrl='([^']*)';", metadata.rstrip(b"\0"))
+                if t:
+                    streamurl = t.group(1)
+                    if streamurl:
+                        streamurl = streamurl.decode("utf-8", errors="replace")
+                        image_ext = ["webp", "png", "jpg", "gif"]
+                        if streamurl.split(".")[-1] in image_ext:
+                            image = True
+                else:
+                    streamurl = None
+
+                radio_obj = SimpleNamespace(title=title, image=streamurl, resp_headers=resp.headers.items())
+                return radio_obj
+
+        except Exception:
+            log.error(
+                f"Icyparser's _metadata_read encountered an error while trying to read a stream at {resp.url}", exc_info=True
+            )
+        return None
+
+    @staticmethod
+    def _clean_html(html: str) -> str:
+        """
+        Strip out any html, as subtle as a hammer.
+        """
+        plain_text = re.sub(HTML_CLEANUP, "", html)
+        return plain_text
+
+    @staticmethod
+    async def _m3u_reader(readlines: List[bytes]) -> Optional[str]:
+        """
+        Helper function for a quick and dirty M3U or M3U8 file read.
+        M3U8's will most likely contain .ts files, which are not readable by this cog.
+
+        Some M3Us seem to follow the standard M3U format, some only have a bare url in
+        the file, so let's just return the very first url with an http or https prefix
+        found, if it's formatted like a real url and not a relative url, and is not a .ts chunk.
+        """
+        for text_line in readlines:
+            text_line_str = text_line.decode()
+            if text_line_str.startswith("http"):
+                if not text_line_str.endswith(".ts"):
+                    return text_line_str
+
+        return None
+
+    @staticmethod
+    async def _pls_reader(readlines: List[bytes]) -> Optional[str]:
+        """
+        Helper function for a quick and dirty PLS file read.
+        """
+        for text_line in readlines:
+            text_line_str = text_line.decode()
+            if text_line_str.startswith("File1="):
+                return text_line_str[6:]
+
+        return None

icyparser/info.json

@@ -0,0 +1,10 @@
+{
+    "author": ["aikaterna"],
+    "description": "Audio addon cog for dislaying icecast/shoutcast info.",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "Thanks for installing, have fun.",
+    "min_bot_version": "3.5.0",
+    "short": "Audio addon cog for dislaying icecast/shoutcast info",
+    "tags": ["audio", "icecast", "shoutcast"],
+    "type": "COG"
+}

info.json

@@ -2,7 +2,7 @@
     "author": [
         "Valerie (1050531216589332581)"
     ],
-    "install_msg": "Thanks for adding Ava Cogs!",
+    "install_msg": "Thanks for adding Ava Cogs! Join our Discord @ https://discord.gg/5CA8sewarU",
     "name": "Ava Cogs",
     "short": "Ava Cogs, for our fork of Red-DiscordBot",
     "description": "Ava Cogs, for our fork of Red-DiscordBot",

inspirobot/__init__.py

@@ -0,0 +1,7 @@
+from .inspirobot import Inspirobot
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(Inspirobot(bot))

inspirobot/info.json

@@ -0,0 +1,11 @@
+{
+    "author": ["aikaterna"],
+    "description": "Fetch a random 'inspiring' message from http://inspirobot.me",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "Thanks for installing, have fun.",
+    "min_bot_version": "3.5.0",
+    "permissions" : ["embed_links"],
+    "short": "Fetch 'inspiring' messages.",
+    "tags": ["inspire", "inspirobot"],
+    "type": "COG"
+}

inspirobot/inspirobot.py

@@ -0,0 +1,30 @@
+import aiohttp
+import discord
+from redbot.core import commands
+
+
+class Inspirobot(commands.Cog):
+    """Posts images generated by https://inspirobot.me"""
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """ Nothing to delete """
+        return
+
+    def __init__(self, bot):
+        self.bot = bot
+        self.session = aiohttp.ClientSession()
+
+    @commands.command()
+    async def inspireme(self, ctx):
+        """Fetch a random "inspirational message" from the bot."""
+        try:
+            async with self.session.request("GET", "http://inspirobot.me/api?generate=true") as page:
+                pic = await page.text(encoding="utf-8")
+                em = discord.Embed()
+                em.set_image(url=pic)
+                await ctx.send(embed=em)
+        except Exception as e:
+            await ctx.send(f"Oops, there was a problem: {e}")
+
+    def cog_unload(self):
+        self.bot.loop.create_task(self.session.close())

invites/__init__.py

@@ -0,0 +1,7 @@
+from .invites import Invites
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(Invites(bot))

invites/info.json

@@ -0,0 +1,11 @@
+{
+    "author": ["aikaterna"],
+    "description": "Invite count display and leaderboard.",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "Thanks for installing. Use `[p]invites` to get started.",
+    "min_bot_version": "3.5.0",
+    "short": "Invite count display and leaderboard.",
+    "tags": ["invites"],
+    "permissions": ["administrator", "embed_links"],
+    "type": "COG"
+}

invites/invites.py

@@ -0,0 +1,316 @@
+from __future__ import annotations
+import discord
+from datetime import datetime
+import re
+from typing import List, Callable
+from redbot.core import commands, checks, Config
+from redbot.core.utils import chat_formatting as cf
+from redbot.vendored.discord.ext import menus
+
+
+OLD_CODE_RE = re.compile("^[0-9a-zA-Z]{16}$")
+CODE_RE = re.compile("^[0-9a-zA-Z]{6,7}$")
+NEW10_CODE_RE = re.compile("^[0-9a-zA-Z]{10}$")
+NEW8_CODE_RE = re.compile("^[0-9a-zA-Z]{8}$")
+
+FAILURE_MSG = "That invite doesn't seem to be valid."
+PERM_MSG = "I need the Administrator permission on this guild to view invite information."
+
+__version__ = "0.0.7"
+
+
+class Invites(commands.Cog):
+    def __init__(self, bot):
+        self.bot = bot
+        self.config = Config.get_conf(self, 2713371001, force_registration=True)
+
+        default_guild = {"pinned_invites": []}
+
+        self.config.register_guild(**default_guild)
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """Nothing to delete"""
+        return
+
+    @commands.guild_only()
+    @commands.group()
+    async def invites(self, ctx: commands.Context):
+        """Invite information."""
+        pass
+
+    @commands.max_concurrency(1, commands.BucketType.user)
+    @invites.command()
+    async def show(self, ctx: commands.Context, invite_code_or_url: str = None):
+        """Show the stats for an invite, or show all invites."""
+        if not ctx.channel.permissions_for(ctx.guild.me).administrator:
+            return await self._send_embed(ctx, PERM_MSG)
+
+        if not invite_code_or_url:
+            pages = MenuInvitePages(await ctx.guild.invites())
+        else:
+            invite_code = await self._find_invite_code(invite_code_or_url)
+            if not invite_code:
+                return await self._send_embed(ctx, FAILURE_MSG)
+            pages = MenuInvitePages([x for x in await ctx.guild.invites() if x.code == invite_code])
+        await self._menu(ctx, pages)
+
+    @invites.command()
+    async def leaderboard(self, ctx: commands.Context, list_all_invites: bool = False):
+        """List pinned invites or all invites in a leaderboard style."""
+        if not ctx.channel.permissions_for(ctx.guild.me).administrator:
+            return await self._send_embed(ctx, PERM_MSG)
+
+        if not list_all_invites:
+            pinned_invites = await self.config.guild(ctx.guild).pinned_invites()
+            if not pinned_invites:
+                return await self._send_embed(ctx, "No invites are pinned, or there are no invites to display.")
+        else:
+            pinned_invites = await ctx.guild.invites()
+        invite_info = ""
+        for i, invite_code_or_object in enumerate(pinned_invites):
+            if not list_all_invites:
+                inv_object = await self._get_invite_from_code(ctx, invite_code_or_object)
+            else:
+                inv_object = invite_code_or_object
+            if not inv_object:
+                # Someone deleted a pinned invite or it expired
+                pinned_invites = await self.config.guild(ctx.guild).pinned_invites()
+                pinned_invites.remove(invite_code_or_object)
+                await self.config.guild(ctx.guild).pinned_invites.set(pinned_invites)
+                continue
+            max_uses = await self.get_invite_max_uses(ctx, inv_object)
+            inv_details = f"{i+1}. {inv_object.url} [ {inv_object.uses} uses / {max_uses} max ]\n"
+            invite_info += inv_details
+
+        pagified_stings = [x for x in cf.pagify(invite_info, delims=["\n"], shorten_by=16)]
+        pages = MenuLeaderboardPages(ctx, pagified_stings, show_all=list_all_invites)
+        await self._menu(ctx, pages)
+
+    @invites.command(aliases=["listpinned"])
+    async def listpin(self, ctx: commands.Context):
+        """List pinned invites."""
+        pinned_invites = await self.config.guild(ctx.guild).pinned_invites()
+        invite_list = "None." if len(pinned_invites) == 0 else "\n".join(pinned_invites)
+        await self._send_embed(ctx, "Pinned Invites", invite_list)
+
+    @invites.command()
+    async def pin(self, ctx: commands.Context, invite_code_or_url: str):
+        """Pin an invite to the leaderboard."""
+        if not ctx.channel.permissions_for(ctx.guild.me).administrator:
+            return await self._send_embed(ctx, PERM_MSG)
+
+        invite_code = await self._find_invite_code(invite_code_or_url)
+        invite_code = await self._check_invite_code(ctx, invite_code)
+        if not invite_code:
+            return await self._send_embed(ctx, FAILURE_MSG)
+
+        existing_pins = await self.config.guild(ctx.guild).pinned_invites()
+        if invite_code not in existing_pins:
+            existing_pins.append(invite_code)
+            await self.config.guild(ctx.guild).pinned_invites.set(existing_pins)
+            await self._send_embed(ctx, f"{invite_code} was added to the pinned list.")
+        else:
+            await self._send_embed(ctx, f"{invite_code} is already in the pinned list.")
+
+    @invites.command()
+    async def unpin(self, ctx: commands.Context, invite_code_or_url: str):
+        """Unpin an invite from the leaderboard."""
+        invite_code = await self._find_invite_code(invite_code_or_url)
+        if not invite_code:
+            return await self._send_embed(ctx, FAILURE_MSG)
+
+        pinned_invites = await self.config.guild(ctx.guild).pinned_invites()
+        if invite_code in pinned_invites:
+            pinned_invites.remove(invite_code)
+        else:
+            return await self._send_embed(ctx, f"{invite_code} isn't in the pinned list.")
+        await self.config.guild(ctx.guild).pinned_invites.set(pinned_invites)
+        await self._send_embed(ctx, f"{invite_code} was removed from the pinned list.")
+
+    @invites.command(hidden=True)
+    async def version(self, ctx):
+        """Invites version."""
+        await self._send_embed(ctx, __version__)
+
+    @staticmethod
+    async def _check_invite_code(ctx: commands.Context, invite_code: str):
+        for invite in await ctx.guild.invites():
+            if invite.code == invite_code:
+                return invite_code
+            else:
+                continue
+
+            return None
+
+    @staticmethod
+    async def _find_invite_code(invite_code_or_url: str):
+        invite_match = (
+            re.fullmatch(OLD_CODE_RE, invite_code_or_url)
+            or re.fullmatch(CODE_RE, invite_code_or_url)
+            or re.fullmatch(NEW10_CODE_RE, invite_code_or_url)
+            or re.fullmatch(NEW8_CODE_RE, invite_code_or_url)
+        )
+        if invite_match:
+            return invite_code_or_url
+        else:
+            sep = invite_code_or_url.rfind("/")
+            if sep:
+                try:
+                    invite_code = invite_code_or_url.rsplit("/", 1)[1]
+                    return invite_code
+                except IndexError:
+                    return None
+
+            return None
+
+    @staticmethod
+    async def _get_invite_from_code(ctx: commands.Context, invite_code: str):
+        for invite in await ctx.guild.invites():
+            if invite.code == invite_code:
+                return invite
+            else:
+                continue
+
+            return None
+
+    @classmethod
+    async def get_invite_max_uses(self, ctx: commands.Context, invite_object: discord.Invite):
+        if invite_object.max_uses == 0:
+            return "\N{INFINITY}"
+        else:
+            return invite_object.max_uses
+
+    async def _menu(self, ctx: commands.Context, pages: List[discord.Embed]):
+        # `wait` in this function is whether the menus wait for completion.
+        # An example of this is with concurrency:
+        # If max_concurrency's wait arg is False (the default):
+        # This function's wait being False will not follow the expected max_concurrency behaviour
+        # This function's wait being True will follow the expected max_concurrency behaviour
+        await MenuActions(source=pages, delete_message_after=False, clear_reactions_after=True, timeout=180).start(
+            ctx, wait=True
+        )
+
+    @staticmethod
+    async def _send_embed(ctx: commands.Context, title: str = None, description: str = None):
+        title = "\N{ZERO WIDTH SPACE}" if title is None else title
+        embed = discord.Embed()
+        embed.title = title
+        if description:
+            embed.description = description
+        embed.colour = await ctx.embed_colour()
+        await ctx.send(embed=embed)
+
+
+class MenuInvitePages(menus.ListPageSource):
+    def __init__(self, methods: List[discord.Invite]):
+        super().__init__(methods, per_page=1)
+
+    async def format_page(self, menu: MenuActions, invite: discord.Invite) -> discord.Embed:
+        # Use the menu to generate pages as they are needed instead of giving it a list of
+        # already-generated embeds.
+        embed = discord.Embed(title=f"Invites for {menu.ctx.guild.name}")
+        max_uses = await Invites.get_invite_max_uses(menu.ctx, invite)
+        msg = f"{cf.bold(invite.url)}\n\n"
+        msg += f"Uses: {invite.uses}/{max_uses}\n"
+        msg += f"Target Channel: {invite.channel.mention}\n"
+        msg += f"Created by: {invite.inviter.mention}\n"
+        msg += f"Created at: {invite.created_at.strftime('%m-%d-%Y @ %H:%M:%S UTC')}\n"
+        if invite.temporary:
+            msg += "Temporary invite\n"
+        if invite.max_age == 0:
+            max_age = f""
+        else:
+            max_age = f"Max age: {self._dynamic_time(int(invite.max_age))}"
+        msg += f"{max_age}"
+        embed.description = msg
+
+        return embed
+
+    @staticmethod
+    def _dynamic_time(time: int):
+        m, s = divmod(time, 60)
+        h, m = divmod(m, 60)
+        d, h = divmod(h, 24)
+
+        if d > 0:
+            msg = "{0}d {1}h"
+        elif d == 0 and h > 0:
+            msg = "{1}h {2}m"
+        elif d == 0 and h == 0 and m > 0:
+            msg = "{2}m {3}s"
+        elif d == 0 and h == 0 and m == 0 and s > 0:
+            msg = "{3}s"
+        else:
+            msg = ""
+        return msg.format(d, h, m, s)
+
+
+class MenuLeaderboardPages(menus.ListPageSource):
+    def __init__(self, ctx: commands.Context, entries: List[str], show_all: bool):
+        super().__init__(entries, per_page=1)
+        self.show_all = show_all
+        self.ctx = ctx
+
+    async def format_page(self, menu: MenuActions, page: str) -> discord.Embed:
+        embed = discord.Embed(title=f"Invite Usage for {self.ctx.guild.name}", description=page)
+        if self.show_all is False:
+            embed.set_footer(text="Only displaying pinned invites.")
+        else:
+            embed.set_footer(text="Displaying all invites.")
+        return embed
+
+
+class MenuActions(menus.MenuPages, inherit_buttons=False):
+    def reaction_check(self, payload):
+        """The function that is used to check whether the payload should be processed.
+        This is passed to :meth:`discord.ext.commands.Bot.wait_for <Bot.wait_for>`.
+
+        There should be no reason to override this function for most users.
+        This is done this way in this cog to let a bot owner operate the menu
+        along with the original command invoker.
+
+        Parameters
+        ------------
+        payload: :class:`discord.RawReactionActionEvent`
+            The payload to check.
+
+        Returns
+        ---------
+        :class:`bool`
+            Whether the payload should be processed.
+        """
+        if payload.message_id != self.message.id:
+            return False
+        if payload.user_id not in (*self.bot.owner_ids, self._author_id):
+            return False
+
+        return payload.emoji in self.buttons
+
+    async def show_checked_page(self, page_number: int) -> None:
+        # This is a custom impl of show_checked_page that allows looping around back to the
+        # beginning of the page stack when at the end and using next, or looping to the end
+        # when at the beginning page and using prev.
+        max_pages = self._source.get_max_pages()
+        try:
+            if max_pages is None:
+                await self.show_page(page_number)
+            elif page_number >= max_pages:
+                await self.show_page(0)
+            elif page_number < 0:
+                await self.show_page(max_pages - 1)
+            elif max_pages > page_number >= 0:
+                await self.show_page(page_number)
+        except IndexError:
+            pass
+
+    @menus.button("\N{UP-POINTING RED TRIANGLE}", position=menus.First(1))
+    async def prev(self, payload: discord.RawReactionActionEvent):
+        await self.show_checked_page(self.current_page - 1)
+
+    @menus.button("\N{DOWN-POINTING RED TRIANGLE}", position=menus.First(2))
+    async def next(self, payload: discord.RawReactionActionEvent):
+        await self.show_checked_page(self.current_page + 1)
+
+    @menus.button("\N{CROSS MARK}", position=menus.Last(0))
+    async def close_menu(self, payload: discord.RawReactionActionEvent) -> None:
+        self.stop()

latex/__init__.py

@@ -0,0 +1,7 @@
+from .latex import Latex
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(Latex(bot))

latex/info.json

@@ -0,0 +1,11 @@
+{
+    "author": ["aikaterna", "Stevy"],
+    "description": "Generates an image for a LaTeX expression.",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "Thanks for installing, have fun.",
+    "min_bot_version": "3.5.0",
+    "short": "Generates an image for a LaTeX expression.",
+    "tags": ["latex"],
+    "requirements": ["pillow"],
+    "type": "COG"
+}

latex/latex.py

@@ -0,0 +1,64 @@
+import aiohttp
+import discord
+import io
+import logging
+import re
+from PIL import Image, ImageOps
+import urllib.parse as parse
+from redbot.core import commands
+
+
+log = logging.getLogger("red.aikaterna.latex")
+
+START_CODE_BLOCK_RE = re.compile(r"^((```(la)?tex)(?=\s)|(```))")
+
+
+class Latex(commands.Cog):
+    """LaTeX expressions via an image."""
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """Nothing to delete."""
+        return
+
+    def __init__(self, bot):
+        self.bot = bot
+        self.session = aiohttp.ClientSession()
+
+    @staticmethod
+    def cleanup_code_block(content):
+        # remove ```latex\n```/```tex\n```/``````
+        if content.startswith("```") and content.endswith("```"):
+            return START_CODE_BLOCK_RE.sub("", content)[:-3]
+        
+        # remove `foo`
+        return content.strip("` \n")
+
+    @commands.guild_only()
+    @commands.command()
+    async def latex(self, ctx, *, equation):
+        """Takes a LaTeX expression and makes it pretty."""
+        base_url = "https://latex.codecogs.com/gif.latex?%5Cbg_white%20%5CLARGE%20"
+        equation = self.cleanup_code_block(equation)
+        equation = parse.quote(equation)
+        url = f"{base_url}{equation}"
+
+        try:
+            async with self.session.get(url) as r:
+                image = await r.read()
+            image = Image.open(io.BytesIO(image)).convert("RGBA")
+        except Exception as exc:
+            log.exception("Something went wrong while trying to read the image:\n ", exc_info=exc)
+            image = None
+
+        if not image:
+            return await ctx.send("I can't get the image from the website, check your console for more information.")
+
+        image = ImageOps.expand(image, border=10, fill="white")
+        image_file_object = io.BytesIO()
+        image.save(image_file_object, format="png")
+        image_file_object.seek(0)
+        image_final = discord.File(fp=image_file_object, filename="latex.png")
+        await ctx.send(file=image_final)
+
+    def cog_unload(self):
+        self.bot.loop.create_task(self.session.close())

luigipoker/__init__.py

@@ -0,0 +1,7 @@
+from .luigipoker import LuigiPoker
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(LuigiPoker(bot))

luigipoker/info.json

@@ -0,0 +1,10 @@
+{
+    "author": ["aikaterna", "themario30"],
+    "description": "Play the Luigi Poker minigame from New Super Mario Brothers.",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "Thanks for installing.",
+    "min_bot_version": "3.5.0",
+    "short": "A Luigi poker minigame.",
+    "tags": ["poker", "game"],
+    "type": "COG"
+}

luigipoker/luigipoker.py

@@ -0,0 +1,428 @@
+import asyncio
+import logging
+from random import randint
+from redbot.core import commands
+from redbot.core.utils.chat_formatting import box
+from redbot.core.utils.predicates import MessagePredicate
+
+
+log = logging.getLogger("red.aikaterna.luigipoker")
+
+
+class Card:
+    def __init__(self, card_number=None):
+        self._number = card_number if card_number else randint(1, 6)
+        self._suit = self._suit()
+
+    def _suit(self):
+        if self._number == 1:
+            suit = "\N{CLOUD}\N{VARIATION SELECTOR-16}"
+        elif self._number == 2:
+            suit = "\N{MUSHROOM}"
+        elif self._number == 3:
+            suit = "\N{SUNFLOWER}"
+        elif self._number == 4:
+            suit = "\N{LARGE GREEN SQUARE}"
+        elif self._number == 5:
+            suit = "\N{LARGE RED SQUARE}"
+        elif self._number == 6:
+            suit = "\N{WHITE MEDIUM STAR}"
+        else:
+            suit = "Error!"
+
+        return suit
+
+    def __repr__(self):
+        return f"{self._suit}"
+
+    def num(self):
+        return self._number
+
+    def suit(self):
+        return self._suit
+
+
+class Deck:
+    def __init__(self):
+        self._length = 5
+        self._deck = self._create_deck()
+        self.first_pair = 0
+        self.second_pair = 0
+        self.new_deck()
+
+    def _create_deck(self):
+        temp = [Card() for x in range(0, self._length)]
+        return temp
+
+    def _new_card(self, i):
+        self._deck[i] = Card()
+
+    def _sort_deck(self):
+        self._deck.sort(key=lambda x: x.num(), reverse=True)
+
+    def new_deck(self):
+        self._deck = self._create_deck()
+        self._sort_deck()
+
+    def deck(self):
+        return self._deck
+
+    def num(self, i):
+        return self._deck[i].num()
+
+    def swap(self, i):
+        for x in i:
+            self._new_card(int(x) - 1)
+        self._sort_deck()
+
+    def suit(self, i):
+        return self._deck[i].suit()
+
+    def len(self):
+        return self._length
+
+
+class LuigiPoker(commands.Cog):
+    """The Luigi Poker minigame from New Super Mario Brothers."""
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """ Nothing to delete """
+        return
+
+    __version__ = "0.1.2"
+
+    def __init__(self, bot):
+        self.bot = bot
+        self._in_game = {}
+        self._hit = {}
+        self.player_deck = Deck()
+        self.dealer_deck = Deck()
+
+    @commands.group()
+    async def poker(self, ctx):
+        """The Luigi Poker minigame from New Super Mario Brothers."""
+        if ctx.invoked_subcommand is None:
+            space = "\N{EN SPACE}"
+            msg = (
+                f"I'm Luigi, Number 1!\n"
+                f"This game plays the same as Luigi's "
+                f"Poker in Super Mario 64 DS Minigames.\n"
+                f"The card's worth is based on the suit.\n"
+                f"Starman > Mario > Luigi > Fire Flower > Mushroom > Cloud.\n"
+                f"{space*3}{Card(6)}{space*4}>{space*3}{Card(5)}{space*3}>{space*3}{Card(4)}{space*3}"
+                f">{space*6}{Card(3)}{space*6}>{space*4}{Card(2)}{space*5}>{space*4}{Card(1)}\n"
+                f"---------------------------------------------------------\n"
+                f"The following table represents the winning matches.\n"
+                f"For example, a Full House is greater than Three of a Kind, but "
+                f"less than a Four of a Kind.\n"
+                f"---------------------------------------------------------\n"
+                f"Flush:           {Card(6)}{Card(6)}{Card(6)}{Card(6)}{Card(6)}\n"
+                f"Four of a Kind:  {Card(6)}{Card(6)}{Card(6)}{Card(6)}\n"
+                f"Full House:      {Card(6)}{Card(6)}{Card(6)}{Card(3)}{Card(3)}\n"
+                f"Three of a Kind: {Card(6)}{Card(6)}{Card(6)}\n"
+                f"Two Pairs:       {Card(6)}{Card(6)}{Card(2)}{Card(2)}\n"
+                f"Pair:            {Card(6)}{Card(6)}\n"
+            )
+            await ctx.send(box(msg))
+            return await ctx.send(
+                f"Are you ready to play my game?! What are you waiting for? Start the game using `{ctx.prefix}poker play`!"
+            )
+
+    @poker.command()
+    async def play(self, ctx):
+        """Starts the Game!"""
+        if not self._in_game.get(ctx.guild.id, False):
+            self._in_game[ctx.guild.id] = True
+            self.player_deck.new_deck()
+            self.dealer_deck.new_deck()
+        else:
+            return await ctx.send("You're already in a game...")
+
+        square = "\N{WHITE MEDIUM SMALL SQUARE}"
+        msg = (
+            f"Dealer's Deck: {square*5}\n"
+            f"Your Deck:     {self.player_deck.suit(0)}{self.player_deck.suit(1)}"
+            f"{self.player_deck.suit(2)}{self.player_deck.suit(3)}{self.player_deck.suit(4)}"
+        )
+
+        await ctx.send(box(msg))
+
+        if self._hit.get(ctx.guild.id, False):
+            await ctx.send("`Stay` or `fold`?")
+            answers = ["stay", "fold"]
+        else:
+            await ctx.send("`Stay`, `hit`, or `fold`?")
+            answers = ["stay", "hit", "fold"]
+        await self._play_response(ctx, answers)
+
+    async def _play_response(self, ctx, answers):
+        pred = MessagePredicate.lower_contained_in(answers, ctx=ctx)
+        try:
+            user_resp = await ctx.bot.wait_for("message", timeout=120, check=pred)
+        except asyncio.TimeoutError:
+            await ctx.send("No response.")
+            return await self.fold(ctx)
+        if "stay" in user_resp.content.lower():
+            return await self.stay(ctx)
+        elif "hit" in user_resp.content.lower():
+            return await self.hit(ctx)
+        elif "fold" in user_resp.content.lower():
+            return await self.fold(ctx)
+        else:
+            log.error(
+                "LuigiPoker: Something broke unexpectedly in _play_response. Please report it.", exc_info=True,
+            )
+
+    async def hit(self, ctx):
+        card_question = await ctx.send(
+            "What cards do you want to swap out?\n"
+            "Use numbers 1 through 5 to specify, with commas in between.\n"
+            "Examples: `1,3,5` or `4, 5`"
+        )
+        try:
+            user_resp = await ctx.bot.wait_for("message", timeout=60, check=MessagePredicate.same_context(ctx))
+        except asyncio.TimeoutError:
+            await ctx.send("No response.")
+            return await self.fold(ctx)
+
+        user_answers = user_resp.content.strip().split(",")
+        user_answers_valid = list(set(user_answers) & set(["1", "2", "3", "4", "5"]))
+        if len(user_answers_valid) == 0:
+            return await self.hit(ctx)
+
+        await ctx.send("Swapping Cards...")
+        self.player_deck.swap(user_answers_valid)
+        square = "\N{WHITE MEDIUM SMALL SQUARE}"
+        msg = (
+            f"Dealer's Deck: {square*5}\n"
+            f"Your Deck:     {self.player_deck.suit(0)}{self.player_deck.suit(1)}"
+            f"{self.player_deck.suit(2)}{self.player_deck.suit(3)}{self.player_deck.suit(4)}"
+        )
+        await ctx.send(box(msg))
+        await ctx.send("`Stay` or `fold`?")
+        self._hit[ctx.guild.id] = True
+        answers = ["stay", "fold"]
+        await self._play_response(ctx, answers)
+
+    async def fold(self, ctx):
+        msg = "You have folded.\n"
+        msg += box(
+            f"Dealer's Deck: {self.dealer_deck.suit(0)}{self.dealer_deck.suit(1)}"
+            f"{self.dealer_deck.suit(2)}{self.dealer_deck.suit(3)}{self.dealer_deck.suit(4)}\n"
+            f"Your Deck:     {self.player_deck.suit(0)}{self.player_deck.suit(1)}"
+            f"{self.player_deck.suit(2)}{self.player_deck.suit(3)}{self.player_deck.suit(4)}"
+        )
+
+        self._in_game[ctx.guild.id] = False
+        self._hit[ctx.guild.id] = False
+        await ctx.send(msg)
+
+    async def stay(self, ctx):
+        say = ""
+        win = False
+        same_move = False
+        tied = False
+
+        # Flush
+        if self.flush(self.player_deck) != self.flush(self.dealer_deck):
+            say = "a Flush"
+            if self.flush(self.player_deck):
+                win = True
+        elif self.flush(self.player_deck) and self.flush(self.dealer_deck):
+            say = "Flush"
+            same_move = True
+            if self.player_deck.first_pair > self.dealer_deck.first_pair:
+                win = True
+            elif self.player_deck.first_pair == self.dealer_deck.first_pair:
+                tied = True
+
+        # Four of a Kind
+        elif self.four_of_a_kind(self.player_deck) != self.four_of_a_kind(self.dealer_deck):
+            say = "a Four of a Kind"
+            if self.four_of_a_kind(self.player_deck):
+                win = True
+        elif self.four_of_a_kind(self.player_deck) and self.four_of_a_kind(self.dealer_deck):
+            say = "Four of a Kind"
+            same_move = True
+            if self.player_deck.first_pair > self.dealer_deck.first_pair:
+                win = True
+            elif self.player_deck.first_pair == self.dealer_deck.first_pair:
+                tied = True
+
+        # Full House
+        elif self.full_house(self.player_deck) != self.full_house(self.dealer_deck):
+            say = "a Full House"
+            if self.full_house(self.player_deck):
+                win = True
+        elif self.full_house(self.player_deck) and self.full_house(self.dealer_deck):
+            say = "Full House"
+            same_move = True
+            if self.player_deck.first_pair > self.dealer_deck.first_pair:
+                win = True
+            elif self.player_deck.second_pair > self.dealer_deck.second_pair:
+                win = True
+            elif (
+                self.player_deck.first_pair == self.dealer_deck.first_pair
+                and self.player_deck.second_pair == self.dealer_deck.second_pair
+            ):
+                tied = True
+
+        # Full House
+        elif self.three_of_a_kind(self.player_deck) != self.three_of_a_kind(self.dealer_deck):
+            say = "a Three of a Kind"
+            if self.three_of_a_kind(self.player_deck):
+                win = True
+        elif self.three_of_a_kind(self.player_deck) and self.three_of_a_kind(self.dealer_deck):
+            say = "Three of a Kind"
+            same_move = True
+            if self.player_deck.first_pair > self.dealer_deck.first_pair:
+                win = True
+            elif self.player_deck.first_pair == self.dealer_deck.first_pair:
+                tied = True
+
+        # Two Pairs
+        elif self.two_pair(self.player_deck) != self.two_pair(self.dealer_deck):
+            say = "Two Pairs"
+            if self.two_pair(self.player_deck):
+                win = True
+        elif self.two_pair(self.player_deck) and self.two_pair(self.dealer_deck):
+            say = "Two Pairs"
+            same_move = True
+            if self.player_deck.first_pair > self.dealer_deck.first_pair:
+                win = True
+            elif self.player_deck.second_pair > self.dealer_deck.second_pair:
+                win = True
+            elif (
+                self.player_deck.first_pair == self.dealer_deck.first_pair
+                and self.player_deck.second_pair == self.dealer_deck.second_pair
+            ):
+                tied = True
+
+        # One Pair
+        elif self.one_pair(self.player_deck) != self.one_pair(self.dealer_deck):
+            say = "a Pair"
+            if self.one_pair(self.player_deck):
+                win = True
+        elif self.one_pair(self.player_deck) and self.one_pair(self.dealer_deck):
+            say = "Pair"
+            same_move = True
+            if self.player_deck.first_pair > self.dealer_deck.first_pair:
+                win = True
+            elif self.player_deck.first_pair == self.dealer_deck.first_pair:
+                tied = True
+        else:
+            tied = True
+
+        msg = "You've stayed.\n"
+
+        if same_move:
+            if win:
+                msg += f"You won! Your {say} is greater than Dealer's {say}!"
+            else:
+                msg += f"You lost! The Dealer's {say} is greater than your {say}!"
+        elif win:
+            msg += f"You won! You got {say}!"
+        elif tied:
+            msg += "Both the Dealer and the Player have tied."
+        else:
+            msg += f"You lost! The Dealer got {say}."
+
+        msg += box(
+            f"Dealer's Deck: {self.dealer_deck.suit(0)}{self.dealer_deck.suit(1)}"
+            f"{self.dealer_deck.suit(2)}{self.dealer_deck.suit(3)}{self.dealer_deck.suit(4)}\n"
+            f"Your Deck:     {self.player_deck.suit(0)}{self.player_deck.suit(1)}"
+            f"{self.player_deck.suit(2)}{self.player_deck.suit(3)}{self.player_deck.suit(4)}"
+        )
+        self._in_game[ctx.guild.id] = False
+        self._hit[ctx.guild.id] = False
+        await ctx.send(msg)
+
+    @staticmethod
+    def one_pair(deck):
+        answer = False
+        for x in range(0, deck.len() - 1):
+            if deck.num(x) == deck.num(x + 1):
+                deck.first_pair = deck.num(x)
+                answer = True
+
+        return answer
+
+    @staticmethod
+    def two_pair(deck):
+        answer = False
+        first_pair = 0
+        second_pair = 0
+
+        for x in range(0, deck.len() - 1):
+            if deck.num(x) == deck.num(x + 1):
+                if first_pair == 0:
+                    first_pair = deck.num(x)
+                elif first_pair != deck.num(x) and second_pair == 0:
+                    second_pair = deck.num(x)
+
+        if first_pair != 0 and second_pair != 0:
+            deck.first_pair = first_pair
+            deck.second_pair = second_pair
+            answer = True
+
+        return answer
+
+    @staticmethod
+    def three_of_a_kind(deck):
+        answer = False
+        for x in range(0, deck.len() - 2):
+            if deck.num(x) == deck.num(x + 1) and deck.num(x + 1) == deck.num(x + 2):
+                deck.first_pair = deck.num(x)
+                answer = True
+
+        return answer
+
+    @staticmethod
+    def full_house(deck):
+        answer = False
+        first_pair = 0
+        second_pair = 0
+        for x in range(0, deck.len() - 2):
+            if deck.num(x) == deck.num(x + 1) and deck.num(x + 1) == deck.num(x + 2):
+                if first_pair == 0:
+                    first_pair = deck.num(x)
+        for x in range(0, deck.len() - 1):
+            if deck.num(x) == deck.num(x + 1):
+                if first_pair != deck.num(x) and second_pair == 0:
+                    second_pair = deck.num(x)
+
+        if first_pair != 0 and second_pair != 0:
+            deck.first_pair = first_pair
+            deck.second_pair = second_pair
+            answer = True
+
+        return answer
+
+    @staticmethod
+    def four_of_a_kind(deck):
+        answer = False
+        for x in range(0, deck.len() - 3):
+            if (
+                deck.num(x) == deck.num(x + 1)
+                and deck.num(x + 1) == deck.num(x + 2)
+                and deck.num(x + 2) == deck.num(x + 3)
+            ):
+                deck.first_pair = deck.num(x)
+                answer = True
+
+        return answer
+
+    @staticmethod
+    def flush(deck):
+        answer = False
+        x = 0
+        if (
+            deck.num(x) == deck.num(x + 1)
+            and deck.num(x + 1) == deck.num(x + 2)
+            and deck.num(x + 2) == deck.num(x + 3)
+            and deck.num(x + 3) == deck.num(x + 4)
+        ):
+            deck.first_pair = deck.num(x)
+            answer = True
+
+        return answer

nsfw/nsfw.py

@@ -29,7 +29,7 @@ class Nsfw(Core):
     @commands.is_owner()
     @commands.group()
     async def nsfwset(self, ctx: commands.Context):
-        """Settings for the Nsfw cog."""
+        """Settings for the NSFW cog."""
 
     @nsfwset.command()
     async def switchredditapi(self, ctx: commands.Context):

otherbot/__init__.py

@@ -0,0 +1,11 @@
+from .otherbot import Otherbot
+
+__red_end_user_data_statement__ = (
+    "This cog does not persistently store end user data. This cog does store discord IDs as needed for operation."
+)
+
+
+async def setup(bot):
+    n = Otherbot(bot)
+    await n.generate_cache()
+    await bot.add_cog(n)

otherbot/info.json

@@ -0,0 +1,11 @@
+{
+    "author": ["aikaterna", "Predä"],
+    "description": "Alerts a role when bot(s) go offline.",
+    "end_user_data_statement": "This cog does not persistently store end user data. This cog does store Discord IDs as needed for operation.",
+    "install_msg": "Thanks for installing, have fun.",
+    "min_bot_version": "3.5.0",
+    "permissions" : ["manage_roles"],
+    "short": "Alerts a role when bot(s) go offline.",
+    "tags": ["bot", "offline", "uptime"],
+    "type": "COG"
+}

otherbot/otherbot.py

@@ -0,0 +1,437 @@
+from typing import Literal
+
+import discord
+from redbot.core.bot import Red
+from redbot.core import commands, checks, Config
+
+
+DEFAULT_OFFLINE_EMOJI = "\N{LARGE RED CIRCLE}"
+DEFAULT_ONLINE_EMOJI = "\N{WHITE HEAVY CHECK MARK}"
+
+
+class Otherbot(commands.Cog):
+    __author__ = ["aikaterna", "Predä 。#1001"]
+    __version__ = "0.11"
+
+    async def red_delete_data_for_user(
+        self, *, requester: Literal["discord", "owner", "user", "user_strict"], user_id: int,
+    ):
+        if requester == "discord":
+            # user is deleted, just comply
+
+            data = await self.config.all_guilds()
+            for guild_id, guild_data in data.items():
+                if user_id in guild_data.get("watching", []):
+                    bypass = guild_data.get("watching", [])
+                    bypass = set(bypass)
+                    bypass.discard(user_id)
+                    await self.config.guild_from_id(guild_id).bypass.set(list(bypass))
+
+    def __init__(self, bot: Red):
+        self.bot = bot
+        self.config = Config.get_conf(self, 2730321001, force_registration=True)
+        self.config.register_guild(
+            ping=None,
+            reporting=None,
+            watching=[],
+            online_watching=[],
+            offline_emoji=DEFAULT_OFFLINE_EMOJI,
+            online_emoji=DEFAULT_ONLINE_EMOJI,
+            embed_offline=True,
+            embed_online=True,
+        )
+
+    async def generate_cache(self):
+        self.otherbot_cache = await self.config.all_guilds()
+
+    def cog_unload(self):
+        self.otherbot_cache.clear()
+
+    async def get_watching(self, watch_list: list, watch_type: str, guild: int):
+        data = []
+        for user_id in watch_list:
+            user = self.bot.get_user(user_id)
+            if not user:
+                async with self.config.guild_from_id(guild).all() as config:
+                    config[watch_type].remove(user_id)
+            else:
+                data.append(user.mention)
+        return data
+
+    @commands.group()
+    @commands.guild_only()
+    @checks.admin_or_permissions(manage_roles=True)
+    async def otherbot(self, ctx: commands.Context):
+        """Otherbot configuration options."""
+        # Following logic from Trusty's welcome cog:
+        # https://github.com/TrustyJAID/Trusty-cogs/blob/master/welcome/welcome.py#L81
+        guild = ctx.guild
+        if not ctx.invoked_subcommand:
+            guild_data = await self.config.guild(guild).all()
+            settings_name = dict(
+                ping="Ping role",
+                reporting="Channel reporting",
+                watching="Offline tracking",
+                online_watching="Online tracking",
+                offline_emoji="Offline emoji",
+                online_emoji="Online emoji",
+                embed_offline="Offline embed",
+                embed_online="Online embed",
+            )
+            msg = ""
+            if ctx.channel.permissions_for(ctx.me).embed_links:
+                em = discord.Embed(
+                    color=await ctx.embed_colour(), title=f"Otherbot settings for {guild.name}"
+                )
+                for attr, name in settings_name.items():
+                    if attr == "ping":
+                        role = guild.get_role(guild_data["ping"])
+                        if role:
+                            msg += f"**{name}**: {role.mention}\n"
+                        else:
+                            msg += f"**{name}**: Not set.\n"
+                    elif attr == "reporting":
+                        channel = guild.get_channel(guild_data["reporting"])
+                        if channel:
+                            msg += f"**{name}**: {channel.mention}\n"
+                        else:
+                            msg += f"**{name}**: Not set.\n"
+                    elif attr == "watching":
+                        if guild_data["watching"]:
+                            msg += (
+                                f"**{name}**: "
+                                + " ".join(
+                                    await self.get_watching(
+                                        guild_data["watching"], "watching", guild.id
+                                    )
+                                )
+                                + "\n"
+                            )
+                        else:
+                            msg += f"**{name}**: Not set.\n"
+                    elif attr == "online_watching":
+                        if guild_data["online_watching"]:
+                            msg += (
+                                f"**{name}**: "
+                                + " ".join(
+                                    await self.get_watching(
+                                        guild_data["online_watching"], "online_watching", guild.id
+                                    )
+                                )
+                                + "\n"
+                            )
+                        else:
+                            msg += f"**{name}**: Not set.\n"
+                    else:
+                        msg += f"**{name}**: {guild_data[attr]}\n"
+                em.description = msg
+                if guild.icon:
+                    em.set_thumbnail(url=guild.icon.url)
+                await ctx.send(embed=em)
+            else:
+                msg = "```\n"
+                for attr, name in settings_name.items():
+                    if attr == "ping":
+                        role = guild.get_role(guild_data["ping"])
+                        if role:
+                            msg += f"{name}: {role.mention}\n"
+                        else:
+                            msg += f"{name}: Not set.\n"
+                    elif attr == "reporting":
+                        channel = guild.get_channel(guild_data["reporting"])
+                        if channel:
+                            msg += f"{name}: {channel.mention}\n"
+                        else:
+                            msg += f"{name}: Not set.\n"
+                    elif attr == "watching":
+                        if guild_data["watching"]:
+                            msg += (
+                                f"{name}: "
+                                + " ".join(
+                                    await self.get_watching(
+                                        guild_data["watching"], "watching", guild.id
+                                    )
+                                )
+                                + "\n"
+                            )
+                        else:
+                            msg += f"{name}: Not set."
+                    elif attr == "online_watching":
+                        if guild_data["online_watching"]:
+                            msg += (
+                                f"{name}: "
+                                + " ".join(
+                                    await self.get_watching(
+                                        guild_data["online_watching"], "online_watching", guild.id
+                                    )
+                                )
+                                + "\n"
+                            )
+                        else:
+                            msg += f"{name}: Not set.\n"
+                    else:
+                        msg += f"**{name}**: {guild_data[attr]}\n"
+                msg += "```"
+                await ctx.send(msg)
+
+    @otherbot.command()
+    async def channel(self, ctx: commands.Context, channel: discord.TextChannel = None):
+        """
+        Sets the channel to report in.
+        
+        Default to the current one.
+        """
+        if not channel:
+            channel = ctx.channel
+        await self.config.guild(ctx.guild).reporting.set(channel.id)
+        await ctx.send(f"Reporting channel set to: {channel.mention}.")
+        await self.generate_cache()
+
+    @otherbot.command()
+    async def pingrole(self, ctx: commands.Context, role_name: discord.Role = None):
+        """Sets the role to use for pinging. Leave blank to reset it."""
+        if not role_name:
+            await self.config.guild(ctx.guild).ping.set(None)
+            return await ctx.send("Ping role cleared.")
+        await self.config.guild(ctx.guild).ping.set(role_name.id)
+        pingrole_id = await self.config.guild(ctx.guild).ping()
+        pingrole_obj = discord.utils.get(ctx.guild.roles, id=pingrole_id)
+        await ctx.send(f"Ping role set to: `{pingrole_obj.name}`.")
+        await self.generate_cache()
+
+    @otherbot.group(name="watch", aliases=["watching"])
+    async def otherbot_watch(self, ctx: commands.Context):
+        """Watch settings."""
+
+    @otherbot_watch.group(name="offline")
+    async def otherbot_watch_offline(self, ctx: commands.Context):
+        """Manage offline notifications."""
+
+    @otherbot_watch_offline.command(name="add")
+    async def otherbot_watch_offline_add(self, ctx: commands.Context, bot: discord.Member):
+        """Add a bot that will be tracked when it goes offline."""
+        if not bot.bot:
+            return await ctx.send(
+                "You can't track normal users. Please try again with a bot user."
+            )
+
+        async with self.config.guild(ctx.guild).watching() as watch_list:
+            watch_list.append(bot.id)
+        await ctx.send(f"I will now track {bot.mention} when it goes offline.")
+        await self.generate_cache()
+
+    @otherbot_watch_offline.command(name="remove")
+    async def otherbot_watch_offline_remove(self, ctx: commands.Context, bot: discord.Member):
+        """Removes a bot currently tracked."""
+        if not bot.bot:
+            return await ctx.send(
+                "You can't choose a normal user. Please try again with a bot user."
+            )
+
+        async with self.config.guild(ctx.guild).watching() as watch_list:
+            try:
+                watch_list.remove(bot.id)
+                await ctx.send(
+                    f"Successfully removed {bot.mention} from offline tracked bot list."
+                )
+            except ValueError:
+                await ctx.send(f"{bot.mention} is not currently tracked.")
+        await self.generate_cache()
+
+    @otherbot_watch_offline.command(name="list")
+    async def otherbot_watch_offline_list(self, ctx: commands.Context):
+        """Lists currently tracked bots."""
+        watching = await self.config.guild(ctx.guild).watching()
+        if not watching:
+            return await ctx.send("There is currently no bots tracked for offline status.")
+
+        watching_list = await self.get_watching(watching, "watching", ctx.guild.id)
+        await ctx.send(
+            f"{len(watching):,} bot{'s' if len(watching) > 1 else ''} are currently tracked for offline status:\n"
+            + ", ".join(watching_list)
+        )
+        await self.generate_cache()
+
+    @otherbot_watch_offline.command(name="emoji")
+    async def otherbot_watch_offline_emoji(self, ctx: commands.Context, *, emoji: str = None):
+        """Choose which emoji that will be used for offline messages."""
+        if not emoji:
+            await self.config.guild(ctx.guild).offline_emoji.set(DEFAULT_OFFLINE_EMOJI)
+            await ctx.send(f"Offline emoji resetted to default: {DEFAULT_OFFLINE_EMOJI}")
+        else:
+            await self.config.guild(ctx.guild).offline_emoji.set(emoji)
+            await ctx.tick()
+        await self.generate_cache()
+
+    @otherbot_watch_offline.command(name="embed")
+    async def otherbot_watch_offline_embed(self, ctx: commands.Context):
+        """Set wether you want to receive notifications in embed or not."""
+        current = await self.config.guild(ctx.guild).embed_offline()
+        await self.config.guild(ctx.guild).embed_offline.set(not current)
+        await ctx.send(
+            "I will now send offline notifications in embeds."
+            if not current
+            else "I will no longer send offline notifications in embeds."
+        )
+        await self.generate_cache()
+
+    @otherbot_watch.group(name="online")
+    async def otherbot_watch_online(self, ctx: commands.Context):
+        """Manage online notifications."""
+
+    @otherbot_watch_online.command(name="add")
+    async def otherbot_watch_online_add(self, ctx: commands.Context, bot: discord.Member):
+        """Add a bot that will be tracked when it comes back online."""
+        if not bot.bot:
+            return await ctx.send(
+                "You can't track normal users. Please try again with a bot user."
+            )
+
+        async with self.config.guild(ctx.guild).online_watching() as watch_list:
+            watch_list.append(bot.id)
+        await ctx.send(f"I will now track {bot.mention} when it goes back online.")
+        await self.generate_cache()
+
+    @otherbot_watch_online.command(name="remove")
+    async def otherbot_watch_online_remove(self, ctx: commands.Context, bot: discord.Member):
+        """Removes a bot currently tracked."""
+        if not bot.bot:
+            return await ctx.send(
+                "You can't choose a normal user. Please try again with a bot user."
+            )
+
+        async with self.config.guild(ctx.guild).online_watching() as watch_list:
+            try:
+                watch_list.remove(bot.id)
+                await ctx.send(f"Successfully removed {bot.mention} from online tracked bot list.")
+            except ValueError:
+                await ctx.send(f"{bot.mention} is not currently tracked.")
+        await self.generate_cache()
+
+    @otherbot_watch_online.command(name="list")
+    async def otherbot_watch_online_list(self, ctx: commands.Context):
+        """Lists currently tracked bots."""
+        watching = await self.config.guild(ctx.guild).online_watching()
+        if not watching:
+            return await ctx.send("There is currently no bots tracked for online status.")
+
+        watching_list = await self.get_watching(watching, "online_watching", ctx.guild.id)
+        await ctx.send(
+            f"{len(watching):,} bot{'s' if len(watching) > 1 else ''} are currently tracked for online status:\n"
+            + ", ".join(watching_list)
+        )
+        await self.generate_cache()
+
+    @otherbot_watch_online.command(name="emoji")
+    async def otherbot_watch_online_emoji(self, ctx: commands.Context, *, emoji: str = None):
+        """Choose which emoji that will be used for online messages."""
+        if not emoji:
+            await self.config.guild(ctx.guild).online_emoji.set(DEFAULT_ONLINE_EMOJI)
+            await ctx.send(f"Online emoji resetted to default: {DEFAULT_ONLINE_EMOJI}")
+        else:
+            await self.config.guild(ctx.guild).online_emoji.set(emoji)
+            await ctx.tick()
+        await self.generate_cache()
+
+    @otherbot_watch_online.command(name="embed")
+    async def otherbot_watch_online_embed(self, ctx: commands.Context):
+        """Set wether you want to receive notifications in embed or not."""
+        current = await self.config.guild(ctx.guild).embed_online()
+        await self.config.guild(ctx.guild).embed_online.set(not current)
+        await ctx.send(
+            "I will now send online notifications in embeds."
+            if not current
+            else "I will no longer send online notifications in embeds."
+        )
+        await self.generate_cache()
+
+    @commands.Cog.listener()
+    async def on_presence_update(self, before: discord.Member, after: discord.Member):
+        if after.guild is None or not after.bot:
+            return
+
+        data = self.otherbot_cache.get(after.guild.id)
+        if data is None:
+            return
+        channel = self.bot.get_channel(data["reporting"])
+        if not channel:
+            return
+        if not (data["watching"] or data["online_watching"]):
+            return
+        if (
+            before.status != discord.Status.offline
+            and after.status == discord.Status.offline
+            and (after.id in data["watching"])
+        ):
+            try:
+                if data["embed_offline"]:
+                    em = discord.Embed(
+                        color=0x8B0000,
+                        description=f"{after.mention} is offline. {data['offline_emoji']}",
+                        timestamp=discord.utils.utcnow(),
+                    )
+                    if not data["ping"]:
+                        await channel.send(embed=em)
+                    else:
+                        await channel.send(
+                            f"<@&{data['ping']}>",
+                            embed=em,
+                            allowed_mentions=discord.AllowedMentions(roles=True),
+                        )
+                else:
+                    if not data["ping"]:
+                        await channel.send(f"{after.mention} is offline. {data['offline_emoji']}")
+                    else:
+                        if discord.version_info.minor < 4:
+                            await channel.send(
+                                f"<@&{data['ping']}>, {after.mention} is offline. {data['offline_emoji']}"
+                            )
+                        else:
+                            await channel.send(
+                                f"<@&{data['ping']}>, {after.mention} is offline. {data['offline_emoji']}",
+                                allowed_mentions=discord.AllowedMentions(roles=True)
+                            )
+                            
+            except discord.Forbidden:
+                async with self.config.guild(after.guild).watching() as old_data:
+                    old_data.remove(after.id)
+        elif (
+            before.status == discord.Status.offline
+            and after.status != discord.Status.offline
+            and (after.id in data["online_watching"])
+        ):
+            try:
+                if data["embed_online"]:
+                    em = discord.Embed(
+                        color=0x008800,
+                        description=f"{after.mention} is back online. {data['online_emoji']}",
+                        timestamp=discord.utils.utcnow(),
+                    )
+                    if not data["ping"]:
+                        await channel.send(embed=em)
+                    else:
+                        await channel.send(
+                            f"<@&{data['ping']}>",
+                            embed=em,
+                            allowed_mentions=discord.AllowedMentions(roles=True),
+                        )
+                else:
+                    if not data["ping"]:
+                        await channel.send(
+                            f"{after.mention} is back online. {data['online_emoji']}"
+                        )
+                    else:
+                        if discord.version_info.minor < 4:
+                            await channel.send(
+                                f"<@&{data['ping']}>, {after.mention} is back online. {data['online_emoji']}"
+                            )
+                            
+                        else:
+                            await channel.send(
+                                f"<@&{data['ping']}>, {after.mention} is back online. {data['online_emoji']}",
+                                allowed_mentions=discord.AllowedMentions(roles=True),
+                            )
+                            
+            except discord.Forbidden:
+                async with self.config.guild(after.guild).online_watching() as old_data:
+                    old_data.remove(after.id)

partycrash/__init__.py

@@ -0,0 +1,7 @@
+from .partycrash import PartyCrash
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(PartyCrash(bot))

partycrash/info.json

@@ -0,0 +1,10 @@
+{
+    "author": ["aikaterna", "Will (tekulvw)"],
+    "description": "Posts invites to servers, if the bot is allowed to view them. Does not generate new invites.",
+    "install_msg": "Note that having an invite available for a server does not automatically grant you permissions to join said server. Thanks for installing, have fun.",
+    "permissions" : ["manage_guild"],
+    "short": "Post server invites.",
+    "tags": ["invite"],
+    "type": "COG",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users."
+}

partycrash/partycrash.py

@@ -0,0 +1,84 @@
+import discord
+from redbot.core import commands, checks
+from redbot.core.utils.chat_formatting import box, pagify
+import asyncio
+
+
+class PartyCrash(commands.Cog):
+    """Partycrash inspired by v2 Admin by Will
+       Does not generate invites, only lists existing invites."""
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """ Nothing to delete """
+        return
+
+    def __init__(self, bot):
+        self.bot = bot
+
+    async def _get_invites(self, guild, ctx):
+        answers = ("yes", "y")
+        if not guild:
+            return await ctx.send("I'm not in that server.")
+        try:
+            invites = await guild.invites()
+        except discord.errors.Forbidden:
+            return await ctx.send(f"I don't have permission to view invites for {guild.name}.")
+        if not invites:
+            return await ctx.send("I couldn't access any invites.")
+        await ctx.send(f"Are you sure you want to post the invite(s) to {guild.name} here?")
+
+        def check(m):
+            return m.author == ctx.author
+
+        try:
+            msg = await ctx.bot.wait_for("message", timeout=15.0, check=check)
+            if msg.content.lower().strip() in answers:
+                msg = f"Invite(s) for **{guild.name}**:"
+                for url in invites:
+                    msg += f"\n{url}"
+                await ctx.send(msg)
+            else:
+                await ctx.send("Alright then.")
+        except asyncio.TimeoutError:
+            await ctx.send("I guess not.")
+
+    @commands.command()
+    @checks.is_owner()
+    async def partycrash(self, ctx, idnum=None):
+        """Lists servers and existing invites for them."""
+        if idnum:
+            guild = self.bot.get_guild(int(idnum))
+            await self._get_invites(guild, ctx)
+        else:
+            msg = ""
+            guilds = sorted(self.bot.guilds, key=lambda s: s.name)
+            for i, guild in enumerate(guilds, 1):
+                if len(guild.name) > 32:
+                    guild_name = f"{guild.name[:32]}..."
+                else:
+                    guild_name = guild.name
+                if i < 10:
+                    i = f"0{i}"
+                msg += f"{i}: {guild_name:35} ({guild.id})\n"
+            msg += "\nTo post the existing invite(s) for a server just type its number."
+            for page in pagify(msg, delims=["\n"]):
+                await ctx.send(box(page))
+
+            def check(m):
+                return m.author == ctx.author
+
+            try:
+                msg = await ctx.bot.wait_for("message", timeout=20.0, check=check)
+                try:
+                    guild_no = int(msg.content.strip())
+                    guild = guilds[guild_no - 1]
+                except ValueError:
+                    return await ctx.send("You must enter a number.")
+                except IndexError:
+                    return await ctx.send("Index out of range.")
+                try:
+                    await self._get_invites(guild, ctx)
+                except discord.errors.Forbidden:
+                    return await ctx.send(f"I don't have permission to get invites for {guild.name}.")
+            except asyncio.TimeoutError:
+                return await ctx.send("No server number entered, try again later.")

pingtime/__init__.py

@@ -0,0 +1,7 @@
+from .pingtime import Pingtime
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(Pingtime(bot))

pingtime/info.json

@@ -0,0 +1,10 @@
+{
+    "author": ["aikaterna"],
+    "description": "It's ping... with latency. Shows all shards.",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "Thanks for installing, have fun.",
+    "min_bot_version": "3.5.0",
+    "short": "Ping pong.",
+    "tags": ["ping", "pingtime", "latency"],
+    "type": "COG"
+}

pingtime/pingtime.py

@@ -0,0 +1,24 @@
+from redbot.core import commands
+
+
+BaseCog = getattr(commands, "Cog", object)
+
+
+class Pingtime(BaseCog):
+    """🏓"""
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """ Nothing to delete """
+        return
+
+    def __init__(self, bot):
+        self.bot = bot
+
+    @commands.command()
+    async def pingtime(self, ctx):
+        """Ping pong."""
+        latencies = self.bot.latencies
+        msg = "Pong!\n"
+        for shard, pingt in latencies:
+            msg += "Shard {}/{}: {}ms\n".format(shard + 1, len(latencies), round(pingt * 1000))
+        await ctx.send(msg)

pressf/__init__.py

@@ -0,0 +1,7 @@
+from .pressf import PressF
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(PressF(bot))

pressf/info.json

@@ -0,0 +1,10 @@
+{
+    "author": ["aikaterna"],
+    "description": "Pay respects to a thing or user by pressing f.",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "Thanks for installing, have fun.",
+    "min_bot_version": "3.5.0",
+    "short": "Press f to pay respects.",
+    "tags": ["f", "pressf", "respects"],
+    "type": "COG"
+}

pressf/pressf.py

@@ -0,0 +1,68 @@
+import asyncio
+import discord
+from redbot.core import commands
+from redbot.core.utils.common_filters import filter_mass_mentions
+
+
+class PressF(commands.Cog):
+    """Pay some respects."""
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """ Nothing to delete """
+        return
+
+    def __init__(self, bot):
+        self.bot = bot
+        self.channels = {}
+
+    @commands.command()
+    @commands.bot_has_permissions(add_reactions=True)
+    async def pressf(self, ctx, *, user: discord.User = None):
+        """Pay respects by pressing F"""
+        if str(ctx.channel.id) in self.channels:
+            return await ctx.send(
+                "Oops! I'm still paying respects in this channel, you'll have to wait until I'm done."
+            )
+
+        if user:
+            answer = user.display_name
+        else:
+            await ctx.send("What do you want to pay respects to?")
+
+            def check(m):
+                return m.author == ctx.author and m.channel == ctx.channel
+
+            try:
+                pressf = await ctx.bot.wait_for("message", timeout=120.0, check=check)
+            except asyncio.TimeoutError:
+                return await ctx.send("You took too long to reply.")
+
+            answer = pressf.content[:1900]
+
+        message = await ctx.send(
+            f"Everyone, let's pay respects to **{filter_mass_mentions(answer)}**! Press the f reaction on this message to pay respects."
+        )
+        await message.add_reaction("\U0001f1eb")
+        self.channels[str(ctx.channel.id)] = {"msg_id": message.id, "reacted": []}
+        await asyncio.sleep(120)
+        try:
+            await message.delete()
+        except (discord.errors.NotFound, discord.errors.Forbidden):
+            pass
+        amount = len(self.channels[str(ctx.channel.id)]["reacted"])
+        word = "person has" if amount == 1 else "people have"
+        await ctx.send(f"**{amount}** {word} paid respects to **{filter_mass_mentions(answer)}**.")
+        del self.channels[str(ctx.channel.id)]
+
+    @commands.Cog.listener()
+    async def on_reaction_add(self, reaction, user):
+        if str(reaction.message.channel.id) not in self.channels:
+            return
+        if self.channels[str(reaction.message.channel.id)]["msg_id"] != reaction.message.id:
+            return
+        if user.id == self.bot.user.id:
+            return
+        if user.id not in self.channels[str(reaction.message.channel.id)]["reacted"]:
+            if str(reaction.emoji) == "\U0001f1eb":
+                await reaction.message.channel.send(f"**{user.name}** has paid their respects.")
+                self.channels[str(reaction.message.channel.id)]["reacted"].append(user.id)

quiz/__init__.py

@@ -0,0 +1,7 @@
+from .quiz import Quiz
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(Quiz(bot))

quiz/info.json

@@ -0,0 +1,10 @@
+{
+    "author": ["Keane", "aikaterna"],
+    "description": "Play a kahoot-like trivia game.",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "Thanks for installing.",
+    "min_bot_version": "3.5.0",
+    "short": "Play a kahoot-like trivia game.",
+    "tags": ["trivia", "quiz"],
+    "type": "COG"
+}

quiz/quiz.py

@@ -0,0 +1,533 @@
+import aiohttp
+import asyncio
+import datetime
+import discord
+import html
+import logging
+import math
+import random
+import time
+
+from redbot.core import bank, checks, commands, Config
+from redbot.core.errors import BalanceTooHigh
+from redbot.core.utils.chat_formatting import box
+
+
+log = logging.getLogger("red.aikaterna.quiz")
+
+
+def check_global_setting_admin():
+    """
+    Command decorator. If the bank is not global, it checks if the author is
+    either a bot admin or has the manage_guild permission.
+    """
+
+    async def pred(ctx: commands.Context):
+        author = ctx.author
+        if not await bank.is_global():
+            if not isinstance(ctx.channel, discord.abc.GuildChannel):
+                return False
+            if await ctx.bot.is_owner(author):
+                return True
+            if author == ctx.guild.owner:
+                return True
+            if ctx.channel.permissions_for(author).manage_guild:
+                return True
+            admin_role_ids = await ctx.bot.get_admin_role_ids(ctx.guild.id)
+            for role in author.roles:
+                if role.id in admin_role_ids:
+                    return True
+        else:
+            return await ctx.bot.is_owner(author)
+
+    return commands.check(pred)
+
+
+class Quiz(commands.Cog):
+    """
+    Play a kahoot-like trivia game with questions from Open Trivia Database.
+    Originally by Keane for Red v2
+    """
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """ Nothing to delete """
+        return
+
+    def __init__(self, bot):
+        self.bot = bot
+
+        self.game_tasks = []
+        self.playing_channels = {}
+        self.session = aiohttp.ClientSession()
+        self.starter_task = self.bot.loop.create_task(self.start_loop())
+
+        self.config = Config.get_conf(self, 2782511001, force_registration=True)
+        default_guild = {
+            "afk": 3,
+            "multiplier": 100,
+            "questions": 20,
+            "show_answer": True,
+            "token": None,
+        }
+        self.config.register_guild(**default_guild)
+
+    @commands.guild_only()
+    @commands.group()
+    async def quiz(self, ctx):
+        """Play a kahoot-like trivia game.
+        Questions from the Open Trivia Database.
+
+        In this game, you will compete with other players to correctly answer each
+        question as quickly as you can. You have 10 seconds to type the answer
+        choice before time runs out. The longer you take to say the right answer,
+        the fewer points you get. If you get it wrong, you get no points. Only the
+        first valid answer (A, B, C, or D) will be recorded - be sure of the
+        answer before replying!
+
+        To end the game, stop responding to the questions and the game will time out.
+        """
+        pass
+
+    @quiz.command(name="play")
+    async def quiz_play(self, ctx, *, category_name_or_id=None):
+        """
+        Create or join a quiz game.
+        Specify a category name or ID number, otherwise it will be random.
+        Use [p]quiz categories to list category names or id numbers.
+        """
+        channel = ctx.message.channel
+        player = ctx.message.author
+
+        if not category_name_or_id:
+            # random
+            category_id = await self.category_selector()
+            category_name = await self.category_name_from_id(category_id)
+
+        elif category_name_or_id.isdigit():
+            # cat id specified
+            if 9 <= int(category_name_or_id) >= 32:
+                return await ctx.send(f"Invalid category number. Use `{ctx.prefix}quiz categories` to see a list.")
+            category_id = category_name_or_id
+            try:
+                category_name = await self.category_name_from_id(int(category_name_or_id))
+            except RuntimeError:
+                return await ctx.send(f"Invalid category ID. Use `{ctx.prefix}quiz categories` to see a list.")
+        else:
+            # cat name specified
+            try:
+                category_name = await self.category_name_match(category_name_or_id)
+            except RuntimeError:
+                return await ctx.send(f"Invalid category name. Use `{ctx.prefix}quiz categories` to see a list.")
+            category_id = await self.category_id_from_name(category_name)
+
+        if channel.id not in self.playing_channels:
+            self.playing_channels[channel.id] = {
+                "Start": datetime.datetime.utcnow(),
+                "Started": False,
+                "Players": {player.id: 0},
+                "Answers": {},
+                "Category": str(category_name),
+                "CategoryID": int(category_id),
+            }
+            return await ctx.send(
+                f"{player.display_name} is starting a quiz game!\n"
+                f"Category: `{category_name}`\n"
+                f"It will start in 30 seconds. Use `{ctx.prefix}quiz play` to join."
+            )
+
+        channelinfo = self.playing_channels[channel.id]
+        if player.id in channelinfo["Players"]:
+            await ctx.send("You are already in the game.")
+        elif channelinfo["Started"]:
+            await ctx.send("A quiz game is already underway.")
+        else:
+            channelinfo["Players"][player.id] = 0
+            await ctx.send(f"{player.display_name} joined the game.")
+
+    @quiz.command(name="categories")
+    async def quiz_cat(self, ctx):
+        """List quiz categories."""
+        async with self.session.get("https://opentdb.com/api_category.php") as response:
+            response_json = await response.json()
+            msg = f"[Category Name]{' ' * 24}[ID]\n"
+            for cat_dict in response_json["trivia_categories"]:
+                padding = 40 - len(cat_dict["name"])
+                msg += f"{cat_dict['name']}{' ' * padding}{cat_dict['id']}\n"
+        embed = discord.Embed(description=box(msg, lang="ini"))
+        await ctx.send(embed=embed)
+
+    @commands.guild_only()
+    @commands.group()
+    @checks.mod_or_permissions(manage_guild=True)
+    async def quizset(self, ctx):
+        """Quiz settings."""
+        if ctx.invoked_subcommand is None:
+            guild_data = await self.config.guild(ctx.guild).all()
+            msg = (
+                f"[Quiz Settings for {ctx.guild.name}]\n"
+                f"AFK questions before end: {guild_data['afk']}\n"
+                f"Credit multiplier:        {guild_data['multiplier']}x\n"
+                f"Number of questions:      {guild_data['questions']}\n"
+                f"Reveal correct answer:    {guild_data['show_answer']}\n"
+            )
+            await ctx.send(box(msg, lang="ini"))
+
+    @quizset.command(name="afk")
+    async def quizset_afk(self, ctx, questions: int):
+        """Set number of questions before the game ends due to non-answers."""
+        if 1 <= questions <= 10:
+            await self.config.guild(ctx.guild).afk.set(questions)
+            plural = "" if int(questions) == 1 else "s"
+            return await ctx.send(
+                f"{questions} question{plural} will be asked before the game times out. "
+                "A question will be counted in this afk count if 0 or 1 person answers. "
+                "2 or more answers on a question will not trigger this counter."
+            )
+        await ctx.send("Please use a number between 1 and 10. The default is 3.")
+
+    @quizset.command(name="show")
+    async def quizset_show(self, ctx):
+        """Toggle revealing the answers."""
+        show = await self.config.guild(ctx.guild).show_answer()
+        await self.config.guild(ctx.guild).show_answer.set(not show)
+        await ctx.send(f"Question answers will be revealed during the game: {not show}")
+
+    @quizset.command(name="questions")
+    async def quizset_questions(self, ctx, questions: int):
+        """Set number of questions per game."""
+        if 5 <= questions <= 50:
+            await self.config.guild(ctx.guild).questions.set(questions)
+            return await ctx.send(f"Number of questions per game: {questions}")
+        await ctx.send("Please use a number between 5 and 50. The default is 20.")
+
+    @check_global_setting_admin()
+    @quizset.command(name="multiplier")
+    async def quizset_multiplier(self, ctx, multiplier: int):
+        """
+        Set the credit multiplier.
+        The accepted range is 0 - 10000.
+        0 will turn credit gain off.
+        Credit gain will be based on the number of questions set and user speed.
+        1x = A small amount of credits like 1-10.
+        100x = A handful of credits: 100-500.
+        10000x = Quite a lot of credits, around 10k to 50k.
+		"""
+        if 0 <= multiplier <= 10000:
+            await self.config.guild(ctx.guild).multiplier.set(multiplier)
+            credits_name = await bank.get_currency_name(ctx.guild)
+            return await ctx.send(f"Credit multipilier: `{multiplier}x`")
+        await ctx.send("Please use a number between 0 and 10000. The default is 100.")
+
+    async def start_loop(self):
+        """Starts quiz games when the timeout period ends."""
+        try:
+            while True:
+                for channelid in list(self.playing_channels):
+                    channelinfo = self.playing_channels[channelid]
+                    since_start = (datetime.datetime.utcnow() - channelinfo["Start"]).total_seconds()
+
+                    if since_start > 30 and not channelinfo["Started"]:
+                        channel = self.bot.get_channel(channelid)
+                        if len(channelinfo["Players"]) > 1:
+                            channelinfo["Started"] = True
+                            task = self.bot.loop.create_task(self.game(channel))
+                            self.game_tasks.append(task)
+                        else:
+                            await channel.send("Nobody else joined the quiz game.")
+                            self.playing_channels.pop(channelid)
+                await asyncio.sleep(2)
+        except Exception:
+            log.error("Error in Quiz start loop.", exc_info=True)
+
+    async def game(self, channel):
+        """Runs a quiz game on a channel."""
+        channelinfo = self.playing_channels[channel.id]
+        category = channelinfo["CategoryID"]
+        category_name = channelinfo["Category"]
+
+        try:
+            response = await self.get_questions(channel.guild, category=channelinfo["CategoryID"])
+        except RuntimeError:
+            await channel.send("An error occurred in retrieving questions. Please try again.")
+            self.playing_channels.pop(channel.id)
+            raise
+
+        # Introduction
+        intro = (
+            f"Welcome to the quiz game! Your category is `{category_name}`.\n"
+            "Remember to answer correctly as quickly as you can for more points.\n"
+            "You have 10 seconds per question: the timer is shown in reactions on each question.\n"
+            "The game will begin shortly."
+        )
+        await channel.send(intro)
+        await asyncio.sleep(4)
+
+        # Question and Answer
+        afk_questions = 0
+        for index, dictionary in enumerate(response["results"]):
+            answers = [dictionary["correct_answer"]] + dictionary["incorrect_answers"]
+
+            # Display question and countdown
+            if len(answers) == 2:  # true/false question
+                answers = ["True", "False", "", ""]
+            else:
+                answers = [html.unescape(answer) for answer in answers]
+                random.shuffle(answers)
+
+            message = ""
+            message += html.unescape(dictionary["question"]) + "\n"
+            message += f"A. {answers[0]}\n"
+            message += f"B. {answers[1]}\n"
+            message += f"C. {answers[2]}\n"
+            message += f"D. {answers[3]}\n"
+
+            message_obj = await channel.send(box(message))
+            await message_obj.add_reaction("0⃣")
+            channelinfo["Answers"].clear()  # clear the previous question's answers
+            start_time = time.perf_counter()
+
+            numbers = ["1⃣", "2⃣", "3⃣", "4⃣", "5⃣", "6⃣", "7⃣", "8⃣", "9⃣", "🔟"]
+            for i in range(10):
+                if len(channelinfo["Answers"]) == len(channelinfo["Players"]):
+                    break
+                await asyncio.sleep(1)
+                await message_obj.add_reaction(numbers[i])
+
+            # Organize answers
+            user_answers = channelinfo["Answers"]
+            # snapshot channelinfo["Answers"] at this point in time
+            # to ignore new answers that are added to it
+            answerdict = {["a", "b", "c", "d"][num]: answers[num] for num in range(4)}
+
+            # Check for AFK
+            if len(user_answers) < 2:
+                afk_questions += 1
+                afk_count = await self.config.guild(channel.guild).afk()
+                if afk_questions == int(afk_count):
+                    await channel.send("The game has been cancelled due to lack of participation.")
+                    self.playing_channels.pop(channel.id)
+                    return
+            else:
+                afk_questions = 0
+
+            # Find and display correct answer
+            correct_letter = ""
+            for letter, answer in answerdict.items():
+                if answer == html.unescape(dictionary["correct_answer"]):
+                    correct_letter = letter
+                    break
+            assert answerdict[correct_letter] == html.unescape(dictionary["correct_answer"])
+
+            if await self.config.guild(channel.guild).show_answer():
+                message = f"Correct answer:```{correct_letter.upper()}. {answerdict[correct_letter]}```"
+                await channel.send(message)
+
+            # Assign scores
+            for playerid in user_answers:
+                if user_answers[playerid]["Choice"] == correct_letter:
+                    time_taken = user_answers[playerid]["Time"] - start_time
+                    assert time_taken > 0
+                    if time_taken < 1:
+                        channelinfo["Players"][playerid] += 1000
+                    else:
+                        # the 20 in the formula below is 2 * 10s (max answer time)
+                        channelinfo["Players"][playerid] += round(1000 * (1 - (time_taken / 20)))
+
+            # Display top 5 players and their points
+            message = self.scoreboard(channel)
+            await channel.send("Scoreboard:\n" + message)
+            await asyncio.sleep(4)
+
+            questions = await self.config.guild(channel.guild).questions()
+            if index < (int(questions) - 1):
+                await channel.send("Next question...")
+                await asyncio.sleep(1)
+
+        await self.end_game(channel)
+
+    async def end_game(self, channel):
+        """Ends a quiz game."""
+        # non-linear credit earning .0002x^{2.9} where x is score/100
+        channelinfo = self.playing_channels[channel.id]
+        idlist = sorted(list(channelinfo["Players"]), key=(lambda idnum: channelinfo["Players"][idnum]), reverse=True,)
+
+        winner = channel.guild.get_member(idlist[0])
+        await channel.send(f"Game over! {winner.mention} won!")
+
+        multiplier = await self.config.guild(channel.guild).multiplier()
+        if multiplier == 0:
+            self.playing_channels.pop(channel.id)
+            return
+
+        leaderboard = "\n"
+        max_credits = self.calculate_credits(channelinfo["Players"][idlist[0]])
+        end_len = len(str(max_credits)) + 1
+        rank_len = len(str(len(channelinfo["Players"])))
+        rank = 1
+
+        for playerid in idlist:
+            player = channel.guild.get_member(playerid)
+
+            if len(player.display_name) > 25 - rank_len - end_len:
+                name = player.display_name[: 22 - rank_len - end_len] + "..."
+            else:
+                name = player.display_name
+
+            leaderboard += str(rank)
+            leaderboard += " " * (1 + rank_len - len(str(rank)))
+            leaderboard += name
+            creds = self.calculate_credits(channelinfo["Players"][playerid]) * int(multiplier)
+            creds_str = str(creds)
+            leaderboard += " " * (26 - rank_len - 1 - len(name) - len(creds_str))
+            leaderboard += creds_str + "\n"
+
+            try:
+                await bank.deposit_credits(player, creds)
+            except BalanceTooHigh as e:
+                await bank.set_balance(player, e.max_balance)
+
+            rank += 1
+
+        await channel.send("Credits earned:\n" + box(leaderboard, lang="py"))
+        self.playing_channels.pop(channel.id)
+
+    def scoreboard(self, channel):
+        """Returns a scoreboard string to be sent to the text channel."""
+        channelinfo = self.playing_channels[channel.id]
+        scoreboard = "\n"
+        idlist = sorted(list(channelinfo["Players"]), key=(lambda idnum: channelinfo["Players"][idnum]), reverse=True,)
+        max_score = channelinfo["Players"][idlist[0]]
+        end_len = len(str(max_score)) + 1
+        rank = 1
+        for playerid in idlist[:5]:
+            player = channel.guild.get_member(playerid)
+            if len(player.display_name) > 24 - end_len:
+                name = player.display_name[: 21 - end_len] + "..."
+            else:
+                name = player.display_name
+            scoreboard += str(rank) + " " + name
+            score_str = str(channelinfo["Players"][playerid])
+            scoreboard += " " * (24 - len(name) - len(score_str))
+            scoreboard += score_str + "\n"
+            rank += 1
+        return box(scoreboard, lang="py")
+
+    def calculate_credits(self, score):
+        """Calculates credits earned from a score."""
+        adjusted = score / 100
+        if adjusted < 156.591:
+            result = 0.0002 * (adjusted ** 2.9)
+        else:
+            result = (0.6625 * math.exp(0.0411 * adjusted)) + 50
+        return round(result)
+
+    @commands.Cog.listener()
+    async def on_message_without_command(self, message):
+        if not message.guild:
+            return
+        authorid = message.author.id
+        channelid = message.channel.id
+        choice = message.content.lower()
+        if channelid in self.playing_channels:
+            channelinfo = self.playing_channels[channelid]
+            if (
+                authorid in channelinfo["Players"]
+                and authorid not in channelinfo["Answers"]
+                and choice in {"a", "b", "c", "d"}
+            ):
+                channelinfo["Answers"][authorid] = {"Choice": choice, "Time": time.perf_counter()}
+
+    # OpenTriviaDB API functions
+    async def get_questions(self, server, category=None, difficulty=None):
+        """Gets questions, resetting a token or getting a new one if necessary."""
+        questions = await self.config.guild(server).questions()
+        parameters = {"amount": questions}
+        if category:
+            parameters["category"] = category
+        if difficulty:
+            parameters["difficulty"] = difficulty
+        for _ in range(3):
+            parameters["token"] = await self.get_token(server)
+            async with self.session.get("https://opentdb.com/api.php", params=parameters) as response:
+                response_json = await response.json()
+                response_code = response_json["response_code"]
+                if response_code == 0:
+                    return response_json
+                elif response_code == 1:
+                    raise RuntimeError("Question retrieval unsuccessful. Response code from OTDB: 1")
+                elif response_code == 2:
+                    raise RuntimeError("Question retrieval unsuccessful. Response code from OTDB: 2")
+                elif response_code == 3:
+                    # Token expired. Obtain new one.
+                    log.debug("Quiz: Response code from OTDB: 3")
+                    await self.config.guild(server).token.set(None)
+                elif response_code == 4:
+                    # Token empty. Reset it.
+                    log.debug("Quiz: Response code from OTDB: 4")
+                    await self.reset_token(server)
+        raise RuntimeError("Failed to retrieve questions.")
+
+    async def get_token(self, server):
+        """Gets the provided server's token, or generates
+        and saves one if one doesn't exist."""
+        token = await self.config.guild(server).token()
+        if not token:
+            async with self.session.get("https://opentdb.com/api_token.php", params={"command": "request"}) as response:
+                response_json = await response.json()
+                token = response_json["token"]
+                await self.config.guild(server).token.set(token)
+        return token
+
+    async def reset_token(self, server):
+        """Resets the provided server's token."""
+        token = await self.config.guild(server).token()
+        async with self.session.get(
+            "https://opentdb.com/api_token.php", params={"command": "reset", "token": token}
+        ) as response:
+            response_code = (await response.json())["response_code"]
+            if response_code != 0:
+                raise RuntimeError(f"Token reset was unsuccessful. Response code from OTDB: {response_code}")
+
+    async def category_selector(self):
+        """Chooses a random category that has enough questions."""
+        for _ in range(10):
+            category = random.randint(9, 32)
+            async with self.session.get("https://opentdb.com/api_count.php", params={"category": category}) as response:
+                response_json = await response.json()
+                assert response_json["category_id"] == category
+                if response_json["category_question_count"]["total_question_count"] > 39:
+                    return category
+        raise RuntimeError("Failed to select a category.")
+
+    async def category_name_from_id(self, idnum):
+        """Finds a category's name from its number."""
+        async with self.session.get("https://opentdb.com/api_category.php") as response:
+            response_json = await response.json()
+            for cat_dict in response_json["trivia_categories"]:
+                if cat_dict["id"] == idnum:
+                    return cat_dict["name"]
+        raise RuntimeError("Failed to find category's name.")
+
+    async def category_name_match(self, name):
+        """Check if a category name exists."""
+        async with self.session.get("https://opentdb.com/api_category.php") as response:
+            response_json = await response.json()
+            for cat_dict in response_json["trivia_categories"]:
+                if cat_dict["name"].lower() == name.lower():
+                    return cat_dict["name"]
+        raise RuntimeError("Failed to find category's name.")
+
+    async def category_id_from_name(self, name):
+        """Finds a category's name from its number."""
+        async with self.session.get("https://opentdb.com/api_category.php") as response:
+            response_json = await response.json()
+            for cat_dict in response_json["trivia_categories"]:
+                if cat_dict["name"] == name:
+                    return cat_dict["id"]
+        raise RuntimeError("Failed to find category's id.")
+
+    def cog_unload(self):
+        self.bot.loop.create_task(self.session.close())
+        self.starter_task.cancel()
+        for task in self.game_tasks:
+            task.cancel()

reminder/LICENSE

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.

reminder/__init__.py

@@ -0,0 +1,12 @@
+from .reminder import Reminder
+
+__red_end_user_data_statement__ = (
+    "This cog stores data provided by users for the express purpose of redisplaying. "
+    "It does not store user data which was not provided through a command. "
+    "Users may remove their own content without making a data removal request. "
+    "This cog does not support data requests, but will respect deletion requests."
+)
+
+
+async def setup(bot):
+    await bot.add_cog(Reminder(bot))

reminder/info.json

@@ -0,0 +1,9 @@
+{
+    "author" : ["ZeLarpMaster#0818", "aikaterna"],
+    "description" : "Lets users tell the bot to remind them about anything they want. Originally by ZeLarpMaster.",
+    "install_msg" : "Enjoy reminding yourself of whatever you wanna remind yourself of! Use `[p]help Reminder` to get started.\nIf you have had ZeLarpMaster's version of Reminder installed in the past, this version of it uses the same data location for ease of switching to a supported version of the cog, as his repo has been archived.",
+    "min_bot_version": "3.5.0",
+    "permissions" : ["embed_links"],
+    "short" : "Allows users to remind themselves about anything they want.",
+    "tags" : ["remind", "reminder", "remindme"]
+}

reminder/reminder.py

@@ -0,0 +1,264 @@
+# Reminder was originally written by ZeLarpMaster#0818
+# https://github.com/ZeLarpMaster/ZeCogsV3/blob/master/reminder/reminder.py
+
+import asyncio
+import collections
+import datetime
+import discord
+import hashlib
+from itertools import islice
+from math import ceil
+import re
+from typing import List, Literal, Optional
+
+from redbot.core import commands, Config
+from redbot.core.bot import Red
+from redbot.core.commands import Context
+from redbot.core.utils.menus import menu, DEFAULT_CONTROLS
+
+
+class Reminder(commands.Cog):
+    """Utilities to remind yourself of whatever you want"""
+
+    __author__ = ["ZeLarpMaster#0818", "aikaterna#1393"]
+
+    TIME_AMNT_REGEX = re.compile("([1-9][0-9]*)([a-z]+)", re.IGNORECASE)
+    TIME_QUANTITIES = collections.OrderedDict(
+        [
+            ("seconds", 1),
+            ("minutes", 60),
+            ("hours", 3600),
+            ("days", 86400),
+            ("weeks", 604800),
+            ("months", 2628000),
+            ("years", 31540000),
+        ]
+    )
+    MAX_SECONDS = TIME_QUANTITIES["years"] * 2
+
+    async def red_delete_data_for_user(
+        self,
+        *,
+        requester: Literal["discord", "owner", "user", "user_strict"],
+        user_id: int,
+    ):
+        await self.config.user_from_id(user_id).clear()
+
+    def __init__(self, bot: Red):
+        super().__init__()
+        self.bot = bot
+        unique_id = int(hashlib.sha512((self.__author__[0] + "@" + self.__class__.__name__).encode()).hexdigest(), 16)
+        self.config = Config.get_conf(self, identifier=unique_id, force_registration=True)
+        self.config.register_user(reminders=[], offset=0)
+        self.futures = {}
+        asyncio.ensure_future(self.start_saved_reminders())
+
+    def cog_unload(self):
+        for user_futures in self.futures.values():
+            for future in user_futures:
+                future.cancel()
+
+    @commands.group(invoke_without_command=True, aliases=["remindme"], name="remind")
+    async def command_remind(self, ctx: Context, time: str, *, reminder_text: str):
+        """
+        Remind yourself of something in a specific amount of time
+
+        Examples for time: `5d`, `10m`, `10m30s`, `1h`, `1y1mo2w5d10h30m15s`
+        Abbreviations: `s` for seconds, `m` for minutes, `h` for hours, `d` for days, `w` for weeks, `mo` for months, `y` for years
+        Any longer abbreviation is accepted. `m` assumes minutes instead of months.
+        One month is counted as exact 365/12 days.
+        Ignores all invalid abbreviations.
+        """
+        seconds = self.get_seconds(time)
+        if seconds is None:
+            response = ":x: Invalid time format."
+        elif seconds >= self.MAX_SECONDS:
+            response = f":x: Too long amount of time. Maximum: 2 years"
+        else:
+            user = ctx.message.author
+            time_now = datetime.datetime.utcnow()
+            days, secs = divmod(seconds, 3600 * 24)
+            end_time = time_now + datetime.timedelta(days=days, seconds=secs)
+            reminder = {"content": reminder_text, "start_time": time_now.timestamp(), "end_time": end_time.timestamp()}
+            async with self.config.user(user).reminders() as user_reminders:
+                user_reminders.append(reminder)
+            self.futures.setdefault(user.id, []).append(
+                asyncio.ensure_future(self.remind_later(user, seconds, reminder_text, reminder))
+            )
+            user_offset = await self.config.user(ctx.author).offset()
+            offset = user_offset * 3600
+            formatted_time = round(end_time.timestamp()) + offset
+            if seconds > 86400:
+                response = f":white_check_mark: I will remind you of that on <t:{int(formatted_time)}:F>."
+            else:
+                response = f":white_check_mark: I will remind you of that in {self.time_from_seconds(seconds)}."
+        await ctx.send(response)
+
+    @command_remind.group(name="forget")
+    async def command_remind_forget(self, ctx: Context):
+        """Forget your reminders"""
+        pass
+
+    @command_remind_forget.command(name="all")
+    async def command_remind_forget_all(self, ctx: Context):
+        """Forget **all** of your reminders"""
+        for future in self.futures.get(ctx.message.author.id, []):
+            future.cancel()
+        async with self.config.user(ctx.message.author).reminders() as user_reminders:
+            user_reminders.clear()
+        await ctx.send(":put_litter_in_its_place: Forgot **all** of your reminders!")
+
+    @command_remind_forget.command(name="one")
+    async def command_remind_forget_one(self, ctx: Context, index_number_of_reminder: int):
+        """
+        Forget one of your reminders
+
+        Use `[p]remind list` to find the index number of the reminder you wish to forget.
+        """
+        async with self.config.user(ctx.message.author).all() as user_data:
+            if not user_data["reminders"]:
+                await ctx.send("You don't have any reminders saved.")
+                return
+            time_sorted_reminders = sorted(user_data["reminders"], key=lambda x: (x["end_time"]))
+            try:
+                removed = time_sorted_reminders.pop(index_number_of_reminder - 1)
+            except IndexError:
+                await ctx.send(f"There is no reminder at index {index_number_of_reminder}.")
+                return
+            user_data["reminders"] = time_sorted_reminders
+            offset = user_data["offset"] * 3600
+            end_time = round((removed["end_time"]) + offset)
+            msg = f":put_litter_in_its_place: Forgot reminder **#{index_number_of_reminder}**\n"
+            msg += f"Date: <t:{end_time}:f>\nContent: `{removed['content']}`"
+            await ctx.send(msg)
+
+    @command_remind.command(name="list")
+    async def command_remind_list(self, ctx: Context):
+        """List your reminders"""
+        user_data = await self.config.user(ctx.message.author).all()
+        if not user_data["reminders"]:
+            await ctx.send("There are no reminders to show.")
+            return
+
+        if not ctx.channel.permissions_for(ctx.me).embed_links:
+            return await ctx.send("I need the `Embed Messages` permission here to be able to display this information.")
+
+        embed_pages = await self.create_remind_list_embeds(ctx, user_data)
+        await ctx.send(embed=embed_pages[0]) if len(embed_pages) == 1 else await menu(
+            ctx, embed_pages, DEFAULT_CONTROLS
+        )
+
+    @command_remind.command(name="offset")
+    async def command_remind_offset(self, ctx: Context, offset_time_in_hours: str):
+        """
+        Set a basic timezone offset
+        from the default of UTC for use in [p]remindme list.
+
+        This command accepts number values from `-23.75` to `+23.75`.
+        You can look up your timezone offset on https://en.wikipedia.org/wiki/List_of_UTC_offsets
+        """
+        offset = self.remind_offset_check(offset_time_in_hours)
+        if offset is not None:
+            await self.config.user(ctx.author).offset.set(offset)
+            await ctx.send(f"Your timezone offset was set to {str(offset).replace('.0', '')} hours from UTC.")
+        else:
+            await ctx.send(f"That doesn't seem like a valid hour offset. Check `{ctx.prefix}help remind offset`.")
+
+    @staticmethod
+    async def chunker(input: List[dict], chunk_size: int) -> List[List[str]]:
+        chunk_list = []
+        iterator = iter(input)
+        while chunk := list(islice(iterator, chunk_size)):
+            chunk_list.append(chunk)
+        return chunk_list
+
+    async def create_remind_list_embeds(self, ctx: Context, user_data: dict) -> List[discord.Embed]:
+        """Embed creator for command_remind_list."""
+        offset = user_data["offset"] * 3600
+        reminder_list = []
+        time_sorted_reminders = sorted(user_data["reminders"], key=lambda x: (x["end_time"]))
+        entry_size = len(str(len(time_sorted_reminders)))
+
+        for i, reminder_dict in enumerate(time_sorted_reminders, 1):
+            entry_number = f"{str(i).zfill(entry_size)}"
+            end_time = round((reminder_dict["end_time"]) + offset)
+            exact_time_timestamp = f"<t:{end_time}:f>"
+            relative_timestamp = f"<t:{end_time}:R>"
+            content = reminder_dict["content"]
+            display_content = content if len(content) < 200 else f"{content[:200]} [...]"
+            reminder = f"`{entry_number}`. {exact_time_timestamp}, {relative_timestamp}:\n{display_content}\n\n"
+            reminder_list.append(reminder)
+
+        reminder_text_chunks = await self.chunker(reminder_list, 7)
+        max_pages = ceil(len(reminder_list) / 7)
+        offset_hours = str(user_data["offset"]).replace(".0", "")
+        offset_text = f" • UTC offset of {offset_hours}h applied" if offset != 0 else ""
+        menu_pages = []
+        for chunk in reminder_text_chunks:
+            embed = discord.Embed(title="", description="".join(chunk))
+            embed.set_author(name=f"Reminders for {ctx.author}", icon_url=ctx.author.avatar.url)
+            embed.set_footer(text=f"Page {len(menu_pages) + 1} of {max_pages}{offset_text}")
+            menu_pages.append(embed)
+        return menu_pages
+
+    def get_seconds(self, time: str):
+        """Returns the amount of converted time or None if invalid"""
+        seconds = 0
+        for time_match in self.TIME_AMNT_REGEX.finditer(time):
+            time_amnt = int(time_match.group(1))
+            time_abbrev = time_match.group(2)
+            time_quantity = discord.utils.find(lambda t: t[0].startswith(time_abbrev), self.TIME_QUANTITIES.items())
+            if time_quantity is not None:
+                seconds += time_amnt * time_quantity[1]
+        return None if seconds == 0 else seconds
+
+    async def remind_later(self, user: discord.User, time: float, content: str, reminder):
+        """Reminds the `user` in `time` seconds with a message containing `content`"""
+        await asyncio.sleep(time)
+        embed = discord.Embed(title="Reminder", description=content, color=discord.Colour.blue())
+        await user.send(embed=embed)
+        async with self.config.user(user).reminders() as user_reminders:
+            user_reminders.remove(reminder)
+
+    @staticmethod
+    def remind_offset_check(offset: str) -> Optional[float]:
+        """Float validator for command_remind_offset."""
+        try:
+            offset = float(offset.replace("+", ""))
+        except ValueError:
+            return None
+        offset = round(offset * 4) / 4.0
+        if not -23.75 < offset < 23.75 or 23.75 < offset < -23.75:
+            return None
+        return offset
+
+    async def start_saved_reminders(self):
+        await self.bot.wait_until_red_ready()
+        user_configs = await self.config.all_users()
+        for user_id, user_config in list(user_configs.items()):  # Making a copy
+            for reminder in user_config["reminders"]:
+                user = self.bot.get_user(user_id)
+                if user is None:
+                    # Delete the reminder if the user doesn't have a mutual server anymore
+                    await self.config.user_from_id(user_id).clear()
+                else:
+                    time_diff = datetime.datetime.fromtimestamp(reminder["end_time"]) - datetime.datetime.utcnow()
+                    time = max(0.0, time_diff.total_seconds())
+                    fut = asyncio.ensure_future(self.remind_later(user, time, reminder["content"], reminder))
+                    self.futures.setdefault(user.id, []).append(fut)
+
+    @staticmethod
+    def time_from_seconds(seconds: int) -> str:
+        hours, remainder = divmod(seconds, 3600)
+        minutes, seconds = divmod(remainder, 60)
+        if hours:
+            msg = f"{hours} hour" if hours == 1 else f"{hours} hours"
+            if minutes != 0:
+                msg += f" and {minutes} minute" if minutes == 1 else f" and {minutes} minutes"
+        elif minutes:
+            msg = f"{minutes} minute" if minutes == 1 else f"{minutes} minutes"
+            if seconds != 0:
+                msg += f" and {seconds} second" if seconds == 1 else f" and {seconds} seconds"
+        else:
+            msg = f"{seconds} seconds" if seconds == 1 else f"and {seconds} seconds"
+        return msg

rndstatus/__init__.py

@@ -0,0 +1,7 @@
+from .rndstatus import RndStatus
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(RndStatus(bot))

rndstatus/info.json

@@ -0,0 +1,10 @@
+{
+    "author": ["aikaterna", "Twentysix"],
+    "description": "Random statuses with an optional bot stats mode. Ported from Twentysix's v2 cog.",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "Thanks for installing, have fun.",
+    "min_bot_version": "3.5.0",
+    "short": "Random bot statuses",
+    "tags": ["status"],
+    "type": "COG"
+}

rndstatus/rndstatus.py

@@ -0,0 +1,210 @@
+import re
+import discord
+from redbot.core import Config, commands, checks
+from redbot.core.utils import AsyncIter
+from random import choice as rndchoice
+from collections import defaultdict
+import contextlib
+import asyncio
+import logging
+
+
+log = logging.getLogger("red.aikaterna.rndstatus")
+
+
+class RndStatus(commands.Cog):
+    """Cycles random statuses or displays bot stats.
+    If a custom status is already set, it won't change it until
+    it's back to none. [p]set game"""
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """ Nothing to delete """
+        return
+
+    def __init__(self, bot):
+        self.bot = bot
+        self.last_change = None
+        self.config = Config.get_conf(self, 2752521001, force_registration=True)
+
+        self.presence_task = asyncio.create_task(self.maybe_update_presence())
+
+        default_global = {
+            "botstats": False,
+            "delay": 300,
+            "statuses": ["her Turn()", "Tomb Raider II", "Transistor", "NEO Scavenger", "Python", "with your heart.",],
+            "streamer": "rndstatusstreamer",
+            "type": 0,
+            "status": 0,
+        }
+        self.config.register_global(**default_global)
+
+    def cog_unload(self):
+        self.presence_task.cancel()
+
+    @commands.group(autohelp=True)
+    @commands.guild_only()
+    @checks.is_owner()
+    async def rndstatus(self, ctx):
+        """Rndstatus group commands."""
+        pass
+
+    @rndstatus.command(name="set")
+    async def _set(self, ctx, *statuses: str):
+        """Sets Red's random statuses.
+        Accepts multiple statuses.
+        Must be enclosed in double quotes in case of multiple words.
+        Example:
+        [p]rndstatus set \"Tomb Raider II\" \"Transistor\" \"with your heart.\"
+        Shows current list if empty."""
+        saved_status = await self.config.statuses()
+        if statuses == () or "" in statuses:
+            msg = (
+                f"Current statuses: {(' | ').join(saved_status)}\n"
+                f"To set new statuses, use the instructions in `{ctx.prefix}help rndstatus set`."
+            )
+            return await ctx.send(msg)
+        await self.config.statuses.set(list(statuses))
+        await self.presence_updater()
+        await ctx.send("Done. Redo this command with no parameters to see the current list of statuses.")
+
+    @rndstatus.command(name="streamer")
+    async def _streamer(self, ctx: commands.Context, *, streamer=None):
+        """Set the streamer name needed for streaming statuses."""
+        saved_streamer = await self.config.streamer()
+        if streamer is None:
+            return await ctx.send(f"Current Streamer: {saved_streamer}")
+        await self.config.streamer.set(streamer)
+        await ctx.send("Done. Redo this command with no parameters to see the current streamer.")
+
+    @rndstatus.command()
+    async def botstats(self, ctx, *statuses: str):
+        """Toggle for a bot stats status instead of random messages."""
+        botstats = await self.config.botstats()
+        await self.config.botstats.set(not botstats)
+        await ctx.send(f"Botstats toggle: {not botstats}.")
+        await self.presence_updater()
+
+    @rndstatus.command()
+    async def delay(self, ctx, seconds: int):
+        """Sets interval of random status switch.
+        Must be 20 or superior."""
+        if seconds < 20:
+            seconds = 20
+        await self.config.delay.set(seconds)
+        await ctx.send(f"Interval set to {seconds} seconds.")
+
+    @rndstatus.command(name="type")
+    async def _rndstatus_type(self, ctx, status_type: int):
+        """Define the rndstatus game type.
+
+        Type list:
+        0 = Playing
+        1 = Streaming
+        2 = Listening
+        3 = Watching
+        5 = Competing"""
+        if 0 <= status_type <= 3 or 0 != 5:
+            rnd_type = {0: "playing", 1: "streaming", 2: "listening", 3: "watching", 5: "competing"}
+            await self.config.type.set(status_type)
+            await self.presence_updater()
+            await ctx.send(f"Rndstatus activity type set to {rnd_type[status_type]}.")
+        else:
+            await ctx.send(
+                f"Status activity type must be between 0 and 3 or 5. "
+                f"See `{ctx.prefix}help rndstatus type` for more information."
+            )
+
+    @rndstatus.command()
+    async def status(self, ctx, status: int):
+        """Define the rndstatus presence status.
+
+        Status list:
+        0 = Online
+        1 = Idle
+        2 = DND
+        3 = Invisible"""
+        if 0 <= status <= 3:
+            rnd_status = {0: "online", 1: "idle", 2: "DND", 3: "invisible"}
+            await self.config.status.set(status)
+            await self.presence_updater()
+            await ctx.send(f"Rndstatus presence status set to {rnd_status[status]}.")
+        else:
+            await ctx.send(
+                f"Status presence type must be between 0 and 3. "
+                f"See `{ctx.prefix}help rndstatus status` for more information."
+            )
+
+    async def maybe_update_presence(self):
+        await self.bot.wait_until_red_ready()
+        delay = await self.config.delay()
+        while True:
+            try:
+                await self.presence_updater()
+            except Exception:
+                log.exception("Something went wrong in maybe_update_presence task:")
+
+            await asyncio.sleep(int(delay))
+
+    async def presence_updater(self):
+        pattern = re.compile(rf"<@!?{self.bot.user.id}>")
+        cog_settings = await self.config.all()
+        guilds = self.bot.guilds
+        try:
+            guild = next(g for g in guilds if not g.unavailable)
+        except StopIteration:
+            return
+        try:
+            current_game = str(guild.me.activity.name)
+        except AttributeError:
+            current_game = None
+        statuses = cog_settings["statuses"]
+        botstats = cog_settings["botstats"]
+        streamer = cog_settings["streamer"]
+        _type = cog_settings["type"]
+        _status = cog_settings["status"]
+
+        url = f"https://www.twitch.tv/{streamer}"
+        prefix = await self.bot.get_valid_prefixes()
+
+        if _status == 0:
+            status = discord.Status.online
+        elif _status == 1:
+            status = discord.Status.idle
+        elif _status == 2:
+            status = discord.Status.dnd
+        elif _status == 3:
+            status = discord.Status.offline
+
+        if botstats:
+            me = self.bot.user
+            clean_prefix = pattern.sub(f"@{me.name}", prefix[0])
+            total_users = len(self.bot.users)
+            servers = str(len(self.bot.guilds))
+            botstatus = f"{clean_prefix}help | {total_users} users | {servers} servers"
+            if (current_game != str(botstatus)) or current_game is None:
+                if _type == 1:
+                    await self.bot.change_presence(activity=discord.Streaming(name=botstatus, url=url))
+                else:
+                    await self.bot.change_presence(activity=discord.Activity(name=botstatus, type=_type), status=status)
+        else:
+            if len(statuses) > 0:
+                new_status = self.random_status(guild, statuses)
+                if (current_game != new_status) or (current_game is None) or (len(statuses) == 1):
+                    if _type == 1:
+                        await self.bot.change_presence(activity=discord.Streaming(name=new_status, url=url))
+                    else:
+                        await self.bot.change_presence(
+                            activity=discord.Activity(name=new_status, type=_type), status=status
+                        )
+
+    def random_status(self, guild, statuses):
+        try:
+            current = str(guild.me.activity.name)
+        except AttributeError:
+            current = None
+        new_statuses = [s for s in statuses if s != current]
+        if len(new_statuses) > 1:
+            return rndchoice(new_statuses)
+        elif len(new_statuses) == 1:
+            return new_statuses[0]
+        return current

rss/__init__.py

@@ -0,0 +1,11 @@
+from redbot.core import commands
+
+from .rss import RSS
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot: commands.Bot):
+    n = RSS(bot)
+    await bot.add_cog(n)
+    n.initialize()

rss/color.py

@@ -0,0 +1,131 @@
+from math import sqrt
+import discord
+import re
+import webcolors
+
+
+_DISCORD_COLOURS = {
+    discord.Color.teal().to_rgb(): 'teal',
+    discord.Color.dark_teal().to_rgb(): 'dark_teal',
+    discord.Color.green().to_rgb(): 'green',
+    discord.Color.dark_green().to_rgb(): 'dark_green',
+    discord.Color.blue().to_rgb(): 'blue',
+    discord.Color.dark_blue().to_rgb(): 'dark_blue',
+    discord.Color.purple().to_rgb(): 'purple',
+    discord.Color.dark_purple().to_rgb(): 'dark_purple',
+    discord.Color.magenta().to_rgb(): 'magenta',
+    discord.Color.dark_magenta().to_rgb(): 'dark_magenta',
+    discord.Color.gold().to_rgb(): 'gold',
+    discord.Color.dark_gold().to_rgb(): 'dark_gold',
+    discord.Color.orange().to_rgb(): 'orange',
+    discord.Color.dark_orange().to_rgb(): 'dark_orange',
+    discord.Color.red().to_rgb(): 'red',
+    discord.Color.dark_red().to_rgb(): 'dark_red',
+    discord.Color.lighter_grey().to_rgb(): 'lighter_grey',
+    discord.Color.light_grey().to_rgb(): 'light_grey',
+    discord.Color.dark_grey().to_rgb(): 'dark_grey',
+    discord.Color.darker_grey().to_rgb(): 'darker_grey',
+    discord.Color.blurple().to_rgb(): 'old_blurple',
+    discord.Color(0x4a90e2).to_rgb(): 'new_blurple',
+    discord.Color.greyple().to_rgb(): 'greyple',
+    discord.Color.dark_theme().to_rgb(): 'discord_dark_theme'
+}
+
+_RGB_NAME_MAP = {webcolors.hex_to_rgb(hexcode): name for hexcode, name in webcolors.css3_hex_to_names.items()}
+_RGB_NAME_MAP.update(_DISCORD_COLOURS)
+
+
+def _distance(point_a: tuple, point_b: tuple):
+    """
+    Euclidean distance between two points using rgb values as the metric space.
+    """
+    # rgb values
+    x1, y1, z1 = point_a
+    x2, y2, z2 = point_b
+
+    # distances
+    dx = x1 - x2
+    dy = y1 - y2
+    dz = z1 - z2
+
+    # final distance
+    return sqrt(dx**2 + dy**2 + dz**2)
+
+def _linear_nearest_neighbour(all_points: list, pivot: tuple):
+    """
+    Check distance against all points from the pivot and return the distance and nearest point.
+    """
+    best_dist = None
+    nearest = None
+    for point in all_points:
+        dist = _distance(point, pivot)
+        if best_dist is None or dist < best_dist:
+            best_dist = dist
+            nearest = point
+    return best_dist, nearest
+
+
+class Color:
+    """Helper for color handling."""
+
+    async def _color_converter(self, hex_code_or_color_word: str):
+        """
+        Used for user input on rss embed color
+        Input:    discord.Color name, CSS3 color name, 0xFFFFFF, #FFFFFF, FFFFFF
+        Output:   0xFFFFFF
+        """
+        # #FFFFFF and FFFFFF to 0xFFFFFF
+        hex_match = re.match(r"#?[a-f0-9]{6}", hex_code_or_color_word.lower())
+        if hex_match:
+            hex_code = f"0x{hex_code_or_color_word.lstrip('#')}"
+            return hex_code
+
+        # discord.Color checking
+        if hasattr(discord.Color, hex_code_or_color_word):
+            hex_code = str(getattr(discord.Color, hex_code_or_color_word)())
+            hex_code = hex_code.replace("#", "0x")
+            return hex_code
+
+        # CSS3 color name checking
+        try:
+            hex_code = webcolors.name_to_hex(hex_code_or_color_word, spec="css3")
+            hex_code = hex_code.replace("#", "0x")
+            return hex_code
+        except ValueError:
+            pass
+
+        return None
+
+    async def _hex_to_css3_name(self, hex_code: str):
+        """
+        Input:  0xFFFFFF
+        Output: CSS3 color name string closest match
+        """
+        hex_code = await self._hex_validator(hex_code)
+        rgb_tuple = await self._hex_to_rgb(hex_code)
+
+        positions = list(_RGB_NAME_MAP.keys())
+        dist, nearest = _linear_nearest_neighbour(positions, rgb_tuple)
+
+        return _RGB_NAME_MAP[nearest]
+
+    async def _hex_to_rgb(self, hex_code: str):
+        """
+        Input:  0xFFFFFF
+        Output: (255, 255, 255)
+        """
+        return webcolors.hex_to_rgb(hex_code)
+
+    async def _hex_validator(self, hex_code: str):
+        """
+        Input:  0xFFFFFF
+        Output: #FFFFFF or None
+        """
+        if hex_code[:2] == "0x":
+            hex_code = hex_code.replace("0x", "#")
+        try:
+            # just a check to make sure it's a real color hex code
+            hex_code = webcolors.normalize_hex(hex_code)
+        except ValueError:
+            hex_code = None
+        return hex_code

rss/info.json

@@ -0,0 +1,11 @@
+{
+    "author": ["aikaterna"],
+    "description": "Read RSS feeds.",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "Thanks for installing.",
+    "min_bot_version": "3.5.0",
+    "permissions": ["embed_links"],
+    "requirements": ["bs4", "feedparser>=6.0.0", "webcolors==1.3", "filetype"],
+    "short": "Read RSS feeds.",
+    "tags": ["rss"]
+}

rss/quiet_template.py

@@ -0,0 +1,31 @@
+from collections import ChainMap
+from string import Template
+
+
+class QuietTemplate(Template):
+    """
+    A subclass of string.Template that is less verbose on a missing key
+    https://github.com/python/cpython/blob/919f0bc8c904d3aa13eedb2dd1fe9c6b0555a591/Lib/string.py#L123
+    """
+
+    def quiet_safe_substitute(self, mapping={}, /, **kws):
+        if mapping is {}:
+            mapping = kws
+        elif kws:
+            mapping = ChainMap(kws, mapping)
+        # Helper function for .sub()
+        def convert(mo):
+            named = mo.group('named') or mo.group('braced')
+            if named is not None:
+                try:
+                    return str(mapping[named])
+                except KeyError:
+                    # return None instead of the tag name so that
+                    # invalid tags are not present in the feed output
+                    return None
+            if mo.group('escaped') is not None:
+                return self.delimiter
+            if mo.group('invalid') is not None:
+                return mo.group()
+            raise ValueError('Unrecognized named group in pattern', self.pattern)
+        return self.pattern.sub(convert, self.template)

rss/rss_feed.py

@@ -0,0 +1,53 @@
+from typing import List
+
+
+class RssFeed():
+    """RSS feed object"""
+
+    def __init__(self, **kwargs):
+        super().__init__()
+        self.name: str = kwargs.get("name", None)
+        self.last_title: str = kwargs.get("last_title", None)
+        self.last_link: str = kwargs.get("last_link", None)
+        self.last_time: str = kwargs.get("last_time", None)
+        self.template: str = kwargs.get("template", None)
+        self.url: str = kwargs.get("url", None)
+        self.template_tags: List[str] = kwargs.get("template_tags", [])
+        self.is_special: List[str] = kwargs.get("is_special", [])
+        self.embed: bool = kwargs.get("embed", True)
+        self.embed_color: str = kwargs.get("embed_color", None)
+        self.embed_image: str = kwargs.get("embed_image", None)
+        self.embed_thumbnail: str = kwargs.get("embed_thumbnail", None)
+
+    def to_json(self) -> dict:
+        return {
+            "name": self.name,
+            "last_title": self.last_title,
+            "last_link": self.last_link,
+            "last_time": self.last_time,
+            "template": self.template,
+            "url": self.url,
+            "template_tags": self.template_tags,
+            "is_special": self.is_special,
+            "embed": self.embed,
+            "embed_color": self.embed_color,
+            "embed_image": self.embed_image,
+            "embed_thumbnail": self.embed_thumbnail,
+        }
+
+    @classmethod
+    def from_json(cls, data: dict):
+        return cls(
+            name=data["name"] if data["name"] else None,
+            last_title=data["last_title"] if data["last_title"] else None,
+            last_link=data["last_link"] if data["last_link"] else None,
+            last_time=data["last_time"] if data["last_time"] else None,
+            template=data["template"] if data["template"] else None,
+            url=data["url"] if data["url"] else None,
+            template_tags=data["template_tags"] if data["template_tags"] else [],
+            is_special=data["is_special"] if data["is_special"] else [],
+            embed=data["embed"] if data["embed"] else True,
+            embed_color=data["embed_color"] if data["embed_color"] else None,
+            embed_image=data["embed_image"] if data["embed_image"] else None,
+            embed_thumbnail=data["embed_thumbnail"] if data["embed_thumbnail"] else None,
+        )

rss/tag_type.py

@@ -0,0 +1,13 @@
+from enum import Enum
+
+
+INTERNAL_TAGS = ["is_special", "template_tags", "embed", "embed_color", "embed_image", "embed_thumbnail"]
+
+VALID_IMAGES = ["png", "webp", "gif", "jpeg", "jpg"]
+
+
+class TagType(Enum):
+    PLAINTEXT = 1
+    HTML = 2
+    DICT = 3
+    LIST = 4

rss_guide.md

@@ -0,0 +1,119 @@
+# RSS Guide
+
+The placeholder for your bot's prefix is `[p]` in this guide.
+
+All commands are under the main command group of `[p]rss`.
+
+### Add a new feed
+
+If you already have a rss feed url to use, great! If you need to find an RSS feed from a website url, use `[p]rss find` with the url.
+
+![rss find](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/9f035b36-72fc-4dc2-a191-02be57b61690)
+
+**Q:** I added my feed but I got something that says "Bozo feed" in response.  
+**A:** Make sure the link is a real RSS feed, in an Atom or XML standard RSS feed format. The `feedparser` library that RSS uses can only read and use RSS feeds that conform to standards. Sometimes when adding a new feed, your bot may be blocked by Cloudflare from navigating to the RSS feed and receive a bozo response - there is no handling in the cog to be able to follow or solve Cloudflare captchas or gates.  
+
+**Q:** I used `[p]rss find` on a website link but it told me "No RSS feeds found in the link provided". I think they do have an RSS feed, what's wrong?  
+**A:** The rss find command searches the page for any links in the website's HTML where the RSS feed is properly called out, to Atom 1.0 or RSS 2.0 specifications.   If the command can't find the feed, maybe approach the site owners to ask for their feeds to identify the feed as application/rss+xml, application/atom+xml, text/xml, or application/rdf+xml for the `link` tag for the feed.
+  
+Add the RSS feed, giving it a name you can refer to later. I'm using `test` in this example.  
+
+![rss feed name](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/622dccdc-0d69-4e51-99f2-61f269bd1218)
+
+### Set a feed post template
+
+Use `[p]rss viewtags` with the feed name to view a small content preview of all template tags on the most recent post.
+
+![viewtags](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/c234d354-a060-4119-8bcc-3e838c23faff)
+
+The default template of every feed is a simple embed with the feed entry title, the url if present, and the date of the entry.
+
+![default template](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/5983a227-f4af-4468-8aed-cccc1816d026)
+
+If you wish to have a simple link post with a title where Discord can auto-unfurl the url, if possible, you only need to toggle off the embed display with `[p]rss embed toggle` and the feed name.
+
+![simple link post](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/0112ebe4-700a-46a6-9c06-add79d7db01e)
+
+Preview your changes at any time with `[p]rss force`.
+
+![rss force](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/b7af1f68-d177-4aa5-865f-45d5a4f48aaa)
+
+For the rest of these examples and explaination, I have toggled the test feed back to using an embed, with `[p]rss embed toggle`.  
+Now let's explore the feed tags present on the feed, so we can modify the way the feed posts look.  
+
+Use `[p]rss listtags` to display the feed tags.
+
+![rss listtags](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/88793962-7efc-4c0d-947b-996b3d539d44)
+
+Templates can include any of these placeholder values, which are prefixed with `$`. Not all feeds will have all of these placeholder values shown - they can vary from feed to feed and even from post to post on the same feed. Templates can also use the same Markdown formatting that you can use natively in Discord messages, like `\n` for a line return, `**` for bold, etc.  
+
+Any tag with `plaintext` in its name is usually a cleaned or unpacked version of the parent tag it was generated from. For example, in our `test` feed here, there is a `$summary_detail` html-containing tag that also has a `$summary_detail_plaintext` version. If we use the summary detail in our template, we will want to choose the plaintext version.  
+
+But what's in that `$summary_detail_plaintext` tag? Let's see...
+
+![template preview](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/c102bc76-cd1e-4ae5-9365-ab41dfe310e6)
+
+Well, this looks good to me on the information I want on these feed posts - let's add the title and the link back.  
+
+I used `[p]rss template test **$title**\n$link\n\n$summary_detail_plaintext` here, giving a bold title with line returns for the link and the summary.
+
+![template preview 2](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/6d763c71-dc26-4366-abea-f168e330767c)
+
+Unfortunately, there are no images to use in these template tags on this test as there are no `$content_image` tags listed in `[p]rss listtags` nor does `$media_content` or the plaintext version of that tag have any image urls. If the post display needed an image preview, we would need to set this feed to display with the embed off, and with a link included, so that Discord can display it if the site is supported.  
+
+##### Media template tags
+The `$media_content` tag, `$media_url` tag, or any other `$media_`-prefixed tag usually holds non-image content. This can include and is not limited to video links and audio links. Rarely, there will be an image url in `$media_content` or `$media_url` tags, but it should not be the case if the feed or site owner is tagging the feed elements or html elements properly.  
+
+##### Image template tags
+Image tags are usually named `$content_image01` or similar, where every image url found in the feed post adds 1 to the name value. For example the second image url gathered from the feed post would be named `$content_image02` if it was present in `[p]rss listtags`. Rarely, an image url might be found under the `$links_plaintext` tag, if present.  
+
+Let's make another test feed that has an image to use.  
+
+![test 2 listtags](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/0d2f7e34-58de-4e5f-b6d6-d10b1202ef7b)
+
+There is a `$media_thumbnail_plaintext` and a `$links_plaintext01` here. Let's see what they contain.  
+
+![test 2 exploring tag content](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/42dd4e99-c7c8-4b17-a361-6589d420cad2)
+
+Looks like an image url for the first and a link to the commit on the feed. Let's give it a real template and set the `$media_thumbnail_plaintext` tag as the embed image.  
+
+I used `[p]rss template aikaterna-cogs aikaterna-cogs\nAuthor: $author\n[$content_plaintext01]($link)`. Note the combination of a template tag with a link - you can use `[text](url)` formatting in an embed with text-containing template tags.  
+
+Let's set the embed thumbnail with the `[p]rss embed thumbnail` command. You can also use `[p]rss embed image` to set the large embed image to a tag instead of the embed thumbnail.  
+
+![set embed thumbnail](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/0fd537a5-fcd7-44d6-8432-c065bcf03b48)
+
+You can set different image template tags to be the main embed image and the embed thumbnail.
+
+![set embed images](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/17e3e836-e1cd-4ba4-a28b-1db65a3340c8)
+
+And that's it! You only need to add your feed and customize it with your template and RSS will check the feed every 5 minutes or so. The hardest part is creating a template you like.
+
+### Double feed posts
+
+RSS qualifies a new post based on the published time and updated time of the feed. Some sites update the updated time of the feed without updating content. This makes the RSS cog "double post" or even continuously post the same post. Use `[p]rss parse` to be able to configure the RSS cog to use the published_parsed feed tag, and stop multi-posting.  
+
+![rss parse](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/e0b7b123-428b-4c38-8c3b-997bd40dbebc)
+
+### Post filtering by tag
+
+Sometimes, when a feed is set up to RSS standards and specifications, tags are included per feed post that provide content filtering. You can check if your feed includes these tags by using `[p]rss listtags` and seeing if there are `$tags` or similar.  
+
+![tags list](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/c4a07812-5801-4970-a9dd-170de96ceb01)
+
+This feed has tags! Let's see what some examples of their tags may be. Alternatively, maybe the site lists their RSS post tags elsewhere as a post tag preview may not include all tags in use on the site.  
+
+![tag list](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/ffe335cf-09e5-4f5d-8585-167ebe0845e5)
+
+Tag filtering is only an allow list. These tag names are case insensitive, you cannot have differing tags like `True Crime` vs. `true crime` - they will be processed the same way.
+
+![tag filter added](https://github.com/aikaterna/aikaterna-cogs/assets/20862007/efde1fa9-21c4-4228-a643-0a8d966bb23d)
+
+### Non-essential noteable features
+
+There are other features of RSS to explore like:
+
+`[p]rss embed color` - changing the embed color bar if you have an embedded post template  
+`[p]rss limit` - limit the amount of characters used per post, but note that this is for the whole template, all template tags combined  
+`[p]rss list` or `[p]rss listall` - list rss feeds in the current channel or all feeds on the Discord server  
+`[p]rss showtemplate` - in case you forgot what you used for a feed's template and you would like to use it elsewhere  

seen/__init__.py

@@ -0,0 +1,12 @@
+from .seen import Seen
+
+__red_end_user_data_statement__ = (
+    "This cog does not persistently store end user data. "
+    "This cog does store discord IDs and last seen timestamp as needed for operation. "
+)
+
+
+async def setup(bot):
+    cog = Seen(bot)
+    await cog.initialize()
+    await bot.add_cog(cog)

seen/info.json

@@ -0,0 +1,9 @@
+{
+    "author": ["aikaterna"],
+    "description": "Check when the user was last active on a server. Originally made by Paddo.",
+    "end_user_data_statement": "This cog does not persistently store end user data. This cog does store discord IDs and last seen timestamp as needed for operation.",
+    "min_bot_version": "3.5.0",
+    "short": "Check when the user was last active on a server.",
+    "tags": ["seen", "activity"],
+    "type": "COG"
+}

seen/seen.py

@@ -0,0 +1,197 @@
+import asyncio
+import contextlib
+import datetime
+from typing import Union, Literal
+
+import discord
+import time
+
+from redbot.core import Config, commands
+
+_SCHEMA_VERSION = 2
+
+
+class Seen(commands.Cog):
+    """Shows last time a user was seen in chat."""
+
+    async def red_delete_data_for_user(
+        self, *, requester: Literal["discord", "owner", "user", "user_strict"], user_id: int,
+    ):
+        if requester in ["discord", "owner"]:
+            data = await self.config.all_members()
+            for guild_id, members in data.items():
+                if user_id in members:
+                    await self.config.member_from_ids(guild_id, user_id).clear()
+
+    def __init__(self, bot):
+        self.bot = bot
+        self.config = Config.get_conf(self, 2784481001, force_registration=True)
+
+        default_global = dict(schema_version=1)
+        default_member = dict(seen=None)
+
+        self.config.register_global(**default_global)
+        self.config.register_member(**default_member)
+
+        self._cache = {}
+        self._task = self.bot.loop.create_task(self._save_to_config())
+
+    async def initialize(self):
+        asyncio.ensure_future(
+            self._migrate_config(from_version=await self.config.schema_version(), to_version=_SCHEMA_VERSION)
+        )
+
+    async def _migrate_config(self, from_version: int, to_version: int):
+        if from_version == to_version:
+            return
+        elif from_version < to_version:
+            all_guild_data = await self.config.all_members()
+            users_data = {}
+            for guild_id, guild_data in all_guild_data.items():
+                for user_id, user_data in guild_data.items():
+                    for _, v in user_data.items():
+                        if not v:
+                            v = None
+                        if user_id not in users_data:
+                            users_data[guild_id][user_id] = {"seen": v}
+                        else:
+                            if (v and not users_data[guild_id][user_id]["seen"]) or (
+                                v
+                                and users_data[guild_id][user_id]["seen"]
+                                and v > users_data[guild_id][user_id]["seen"]
+                            ):
+                                users_data[guild_id][user_id] = {"seen": v}
+
+            group = self.config._get_base_group(self.config.MEMBER)  # Bulk update to new scope
+            async with group.all() as new_data:
+                for guild_id, member_data in users_data.items():
+                    new_data[guild_id] = member_data
+
+            # new schema is now in place
+            await self.config.schema_version.set(_SCHEMA_VERSION)
+
+            # migration done, now let's delete all the old stuff
+            await self.config.clear_all_members()
+
+    @commands.guild_only()
+    @commands.command(name="seen")
+    @commands.bot_has_permissions(embed_links=True)
+    async def _seen(self, ctx, *, author: discord.Member):
+        """Shows last time a user was seen in chat."""
+        member_seen_config = await self.config.member(author).seen()
+        member_seen_cache = self._cache.get(author.guild.id, {}).get(author.id, None)
+
+        if not member_seen_cache and not member_seen_config:
+            embed = discord.Embed(colour=discord.Color.red(), title="I haven't seen that user yet.")
+            return await ctx.send(embed=embed)
+
+        if not member_seen_cache:
+            member_seen = member_seen_config
+        elif not member_seen_config:
+            member_seen = member_seen_cache
+        elif member_seen_cache > member_seen_config:
+            member_seen = member_seen_cache
+        elif member_seen_config > member_seen_cache:
+            member_seen = member_seen_config
+        else:
+            member_seen = member_seen_cache or member_seen_config
+
+        now = int(time.time())
+        time_elapsed = int(now - member_seen)
+        output = self._dynamic_time(time_elapsed)
+
+        if output[2] < 1:
+            ts = "just now"
+        else:
+            ts = ""
+            if output[0] == 1:
+                ts += "{} day, ".format(output[0])
+            elif output[0] > 1:
+                ts += "{} days, ".format(output[0])
+            if output[1] == 1:
+                ts += "{} hour, ".format(output[1])
+            elif output[1] > 1:
+                ts += "{} hours, ".format(output[1])
+            if output[2] == 1:
+                ts += "{} minute ago".format(output[2])
+            elif output[2] > 1:
+                ts += "{} minutes ago".format(output[2])
+        em = discord.Embed(colour=discord.Color.green())
+        avatar = author.display_avatar
+        em.set_author(name="{} was seen {}".format(author.display_name, ts), icon_url=avatar)
+        await ctx.send(embed=em)
+
+    @staticmethod
+    def _dynamic_time(time_elapsed):
+        m, s = divmod(time_elapsed, 60)
+        h, m = divmod(m, 60)
+        d, h = divmod(h, 24)
+        return d, h, m
+
+    @commands.Cog.listener()
+    async def on_message(self, message):
+        if getattr(message, "guild", None):
+            if message.guild.id not in self._cache:
+                self._cache[message.guild.id] = {}
+            self._cache[message.guild.id][message.author.id] = int(time.time())
+
+    @commands.Cog.listener()
+    async def on_typing(
+        self, channel: discord.abc.Messageable, user: Union[discord.User, discord.Member], when: datetime.datetime,
+    ):
+        if getattr(user, "guild", None):
+            if user.guild.id not in self._cache:
+                self._cache[user.guild.id] = {}
+            self._cache[user.guild.id][user.id] = int(time.time())
+
+    @commands.Cog.listener()
+    async def on_message_edit(self, before: discord.Message, after: discord.Message):
+        if getattr(after, "guild", None):
+            if after.guild.id not in self._cache:
+                self._cache[after.guild.id] = {}
+            self._cache[after.guild.id][after.author.id] = int(time.time())
+
+    @commands.Cog.listener()
+    async def on_reaction_remove(self, reaction: discord.Reaction, user: Union[discord.Member, discord.User]):
+        if getattr(user, "guild", None):
+            if user.guild.id not in self._cache:
+                self._cache[user.guild.id] = {}
+            self._cache[user.guild.id][user.id] = int(time.time())
+
+    @commands.Cog.listener()
+    async def on_reaction_add(self, reaction: discord.Reaction, user: Union[discord.Member, discord.User]):
+        if getattr(user, "guild", None):
+            if user.guild.id not in self._cache:
+                self._cache[user.guild.id] = {}
+            self._cache[user.guild.id][user.id] = int(time.time())
+
+    def cog_unload(self):
+        self.bot.loop.create_task(self._clean_up())
+
+    async def _clean_up(self):
+        if self._task:
+            self._task.cancel()
+        if self._cache:
+            group = self.config._get_base_group(self.config.MEMBER)  # Bulk update to config
+            async with group.all() as new_data:
+                for guild_id, member_data in self._cache.items():
+                    if str(guild_id) not in new_data:
+                        new_data[str(guild_id)] = {}
+                    for member_id, seen in member_data.items():
+                        new_data[str(guild_id)][str(member_id)] = {"seen": seen}
+
+    async def _save_to_config(self):
+        await self.bot.wait_until_ready()
+        with contextlib.suppress(asyncio.CancelledError):
+            while True:
+                users_data = self._cache.copy()
+                self._cache = {}
+                group = self.config._get_base_group(self.config.MEMBER)  # Bulk update to config
+                async with group.all() as new_data:
+                    for guild_id, member_data in users_data.items():
+                        if str(guild_id) not in new_data:
+                            new_data[str(guild_id)] = {}
+                        for member_id, seen in member_data.items():
+                            new_data[str(guild_id)][str(member_id)] = {"seen": seen}
+
+                await asyncio.sleep(60)

snacktime/__init__.py

@@ -0,0 +1,7 @@
+from .snacktime import Snacktime
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(Snacktime(bot))

snacktime/info.json

@@ -0,0 +1,9 @@
+{
+    "author" : ["irdumb", "aikaterna"],
+    "description" : "snackburr will come around every-so-often if you've asked him to.\nI hear snackburr likes to come around more often when people are partyin.",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg" : "A snack delivery bear has arrived ʕ•ᴥ• ʔ",
+    "min_bot_version": "3.5.0",
+    "short" : "ʕ •ᴥ•ʔ < It's snacktime, who wants snacks?",
+    "tags" : ["snack", "snacktime", "snackburr", "party", "party time"]
+}

snacktime/phrases.py

@@ -0,0 +1,129 @@
+FRIENDS = {
+    "Snackburr": "ʕ •ᴥ•ʔ <",
+    "Pancakes": "₍⸍⸌̣ʷ̣̫⸍̣⸌₎ <",
+    "Mr Pickles": "(=｀ェ´=) <",
+    "Satin": "▼・ᴥ・▼ <",
+    "Thunky": "ᘛ⁐̤ᕐᐷ <",
+    "Jingle": "꒰∗'꒳'꒱ <",
+    "FluffButt": r"/ᐠ｡ꞈ｡ᐟ\ <",
+    "Staplefoot": "(￣(エ)￣) <",
+}
+
+
+SNACKBURR_PHRASES = {
+    "SNACKTIME": [
+        "It's snack time!",
+        "I'm back with s'more snacks! Who wants!?",
+        "I'm back errbody! Who wants some snacks!?",
+        "Woo man those errands are crazy! Anyways, anybody want some snacks?",
+        "I got snacks! If nobody wants em, I'm gonna eat em all!!",
+        "Hey, I'm back! Anybody in the mood for some snacks?!",
+        "Heyyaaayayyyaya! I say Hey, I got snacks!",
+        "Heyyaaayayyyaya! I say Hey, What's goin on?... I uh.. I got snacks.",
+        "If anybody has reason why these snacks and my belly should not be wed, speak now or forever hold your peace!",
+        "Got another snack delivery guys!",
+        "Did somebody say snacks?!?! o/",
+        "Choo Choo! it's the pb train! Come on over guys!",
+        "Snacks are here! Dig in! Who wants a plate?",
+        "Pstt.. I got the snacks you were lookin for. <.<",
+        "I hope you guys are hungry! Cause i'm loaded to the brim with snacks!!!",
+        "I was hungry on the way over so I kinda started without you guys :3 Who wants snacks!?!",
+        "Beep beep! I got a snack delivery comin in! Who wants snacks!",
+        "Guess what time it is?! It's snacktime!! Who wants?!",
+        "Hey check out this sweet stach o' snacks I found! Who wants a cut?",
+        "Who's ready to gobble down some snacks!?",
+        "So who's gonna help me eat all these snacks? :3",
+        "Eyoooooooo I haz snacks! Yall wanna munch???",
+    ],
+    "OUT": [
+        "I'm out of snacks! I'll be back with more soon.",
+        "I'm out of snacks :( I'll be back soon with more!",
+        "Aight, I gotta head out! I'll be back with more, don worry :3",
+        "Alright, I gotta get back to my errands. I'll see you guys soon!",
+        "Uh okays, imma get back to my errands cuz outta snacks!",
+        "Yall are cool but i gotta get back to my errands. I'll visit again soon!",
+        "Errands call! Thanks for the help with eating all these snacks, I'll come again :3",
+        "I have to go back do my stuffs, but as soon as I get more snacks imma come and share!!!",
+    ],
+    "LONELY": ["I guess you guys don't like snacktimes.. I'll stop comin around."],
+    "NO_TAKERS": [
+        "I guess nobody wants snacks... more for me!",
+        "Guess nobody's here.. I'll just head out then",
+        "I don't see anybody.. <.< ... >.> ... All the snacks for me!!",
+        "I guess nobody wants snacks huh.. Well, I'll come back later",
+        "I guess i'll just come back later..",
+        "Well. Since yall dun want snacks imma eat them all!!!",
+        "Where is everyone, I brought so many snacks...",
+        "I did offer to share, but I guess you dun want. Oh well, I'll come back later :3",
+        "Whoa... you dun wanna have any snacks?!",
+        "I'll just eat all those snacks by myself then!",
+        ":3 okay, catch yall lata",
+    ],
+    "GIVE": [
+        "Here ya go, {0}, here's {1} pb!",
+        "Alright here ya go, {0}, {1} pb for you!",
+        "Yeah! Here you go, {0}! {1} pb!",
+        "Of course {0}! Here's {1} pb!",
+        "Ok {0}, here's {1} pb for you. Anyone else want some?",
+        "Alllright, {1} pb for {0}!",
+        "Hold your horses {0}! Alright, {1} pb for you :)",
+        "Woooooooooo hey {0}, here have {1} pb!",
+        "Here's {1} pb for {0} :3",
+        "Heyheyehy hiya {0}! Here's {1} pb for you!",
+        "Oh hiya {0} :) imma give you {1} pb now!",
+        "Heyyyyyyyyyyy {0}, I brought you {1} pb :)",
+        "Oh you wanna munchies? I have munchies for you, {0}! Have {1} pb :)",
+        "{1} pb for {0}!!!",
+        "{0} {0} {0}! Grab {1} pb!",
+    ],
+    "LAST_SECOND": [
+        "Fine fine, {0}, I'll give you {1} of my on-the-road pb.. Cya!",
+        "Oh! {0}, you caught me right before I left! Alright, i'll give you {1} of my own pb",
+    ],
+    "GREEDY": [
+        "Don't be greedy now! you already got some pb {0}!",
+        "You already got your snacks {0}!",
+        "Come on {0}, you already got your snacks! We gotta make sure there's some for errbody!",
+        "But! {0} you already had a bunch of snacks!",
+        "Hey {0}, there must be snacks for others too!!",
+        "Donot be like that, {0}, I wanna give snacks to errybody!",
+        "Aw but {0}, we gonna run outta snacks if I give you again :(",
+        "Let's make a deal, remind me when I come back from my errands next time, {0} :3",
+        "Next time I'm comin 'round imma give you again, {0}",
+        "I alredy handed you snacks {0}...",
+        "But... but... you... you had your snacks {0} ._.",
+        "I wanna give snacks to errybody! You can't have them all, {0}!",
+        "You already munched on some snacks, {0}!",
+        "Did you already gobble down yours, {0}? Gotta leave some for the others!",
+    ],
+    "EAT_BEFORE": [
+        "monstrously",
+        "shyly",
+        "earnestly",
+        "eagerly",
+        "enthusiastically",
+        "ravenously",
+        "delicately",
+        "daintily",
+    ],
+    "EAT_AFTER": [
+        "gobbles up",
+        "pigs out on",
+        "wolfs down",
+        "chows down",
+        "munches on",
+        "chugs",
+        "puts away",
+        "ravages",
+        "siphons into their mouth",
+        "disposes of",
+        "swallows",
+        "chomps",
+        "consumes",
+        "demolishes",
+        "partakes of",
+        "ingests",
+    ],
+    "ENABLE": ["Oh you guys want snacks?! Aight, I'll come around every so often to hand some out!"],
+    "DISABLE": ["You guys don't want snacks anymore? Alright, I'll stop comin around."],
+}

snacktime/snacktime.py

@@ -0,0 +1,544 @@
+import asyncio
+import discord
+import logging
+import re
+from random import randint
+from random import choice as randchoice
+
+from redbot.core import bank, checks, commands, Config
+from redbot.core.errors import BalanceTooHigh
+from redbot.core.utils.chat_formatting import box, humanize_list, pagify
+
+from .phrases import FRIENDS, SNACKBURR_PHRASES
+
+
+log = logging.getLogger("red.aikaterna.snacktime")
+
+
+class Snacktime(commands.Cog):
+    """Snackburr's passing out pb jars!"""
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """ Nothing to delete """
+        return
+
+    def __init__(self, bot):
+        self.bot = bot
+        self.config = Config.get_conf(self, 2712291001, force_registration=True)
+
+        self.snackSchedule = {}
+        self.snacktimePrediction = {}
+        self.previousSpeaker = {}
+        self.snackInProgress = {}
+        self.acceptInput = {}
+        self.alreadySnacked = {}
+        self.msgsPassed = {}
+        self.startLock = {}
+        self.snacktimeCheckLock = {}
+        self.lockRequests = {}
+        self.channel_persona = {}
+
+        default_guild = {
+            "DELIVER_CHANNELS": [],
+            "FRIENDS": False,
+            "EVENT_START_DELAY": 1800,
+            "EVENT_START_DELAY_VARIANCE": 900,
+            "SNACK_DURATION": 240,
+            "SNACK_DURATION_VARIANCE": 120,
+            "MSGS_BEFORE_EVENT": 8,
+            "SNACK_AMOUNT": 200,
+            "USE_CURRENCY": False
+        }
+
+        default_channel = {"repeatMissedSnacktimes": 0}
+
+        self.config.register_guild(**default_guild)
+        self.config.register_channel(**default_channel)
+
+    async def persona_choice(self, ctx: None, message: None):
+        if ctx:
+            invite_friends = await self.config.guild(ctx.guild).FRIENDS()
+        else:
+            invite_friends = await self.config.guild(message.guild).FRIENDS()
+        personas = FRIENDS
+        if not invite_friends:
+            return "Snackburr" if message else "ʕ •ᴥ•ʔ <"
+        elif invite_friends is True:
+            try:
+                del personas["Snackburr"]
+            except KeyError:
+                pass
+        if message:
+            return randchoice(list(personas.keys()))
+        else:
+            return randchoice(list(personas.values()))
+
+    async def get_response(self, msg, phrase_type):
+        scid = f"{msg.guild.id}-{msg.channel.id}"
+        persona = self.channel_persona[scid]
+        persona_phrase = FRIENDS.get(persona)
+        phrase = randchoice(SNACKBURR_PHRASES[phrase_type])
+        return f"`{persona_phrase} {phrase}`"
+
+    # Is snackburr gonna like the currency or nah
+    @staticmethod
+    def is_custom(currency_name: str):
+        custom = re.search(r'<:\w*:\d*>', currency_name)
+        animated = re.search(r'<a:\w*:\d*>', currency_name)
+        if custom or animated:
+            return True
+
+    @commands.cooldown(1, 1, commands.BucketType.channel)
+    @commands.guild_only()
+    @commands.command()
+    async def eat(self, ctx, amount: int):
+        """
+        all this talk about pb is makin me hungry.
+
+        how bout you guys?
+        """
+        use_red_currency = await self.config.guild(ctx.guild).USE_CURRENCY()
+        if use_red_currency:
+            currency_name = await bank.get_currency_name(ctx.guild)
+        else:
+            currency_name = "pb jars"
+        if self.is_custom(currency_name):
+            currency_name = f"`{currency_name}`"
+        persona = await self.persona_choice(ctx=ctx, message=None)
+        if amount < 0:
+            return await ctx.send(f"`{persona} Woah slow down!`")
+        if amount > await bank.get_balance(ctx.author):
+            return await ctx.send(f"`{persona} You don't got that much {currency_name}!.. don't look at me..`")
+
+        await bank.withdraw_credits(ctx.author, amount)
+
+        first_phrase = randchoice(SNACKBURR_PHRASES["EAT_BEFORE"])
+        second_phrase = randchoice(SNACKBURR_PHRASES["EAT_AFTER"])
+
+        await ctx.send(
+            f"`{persona} {ctx.author.display_name} {first_phrase} {second_phrase} {amount} whole {currency_name}!`"
+        )
+
+    @commands.guild_only()
+    @commands.group()
+    @checks.mod_or_permissions(manage_guild=True)
+    async def snackset(self, ctx):
+        """snack stuff"""
+        if ctx.invoked_subcommand is None:
+            guild_data = await self.config.guild(ctx.guild).all()
+            channel_names = []
+            if guild_data["DELIVER_CHANNELS"]:
+                for channel_id in guild_data["DELIVER_CHANNELS"]:
+                    channel_obj = self.bot.get_channel(channel_id)
+                    if channel_obj:
+                        channel_names.append(channel_obj.name)
+            if len(channel_names) == 0:
+                channel_names = ["No channels set."]
+
+            if guild_data["FRIENDS"] is True:
+                invite_friends = "Friends only"
+            elif guild_data["FRIENDS"] is False:
+                invite_friends = "Snackburr only"
+            else:
+                invite_friends = "Everyone's invited!"
+
+            use_red_currency = await self.config.guild(ctx.guild).USE_CURRENCY()
+
+            msg = f"[Delivering in]:           {humanize_list(channel_names)}\n"
+            msg += f"[Event start delay]:       {guild_data['EVENT_START_DELAY']} seconds\n"
+            msg += f"[Event start variance]:    {guild_data['EVENT_START_DELAY_VARIANCE']} seconds\n"
+            msg += f"[Friends status]:          {invite_friends}\n"
+            msg += f"[Messages before event]:   {guild_data['MSGS_BEFORE_EVENT']}\n"
+            msg += f"[Snack amount limit]:      {guild_data['SNACK_AMOUNT']}\n"
+            msg += f"[Use custom currency]:     {use_red_currency}\n"
+            msg += f"[Snack duration]:          {guild_data['SNACK_DURATION']} seconds\n"
+            msg += f"[Snack duration variance]: {guild_data['SNACK_DURATION_VARIANCE']} seconds\n"
+
+            for page in pagify(msg, delims=["\n"]):
+                await ctx.send(box(page, lang="ini"))
+
+    @snackset.command()
+    async def errandtime(self, ctx, seconds: int):
+        """How long snackburr needs to be out doin errands.. more or less."""
+        event_start_delay_variance = await self.config.guild(ctx.guild).EVENT_START_DELAY_VARIANCE()
+        if seconds <= event_start_delay_variance:
+            await ctx.send("errandtime must be greater than errandvariance!")
+        elif seconds <= 0:
+            await ctx.send("errandtime must be greater than 0")
+        else:
+            await self.config.guild(ctx.guild).EVENT_START_DELAY.set(seconds)
+            await ctx.send(f"snackburr's errands will now take around {round(seconds/60, 2)} minutes!")
+
+    @snackset.command()
+    async def errandvariance(self, ctx, seconds: int):
+        """How early or late snackburr might be to snacktime"""
+        event_start_delay = await self.config.guild(ctx.guild).EVENT_START_DELAY()
+        if seconds >= event_start_delay:
+            await ctx.send("errandvariance must be less than errandtime!")
+        elif seconds < 0:
+            await ctx.send("errandvariance must be 0 or greater!")
+        else:
+            await self.config.guild(ctx.guild).EVENT_START_DELAY_VARIANCE.set(seconds)
+            await ctx.send(f"snackburr now might be {round(seconds/60, 2)} minutes early or late to snacktime")
+
+    @snackset.command(name="snacktime")
+    async def snacktimetime(self, ctx, seconds: int):
+        """How long snackburr will hang out giving out snacks!.. more or less."""
+        snack_duration_variance = await self.config.guild(ctx.guild).SNACK_DURATION_VARIANCE()
+        if seconds <= snack_duration_variance:
+            await ctx.send("snacktime must be greater than snackvariance!")
+        elif seconds <= 0:
+            await ctx.send("snacktime must be greater than 0")
+        else:
+            await self.config.guild(ctx.guild).SNACK_DURATION.set(seconds)
+            await ctx.send(f"snacktimes will now last around {round(seconds/60, 2)} minutes!")
+
+    @snackset.command(name="snackvariance")
+    async def snacktimevariance(self, ctx, seconds: int):
+        """How early or late snackburr might have to leave for errands"""
+        snack_duration = await self.config.guild(ctx.guild).SNACK_DURATION()
+        if seconds >= snack_duration:
+            await ctx.send("snackvariance must be less than snacktime!")
+        elif seconds < 0:
+            await ctx.send("snackvariance must be 0 or greater!")
+        else:
+            await self.config.guild(ctx.guild).SNACK_DURATION_VARIANCE.set(seconds)
+            await ctx.send(f"snackburr now may have to leave snacktime {round(seconds/60, 2)} minutes early or late")
+
+    @snackset.command()
+    async def msgsneeded(self, ctx, amt: int):
+        """How many messages must pass in a conversation before a snacktime can start"""
+        if amt <= 0:
+            await ctx.send("msgsneeded must be greater than 0")
+        else:
+            await self.config.guild(ctx.guild).MSGS_BEFORE_EVENT.set(amt)
+            await ctx.send(f"snackburr will now wait until {amt} messages pass until he comes with snacks")
+
+    @snackset.command()
+    async def amount(self, ctx, amt: int):
+        """How much pb max snackburr should give out to each person per snacktime"""
+        if amt <= 0:
+            await ctx.send("amount must be greater than 0")
+        else:
+            await self.config.guild(ctx.guild).SNACK_AMOUNT.set(amt)
+            use_red_currency = await self.config.guild(ctx.guild).USE_CURRENCY()
+            if use_red_currency:
+                currency_name = await bank.get_currency_name(ctx.guild)
+            else:
+                currency_name = "pb jars"
+            if self.is_custom(currency_name):
+                currency_name = f"`{currency_name}`"
+            await ctx.send(f"snackburr will now give out {amt} {currency_name} max per person per snacktime.")
+
+    @snackset.command()
+    async def togglecurrency(self, ctx):
+        """Toggle whether to use server currency name instead of pb"""
+        toggled = await self.config.guild(ctx.guild).USE_CURRENCY()
+        if not toggled:
+            currency_name = await bank.get_currency_name(ctx.guild)
+            if self.is_custom(currency_name):
+                await ctx.send("snackburr doesnt like that currency name.. but will use it anyway :unamused:")
+            else:
+                await ctx.send("snackburr will now use the bots currency name... lame.....")
+            await self.config.guild(ctx.guild).USE_CURRENCY.set(True)
+        else:
+            await self.config.guild(ctx.guild).USE_CURRENCY.set(False)
+            await ctx.send("snackburr will now use pb again yay!")
+
+    @snackset.command(name="friends")
+    async def snackset_friends(self, ctx, choice: int):
+        """snackburr's friends wanna know what all the hub-bub's about!
+
+        Do you want to
+        1: invite them to the party,
+        2: only allow snackburr to chillax with you guys, or
+        3: kick snackburr out on the curb in favor of his obviously cooler friends?
+        """
+
+        if choice not in (1, 2, 3):
+            return await ctx.send_help()
+
+        choices = {
+            1: ("both", "Everybody's invited!"),
+            2: (False, "You chose to not invite snackburr's friends."),
+            3: (True, "You kick snackburr out in favor of his friends! Ouch. Harsh..."),
+        }
+        choice = choices[choice]
+
+        await self.config.guild(ctx.guild).FRIENDS.set(choice[0])
+        await ctx.send(choice[1])
+
+    @snackset.command()
+    async def deliver(self, ctx):
+        """Asks snackburr to start delivering to this channel"""
+        deliver_channels = await self.config.guild(ctx.guild).DELIVER_CHANNELS()
+        if not deliver_channels:
+            deliver_channels = []
+        if ctx.channel.id not in deliver_channels:
+            deliver_channels.append(ctx.channel.id)
+            await self.config.guild(ctx.guild).DELIVER_CHANNELS.set(deliver_channels)
+            await ctx.send("snackburr will start delivering here!")
+        else:
+            deliver_channels.remove(ctx.channel.id)
+            await self.config.guild(ctx.guild).DELIVER_CHANNELS.set(deliver_channels)
+            await ctx.send("snackburr will stop delivering here!")
+
+    @commands.guild_only()
+    @commands.command()
+    async def snacktime(self, ctx):
+        """Man i'm hungry! When's snackburr gonna get back with more snacks?"""
+        scid = f"{ctx.message.guild.id}-{ctx.message.channel.id}"
+        if self.snacktimePrediction.get(scid, None) == None:
+            if self.acceptInput.get(scid, False):
+                return
+            else:
+                phrases = [
+                    r"Don't look at me. I donno where snackburr's at ¯\_(ツ)_/¯",
+                    "I hear snackburr likes parties. *wink wink",
+                    "I hear snackburr is attracted to channels with active conversations",
+                    "If you party, snackburr will come! 〈( ^o^)ノ",
+                ]
+                await ctx.send(randchoice(phrases))
+            return
+        seconds = self.snacktimePrediction[scid] - self.bot.loop.time()
+        if self.snacktimeCheckLock.get(scid, False):
+            if randint(1, 4) == 4:
+                await ctx.send("Hey, snackburr's on errands. I ain't his keeper Kappa")
+            return
+        self.snacktimeCheckLock[scid] = True
+        if seconds < 0:
+            await ctx.send(f"I'm not sure where snackburr is.. He's already {round(abs(seconds/60), 2)} minutes late!")
+        else:
+            await ctx.send(f"snackburr's out on errands! I think he'll be back in {round(seconds/60, 2)} minutes")
+        await asyncio.sleep(40)
+        self.snacktimeCheckLock[scid] = False
+
+    async def startSnack(self, message):
+        scid = f"{message.guild.id}-{message.channel.id}"
+        if self.acceptInput.get(scid, False):
+            return
+        self.channel_persona[scid] = await self.persona_choice(ctx=None, message=message)
+        await message.channel.send(await self.get_response(message, "SNACKTIME"))
+
+        self.acceptInput[scid] = True
+        self.alreadySnacked[scid] = []
+
+        guild_data = await self.config.guild(message.guild).all()
+
+        duration = guild_data["SNACK_DURATION"] + randint(
+            -guild_data["SNACK_DURATION_VARIANCE"], guild_data["SNACK_DURATION_VARIANCE"]
+        )
+        await asyncio.sleep(duration)
+        # sometimes fails sending messages and stops all future snacktimes. Hopefully this fixes it.
+        try:
+            # list isn't empty
+            if self.alreadySnacked.get(scid, False):
+                await message.channel.send(await self.get_response(message, "OUT"))
+                await self.config.channel(message.channel).repeatMissedSnacktimes.set(0)
+            else:
+                await message.channel.send(await self.get_response(message, "NO_TAKERS"))
+                repeat_missed_snacktimes = await self.config.channel(message.channel).repeatMissedSnacktimes()
+                await self.config.channel(message.channel).repeatMissedSnacktimes.set(repeat_missed_snacktimes + 1)
+                await asyncio.sleep(2)
+                if (repeat_missed_snacktimes + 1) > 9:  # move to a setting
+                    await message.channel.send(await self.get_response(message, "LONELY"))
+                    deliver_channels = await self.config.guild(message.guild).DELIVER_CHANNELS()
+                    new_deliver_channels = deliver_channels.remove(message.channel.id)
+                    await self.config.guild(message.guild).DELIVER_CHANNELS.set(new_deliver_channels)
+                    await self.config.channel(message.channel).repeatMissedSnacktimes.set(0)
+        except:
+            log.error("Snacktime: Failed to send message in startSnack")
+        self.acceptInput[scid] = False
+        self.snackInProgress[scid] = False
+
+    @commands.Cog.listener()
+    async def on_message(self, message):
+        if not message.guild:
+            return
+        if message.author.bot:
+            return
+        if not message.channel.permissions_for(message.guild.me).send_messages:
+            return
+
+        deliver_channels = await self.config.guild(message.guild).DELIVER_CHANNELS()
+        if not deliver_channels:
+            return
+        if message.channel.id not in deliver_channels:
+            return
+        scid = f"{message.guild.id}-{message.channel.id}"
+        if message.author.id != self.bot.user.id:
+            # if nobody has said anything since start
+            if self.previousSpeaker.get(scid, None) == None:
+                self.previousSpeaker[scid] = message.author.id
+            # if new speaker
+            elif self.previousSpeaker[scid] != message.author.id:
+                self.previousSpeaker[scid] = message.author.id
+                msgTime = self.bot.loop.time()
+                # if there's a scheduled snack
+                if self.snackSchedule.get(scid, None) != None:
+                    # if it's time for a snack
+                    if msgTime > self.snackSchedule[scid]:
+                        # 1 schedule at a time, so remove schedule
+                        self.snackSchedule[scid] = None
+                        self.snackInProgress[scid] = True
+
+                        # wait to make it more natural
+                        naturalWait = randint(30, 240)
+                        log.debug(f"Snacktime: snack trigger msg: {message.content}")
+                        log.debug(f"Snacktime: Waiting {str(naturalWait)} seconds")
+                        await asyncio.sleep(naturalWait)
+                        # start snacktime
+                        await self.startSnack(message)
+                # if no snack coming, schedule one
+                elif self.snackInProgress.get(scid, False) == False and not self.startLock.get(scid, False):
+                    self.msgsPassed[scid] = self.msgsPassed.get(scid, 0) + 1
+                    # check for collisions
+                    msgs_before_event = await self.config.guild(message.guild).MSGS_BEFORE_EVENT()
+                    if self.msgsPassed[scid] > msgs_before_event:
+                        self.startLock[scid] = True
+                        if self.lockRequests.get(scid, None) == None:
+                            self.lockRequests[scid] = []
+                        self.lockRequests[scid].append(message)
+                        await asyncio.sleep(1)
+                        log.debug(
+                            f"Snacktime: :-+-|||||-+-: Lock request: {str(self.lockRequests[scid][0] == message)}"
+                        )
+                        if self.lockRequests[scid][0] == message:
+                            await asyncio.sleep(5)
+                            log.debug(f"Snacktime: {message.author.name} - I got the Lock")
+                            self.lockRequests[scid] = []
+                            # someone got through already
+                            if self.msgsPassed[scid] < msgs_before_event or self.snackInProgress.get(scid, False):
+                                log.debug("Snacktime: Lock: someone got through already.")
+                                return
+                            else:
+                                log.debug(
+                                    "Snacktime: Lock: looks like i'm in the clear. lifting lock. If someone comes now, they should get the lock"
+                                )
+                                self.msgsPassed[scid] = msgs_before_event
+                                self.startLock[scid] = False
+                        else:
+                            log.debug(f"Snacktime: {message.author.name} Failed lock")
+                            return
+                    if self.msgsPassed[scid] == msgs_before_event:
+                        # schedule a snack
+                        log.debug(f"Snacktime: activity: {message.content}")
+                        guild_data = await self.config.guild(message.guild).all()
+                        timeTillSnack = guild_data["EVENT_START_DELAY"] + randint(
+                            -guild_data["EVENT_START_DELAY_VARIANCE"], guild_data["EVENT_START_DELAY_VARIANCE"],
+                        )
+                        log.debug(f"Snacktime: {str(timeTillSnack)} seconds till snacktime")
+                        self.snacktimePrediction[scid] = msgTime + guild_data["EVENT_START_DELAY"]
+                        self.snackSchedule[scid] = msgTime + timeTillSnack
+                        self.msgsPassed[scid] = 0
+
+            # it's snacktime! who want's snacks?
+            if self.acceptInput.get(scid, False):
+                if message.author.id not in self.alreadySnacked.get(scid, []):
+                    agree_phrases = [
+                        "holds out hand",
+                        "im ready",
+                        "i'm ready",
+                        "hit me up",
+                        "hand over",
+                        "hand me",
+                        "kindly",
+                        "i want",
+                        "i'll have",
+                        "ill have",
+                        "yes",
+                        "pls",
+                        "plz",
+                        "please",
+                        "por favor",
+                        "can i",
+                        "i'd like",
+                        "i would",
+                        "may i",
+                        "in my mouth",
+                        "in my belly",
+                        "snack me",
+                        "gimme",
+                        "give me",
+                        "i'll take",
+                        "ill take",
+                        "i am",
+                        "about me",
+                        "me too",
+                        "of course",
+                    ]
+                    userWants = False
+                    for agreePhrase in agree_phrases:
+                        # no one word answers
+                        if agreePhrase in message.content.lower() and len(message.content.split()) > 1:
+                            userWants = True
+                            break
+                    if userWants:
+                        if self.alreadySnacked.get(scid, None) == None:
+                            self.alreadySnacked[scid] = []
+                        self.alreadySnacked[scid].append(message.author.id)
+
+                        # If user is blacklisted, don't give him/her anything.
+                        # We're still passing it to the list to avoid this calculation down the line,
+                        if await self.bot.allowed_by_whitelist_blacklist(
+                            who=message.author
+                        ) is False:
+                            return
+
+                        await asyncio.sleep(randint(1, 6))
+                        snack_amount = await self.config.guild(message.guild).SNACK_AMOUNT()
+                        snackAmt = randint(1, snack_amount)
+                        try:
+                            if self.acceptInput.get(scid, False):
+                                resp = await self.get_response(message, "GIVE")
+                                resp = resp.format(message.author.name, snackAmt)
+                                use_red_currency = await self.config.guild(message.guild).USE_CURRENCY()
+                                if use_red_currency:
+                                    currency_name = await bank.get_currency_name(message.guild)
+                                    if self.is_custom(currency_name):
+                                        currency_name = f"`{currency_name}`"
+                                    resp = resp.replace("pb", currency_name)
+                                await message.channel.send(resp)
+                            else:
+                                resp = await self.get_response(message, "LAST_SECOND")
+                                resp = resp.format(message.author.name, snackAmt)
+                                use_red_currency = await self.config.guild(message.guild).USE_CURRENCY()
+                                if use_red_currency:
+                                    currency_name = await bank.get_currency_name(message.guild)
+                                    if self.is_custom(currency_name):
+                                        currency_name = f"`{currency_name}`"
+                                    resp = resp.replace("pb", currency_name)
+                                await message.channel.send(resp)
+                            try:
+                                await bank.deposit_credits(message.author, snackAmt)
+                            except BalanceTooHigh as b:
+                                await bank.set_balance(message.author, b.max_balance)
+                        except Exception as e:
+                            log.info(
+                                f"Failed to send pb message. {message.author.name} didn't get pb\n", exc_info=True,
+                            )
+
+                else:
+                    more_phrases = [
+                        "more pl",
+                        "i have some more",
+                        "i want more",
+                        "i have another",
+                        "i have more",
+                        "more snack",
+                    ]
+                    userWants = False
+                    for morePhrase in more_phrases:
+                        if morePhrase in message.content.lower():
+                            userWants = True
+                            break
+                    if userWants:
+                        if await self.bot.allowed_by_whitelist_blacklist(
+                            who=message.author
+                        ) is False:
+                            return
+
+                        await asyncio.sleep(randint(1, 6))
+                        if self.acceptInput.get(scid, False):
+                            resp = await self.get_response(message, "GREEDY")
+                            await message.channel.send(resp.format(message.author.name))

timezone/__init__.py

@@ -0,0 +1,16 @@
+from .timezone import Timezone
+
+__red_end_user_data_statement__ = (
+    "This cog stores data provided by users "
+    "for the express purpose of redisplaying. "
+    "It does not store user data which was not "
+    "provided through a command. "
+    "Users may remove their own content "
+    "without making a data removal request. "
+    "This cog does not support data requests, "
+    "but will respect deletion requests."
+)
+
+
+async def setup(bot):
+    await bot.add_cog(Timezone(bot))

timezone/info.json

@@ -0,0 +1,10 @@
+{
+    "author": ["aikaterna", "fishyfing"],
+    "description": "Check timezones, user times, or times in specific places. Originally made by Fishyfing.",
+    "end_user_data_statement": "This cog stores data provided by users for the express purpose of redisplaying. It does not store user data which was not provided through a command. Users may remove their own content without making a data removal request. This cog does not support data requests, but will respect deletion requests.",
+    "min_bot_version": "3.5.0",
+    "requirements": ["fuzzywuzzy", "pytz"],
+    "short": "Check times for users and places.",
+    "tags": ["time", "timezone"],
+    "type": "COG"
+}

timezone/timezone.py

@@ -0,0 +1,216 @@
+import discord
+import pytz
+from datetime import datetime
+from fuzzywuzzy import fuzz, process
+from typing import Optional, Literal
+from redbot.core import Config, commands
+from redbot.core.utils.chat_formatting import pagify
+from redbot.core.utils.menus import close_menu, menu, DEFAULT_CONTROLS
+
+
+__version__ = "2.1.1"
+
+
+class Timezone(commands.Cog):
+    """Gets times across the world..."""
+    def __init__(self, bot):
+        self.bot = bot
+        self.config = Config.get_conf(self, 278049241001, force_registration=True)
+        default_user = {"usertime": None}
+        self.config.register_user(**default_user)
+        
+    async def red_delete_data_for_user(
+        self, *, requester: Literal["discord", "owner", "user", "user_strict"], user_id: int,
+    ):
+        await self.config.user_from_id(user_id).clear()
+
+    async def get_usertime(self, user: discord.User):
+        tz = None
+        usertime = await self.config.user(user).usertime()
+        if usertime:
+            tz = pytz.timezone(usertime)
+
+        return usertime, tz
+
+    def fuzzy_timezone_search(self, tz: str):
+        fuzzy_results = process.extract(tz.replace(" ", "_"), pytz.common_timezones, limit=500, scorer=fuzz.partial_ratio)
+        matches = [x for x in fuzzy_results if x[1] > 98] 
+        return matches
+
+    async def format_results(self, ctx, tz):
+        if not tz:
+            await ctx.send(
+                "Error: Incorrect format or no matching timezones found.\n"
+                "Use: **Continent/City** with correct capitals or a partial timezone name to search. "
+                "e.g. `America/New_York` or `New York`\nSee the full list of supported timezones here:\n"
+                "<https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>"
+            )
+            return None
+        elif len(tz) == 1:
+            # command specific response, so don't do anything here
+            return tz
+        else:
+            msg = ""
+            for timezone in tz:
+                msg += f"{timezone[0]}\n"
+
+            embed_list = []
+            for page in pagify(msg, delims=["\n"], page_length=500):
+                e = discord.Embed(title=f"{len(tz)} results, please be more specific.", description=page)
+                e.set_footer(text="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones")
+                embed_list.append(e)
+            if len(embed_list) == 1:
+                close_control = {"\N{CROSS MARK}": close_menu}
+                await menu(ctx, embed_list, close_control)
+            else:
+                await menu(ctx, embed_list, DEFAULT_CONTROLS)
+            return None
+
+    @commands.guild_only()
+    @commands.group()
+    async def time(self, ctx):
+        """
+        Checks the time.
+
+        For the list of supported timezones, see here:
+        https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+        """
+        pass
+
+    @time.command()
+    async def tz(self, ctx, *, timezone_name: Optional[str] = None):
+        """Gets the time in any timezone."""
+        if timezone_name is None:
+            time = datetime.now()
+            fmt = "**%H:%M** %d-%B-%Y"
+            await ctx.send(f"Current system time: {time.strftime(fmt)}")
+        else:
+            tz_results = self.fuzzy_timezone_search(timezone_name)
+            tz_resp = await self.format_results(ctx, tz_results)
+            if tz_resp:
+                time = datetime.now(pytz.timezone(tz_resp[0][0]))
+                fmt = "**%H:%M** %d-%B-%Y **%Z (UTC %z)**"
+                await ctx.send(time.strftime(fmt))
+
+    @time.command()
+    async def iso(self, ctx, *, iso_code=None):
+        """Looks up ISO3166 country codes and gives you a supported timezone."""
+        if iso_code is None:
+            await ctx.send("That doesn't look like a country code!")
+        else:
+            exist = True if iso_code.upper() in pytz.country_timezones else False
+            if exist is True:
+                tz = str(pytz.country_timezones(iso_code.upper()))
+                msg = (
+                    f"Supported timezones for **{iso_code.upper()}:**\n{tz[:-1][1:]}"
+                    f"\n**Use** `{ctx.prefix}time tz Continent/City` **to display the current time in that timezone.**"
+                )
+                await ctx.send(msg)
+            else:
+                await ctx.send(
+                    "That code isn't supported.\nFor a full list, see here: "
+                    "<https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes>\n"
+                    "Use the two-character code under the `Alpha-2 code` column."
+                )
+
+    @time.command()
+    async def me(self, ctx, *, timezone_name=None):
+        """
+        Sets your timezone.
+        Usage: [p]time me Continent/City
+        Using the command with no timezone will show your current timezone, if any.
+        """
+        if timezone_name is None:
+            usertime, timezone_name = await self.get_usertime(ctx.author)
+            if not usertime:
+                await ctx.send(
+                    f"You haven't set your timezone. Do `{ctx.prefix}time me Continent/City`: "
+                    "see <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>"
+                )
+            else:
+                time = datetime.now(timezone_name)
+                time = time.strftime("**%H:%M** %d-%B-%Y **%Z (UTC %z)**")
+                msg = f"Your current timezone is **{usertime}.**\n" f"The current time is: {time}"
+                await ctx.send(msg)
+        else:
+            tz_results = self.fuzzy_timezone_search(timezone_name)
+            tz_resp = await self.format_results(ctx, tz_results)
+            if tz_resp:
+                await self.config.user(ctx.author).usertime.set(tz_resp[0][0])
+                await ctx.send(f"Successfully set your timezone to **{tz_resp[0][0]}**.")
+
+    @time.command()
+    @commands.is_owner()
+    async def set(self, ctx, user: discord.User, *, timezone_name=None):
+        """
+        Allows the bot owner to edit users' timezones.
+        Use a user id for the user if they are not present in your server.
+        """
+        if not user:
+            user = ctx.author
+        if len(self.bot.users) == 1:
+            return await ctx.send("This cog requires Discord's Privileged Gateway Intents to function properly.")
+        if user not in self.bot.users:
+            return await ctx.send("I can't see that person anywhere.")
+        if timezone_name is None:
+            return await ctx.send_help()
+        else:
+            tz_results = self.fuzzy_timezone_search(timezone_name)
+            tz_resp = await self.format_results(ctx, tz_results)
+            if tz_resp:
+                await self.config.user(user).usertime.set(tz_resp[0][0])
+                await ctx.send(f"Successfully set {user.name}'s timezone to **{tz_resp[0][0]}**.")
+
+    @time.command()
+    async def user(self, ctx, user: discord.Member = None):
+        """Shows the current time for the specified user."""
+        if not user:
+            await ctx.send("That isn't a user!")
+        else:
+            usertime, tz = await self.get_usertime(user)
+            if usertime:
+                time = datetime.now(tz)
+                fmt = "**%H:%M** %d-%B-%Y **%Z (UTC %z)**"
+                time = time.strftime(fmt)
+                await ctx.send(
+                    f"{user.name}'s current timezone is: **{usertime}**\n" f"The current time is: {str(time)}"
+                )
+            else:
+                await ctx.send("That user hasn't set their timezone.")
+
+    @time.command()
+    async def compare(self, ctx, user: discord.Member = None):
+        """Compare your saved timezone with another user's timezone."""
+        if not user:
+            return await ctx.send_help()
+
+        usertime, user_tz = await self.get_usertime(ctx.author)
+        othertime, other_tz = await self.get_usertime(user)
+
+        if not usertime:
+            return await ctx.send(
+                f"You haven't set your timezone. Do `{ctx.prefix}time me Continent/City`: "
+                "see <https://en.wikipedia.org/wiki/List_of_tz_database_time_zones>"
+            )
+        if not othertime:
+            return await ctx.send(f"That user's timezone isn't set yet.")
+
+        user_now = datetime.now(user_tz)
+        user_diff = user_now.utcoffset().total_seconds() / 60 / 60
+        other_now = datetime.now(other_tz)
+        other_diff = other_now.utcoffset().total_seconds() / 60 / 60
+        time_diff = abs(user_diff - other_diff)
+        time_diff_text = f"{time_diff:g}"
+        fmt = "**%H:%M %Z (UTC %z)**"
+        other_time = other_now.strftime(fmt)
+        plural = "" if time_diff_text == "1" else "s"
+        time_amt = "the same time zone as you" if time_diff_text == "0" else f"{time_diff_text} hour{plural}"
+        position = "ahead of" if user_diff < other_diff else "behind"
+        position_text = "" if time_diff_text == "0" else f" {position} you"
+
+        await ctx.send(f"{user.display_name}'s time is {other_time} which is {time_amt}{position_text}.")
+
+    @time.command()
+    async def version(self, ctx):
+        """Show the cog version."""
+        await ctx.send(f"Timezone version: {__version__}.")

tools/__init__.py

@@ -0,0 +1,7 @@
+from .tools import Tools
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(Tools(bot))

tools/converter.py

@@ -0,0 +1,45 @@
+import discord
+from fuzzywuzzy import fuzz, process
+from typing import List
+from unidecode import unidecode
+
+from discord.ext.commands.converter import IDConverter, _get_from_guilds
+from discord.ext.commands.errors import BadArgument
+
+from redbot.core import commands
+
+
+class FuzzyMember(IDConverter):
+    """
+    Original class written by TrustyJaid#0001
+    https://github.com/TrustyJAID/Trusty-cogs/blob/c739903aa2c8111c58b3d5e695a1221cbe1f57d9/serverstats/converters.py
+
+    This will accept partial names and perform a fuzzy search for
+    members within the guild and return a list of member objects.
+
+    Guidance code on how to do this from:
+    https://github.com/Rapptz/discord.py/blob/rewrite/discord/ext/commands/converter.py#L85
+    https://github.com/Cog-Creators/Red-DiscordBot/blob/V3/develop/redbot/cogs/mod/mod.py#L24
+    """
+
+    async def convert(self, ctx: commands.Context, argument: str) -> List[discord.Member]:
+        bot = ctx.bot
+        guild = ctx.guild
+        result = []
+
+        members = {m: unidecode(m.name) for m in guild.members}
+        fuzzy_results = process.extract(argument, members, limit=1000, scorer=fuzz.partial_ratio)
+        matching_names = [m[2] for m in fuzzy_results if m[1] > 90]
+        for x in matching_names:
+            result.append(x)
+
+        nick_members = {m: unidecode(m.nick) for m in guild.members if m.nick and m not in matching_names}
+        fuzzy_results2 = process.extract(argument, nick_members, limit=50, scorer=fuzz.partial_ratio)
+        matching_nicks = [m[2] for m in fuzzy_results2 if m[1] > 90]
+        for x in matching_nicks:
+            result.append(x)
+
+        if not result or result == [None]:
+            raise BadArgument('Member "{}" not found'.format(argument))
+
+        return result

tools/info.json

@@ -0,0 +1,12 @@
+{
+    "author": ["aikaterna", "sitryk"],
+    "description": "Mod and admin tools.",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "Thanks for installing. Use `[p]help` Tools to get started.",
+    "min_bot_version": "3.5.0",
+    "permissions" : ["ban_members", "manage_channels"],
+    "requirements": ["tabulate", "unidecode"],
+    "short": "Mod and admin tools.",
+    "tags": ["tools"],
+    "type": "COG"
+}

trackdecoder/__init__.py

@@ -0,0 +1,7 @@
+from .trackdecoder import TrackDecoder
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(TrackDecoder(bot))

trackdecoder/info.json

@@ -0,0 +1,10 @@
+{
+    "author": ["aikaterna", "devoxin#0001"],
+    "description": "Utility cog for decoding b64 encoded Lavalink Track strings.",
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "Thanks for installing.",
+    "min_bot_version": "3.5.0",
+    "short": "Utility cog for decoding b64 encoded Lavalink Track strings.",
+    "tags": ["lavalink"],
+    "type": "COG"
+}

trackdecoder/trackdecoder.py

@@ -0,0 +1,110 @@
+from base64 import b64decode
+import json
+from io import BytesIO
+import struct
+from types import SimpleNamespace
+
+from redbot.core import checks, commands
+from redbot.core.utils.chat_formatting import box
+
+
+class TrackDecoder(commands.Cog):
+    """Decodes a b64 encoded audio track string."""
+
+    def __init__(self, bot):
+        self.bot = bot
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """Nothing to delete"""
+        return
+
+    @checks.is_owner()
+    @commands.command()
+    @commands.guild_only()
+    async def trackdecode(self, ctx: commands.Context, *, track: str):
+        """
+        Decodes a b64 encoded audio track string.
+
+        This command is possible thanks to devoxin#0001's work.
+        `https://github.com/Devoxin/Lavalink.py`
+        """
+        decoded = self.decode_track(track)
+        if not decoded:
+            return await ctx.send(f"Not a valid track.")
+
+        msg = (
+            f"[Title]:      {decoded.title}\n"
+            f"[Author]:     {decoded.author}\n"
+            f"[URL]:        {decoded.uri}\n"
+            f"[Identifier]: {decoded.identifier}\n"
+            f"[Source]:     {decoded.source}\n"
+            f"[Length]:     {decoded.length}\n"
+            f"[Stream]:     {decoded.is_stream}\n"
+            f"[Position]:   {decoded.position}\n"
+        )
+
+        await ctx.send(box(msg, lang="ini"))
+
+    @staticmethod
+    def decode_track(track, decode_errors="ignore"):
+        """
+        Source is derived from:
+        https://github.com/Devoxin/Lavalink.py/blob/3688fe6aff265ff53928ec811279177a88aa9664/lavalink/utils.py
+        """
+        reader = DataReader(track)
+
+        try:
+            flags = (reader.read_int() & 0xC0000000) >> 30
+        except struct.error:
+            return None
+
+        (version,) = struct.unpack("B", reader.read_byte()) if flags & 1 != 0 else 1
+
+        track = SimpleNamespace(
+            title=reader.read_utf().decode(errors=decode_errors),
+            author=reader.read_utf().decode(),
+            length=reader.read_long(),
+            identifier=reader.read_utf().decode(),
+            is_stream=reader.read_boolean(),
+            uri=reader.read_utf().decode() if reader.read_boolean() else None,
+            source=reader.read_utf().decode(),
+            position=reader.read_long(),
+        )
+
+        return track
+
+
+class DataReader:
+    """
+    Source is from:
+    https://github.com/Devoxin/Lavalink.py/blob/3688fe6aff265ff53928ec811279177a88aa9664/lavalink/datarw.py
+    """
+
+    def __init__(self, ts):
+        self._buf = BytesIO(b64decode(ts))
+
+    def _read(self, n):
+        return self._buf.read(n)
+
+    def read_byte(self):
+        return self._read(1)
+
+    def read_boolean(self):
+        (result,) = struct.unpack("B", self.read_byte())
+        return result != 0
+
+    def read_unsigned_short(self):
+        (result,) = struct.unpack(">H", self._read(2))
+        return result
+
+    def read_int(self):
+        (result,) = struct.unpack(">i", self._read(4))
+        return result
+
+    def read_long(self):
+        (result,) = struct.unpack(">Q", self._read(8))
+        return result
+
+    def read_utf(self):
+        text_length = self.read_unsigned_short()
+        return self._read(text_length)

trickortreat/__init__.py

@@ -0,0 +1,18 @@
+import asyncio
+
+from .trickortreat import TrickOrTreat
+
+__red_end_user_data_statement__ = (
+    "This cog does not persistently store end user data. "
+    "This cog does store discord IDs as needed for operation. "
+    "This cog does store user stats for the cog such as their score. "
+    "Users may remove their own content without making a data removal request."
+    "This cog does not support data requests, "
+    "but will respect deletion requests."
+)
+
+
+async def setup(bot):
+    cog = TrickOrTreat(bot)
+    await bot.add_cog(cog)
+    asyncio.create_task(cog.cleanup())

trickortreat/info.json

@@ -0,0 +1,10 @@
+{
+    "author": ["aikaterna"],
+    "description": "Trick or treating for your server.",
+    "end_user_data_statement": "This cog does not persistently store end user data. This cog does store discord IDs as needed for operation. This cog does store user stats for the cog such as their score. Users may remove their own content without making a data removal request. This cog does not support data requests, but will respect deletion requests.",
+    "install_msg": "Thanks for installing. Use `[p]help TrickOrTreat` to get started, specifically by toggling it on in your server and then setting active trick or treating channels.",
+    "min_bot_version": "3.5.0",
+    "short": "Trick or treat.",
+    "tags": ["trick or treat", "candy", "pick", "halloween"],
+    "type": "COG"
+}

trickortreat/trickortreat.py

@@ -0,0 +1,827 @@
+import asyncio
+import datetime
+from typing import Literal, Optional
+
+import discord
+import random
+import math
+from redbot.core import commands, checks, Config, bank
+from redbot.core.utils.chat_formatting import box, pagify, humanize_number
+from redbot.core.utils.menus import menu, DEFAULT_CONTROLS
+
+__version__ = "0.2.12"
+
+
+class TrickOrTreat(commands.Cog):
+    """Trick or treating for your server."""
+
+    async def red_delete_data_for_user(
+        self,
+        *,
+        requester: Literal["discord", "owner", "user", "user_strict"],
+        user_id: int,
+    ):
+        await self.config.user_from_id(user_id).clear()
+
+    def __init__(self, bot):
+        self.bot = bot
+        self.config = Config.get_conf(self, 2710311393, force_registration=True)
+
+        default_guild = {"cooldown": 300, "channel": [], "pick": 50, "toggle": False}
+        default_global = {"schema": "v1"}
+
+        default_user = {
+            "candies": 0,
+            "chocolates": 0,
+            "cookies": 0,
+            "eaten": 0,
+            "last_tot": "2018-01-01 00:00:00.000001",
+            "lollipops": 0,
+            "sickness": 0,
+            "stars": 0,
+        }
+
+        self.config.register_user(**default_user)
+        self.config.register_guild(**default_guild)
+        self.config.register_global(**default_global)
+
+    async def cleanup(self):
+        # Schema didn't exist before, so it will be initialized at v1.
+        # This will also run once for new cog installs
+        schema = await self.config.schema()
+        if schema == "v2":
+            return
+        await self.bot.wait_until_red_ready()
+        users = await self.config.all_users()
+        for uid, data in users.items():
+            if "chocolate" not in data:
+                continue
+            async with self.config.user_from_id(uid).all() as user:
+                user["chocolates"] += user["chocolate"]
+                del user["chocolate"]
+        await self.config.schema.set("v2")
+
+    @commands.guild_only()
+    @commands.cooldown(1, 1, commands.BucketType.user)
+    @commands.command()
+    async def eatcandy(self, ctx, number: Optional[int] = 1, candy_type=None):
+        """Eat some candy.
+
+        Valid types: candy/candie(s), chocolate(s), lollipop(s), cookie(s), star(s)
+        Examples:
+            `[p]eatcandy 3 lollipops`
+            `[p]eatcandy star`
+
+        \N{CANDY}
+        The star of this competition. You should try to eat all of these, but don't get too sick.
+
+        \N{CHOCOLATE BAR}
+        Reduces sickness by 10.
+
+        \N{LOLLIPOP}
+        Reduces sickness by 20.
+
+        \N{FORTUNE COOKIE}
+        Sets sickness to a random amount - fortune favours the brave.
+
+        \N{WHITE MEDIUM STAR}
+        Resets sickness to 0.
+        """
+        userdata = await self.config.user(ctx.author).all()
+        pick = await self.config.guild(ctx.guild).pick()
+        if not candy_type:
+            candy_type = "candies"
+        if number < 0:
+            return await ctx.send(
+                "That doesn't sound fun.",
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+        if number == 0:
+            return await ctx.send(
+                "You pretend to eat a candy.",
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+        if candy_type in ["candies", "candy", "\U0001f36c"]:
+            candy_type = "candies"
+        if candy_type in ["lollipops", "lollipop", "\U0001f36d"]:
+            candy_type = "lollipops"
+        if candy_type in ["stars", "star", "\U00002b50"]:
+            candy_type = "stars"
+        if candy_type in ["chocolate", "chocolates", "\U0001f36b"]:
+            candy_type = "chocolates"
+        if candy_type in ["cookie", "cookies", "\U0001f960"]:
+            candy_type = "cookies"
+        candy_list = ["candies", "chocolates", "lollipops", "cookies", "stars"]
+        if candy_type not in candy_list:
+            return await ctx.send(
+                "That's not a candy type! Use the inventory command to see what you have.",
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+        if userdata[candy_type] < number:
+            return await ctx.send(
+                f"You don't have that many {candy_type}.",
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+        if userdata[candy_type] == 0:
+            return await ctx.send(
+                f"You contemplate the idea of eating {candy_type}.",
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+
+        eat_phrase = [
+            "You leisurely enjoy",
+            "You take the time to savor",
+            "You eat",
+            "You scarf down",
+            "You sigh in contentment after eating",
+            "You gobble up",
+            "You make a meal of",
+            "You devour",
+            "You monstrously pig out on",
+            "You hastily chomp down on",
+            "You daintily partake of",
+            "You earnestly consume",
+        ]
+        if candy_type in ["candies", "candy"]:
+            if (userdata["sickness"] + number * 2) in range(70, 95):
+                await ctx.send(
+                    "After all that candy, sugar doesn't sound so good.",
+                    reference=ctx.message.to_reference(fail_if_not_exists=False),
+                )
+                yuck = random.randint(1, 10)
+                if yuck == 10:
+                    await self.config.user(ctx.author).sickness.set(userdata["sickness"] + 25)
+                if yuck in range(1, 9):
+                    await self.config.user(ctx.author).sickness.set(userdata["sickness"] + (yuck * 2))
+
+                if userdata["candies"] > 3 + number:
+                    lost_candy = userdata["candies"] - random.randint(1, 3) - number
+                else:
+                    lost_candy = userdata["candies"]
+
+                pick_now = await self.config.guild(ctx.guild).pick()
+                if lost_candy < 0:
+                    await self.config.user(ctx.author).candies.set(0)
+                    await self.config.guild(ctx.guild).pick.set(pick_now + lost_candy)
+                else:
+                    await self.config.user(ctx.author).candies.set(userdata["candies"] - lost_candy)
+                    await self.config.guild(ctx.guild).pick.set(pick_now + lost_candy)
+
+                await self.config.user(ctx.author).eaten.set(userdata["eaten"] + (userdata["candies"] - lost_candy))
+
+                return await ctx.send(
+                    f"You begin to think you don't need all this candy, maybe...\n*{lost_candy} candies are left behind*",
+                    reference=ctx.message.to_reference(fail_if_not_exists=False),
+                )
+
+            if (userdata["sickness"] + number) > 96:
+                await self.config.user(ctx.author).sickness.set(userdata["sickness"] + 30)
+                lost_candy = userdata["candies"] - random.randint(1, 5)
+                if lost_candy <= 0:
+                    await self.config.user(ctx.author).candies.set(0)
+                    message = await ctx.send(
+                        "...",
+                        reference=ctx.message.to_reference(fail_if_not_exists=False),
+                    )
+                    await asyncio.sleep(2)
+                    await message.edit(content="..........")
+                    await asyncio.sleep(2)
+                    return await message.edit(
+                        content="You feel absolutely disgusted. At least you don't have any candies left."
+                    )
+                await self.config.guild(ctx.guild).pick.set(pick + lost_candy)
+                await self.config.user(ctx.author).candies.set(0)
+                await self.config.user(ctx.author).eaten.set(userdata["eaten"] + (userdata["candies"] - lost_candy))
+                message = await ctx.send("...", reference=ctx.message.to_reference(fail_if_not_exists=False))
+                await asyncio.sleep(2)
+                await message.edit(content="..........")
+                await asyncio.sleep(2)
+                return await message.edit(
+                    content=f"You toss your candies on the ground in disgust.\n*{lost_candy} candies are left behind*"
+                )
+
+            pluralcandy = "candy" if number == 1 else "candies"
+            await ctx.send(
+                f"{random.choice(eat_phrase)} {number} {pluralcandy}. (Total eaten: `{humanize_number(await self.config.user(ctx.author).eaten() + number)}` \N{CANDY})",
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+            await self.config.user(ctx.author).sickness.set(userdata["sickness"] + (number * 2))
+            await self.config.user(ctx.author).candies.set(userdata["candies"] - number)
+            await self.config.user(ctx.author).eaten.set(userdata["eaten"] + number)
+
+        if candy_type in ["chocolates", "chocolate"]:
+            pluralchoc = "chocolate" if number == 1 else "chocolates"
+            await ctx.send(
+                f"{random.choice(eat_phrase)} {number} {pluralchoc}. You feel slightly better!\n*Sickness has gone down by {number * 10}*",
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+            new_sickness = userdata["sickness"] - (number * 10)
+            if new_sickness < 0:
+                new_sickness = 0
+            await self.config.user(ctx.author).sickness.set(new_sickness)
+            await self.config.user(ctx.author).chocolates.set(userdata["chocolates"] - number)
+            await self.config.user(ctx.author).eaten.set(userdata["eaten"] + number)
+
+        if candy_type in ["lollipops", "lollipop"]:
+            pluralpop = "lollipop" if number == 1 else "lollipops"
+            await ctx.send(
+                f"{random.choice(eat_phrase)} {number} {pluralpop}. You feel slightly better!\n*Sickness has gone down by {number * 20}*",
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+            new_sickness = userdata["sickness"] - (number * 20)
+            if new_sickness < 0:
+                new_sickness = 0
+            await self.config.user(ctx.author).sickness.set(new_sickness)
+            await self.config.user(ctx.author).lollipops.set(userdata["lollipops"] - number)
+            await self.config.user(ctx.author).eaten.set(userdata["eaten"] + number)
+
+        if candy_type in ["cookies", "cookie"]:
+            pluralcookie = "cookie" if number == 1 else "cookies"
+            new_sickness = random.randint(0, 100)
+            old_sickness = userdata["sickness"]
+            if new_sickness > old_sickness:
+                phrase = f"You feel worse!\n*Sickness has gone up by {new_sickness - old_sickness}*"
+            else:
+                phrase = f"You feel better!\n*Sickness has gone down by {old_sickness - new_sickness}*"
+            await ctx.reply(f"{random.choice(eat_phrase)} {number} {pluralcookie}. {phrase}")
+            await self.config.user(ctx.author).sickness.set(new_sickness)
+            await self.config.user(ctx.author).cookies.set(userdata["cookies"] - number)
+            await self.config.user(ctx.author).eaten.set(userdata["eaten"] + number)
+
+        if candy_type in ["stars", "star"]:
+            pluralstar = "star" if number == 1 else "stars"
+            await ctx.send(
+                f"{random.choice(eat_phrase)} {number} {pluralstar}. You feel great!\n*Sickness has been reset*",
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+            await self.config.user(ctx.author).sickness.set(0)
+            await self.config.user(ctx.author).stars.set(userdata["stars"] - number)
+            await self.config.user(ctx.author).eaten.set(userdata["eaten"] + number)
+
+    @commands.guild_only()
+    @checks.mod_or_permissions(administrator=True)
+    @commands.command()
+    async def totbalance(self, ctx):
+        """[Admin] Check how many candies are 'on the ground' in the guild."""
+        pick = await self.config.guild(ctx.guild).pick()
+        await ctx.send(f"The guild is currently holding: {pick} \N{CANDY}")
+
+    @commands.guild_only()
+    @commands.command()
+    async def buycandy(self, ctx, pieces: int):
+        """Buy some candy. Prices could vary at any time."""
+        candy_now = await self.config.user(ctx.author).candies()
+        credits_name = await bank.get_currency_name(ctx.guild)
+        if pieces <= 0:
+            return await ctx.send(
+                "Not in this reality.",
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+        candy_price = int(round(await bank.get_balance(ctx.author)) * 0.04) * pieces
+        if candy_price in range(0, 10):
+            candy_price = pieces * 10
+        try:
+            await bank.withdraw_credits(ctx.author, candy_price)
+        except ValueError:
+            return await ctx.send(
+                f"Not enough {credits_name} ({candy_price} required).",
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+        await self.config.user(ctx.author).candies.set(candy_now + pieces)
+        await ctx.send(
+            f"Bought {pieces} candies with {candy_price} {credits_name}.",
+            reference=ctx.message.to_reference(fail_if_not_exists=False),
+        )
+
+    @commands.guild_only()
+    @commands.command()
+    @commands.bot_has_permissions(embed_links=True, add_reactions=True)
+    async def cboard(self, ctx):
+        """Show the candy eating leaderboard."""
+        space = "\N{SPACE}"
+        userinfo = await self.config._all_from_scope(scope="USER")
+        if not userinfo:
+            return await ctx.send(
+                "No one has any candy.",
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+        async with ctx.typing():
+            sorted_acc = sorted(userinfo.items(), key=lambda x: x[1]["eaten"], reverse=True)
+        # Leaderboard logic from https://github.com/Cog-Creators/Red-DiscordBot/blob/V3/develop/redbot/cogs/economy/economy.py#L445
+        pound_len = len(str(len(sorted_acc)))
+        score_len = 10
+        header = "{pound:{pound_len}}{score:{score_len}}{name:2}\n".format(
+            pound="#",
+            pound_len=pound_len + 3,
+            score="Candies Eaten",
+            score_len=score_len + 6,
+            name="Name",
+        )
+        scoreboard_msg = self._red(header)
+        for pos, account in enumerate(sorted_acc):
+            if account[1]["eaten"] == 0:
+                continue
+            try:
+                if account[0] in [member.id for member in ctx.guild.members]:
+                    user_obj = ctx.guild.get_member(account[0])
+                else:
+                    user_obj = await self.bot.fetch_user(account[0])
+            except AttributeError:
+                user_obj = await self.bot.fetch_user(account[0])
+
+            if user_obj.discriminator != "0":
+                if len(user_obj.name) > 28:
+                    user_name = f"{user_obj.name[:19]}...#{user_obj.discriminator}"
+                else:
+                    user_name = f"{user_obj.name}#{user_obj.discriminator}"
+            else:
+                if len(user_obj.name) > 28:
+                    user_name = f"{user_obj.name[:25]}..."
+                else:
+                    user_name = user_obj.name
+
+            user_idx = pos + 1
+            if user_obj == ctx.author:
+                user_highlight = self._yellow(f"<<{user_name}>>")
+                scoreboard_msg += (
+                    f"{self._yellow(user_idx)}. {space*pound_len}"
+                    f"{humanize_number(account[1]['eaten']) + ' 🍬': <{score_len + 4}} {user_highlight}\n"
+                )
+            else:
+                scoreboard_msg += (
+                    f"{self._yellow(user_idx)}. {space*pound_len}"
+                    f"{humanize_number(account[1]['eaten']) + ' 🍬': <{score_len + 4}} {user_name}\n"
+                )
+
+        page_list = []
+        pages = 1
+        for page in pagify(scoreboard_msg, delims=["\n"], page_length=1000):
+            embed = discord.Embed(
+                colour=0xF4731C,
+                description=box(f"\N{CANDY} Global Leaderboard \N{CANDY}", lang="prolog") + (box(page, lang="ansi")),
+            )
+            embed.set_footer(
+                text=f"Page {humanize_number(pages)}/{humanize_number(math.ceil(len(scoreboard_msg) / 1000))}"
+            )
+            pages += 1
+            page_list.append(embed)
+        return await menu(ctx, page_list, DEFAULT_CONTROLS)
+
+    @commands.guild_only()
+    @commands.command()
+    @commands.bot_has_permissions(embed_links=True)
+    async def cinventory(self, ctx):
+        """Check your inventory."""
+        userdata = await self.config.user(ctx.author).all()
+        sickness = userdata["sickness"]
+        msg = f"{ctx.author.mention}'s Candy Bag:"
+        em = discord.Embed(color=await ctx.embed_color())
+        em.description = f"{userdata['candies']} \N{CANDY}"
+        if userdata["chocolates"]:
+            em.description += f"\n{userdata['chocolates']} \N{CHOCOLATE BAR}"
+        if userdata["lollipops"]:
+            em.description += f"\n{userdata['lollipops']} \N{LOLLIPOP}"
+        if userdata["cookies"]:
+            em.description += f"\n{userdata['cookies']} \N{FORTUNE COOKIE}"
+        if userdata["stars"]:
+            em.description += f"\n{userdata['stars']} \N{WHITE MEDIUM STAR}"
+        if sickness in range(41, 56):
+            em.description += f"\n\n**Sickness is over 40/100**\n*You don't feel so good...*"
+        elif sickness in range(56, 71):
+            em.description += f"\n\n**Sickness is over 55/100**\n*You don't feel so good...*"
+        elif sickness in range(71, 86):
+            em.description += f"\n\n**Sickness is over 70/100**\n*You really don't feel so good...*"
+        elif sickness in range(86, 101):
+            em.description += f"\n\n**Sickness is over 85/100**\n*The thought of more sugar makes you feel awful...*"
+        elif sickness > 100:
+            em.description += f"\n\n**Sickness is over 100/100**\n*Better wait a while for more candy...*"
+        await ctx.send(msg, embed=em)
+
+    @commands.guild_only()
+    @checks.is_owner()
+    @commands.command()
+    async def totclearall(self, ctx, are_you_sure=False):
+        """[Owner] Clear all saved game data."""
+        if not are_you_sure:
+            msg = "This will clear ALL saved data for this cog and reset it to the defaults.\n"
+            msg += f"If you are absolutely sure you want to do this, use `{ctx.prefix}totclearall yes`."
+            return await ctx.send(msg)
+        await self.config.clear_all()
+        await ctx.send("All data for this cog has been cleared.")
+
+    @commands.guild_only()
+    @checks.mod_or_permissions(administrator=True)
+    @commands.command()
+    async def totcooldown(self, ctx, cooldown_time: int = 0):
+        """Set the cooldown time for trick or treating on the server."""
+        if cooldown_time < 0:
+            return await ctx.send("Nice try.")
+        if cooldown_time == 0:
+            await self.config.guild(ctx.guild).cooldown.set(300)
+            return await ctx.send("Trick or treating cooldown time reset to 5m.")
+        elif 1 <= cooldown_time <= 30:
+            await self.config.guild(ctx.guild).cooldown.set(30)
+            return await ctx.send("Trick or treating cooldown time set to the minimum of 30s.")
+        else:
+            await self.config.guild(ctx.guild).cooldown.set(cooldown_time)
+            await ctx.send(f"Trick or treating cooldown time set to {cooldown_time}s.")
+
+    @commands.guild_only()
+    @commands.cooldown(1, 600, discord.ext.commands.BucketType.user)
+    @commands.command()
+    async def pickup(self, ctx):
+        """Pick up some candy, if there is any."""
+        candies = await self.config.user(ctx.author).candies()
+        to_pick = await self.config.guild(ctx.guild).pick()
+        chance = random.randint(1, 100)
+        found = round((chance / 100) * to_pick)
+        await self.config.user(ctx.author).candies.set(candies + found)
+        await self.config.guild(ctx.guild).pick.set(to_pick - found)
+        message = await ctx.send(
+            "You start searching the area for candy...",
+            reference=ctx.message.to_reference(fail_if_not_exists=False),
+        )
+        await asyncio.sleep(3)
+        await message.edit(content=f"You found {found} \N{CANDY}!")
+
+    @commands.guild_only()
+    @commands.cooldown(1, 600, discord.ext.commands.BucketType.user)
+    @commands.command()
+    async def stealcandy(self, ctx, user: discord.Member = None):
+        """Steal some candy."""
+        guild_users = [m.id for m in ctx.guild.members if m is not m.bot and not m == ctx.author]
+        candy_users = await self.config._all_from_scope(scope="USER")
+        valid_user = list(set(guild_users) & set(candy_users))
+        if not valid_user:
+            return await ctx.send(
+                "No one has any candy yet!",
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+        if not user:
+            picked_user = self.bot.get_user(random.choice(valid_user))
+        elif user == ctx.author or user == user.bot:
+            picked_user = self.bot.get_user(random.choice(valid_user))
+        elif user != ctx.author or user != user.bot:
+            picked_user = user
+        else:
+            picked_user = self.bot.get_user(random.choice(valid_user))
+
+        if picked_user.discriminator != "0":
+            picked_user_name = f"{picked_user.name}#{picked_user.discriminator}"
+        else:
+            picked_user_name = picked_user.name
+
+        picked_candy_now = await self.config.user(picked_user).candies()
+        if picked_candy_now == 0:
+            chance = random.randint(1, 25)
+            if chance in range(21, 25):
+                new_picked_user = self.bot.get_user(random.choice(valid_user))
+
+                if new_picked_user.discriminator != "0":
+                    new_picked_user_name = f"{new_picked_user.name}#{new_picked_user.discriminator}"
+                else:
+                    new_picked_user_name = new_picked_user.name
+
+                new_picked_candy_now = await self.config.user(new_picked_user).candies()
+                if chance in range(24, 25):
+                    if new_picked_candy_now == 0:
+                        message = await ctx.send(
+                            "You see an unsuspecting guildmate...",
+                            reference=ctx.message.to_reference(fail_if_not_exists=False),
+                        )
+                        await asyncio.sleep(random.randint(3, 6))
+                        return await message.edit(
+                            content=f"There was nothing in {picked_user}'s pockets, so you picked {new_picked_user_name}'s pockets but they had no candy either!"
+                        )
+                else:
+                    message = await ctx.send(
+                        "You see an unsuspecting guildmate...",
+                        reference=ctx.message.to_reference(fail_if_not_exists=False),
+                    )
+                    await asyncio.sleep(random.randint(3, 6))
+                    return await message.edit(
+                        content=f"There was nothing in {picked_user}'s pockets, so you looked around again... you saw {new_picked_user_name} in the distance, but you didn't think you could catch up..."
+                    )
+            if chance in range(10, 20):
+                message = await ctx.send(
+                    "You start sneaking around in the shadows...",
+                    reference=ctx.message.to_reference(fail_if_not_exists=False),
+                )
+                await asyncio.sleep(random.randint(3, 6))
+                return await message.edit(
+                    content=f"You snuck up on {picked_user} and tried picking their pockets but there was nothing there!"
+                )
+            else:
+                message = await ctx.send(
+                    "You start looking around for a target...",
+                    reference=ctx.message.to_reference(fail_if_not_exists=False),
+                )
+                await asyncio.sleep(random.randint(3, 6))
+                return await message.edit(content="You snuck around for a while but didn't find anything.")
+        user_candy_now = await self.config.user(ctx.author).candies()
+        multip = random.randint(1, 100) / 100
+        if multip > 0.7:
+            multip = 0.7
+        pieces = round(picked_candy_now * multip)
+        if pieces <= 0:
+            message = await ctx.send(
+                "You stealthily move over to an unsuspecting person...",
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+            await asyncio.sleep(4)
+            return await message.edit(content="You found someone to pickpocket, but they had nothing but pocket lint.")
+        chance = random.randint(1, 25)
+        sneak_phrases = [
+            "You look around furtively...",
+            "You glance around slowly, looking for your target...",
+            "You see someone with a full candy bag...",
+        ]
+        if chance <= 10:
+            message = await ctx.send(
+                "You creep closer to the target...",
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+            await asyncio.sleep(random.randint(3, 5))
+            return await message.edit(content="You snuck around for a while but didn't find anything.")
+        if chance > 18:
+            await self.config.user(picked_user).candies.set(picked_candy_now - pieces)
+            await self.config.user(ctx.author).candies.set(user_candy_now + pieces)
+            message = await ctx.send(
+                random.choice(sneak_phrases),
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+            await asyncio.sleep(4)
+            await message.edit(content="There seems to be an unsuspecting victim in the corner...")
+            await asyncio.sleep(4)
+            return await message.edit(content=f"You stole {pieces} \N{CANDY} from {picked_user}!")
+        if chance in range(11, 17):
+            await self.config.user(picked_user).candies.set(picked_candy_now - round(pieces / 2))
+            await self.config.user(ctx.author).candies.set(user_candy_now + round(pieces / 2))
+            message = await ctx.send(
+                random.choice(sneak_phrases),
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+            await asyncio.sleep(4)
+            await message.edit(content="There seems to be an unsuspecting victim in the corner...")
+            await asyncio.sleep(4)
+            return await message.edit(content=f"You stole {round(pieces/2)} \N{CANDY} from {picked_user}!")
+        else:
+            message = await ctx.send(
+                random.choice(sneak_phrases),
+                reference=ctx.message.to_reference(fail_if_not_exists=False),
+            )
+            await asyncio.sleep(4)
+            noise_msg = [
+                "You hear a sound behind you! When you turn back, your target is gone.",
+                "You look away for a moment and your target has vanished.",
+                "Something flashes in your peripheral vision, and as you turn to look, your target gets away...",
+            ]
+            await message.edit(content=random.choice(noise_msg))
+
+    @commands.guild_only()
+    @checks.mod_or_permissions(administrator=True)
+    @commands.group()
+    async def totchannel(self, ctx):
+        """Channel management for Trick or Treat."""
+        if ctx.invoked_subcommand is not None or isinstance(ctx.invoked_subcommand, commands.Group):
+            return
+        channel_list = await self.config.guild(ctx.guild).channel()
+        channel_msg = "Trick or Treat Channels:\n"
+        for chan in channel_list:
+            channel_obj = self.bot.get_channel(chan)
+            if channel_obj:
+                channel_msg += f"{channel_obj.name}\n"
+        await ctx.send(box(channel_msg))
+
+    @commands.guild_only()
+    @totchannel.command()
+    async def add(self, ctx, channel: discord.TextChannel):
+        """Add a text channel for Trick or Treating."""
+        channel_list = await self.config.guild(ctx.guild).channel()
+        tottoggle = await self.config.guild(ctx.guild).toggle()
+        if not tottoggle:
+            toggle_info = (
+                f"\nThe game toggle for this server is **Off**. Turn it on with the `{ctx.prefix}tottoggle` command."
+            )
+        else:
+            toggle_info = ""
+        if channel.id not in channel_list:
+            channel_list.append(channel.id)
+            await self.config.guild(ctx.guild).channel.set(channel_list)
+            await ctx.send(f"{channel.mention} added to the valid Trick or Treat channels.{toggle_info}")
+        else:
+            await ctx.send(f"{channel.mention} is already in the list of Trick or Treat channels.{toggle_info}")
+
+    @commands.guild_only()
+    @totchannel.command()
+    async def remove(self, ctx, channel: discord.TextChannel):
+        """Remove a text channel from Trick or Treating."""
+        channel_list = await self.config.guild(ctx.guild).channel()
+        if channel.id in channel_list:
+            channel_list.remove(channel.id)
+        else:
+            return await ctx.send(f"{channel.mention} not in whitelist.")
+        await self.config.guild(ctx.guild).channel.set(channel_list)
+        await ctx.send(f"{channel.mention} removed from the list of Trick or Treat channels.")
+
+    @commands.guild_only()
+    @checks.mod_or_permissions(administrator=True)
+    @commands.command()
+    async def tottoggle(self, ctx):
+        """Toggle trick or treating on the whole server."""
+        toggle = await self.config.guild(ctx.guild).toggle()
+        msg = f"Trick or Treating active: {not toggle}.\n"
+        channel_list = await self.config.guild(ctx.guild).channel()
+        if not channel_list:
+            channel_list.append(ctx.message.channel.id)
+            await self.config.guild(ctx.guild).channel.set(channel_list)
+            msg += f"Trick or Treating channel added: {ctx.message.channel.mention}"
+        await self.config.guild(ctx.guild).toggle.set(not toggle)
+        await ctx.send(msg)
+
+    @commands.guild_only()
+    @commands.command(hidden=True)
+    async def totversion(self, ctx):
+        """Trick or Treat version."""
+        await ctx.send(f"Trick or Treat version {__version__}")
+
+    async def has_perm(self, user):
+        return await self.bot.allowed_by_whitelist_blacklist(user)
+
+    @commands.Cog.listener()
+    async def on_message_without_command(self, message):
+        if isinstance(message.channel, discord.abc.PrivateChannel):
+            return
+        if message.author.bot:
+            return
+        if not await self.has_perm(message.author):
+            return
+
+        chance = random.randint(1, 12)
+        if chance % 4 == 0:
+            sickness_now = await self.config.user(message.author).sickness()
+            sick_chance = random.randint(1, 12)
+            if sick_chance % 3 == 0:
+                new_sickness = sickness_now - sick_chance
+                if new_sickness < 0:
+                    new_sickness = 0
+                await self.config.user(message.author).sickness.set(new_sickness)
+
+        pick_chance = random.randint(1, 12)
+        if pick_chance % 4 == 0:
+            random_candies = random.randint(1, 3)
+            guild_pool = await self.config.guild(message.guild).pick()
+            await self.config.guild(message.guild).pick.set(guild_pool + random_candies)
+
+        content = (message.content).lower()
+        if not content.startswith("trick or treat"):
+            return
+        toggle = await self.config.guild(message.guild).toggle()
+        if not toggle:
+            return
+        channel = await self.config.guild(message.guild).channel()
+        if message.channel.id not in channel:
+            return
+        userdata = await self.config.user(message.author).all()
+
+        last_time = datetime.datetime.strptime(str(userdata["last_tot"]), "%Y-%m-%d %H:%M:%S.%f")
+        now = datetime.datetime.now(datetime.timezone.utc)
+        now = now.replace(tzinfo=None)
+        if int((now - last_time).total_seconds()) < await self.config.guild(message.guild).cooldown():
+            messages = [
+                "The thought of candy right now doesn't really sound like a good idea.",
+                "All the lights on this street are dark...",
+                "It's starting to get late.",
+                "The wind howls through the trees. Does it seem darker all of a sudden?",
+                "You start to walk the long distance to the next house...",
+                "You take a moment to count your candy before moving on.",
+                "The house you were approaching just turned the light off.",
+                "The wind starts to pick up as you look for the next house...",
+            ]
+            return await message.channel.send(
+                random.choice(messages), reference=message.to_reference(fail_if_not_exists=False)
+            )
+        await self.config.user(message.author).last_tot.set(str(now))
+        candy = random.randint(1, 25)
+        lollipop = random.randint(0, 100)
+        star = random.randint(0, 100)
+        chocolates = random.randint(0, 100)
+        cookie = random.randint(0, 100)
+        win_message = f"{message.author.mention}\nYou received:\n{candy}\N{CANDY}"
+        await self.config.user(message.author).candies.set(userdata["candies"] + candy)
+
+        if chocolates == 100:
+            await self.config.user(message.author).chocolates.set(userdata["chocolates"] + 6)
+            win_message += "\n**BONUS**: 6 \N{CHOCOLATE BAR}"
+        elif 99 >= chocolates >= 95:
+            await self.config.user(message.author).chocolates.set(userdata["chocolates"] + 5)
+            win_message += "\n**BONUS**: 5 \N{CHOCOLATE BAR}"
+        elif 94 >= chocolates >= 90:
+            await self.config.user(message.author).chocolates.set(userdata["chocolates"] + 4)
+            win_message += "\n**BONUS**: 4 \N{CHOCOLATE BAR}"
+        elif 89 >= chocolates >= 80:
+            await self.config.user(message.author).chocolates.set(userdata["chocolates"] + 3)
+            win_message += "\n**BONUS**: 3 \N{CHOCOLATE BAR}"
+        elif 79 >= chocolates >= 75:
+            await self.config.user(message.author).chocolates.set(userdata["chocolates"] + 2)
+            win_message += "\n**BONUS**: 2 \N{CHOCOLATE BAR}"
+        elif 74 >= chocolates >= 70:
+            await self.config.user(message.author).chocolates.set(userdata["chocolates"] + 1)
+            win_message += "\n**BONUS**: 1 \N{CHOCOLATE BAR}"
+
+        if lollipop == 100:
+            await self.config.user(message.author).lollipops.set(userdata["lollipops"] + 4)
+            win_message += "\n**BONUS**: 4 \N{LOLLIPOP}"
+        elif 99 >= lollipop >= 95:
+            await self.config.user(message.author).lollipops.set(userdata["lollipops"] + 3)
+            win_message += "\n**BONUS**: 3 \N{LOLLIPOP}"
+        elif 94 >= lollipop >= 85:
+            await self.config.user(message.author).lollipops.set(userdata["lollipops"] + 2)
+            win_message += "\n**BONUS**: 2 \N{LOLLIPOP}"
+        elif 84 >= lollipop >= 75:
+            await self.config.user(message.author).lollipops.set(userdata["lollipops"] + 1)
+            win_message += "\n**BONUS**: 1 \N{LOLLIPOP}"
+
+        if cookie == 100:
+            await self.config.user(message.author).cookies.set(userdata["cookies"] + 4)
+            win_message += "\n**BONUS**: 4 \N{FORTUNE COOKIE}"
+        elif 99 >= cookie >= 97:
+            await self.config.user(message.author).cookies.set(userdata["cookies"] + 3)
+            win_message += "\n**BONUS**: 3 \N{FORTUNE COOKIE}"
+        elif 96 >= cookie >= 85:
+            await self.config.user(message.author).cookies.set(userdata["cookies"] + 2)
+            win_message += "\n**BONUS**: 2 \N{FORTUNE COOKIE}"
+        elif 84 >= cookie >= 75:
+            await self.config.user(message.author).cookies.set(userdata["cookies"] + 1)
+            win_message += "\n**BONUS**: 1 \N{FORTUNE COOKIE}"
+
+        if star == 100:
+            await self.config.user(message.author).stars.set(userdata["stars"] + 4)
+            win_message += "\n**BONUS**: 4 \N{WHITE MEDIUM STAR}"
+        elif 99 >= star >= 97:
+            await self.config.user(message.author).stars.set(userdata["stars"] + 3)
+            win_message += "\n**BONUS**: 3 \N{WHITE MEDIUM STAR}"
+        elif 96 >= star >= 85:
+            await self.config.user(message.author).stars.set(userdata["stars"] + 2)
+            win_message += "\n**BONUS**: 2 \N{WHITE MEDIUM STAR}"
+        elif 84 >= star >= 75:
+            await self.config.user(message.author).stars.set(userdata["stars"] + 1)
+            win_message += "\n**BONUS**: 1 \N{WHITE MEDIUM STAR}"
+
+        walking_messages = [
+            "*You hear footsteps...*",
+            "*You're left alone with your thoughts as you wait for the door to open...*",
+            "*The wind howls through the trees...*",
+            "*Does it feel colder out here all of a sudden?*",
+            "*Somewhere inside the house, you hear wood creaking...*",
+            "*You walk up the path to the door and knock...*",
+            "*You knock on the door...*",
+            "*There's a movement in the shadows by the side of the house...*",
+        ]
+        bot_talking = await message.channel.send(
+            random.choice(walking_messages), reference=message.to_reference(fail_if_not_exists=False)
+        )
+        await asyncio.sleep(random.randint(5, 8))
+        door_messages = [
+            "*The door slowly opens...*",
+            "*The ancient wooden door starts to open...*",
+            "*A light turns on overhead...*",
+            "*You hear a scuffling noise...*",
+            "*There's someone talking inside...*",
+            "*The wind whips around your feet...*",
+            "*A crow caws ominously...*",
+            "*You hear an owl hooting in the distance...*",
+        ]
+        await bot_talking.edit(content=random.choice(door_messages))
+        await asyncio.sleep(random.randint(5, 8))
+        greet_messages = [
+            "Oh, hello. What a cute costume. Here, have some candy.",
+            "Look at that costume. Here you go.",
+            "Out this late at night?",
+            "Here's a little something for you.",
+            "The peppermint ones are my favorite.",
+            "Come back again later if you see the light on still.",
+            "Go ahead, take a few.",
+            "Here you go.",
+            "Aww, look at you. Here, take this.",
+            "Don't eat all those at once!",
+            "Well, I think this is the last of it. Go ahead and take it.",
+            "*I hear the next door neighbors have some pretty good candy too, this year.*",
+        ]
+        await bot_talking.edit(content=random.choice(greet_messages))
+        await asyncio.sleep(2)
+        await message.channel.send(win_message)
+
+    @staticmethod
+    def _red(to_transform: str):
+        red_ansi_prefix = "\u001b[0;31m"
+        reset_ansi_prefix = "\u001b[0;0m"
+        new_string = f"{red_ansi_prefix}{to_transform}{reset_ansi_prefix}"
+        return new_string
+
+    @staticmethod
+    def _yellow(to_transform: str):
+        yellow_ansi_prefix = "\u001b[0;33m"
+        reset_ansi_prefix = "\u001b[0;0m"
+        new_string = f"{yellow_ansi_prefix}{to_transform}{reset_ansi_prefix}"
+        return new_string

ttt/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ttt/__init__.py

@@ -0,0 +1,6 @@
+from .ttt import TTT
+
+__red_end_user_data_statement__ = "This cog does store temporarily (in memory) data about users, which is cleared after the game is done."
+
+async def setup(bot):
+    await bot.add_cog(TTT(bot))

ttt/info.json

@@ -0,0 +1,11 @@
+{
+    "author": ["aikaterna", "HizkiFW"],
+    "description": "Tic Tac Toe",
+    "end_user_data_statement": "This cog does store temporarily (in memory) data about users, which is cleared after the game is done.",
+    "install_msg": "Thanks for installing.",
+    "min_bot_version": "3.5.0",
+    "permissions": ["add_reactions"],
+    "short": "Tic Tac Toe",
+    "tags": ["game", "games", "tic tac toe", "ttt"],
+    "type": "COG"
+}

ttt/ttt.py

@@ -0,0 +1,256 @@
+# Ported from https://github.com/hizkifw/discord-tictactoe
+# This cog is licensed under Apache-2.0, which is bundled with the cog file under LICENSE.
+
+import discord
+import logging
+from redbot.core import commands
+
+
+log = logging.getLogger("red.aikaterna.ttt")
+
+
+class TTT(commands.Cog):
+    """
+    Tic Tac Toe
+    """
+
+    def __init__(self, bot):
+        self.bot = bot
+        self.ttt_games = {}
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """Nothing to delete"""
+        return
+
+    @commands.guild_only()
+    @commands.bot_has_permissions(add_reactions=True)
+    @commands.max_concurrency(1, commands.BucketType.user)
+    @commands.command()
+    async def ttt(self, ctx, move=""):
+        """ Tic Tac Toe """
+        await self.ttt_new(ctx.author, ctx.channel)
+
+    async def ttt_new(self, user, channel):
+        self.ttt_games[user.id] = [" "] * 9
+        response = self._make_board(user)
+        response += "Your move:"
+        msg = await channel.send(response)
+        await self._make_buttons(msg)
+
+    async def ttt_move(self, user, message, move):
+        log.debug(f"ttt_move:{user.id}")
+        # Check user currently playing
+        if user.id not in self.ttt_games:
+            log.debug("New ttt game")
+            return await self.ttt_new(user, message.channel)
+
+        # Check spot is empty
+        if self.ttt_games[user.id][move] == " ":
+            self.ttt_games[user.id][move] = "x"
+            log.debug(f"Moved to {move}")
+        else:
+            log.debug(f"Invalid move: {move}")
+            return None
+
+        # Check winner
+        check = self._do_checks(self.ttt_games[user.id])
+        if check is not None:
+            msg = "It's a draw!" if check == "draw" else f"{check[-1]} wins!"
+            log.debug(msg)
+            await message.edit(content=f"{self._make_board(user)}{msg}")
+            return None
+        log.debug("Check passed")
+
+        # AI move
+        mv = self._ai_think(self._matrix(self.ttt_games[user.id]))
+        self.ttt_games[user.id][self._coords_to_index(mv)] = "o"
+        log.debug("AI moved")
+
+        # Update board
+        await message.edit(content=self._make_board(user))
+        log.debug("Board updated")
+
+        # Check winner again
+        check = self._do_checks(self.ttt_games[user.id])
+        if check is not None:
+            msg = "It's a draw!" if check == "draw" else f"{check[-1]} wins!"
+            log.debug(msg)
+            await message.edit(content=f"{self._make_board(user)}{msg}")
+        log.debug("Check passed")
+
+    def _make_board(self, author):
+        return f"{author.mention}\n{self._table(self.ttt_games[author.id])}\n"
+
+    async def _make_buttons(self, msg):
+        await msg.add_reaction("\u2196")  # 0 tl
+        await msg.add_reaction("\u2B06")  # 1 t
+        await msg.add_reaction("\u2197")  # 2 tr
+        await msg.add_reaction("\u2B05")  # 3 l
+        await msg.add_reaction("\u23FA")  # 4 mid
+        await msg.add_reaction("\u27A1")  # 5 r
+        await msg.add_reaction("\u2199")  # 6 bl
+        await msg.add_reaction("\u2B07")  # 7 b
+        await msg.add_reaction("\u2198")  # 8 br
+
+    @commands.Cog.listener()
+    async def on_reaction_add(self, reaction, user):
+        if reaction.message.guild is None:
+            return
+        if reaction.message.author != self.bot.user:
+            return
+        game_session = self.ttt_games.get(user.id, None)
+        if game_session is None:
+            return
+        move = self._decode_move(str(reaction.emoji))
+        if move is None:
+            return
+        await self.ttt_move(user, reaction.message, move)
+
+    @staticmethod
+    def _decode_move(emoji):
+        dict = {
+            "\u2196": 0,
+            "\u2B06": 1,
+            "\u2197": 2,
+            "\u2B05": 3,
+            "\u23FA": 4,
+            "\u27A1": 5,
+            "\u2199": 6,
+            "\u2B07": 7,
+            "\u2198": 8,
+        }
+        return dict[emoji] if emoji in dict else None
+
+    @staticmethod
+    def _table(xo):
+        return (
+            (("%s%s%s\n" * 3) % tuple(xo))
+            .replace("o", ":o2:")
+            .replace("x", ":regional_indicator_x:")
+            .replace(" ", ":white_large_square:")
+        )
+
+    @staticmethod
+    def _matrix(b):
+        return [[b[0], b[1], b[2]], [b[3], b[4], b[5]], [b[6], b[7], b[8]]]
+
+    @staticmethod
+    def _coords_to_index(coords):
+        map = {(0, 0): 0, (0, 1): 1, (0, 2): 2, (1, 0): 3, (1, 1): 4, (1, 2): 5, (2, 0): 6, (2, 1): 7, (2, 2): 8}
+        return map[coords]
+
+    def _do_checks(self, b):
+        m = self._matrix(b)
+        if self._check_win(m, "x"):
+            return "win X"
+        if self._check_win(m, "o"):
+            return "win O"
+        if self._check_draw(b):
+            return "draw"
+        return None
+
+    # The following comes from an old project
+    # https://gist.github.com/HizkiFW/0aadefb73e71794fb4a2802708db5bcf
+    @staticmethod
+    def _find_streaks(m, xo):
+        row = [0, 0, 0]
+        col = [0, 0, 0]
+        dia = [0, 0]
+
+        # Check rows and columns for X streaks
+        for y in range(3):
+            for x in range(3):
+                if m[y][x] == xo:
+                    row[y] += 1
+                    col[x] += 1
+
+        # Check diagonals
+        if m[0][0] == xo:
+            dia[0] += 1
+        if m[1][1] == xo:
+            dia[0] += 1
+            dia[1] += 1
+        if m[2][2] == xo:
+            dia[0] += 1
+        if m[2][0] == xo:
+            dia[1] += 1
+        if m[0][2] == xo:
+            dia[1] += 1
+
+        return (row, col, dia)
+
+    @staticmethod
+    def _find_empty(matrix, rcd, n):
+        # Rows
+        if rcd == "r":
+            for x in range(3):
+                if matrix[n][x] == " ":
+                    return x
+        # Columns
+        if rcd == "c":
+            for x in range(3):
+                if matrix[x][n] == " ":
+                    return x
+        # Diagonals
+        if rcd == "d":
+            if n == 0:
+                for x in range(3):
+                    if matrix[x][x] == " ":
+                        return x
+            else:
+                for x in range(3):
+                    if matrix[x][2 - x] == " ":
+                        return x
+
+        return False
+
+    def _check_win(self, m, xo):
+        row, col, dia = self._find_streaks(m, xo)
+        dia.append(0)
+
+        for i in range(3):
+            if row[i] == 3 or col[i] == 3 or dia[i] == 3:
+                return True
+
+        return False
+
+    @staticmethod
+    def _check_draw(board):
+        return not " " in board
+
+    def _ai_think(self, m):
+        rx, cx, dx = self._find_streaks(m, "x")
+        ro, co, do = self._find_streaks(m, "o")
+
+        mv = self._ai_move(2, m, ro, co, do)
+        if mv is not False:
+            return mv
+        mv = self._ai_move(2, m, rx, cx, dx)
+        if mv is not False:
+            return mv
+        mv = self._ai_move(1, m, ro, co, do)
+        if mv is not False:
+            return mv
+        return self._ai_move(1, m, rx, cx, dx)
+
+    def _ai_move(self, n, m, row, col, dia):
+        for r in range(3):
+            if row[r] == n:
+                x = self._find_empty(m, "r", r)
+                if x is not False:
+                    return (r, x)
+            if col[r] == n:
+                y = self._find_empty(m, "c", r)
+                if y is not False:
+                    return (y, r)
+
+        if dia[0] == n:
+            y = self._find_empty(m, "d", 0)
+            if y is not False:
+                return (y, y)
+        if dia[1] == n:
+            y = self._find_empty(m, "d", 1)
+            if y is not False:
+                return (y, 2 - y)
+
+        return False

urlfetch/__init__.py

@@ -0,0 +1,7 @@
+from .urlfetch import UrlFetch
+
+__red_end_user_data_statement__ = "This cog does not persistently store data or metadata about users."
+
+
+async def setup(bot):
+    await bot.add_cog(UrlFetch(bot))

urlfetch/info.json

@@ -0,0 +1,9 @@
+{
+    "author": ["aikaterna"],
+    "end_user_data_statement": "This cog does not persistently store data or metadata about users.",
+    "install_msg": "Thanks for installing.",
+    "min_bot_version": "3.5.0",
+    "short": "Fetch text from a URL.",
+    "description": "Fetch text from a URL.",
+    "tags": ["api"]
+}

urlfetch/urlfetch.py

@@ -0,0 +1,82 @@
+import asyncio
+import aiohttp
+import logging
+from urllib.parse import urlparse
+
+from redbot.core import checks, commands
+from redbot.core.utils.chat_formatting import box, pagify
+from redbot.core.utils.menus import menu, DEFAULT_CONTROLS
+
+log = logging.getLogger("red.aikaterna.urlfetch")
+
+
+__version__ = "1.1.0"
+
+
+class UrlFetch(commands.Cog):
+    """Grab stuff from a text API."""
+
+    def __init__(self, bot):
+        self.bot = bot
+
+        self._headers = {'User-Agent': 'Python/3.8'}
+
+    async def red_delete_data_for_user(self, **kwargs):
+        """Nothing to delete"""
+        return
+
+    @commands.command()
+    async def urlfetch(self, ctx, url: str):
+        """
+        Input a URL to read.
+        """
+        async with ctx.typing():
+            valid_url = await self._valid_url(ctx, url)
+            if valid_url:
+                text = await self._get_url_content(url)
+                if text:
+                    page_list = []
+                    for page in pagify(text, delims=["\n"], page_length=1800):
+                        page_list.append(box(page))
+                    if len(page_list) == 1:
+                        await ctx.send(box(page))
+                    else:
+                        await menu(ctx, page_list, DEFAULT_CONTROLS)
+            else:
+                return
+
+    async def _get_url_content(self, url: str):
+        try:
+            timeout = aiohttp.ClientTimeout(total=20)
+            async with aiohttp.ClientSession(headers=self._headers, timeout=timeout) as session:
+                async with session.get(url) as resp:
+                    text = await resp.text()
+            return text
+        except aiohttp.client_exceptions.ClientConnectorError:
+            log.error(f"aiohttp failure accessing site at url:\n\t{url}", exc_info=True)
+            return None
+        except asyncio.exceptions.TimeoutError:
+            log.error(f"asyncio timeout while accessing feed at url:\n\t{url}")
+            return None
+        except Exception:
+            log.error(f"General failure accessing site at url:\n\t{url}", exc_info=True)
+            return None
+
+    async def _valid_url(self, ctx, url: str):
+        try:
+            result = urlparse(url)
+        except Exception as e:
+            log.exception(e, exc_info=e)
+            await ctx.send("There was an issue trying to fetch that site. Please check your console for the error.")
+            return None
+
+        if all([result.scheme, result.netloc]):
+            text = await self._get_url_content(url)
+            if not text:
+                await ctx.send("No text present at the given url.")
+                return None
+            else:
+                return text
+        else:
+            await ctx.send(f"That url seems to be incomplete.")
+            return None