Ability to change the main Modmail color

Author: Taaku18

bot.py

@@ -240,6 +240,19 @@ def recipient_color(self):
         else:
             return color
 
+    @property
+    def main_color(self):
+        color = self.config.get('main_color')
+        if not color:
+            return discord.Color.blurple()
+        try:
+            color = int(color.lstrip('#'), base=16)
+        except ValueError:
+            print('Invalid main_color provided')
+            return discord.Color.blurple()
+        else:
+            return color
+
     async def on_connect(self):
         print(LINE)
         print(Fore.CYAN, end='')

cogs/modmail.py

@@ -48,7 +48,7 @@ async def setup(self, ctx):
                         '<channel-id>` command to set up a custom log channel'
                         ', then you can delete the default '
                         f'{log_channel.mention} channel.',
-            color=discord.Color.blurple()
+            color=self.bot.main_color
         )
 
         embed.set_footer(text=f'Type "{self.bot.prefix}help" '
@@ -71,7 +71,7 @@ async def snippets(self, ctx):
         embeds = []
 
         if self.bot.snippets:
-            embed = discord.Embed(color=discord.Color.blurple(),
+            embed = discord.Embed(color=self.bot.main_color,
                                   description='Here is a list of snippets '
                                               'that are currently configured.')
         else:
@@ -88,7 +88,7 @@ async def snippets(self, ctx):
 
         for name, value in self.bot.snippets.items():
             if len(embed.fields) == 5:
-                embed = discord.Embed(color=discord.Color.blurple(),
+                embed = discord.Embed(color=self.bot.main_color,
                                       description=embed.description)
                 embed.set_author(name='Snippets', icon_url=ctx.guild.icon_url)
                 embeds.append(embed)
@@ -108,7 +108,7 @@ async def add_(self, ctx, name: str.lower, *, value):
 
         embed = discord.Embed(
             title='Added snippet',
-            color=discord.Color.blurple(),
+            color=self.bot.main_color,
             description=f'`{name}` points to: {value}'
         )
 
@@ -121,7 +121,7 @@ async def del_(self, ctx, *, name: str.lower):
         if self.bot.config.snippets.get(name):
             embed = discord.Embed(
                 title='Removed snippet',
-                color=discord.Color.blurple(),
+                color=self.bot.main_color,
                 description=f'`{name}` no longer exists.'
             )
             del self.bot.config['snippets'][name]
@@ -261,7 +261,7 @@ async def notify(self, ctx, *, role=None):
         else:
             mentions.append(mention)
             await self.bot.config.update()
-            embed = discord.Embed(color=discord.Color.blurple(),
+            embed = discord.Embed(color=self.bot.main_color,
                                   description=f'{mention} will be mentioned '
                                   'on the next message received.')
         return await ctx.send(embed=embed)
@@ -299,7 +299,7 @@ async def subscribe(self, ctx, *, role=None):
             mentions.append(mention)
             await self.bot.config.update()
             embed = discord.Embed(
-                color=discord.Color.blurple(),
+                color=self.bot.main_color,
                 description=f'{mention} will now be '
                 'notified of all messages received.'
             )
@@ -332,7 +332,7 @@ async def unsubscribe(self, ctx, *, role=None):
         else:
             mentions.remove(mention)
             await self.bot.config.update()
-            embed = discord.Embed(color=discord.Color.blurple(),
+            embed = discord.Embed(color=self.bot.main_color,
                                   description=f'{mention} is now unsubscribed '
                                   'to this thread.')
         return await ctx.send(embed=embed)
@@ -351,7 +351,7 @@ async def loglink(self, ctx):
         log_link = await self.bot.api.get_log_link(ctx.channel.id)
         await ctx.send(
             embed=discord.Embed(
-                color=discord.Color.blurple(),
+                color=self.bot.main_color,
                 description=log_link
             )
         )
@@ -376,7 +376,7 @@ def format_log_embeds(self, logs, avatar_url):
             username = entry['recipient']['name'] + '#'
             username += entry['recipient']['discriminator']
 
-            embed = discord.Embed(color=discord.Color.blurple(),
+            embed = discord.Embed(color=self.bot.main_color,
                                   timestamp=created_at)
             embed.set_author(name=f'{title} - {username}',
                              icon_url=avatar_url,
@@ -616,7 +616,7 @@ async def contact(self, ctx,
                 title='Created thread',
                 description=f'Thread started in {thread.channel.mention} '
                 f'for {user.mention}',
-                color=discord.Color.blurple()
+                color=self.bot.main_color
             )
 
         return await ctx.send(embed=embed)
@@ -627,7 +627,7 @@ async def contact(self, ctx,
     async def blocked(self, ctx):
         """Returns a list of blocked users"""
         embed = discord.Embed(title='Blocked Users',
-                              color=discord.Color.blurple(),
+                              color=self.bot.main_color,
                               description='Here is a list of blocked users.')
 
         users = []
@@ -675,7 +675,7 @@ async def block(self, ctx, user: User = None, *, reason=None):
             extend = f'for `{reason}`' if reason else ''
             embed = discord.Embed(
                 title='Success',
-                color=discord.Color.blurple(),
+                color=self.bot.main_color,
                 description=f'{mention} is now blocked ' + extend
             )
         else:
@@ -707,7 +707,7 @@ async def unblock(self, ctx, *, user: User = None):
             await self.bot.config.update()
             embed = discord.Embed(
                 title='Success',
-                color=discord.Color.blurple(),
+                color=self.bot.main_color,
                 description=f'{mention} is no longer blocked'
             )
         else:

cogs/utility.py

@@ -46,7 +46,7 @@ def format_cog_help(self, ctx, cog):
         for fmt in fmts:
             embed = Embed(
                 description='*' + inspect.getdoc(cog) + '*',
-                color=Color.blurple()
+                color=self.bot.main_color
             )
 
             embed.add_field(name='Commands', value=fmt)
@@ -62,7 +62,7 @@ def format_command_help(self, cmd):
         """Formats command help."""
         prefix = self.bot.prefix
         embed = Embed(
-            color=Color.blurple(),
+            color=self.bot.main_color,
             description=cmd.help
         )
 
@@ -143,7 +143,7 @@ async def changelog(self, ctx):
     @trigger_typing
     async def about(self, ctx):
         """Shows information about the bot."""
-        embed = Embed(color=Color.blurple(),
+        embed = Embed(color=self.bot.main_color,
                       timestamp=datetime.utcnow())
         embed.set_author(name='Modmail - About',
                          icon_url=self.bot.user.avatar_url)
@@ -204,7 +204,7 @@ async def github(self, ctx):
         embed = Embed(
             title='GitHub',
             description='Current User',
-            color=Color.blurple()
+            color=self.bot.main_color
         )
         user = data['user']
         embed.set_author(name=user['username'],
@@ -227,7 +227,7 @@ async def update(self, ctx):
         embed = Embed(
             title='Already up to date',
             description=desc,
-            color=Color.blurple()
+            color=self.bot.main_color
         )
 
         if metadata['latest_version'] == self.bot.version:
@@ -294,7 +294,7 @@ async def activity(self, ctx, activity_type: str, *, message: str = ''):
             await self.bot.config.update()
             embed = Embed(
                 title='Activity Removed',
-                color=Color.blurple()
+                color=self.bot.main_color
             )
             return await ctx.send(embed=embed)
 
@@ -334,7 +334,7 @@ async def activity(self, ctx, activity_type: str, *, message: str = ''):
         embed = Embed(
             title='Activity Changed',
             description=desc,
-            color=Color.blurple()
+            color=self.bot.main_color
         )
         return await ctx.send(embed=embed)
 
@@ -346,7 +346,7 @@ async def ping(self, ctx):
         embed = Embed(
             title='Pong! Websocket Latency:',
             description=f'{self.bot.ws.latency * 1000:.4f} ms',
-            color=Color.blurple()
+            color=self.bot.main_color
         )
         return await ctx.send(embed=embed)
 
@@ -359,15 +359,15 @@ async def mention(self, ctx, *, mention=None):
         if mention is None:
             embed = Embed(
                 title='Current text',
-                color=Color.blurple(),
+                color=self.bot.main_color,
                 description=f'{current}'
             )
 
         else:
             embed = Embed(
                 title='Changed mention!',
                 description=f'On thread creation the bot now says {mention}',
-                color=Color.blurple()
+                color=self.bot.main_color
             )
             self.bot.config['mention'] = mention
             await self.bot.config.update()
@@ -382,7 +382,7 @@ async def prefix(self, ctx, *, prefix=None):
         current = self.bot.prefix
         embed = Embed(
             title='Current prefix',
-            color=Color.blurple(),
+            color=self.bot.main_color,
             description=f'{current}'
         )
 
@@ -411,7 +411,7 @@ async def options(self, ctx):
         valid = ', '.join(f'`{k}`' for k in allowed)
         embed = Embed(title='Valid Keys',
                       description=valid,
-                      color=Color.blurple())
+                      color=self.bot.main_color)
         return await ctx.send(embed=embed)
 
     @config.command()
@@ -430,7 +430,7 @@ async def set(self, ctx, key: str.lower, *, value):
             else:
                 embed = Embed(
                     title='Success',
-                    color=Color.blurple(),
+                    color=self.bot.main_color,
                     description=f'Set `{key}` to `{value_text}`'
                 )
                 await self.bot.config.update({key: value})
@@ -452,7 +452,7 @@ async def del_config(self, ctx, key: str.lower):
         if key in keys:
             embed = Embed(
                 title='Success',
-                color=Color.blurple(),
+                color=self.bot.main_color,
                 description=f'`{key}` had been deleted from the config.'
             )
             try:
@@ -481,7 +481,7 @@ async def get(self, ctx, key=None):
             if key in keys:
                 desc = f'`{key}` is set to `{self.bot.config.get(key)}`'
                 embed = Embed(
-                    color=Color.blurple(),
+                    color=self.bot.main_color,
                     description=desc
                 )
                 embed.set_author(name='Config variable',
@@ -498,7 +498,7 @@ async def get(self, ctx, key=None):
 
         else:
             embed = Embed(
-                color=Color.blurple(),
+                color=self.bot.main_color,
                 description='Here is a list of currently '
                             'set configuration variables.'
             )
@@ -527,12 +527,12 @@ async def alias(self, ctx):
 
         if self.bot.aliases:
             embed = Embed(
-                color=Color.blurple(),
+                color=self.bot.main_color,
                 description=desc
             )
         else:
             embed = Embed(
-                color=Color.blurple(),
+                color=self.bot.main_color,
                 description='You dont have any aliases at the moment.'
             )
         embed.set_author(name='Command aliases', icon_url=ctx.guild.icon_url)
@@ -542,7 +542,7 @@ async def alias(self, ctx):
 
         for name, value in self.bot.aliases.items():
             if len(embed.fields) == 5:
-                embed = Embed(color=Color.blurple(), description=desc)
+                embed = Embed(color=self.bot.main_color, description=desc)
                 embed.set_author(name='Command aliases',
                                  icon_url=ctx.guild.icon_url)
                 embed.set_footer(text=f'Do {self.bot.prefix}help '
@@ -583,7 +583,7 @@ async def add_(self, ctx, name: str.lower, *, value):
 
         embed = Embed(
             title='Added alias',
-            color=Color.blurple(),
+            color=self.bot.main_color,
             description=f'`{name}` points to: {value}'
         )
 
@@ -602,7 +602,7 @@ async def del_alias(self, ctx, *, name: str.lower):
 
             embed = Embed(
                 title='Removed alias',
-                color=Color.blurple(),
+                color=self.bot.main_color,
                 description=f'`{name}` no longer exists.'
             )
 

core/config.py

@@ -13,12 +13,13 @@ class ConfigManager(ConfigManagerABC):
         'twitch_url',
         # bot settings
         'main_category_id', 'disable_autoupdates', 'prefix', 'mention',
+        'main_color',
         # logging
         'log_channel_id',
         # threads
         'sent_emoji', 'blocked_emoji', 'thread_creation_response',
         # moderation
-        'recipient_color', 'mod_tag', 'mod_color',
+        'recipient_color', 'mod_tag', 'mod_color'
         # anonymous message
         'anon_username', 'anon_avatar_url', 'anon_tag'
     }
@@ -48,7 +49,7 @@ class ConfigManager(ConfigManagerABC):
     }
 
     colors = {
-        'mod_color', 'recipient_color'
+        'mod_color', 'recipient_color', 'main_color'
     }
 
     valid_keys = allowed_to_change_in_command | internal_keys | protected_keys

core/models.py

@@ -129,6 +129,11 @@ def mod_color(self) -> typing.Union[Color, int]:
     def recipient_color(self) -> typing.Union[Color, int]:
         raise NotImplementedError
 
+    @property
+    @abc.abstractmethod
+    def main_color(self) -> typing.Union[Color, int]:
+        raise NotImplementedError
+
     @abc.abstractmethod
     async def process_modmail(self, message: Message) -> None:
         raise NotImplementedError