Quality of life improvments

.gitignore

@@ -10,4 +10,4 @@ db.json
 # Ignore the assets
 assets/
 
-token.txt
+config.yaml

config.yaml

@@ -0,0 +1,2 @@
+token: ""
+prefix: "!"

main.py

@@ -1,71 +1,100 @@
+import random
+import os
 import sys
 sys.path.insert(0, './ace-attorney-bot')
 import anim
+import yaml
 import discord
-import re
+from discord.ext import commands
 from message import Message
 from collections import Counter
 from comment_bridge import Comment
-import os
 
+if not os.path.isfile("config.yaml"):
+    sys.exit("'config.yaml' is missing!")
+else:
+    with open("config.yaml") as file:
+        configuration = yaml.load(file, Loader=yaml.FullLoader)
+        token = configuration["token"].strip()
+        prefix = configuration["prefix"].strip()
 
-with open('token.txt', 'r') as tokenFile:
-    token = tokenFile.read().replace('\r', '').replace('\n', '')
+if not token:
+    sys.exit("The 'token' is missing in the 'config.yaml' file!")
+if not prefix:
+    sys.exit("The 'prefix' is missing in the 'config.yaml' file!")
 
+client = commands.Bot(command_prefix=prefix, intents=discord.Intents.default())
 
-
-client = discord.Client()
+# Removing default help command
+client.remove_command("help")
 
 @client.event
 async def on_ready():
-    game = discord.Game("use: !render <number of messages> | !render 2")
-    await client.change_presence(activity=game)
+    print("Bot is ready!")
+    print(f"Logged in as {client.user.name}#{client.user.discriminator} ({client.user.id})")
+    activity = discord.Game(f"{prefix}help")
+    await client.change_presence(activity=activity)
 
 @client.event
-async def on_message(mention: discord.Message):
-    if mention.author == client.user:
+async def on_message(message):
+    # Ignore message if the author is a bot (or the client's logged user)
+    if message.author is client.user or message.author.bot:
+        return
+    if message.channel.type is discord.ChannelType.private:
+        embedResponse = discord.Embed(description="I won't process any messages via PM.\nIf you have any problem please go to [the support server](https://discord.gg/pcS4MPbRDU).", color=0xff0000)
+        await message.channel.send(embed=embedResponse)
         return
 
-    if mention.guild == None:
-        await mention.channel.send(content='I can\'t process any messages via PM. If you have any problem please go to the support server. https://discord.gg/pcS4MPbRDU')
-        return
+    await client.process_commands(message)
 
-    match = re.match(r'!render (\d+)', mention.content)
-    if match:
-        async with mention.channel.typing():
-            number = int(match.group(1))
-            if (number < 2 or number > 150):
-                await mention.channel.send(content='Number of messages must be between 2 and 150')
-                return
-            messages = []
-            async for message in mention.channel.history(limit=number, oldest_first=False, before=mention.reference.resolved if mention.reference else mention):
-                msg = Message(message)
-                if msg.text.strip():
-                    messages.insert(0, msg)
+@client.command()
+async def help(context):
+    dummyAmount = random.randint(2, 150)
+    embedHelp = discord.Embed(description="Discord bot that turns message chains into ace attorney scenes.", color=0x3366CC, footer="Do not include these symbols (\"<\" and \">\") when using this command")
+    embedHelp.set_author(name=client.user.name, icon_url=client.user.avatar_url)
+    embedHelp.add_field(name="How to use?", value=f"`{prefix}render <number_of_messages>`", inline=False)
+    embedHelp.add_field(name="Example", value=f"Turn the last {dummyAmount} messages into an ace attorney scene: `{prefix}render {dummyAmount}`", inline=False)
+    embedHelp.add_field(name="Starting message", value="By default the bot will load the specified number of messages from the last message (before using the command) going backwards, if you want the message count to start from another message, reply to it when using the command.", inline=False)
+    await context.send(embed=embedHelp)
+
+@client.command()
+async def render(context, numberOfMessages):
+    if numberOfMessages.isdigit() and int(numberOfMessages) in range (2, 151):
+
+        messages = []
+        async for message in context.channel.history(limit=int(numberOfMessages), oldest_first=False, before=context.message.reference.resolved if context.message.reference else context.message):
+            msg = Message(message)
+            if msg.text.strip():
+                messages.insert(0, msg)
      
-            thread = []
-            users_to_names = {}
-            counter = Counter()
-            for message in messages:
-                thread.append(Comment(message))
-                users_to_names[message.user.id] = message.user.name
-                counter.update({message.user.id: 1})
-            if (len(users_to_names) >= 2): 
-                most_common = [users_to_names[t[0]] for t in counter.most_common()]
-                characters = anim.get_characters(most_common)
-                output_filename = str(mention.id) + '.mp4'
-                anim.comments_to_scene(thread, characters, output_filename=output_filename)
+        thread = []
+        users_to_names = {}
+        counter = Counter()
+        for message in messages:
+            thread.append(Comment(message))
+            users_to_names[message.user.id] = message.user.name
+            counter.update({message.user.id: 1})
+        if (len(users_to_names) >= 2): 
+            most_common = [users_to_names[t[0]] for t in counter.most_common()]
+            characters = anim.get_characters(most_common)
+            output_filename = str(context.message.id) + '.mp4'
+            anim.comments_to_scene(thread, characters, output_filename=output_filename)
+            try:
+                await context.send(file=discord.File(output_filename))
+            except Exception as e:
                 try:
-                    await mention.channel.send(file=discord.File(output_filename))
-                except Exception as e:
-                    try:
-                        await mention.channel.send("Error: {e}".format(e=e))
-                    except Exception:
-                        pass
-                clean(thread, output_filename)
-            else:
-                await mention.channel.send(content='There should be at least two people in the conversation')
-
+                    embedResponse = discord.Embed(description=f"Error: {e}", color=0xff0000)
+                    await context.send(embed=embedResponse, mention_author=False)
+                except Exception:
+                    pass
+            clean(thread, output_filename)
+        else:
+            embedResponse = discord.Embed(description="There should be at least two people in the conversation", color=0xff0000)
+            await context.send(embed=embedResponse, mention_author=False)
+    else:
+        embedResponse = discord.Embed(description="Number of messages must be between 2 and 150", color=0xff0000)
+        await context.reply(embed=embedResponse, mention_author=False)
+        return
 
 def clean(thread, output_filename):
     try:
@@ -79,4 +108,4 @@ def clean(thread, output_filename):
     except Exception as second_e:
         print(second_e)
 
-client.run(token)
+client.run(configuration["token"])

requirements.txt

@@ -1,2 +1,3 @@
 discord.py
 emoji
+pyyaml