Template v2.8

* Blacklisted users are now **saved** in the file
* Moved config file to JSON
* Moved the blacklist in a separate file (`blacklist.json`)
* The colors are no longer saved in the config file

Author: kkrypt0nn

README.md

@@ -17,16 +17,15 @@ I would've been happy if there were any template existing. However, there wasn't
 decided to create my own template to let <b>you</b> guys create your discord bot easily.
 
 Please note that this template is not supposed to be the best template, but a good template to start learning how
-discord.py works and to make your own bot in a simple way.
+discord.py works and to make your own bot easily.
 
-If you plan to use this template to make your own template or bot, you **have to** give me credits somewhere and keep
-the copyright notice on the files.
-See [the license file](https://github.com/kkrypt0nn/Python-Discord-Bot-Template/blob/master/LICENSE.md) for more
-information.
+If you plan to use this template to make your own template or bot, you **have to**:
 
-## Authors
+- Keep the credits, and a link to this repository in all the files that contains my code
+- Keep the same license
 
-* **[Krypton (@kkrypt0nn)](https://github.com/kkrypt0nn)**
+See [the license file](https://github.com/kkrypt0nn/Python-Discord-Bot-Template/blob/master/LICENSE.md) for more
+information, I reserve the right to take down any repository that does not meet these requirements.
 
 ## Support
 
@@ -40,8 +39,8 @@ All the updates of the template are available [here](UPDATES.md).
 
 ## Disclaimer
 
-**Nothing** is being saved during runtime in the configuration file, please take a look at the [TODO file](TODO.md) to
-know if this has been implemented.
+When using the template you confirm that you have read the [license](LICENSE.md) and comprehend that I can take down
+your repository if you do not meet these requirements.
 
 Please do not open issues or pull requests about things that are written in the [TODO file](TODO.md), they are **
 already** under work for the version 3.0 of the template.
@@ -64,18 +63,19 @@ Alternatively you can do the following:
 
 ## How to set up
 
-To set up the bot I made it as simple as possible. I now created a [config.yaml](config.yaml) file where you can put the
+To set up the bot I made it as simple as possible. I now created a [config.json](config.json) file where you can put the
 needed things to edit.
 
 Here is an explanation of what everything is:
 
-| Variable              | What it is                                                            |
-| ----------------------| ----------------------------------------------------------------------|
-| YOUR_BOT_PREFIX_HERE  | The prefix(es) of your bot                                            |
-| YOUR_BOT_TOKEN_HERE   | The token of your bot                                                 |
-| APPLICATION_ID        | The application ID of your bot                                        |
-| OWNERS                | The user ID of all the bot owners                                     |
-| BLACKLIST             | The user ID of all the users who can't use the bot                    |
+| Variable                  | What it is                                                            |
+| ------------------------- | ----------------------------------------------------------------------|
+| YOUR_BOT_PREFIX_HERE      | The prefix(es) of your bot                                            |
+| YOUR_BOT_TOKEN_HERE       | The token of your bot                                                 |
+| YOUR_APPLICATION_ID_HERE  | The application ID of your bot                                        |
+| OWNERS                    | The user ID of all the bot owners                                     |
+
+In the [blacklist](blacklist.json) file you now can add IDs (as integers) in the `ids` list.
 
 ## How to start
 

TODO.md

@@ -6,5 +6,5 @@
 * [ ] Add a lock command that will let administrators temporary lock a channel, useful in case of a raid
 * [ ] Add an archive command that lets administrators archive a text channel in a text file
 * [ ] Add an issue and pull request template for the repository
-* [ ] Be able to save data to JSON (blacklist, owners, etc.)
-* [ ] Move config to JSON
+* [X] Be able to save data to JSON (blacklist, owners, etc.)
+* [X] Move config to JSON

UPDATES.md

@@ -2,6 +2,13 @@
 
 Here is the list of all the updates that I made on this template.
 
+### Version 2.8
+
+* Blacklisted users are now **saved** in the file
+* Moved config file to JSON
+* Moved the blacklist in a separate file (`blacklist.json`)
+* The colors are no longer saved in the config file
+
 ### Version 2.7
 
 * Added a check for `commands.MissingRequiredArgument` in the error handler
@@ -12,8 +19,8 @@ Here is the list of all the updates that I made on this template.
 * Removed an unnecessary `self.bot.logout()` statement
 * Removed the `dick` command, as I want to keep this template safe for work
 * Renamed the names of the arguments in some commands
-* The bot now **tries** to send an embed in the private message of the command author for the `invite` and `server` commands, if this was not successful it will be sent in the channel
-
+* The bot now **tries** to send an embed in the private message of the command author for the `invite` and `server`
+  commands, if this was not successful it will be sent in the channel
 
 ### Version 2.6
 

blacklist.json

@@ -0,0 +1,4 @@
+{
+  "ids": [
+  ]
+}

bot.py

@@ -3,24 +3,24 @@
 Description:
 This is a template to create your own discord bot in python.
 
-Version: 2.7
+Version: 2.8
 """
 
+import json
 import os
 import platform
 import random
 import sys
 
 import discord
-import yaml
 from discord.ext import commands, tasks
 from discord.ext.commands import Bot
 
-if not os.path.isfile("config.yaml"):
-    sys.exit("'config.yaml' not found! Please add it and try again.")
+if not os.path.isfile("config.json"):
+    sys.exit("'config.json' not found! Please add it and try again.")
 else:
-    with open("config.yaml") as file:
-        config = yaml.load(file, Loader=yaml.FullLoader)
+    with open("config.json") as file:
+        config = json.load(file)
 
 """	
 Setup bot intents (events restrictions)
@@ -97,8 +97,9 @@ async def on_message(message):
     if message.author == bot.user or message.author.bot:
         return
     # Ignores if a command is being executed by a blacklisted user
-
-    if message.author.id in config["blacklist"]:
+    with open("blacklist.json") as file:
+        blacklist = json.load(file)
+    if message.author.id in blacklist["ids"]:
         return
     await bot.process_commands(message)
 
@@ -123,23 +124,23 @@ async def on_command_error(context, error):
         embed = discord.Embed(
             title="Hey, please slow down!",
             description=f"You can use this command again in {f'{round(hours)} hours' if round(hours) > 0 else ''} {f'{round(minutes)} minutes' if round(minutes) > 0 else ''} {f'{round(seconds)} seconds' if round(seconds) > 0 else ''}.",
-            color=config["error"]
+            color=0xE02B2B
         )
         await context.send(embed=embed)
     elif isinstance(error, commands.MissingPermissions):
         embed = discord.Embed(
             title="Error!",
             description="You are missing the permission `" + ", ".join(
                 error.missing_perms) + "` to execute this command!",
-            color=config["error"]
+            color=0xE02B2B
         )
         await context.send(embed=embed)
     elif isinstance(error, commands.MissingRequiredArgument):
         embed = discord.Embed(
             title="Error!",
             description=str(error).capitalize(),
             # We need to capitalize because the command arguments have no capital letter in the code.
-            color=config["error"]
+            color=0xE02B2B
         )
         await context.send(embed=embed)
     raise error

cogs/fun.py

@@ -7,21 +7,21 @@
 """
 
 import asyncio
+import json
 import os
 import random
 import sys
 
 import aiohttp
 import discord
-import yaml
 from discord.ext import commands
 from discord.ext.commands import BucketType
 
-if not os.path.isfile("config.yaml"):
-    sys.exit("'config.yaml' not found! Please add it and try again.")
+if not os.path.isfile("config.json"):
+    sys.exit("'config.json' not found! Please add it and try again.")
 else:
-    with open("config.yaml") as file:
-        config = yaml.load(file, Loader=yaml.FullLoader)
+    with open("config.json") as file:
+        config = json.load(file)
 
 
 class Fun(commands.Cog, name="fun"):
@@ -51,13 +51,13 @@ async def dailyfact(self, context):
             async with session.get("https://uselessfacts.jsph.pl/random.json?language=en") as request:
                 if request.status == 200:
                     data = await request.json()
-                    embed = discord.Embed(description=data["text"], color=config["main_color"])
+                    embed = discord.Embed(description=data["text"], color=0xD75BF4)
                     await context.send(embed=embed)
                 else:
                     embed = discord.Embed(
                         title="Error!",
                         description="There is something wrong with the API, please try again later",
-                        color=config["error"]
+                        color=0xE02B2B
                     )
                     await context.send(embed=embed)
                     # We need to reset the cool down since the user didn't got his daily fact.
@@ -75,7 +75,7 @@ async def rock_paper_scissors(self, context):
             "🧻": 1,
             "✂": 2
         }
-        embed = discord.Embed(title="Please choose", color=config["warning"])
+        embed = discord.Embed(title="Please choose", color=0xF59E42)
         embed.set_author(name=context.author.display_name, icon_url=context.author.avatar_url)
         choose_message = await context.send(embed=embed)
         for emoji in reactions:
@@ -93,30 +93,30 @@ def check(reaction, user):
             bot_choice_emote = random.choice(list(reactions.keys()))
             bot_choice_index = reactions[bot_choice_emote]
 
-            result_embed = discord.Embed(color=config["success"])
+            result_embed = discord.Embed(color=0x42F56C)
             result_embed.set_author(name=context.author.display_name, icon_url=context.author.avatar_url)
             await choose_message.clear_reactions()
 
             if user_choice_index == bot_choice_index:
                 result_embed.description = f"**That's a draw!**\nYou've chosen {user_choice_emote} and I've chosen {bot_choice_emote}."
-                result_embed.colour = config["warning"]
+                result_embed.colour = 0xF59E42
             elif user_choice_index == 0 and bot_choice_index == 2:
                 result_embed.description = f"**You won!**\nYou've chosen {user_choice_emote} and I've chosen {bot_choice_emote}."
-                result_embed.colour = config["success"]
+                result_embed.colour = 0x42F56C
             elif user_choice_index == 1 and bot_choice_index == 0:
                 result_embed.description = f"**You won!**\nYou've chosen {user_choice_emote} and I've chosen {bot_choice_emote}."
-                result_embed.colour = config["success"]
+                result_embed.colour = 0x42F56C
             elif user_choice_index == 2 and bot_choice_index == 1:
                 result_embed.description = f"**You won!**\nYou've chosen {user_choice_emote} and I've chosen {bot_choice_emote}."
-                result_embed.colour = config["success"]
+                result_embed.colour = 0x42F56C
             else:
                 result_embed.description = f"**I won!**\nYou've chosen {user_choice_emote} and I've chosen {bot_choice_emote}."
-                result_embed.colour = config["error"]
+                result_embed.colour = 0xE02B2B
                 await choose_message.add_reaction("🇱")
             await choose_message.edit(embed=result_embed)
         except asyncio.exceptions.TimeoutError:
             await choose_message.clear_reactions()
-            timeout_embed = discord.Embed(title="Too late", color=config["error"])
+            timeout_embed = discord.Embed(title="Too late", color=0xE02B2B)
             timeout_embed.set_author(name=context.author.display_name, icon_url=context.author.avatar_url)
             await choose_message.edit(embed=timeout_embed)
 

cogs/general.py

@@ -14,14 +14,13 @@
 
 import aiohttp
 import discord
-import yaml
 from discord.ext import commands
 
-if not os.path.isfile("config.yaml"):
-    sys.exit("'config.yaml' not found! Please add it and try again.")
+if not os.path.isfile("config.json"):
+    sys.exit("'config.json' not found! Please add it and try again.")
 else:
-    with open("config.yaml") as file:
-        config = yaml.load(file, Loader=yaml.FullLoader)
+    with open("config.json") as file:
+        config = json.load(file)
 
 
 class general(commands.Cog, name="general"):
@@ -35,7 +34,7 @@ async def info(self, context):
         """
         embed = discord.Embed(
             description="Used Krypton's template",
-            color=config["success"]
+            color=0x42F56C
         )
         embed.set_author(
             name="Bot Information"
@@ -80,7 +79,7 @@ async def serverinfo(self, context):
         embed = discord.Embed(
             title="**Server Name:**",
             description=f"{server}",
-            color=config["success"]
+            color=0x42F56C
         )
         embed.set_thumbnail(
             url=server.icon_url
@@ -118,7 +117,7 @@ async def ping(self, context):
         embed = discord.Embed(
             title="🏓 Pong!",
             description=f"The bot latency is {round(self.bot.latency * 1000)}ms.",
-            color=config["success"]
+            color=0x42F56C
         )
         await context.send(embed=embed)
 
@@ -129,7 +128,7 @@ async def invite(self, context):
         """
         embed = discord.Embed(
             description=f"Invite me by clicking [here](https://discordapp.com/oauth2/authorize?&client_id={config['application_id']}&scope=bot&permissions=470150263).",
-            color=config['main_color']
+            color=0xD75BF4
         )
         try:
             # To know what permissions to give to your bot, please see here: https://discordapi.com/permissions.html and remember to not give Administrator permissions.
@@ -145,7 +144,7 @@ async def server(self, context):
         """
         embed = discord.Embed(
             description=f"Join the support server for the bot by clicking [here](https://discord.gg/HzJ3Gfr).",
-            color=config['main_color']
+            color=0xD75BF4
         )
         try:
             await context.author.send(embed=embed)
@@ -161,7 +160,7 @@ async def poll(self, context, *, title):
         embed = discord.Embed(
             title="A new poll has been created!",
             description=f"{title}",
-            color=config["success"]
+            color=0x42F56C
         )
         embed.set_footer(
             text=f"Poll created by: {context.message.author} • React to vote!"
@@ -184,7 +183,7 @@ async def eight_ball(self, context, *, question):
         embed = discord.Embed(
             title="**My Answer:**",
             description=f"{answers[random.randint(0, len(answers))]}",
-            color=config["success"]
+            color=0x42F56C
         )
         embed.set_footer(
             text=f"The question was: {question}"
@@ -205,7 +204,7 @@ async def bitcoin(self, context):
             embed = discord.Embed(
                 title=":information_source: Info",
                 description=f"Bitcoin price is: ${response['bpi']['USD']['rate']}",
-                color=config["success"]
+                color=0x42F56C
             )
             await context.send(embed=embed)
 

cogs/help.py

@@ -6,18 +6,18 @@
 Version: 2.7
 """
 
+import json
 import os
 import sys
 
 import discord
-import yaml
 from discord.ext import commands
 
-if not os.path.isfile("config.yaml"):
-    sys.exit("'config.yaml' not found! Please add it and try again.")
+if not os.path.isfile("config.json"):
+    sys.exit("'config.json' not found! Please add it and try again.")
 else:
-    with open("config.yaml") as file:
-        config = yaml.load(file, Loader=yaml.FullLoader)
+    with open("config.json") as file:
+        config = json.load(file)
 
 
 class Help(commands.Cog, name="help"):
@@ -32,7 +32,7 @@ async def help(self, context):
         prefix = config["bot_prefix"]
         if not isinstance(prefix, str):
             prefix = prefix[0]
-        embed = discord.Embed(title="Help", description="List of available commands:", color=config["success"])
+        embed = discord.Embed(title="Help", description="List of available commands:", color=0x42F56C)
         for i in self.bot.cogs:
             cog = self.bot.get_cog(i.lower())
             commands = cog.get_commands()