WIP: V2

.github/workflows/pylint.yml

@@ -0,0 +1,26 @@
+name: Pylint
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10.6", "3.11.1"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install pylint
+      run: |
+        python -m pip install --upgrade pip
+        pip install pylint
+    - name: Install dependencies
+      run: |
+        pip install -r requirements.txt
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files '*.py')

.gitignore

@@ -0,0 +1,6 @@
+.idea
+.vscode
+cogs/__pycache__
+__pycache__
+.env
+config.json

.pylintrc

@@ -0,0 +1,2 @@
+[MESSAGES CONTROL]
+disable=missing-docstring,missing-module-docstring,line-too-long,no-member,global-statement,no-name-in-module

CONFIGURATION.md

@@ -0,0 +1,32 @@
+# Configuration
+
+## File locations
+If set to use a JSON file, the file must be in the root directory, if set to use environment variables, the environment variables must be set in the environment the bot is running in.
+
+## Token
+Discord bot authentication token, can be generated in the [Developer Portal](https://discord.com/developers/applications/)
+
+| type   | JSON file | environment  |
+|--------|-------------|---------------------|
+| string | `Token` | `TOKEN` |
+
+## Owner ID
+The owner ID of the bot, this is used for owner only commands.
+
+| type   | JSON file | environment  |
+|--------|-------------|---------------------|
+| string | `OwnerID` | `OWNERID` |
+
+## Sharded
+Whether the bot is sharded or not, only enable this if your bot is in more then 1000 servers.
+
+| type   | JSON file | environment  |
+|--------|-------------|---------------------|
+| boolean | `Sharded` | `SHARDED` |
+
+## Branch
+The branch of the bot, this is used for the `pull` command to pull from the correct branch
+
+| type   | JSON file | environment  |
+|--------|-------------|---------------------|
+| string | `Branch` | `BRANCH` |

CONTRIBUTING.md

@@ -0,0 +1,4 @@
+# Contributing
+If you want to contribute, make a [fork](https://github.com/Soapy7261/DobbieBot/fork), make your changes there, and then make a [pull request](https://github.com/Soapy7261/DobbieBot/compare), it must also follow the [licence](https://github.com/Soapy7261/DobbieBot/blob/main/LICENCE)
+
+If you are contributing to fix a security issue, please see [SECURITY.md](./SECURITY.md)

LICENSE.txt → LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Soapy7261
+Copyright (c) 2024 Soapy7261
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,7 +1,13 @@
 # DobbieBot
-Discord fork used: pycord
+Discord fork used: py-cord
 
 Checkout [this to install it](https://docs.pycord.dev/en/master/installing.html).
 
-There are some Id's what you need to change, <br>
-this progam gets the bot tolken by using a .env file 
+# Self hosting
+
+## Creating a bot
+2. Create a [Discord application](https://discord.com/developers/applications/).
+   You have to enable all intents.
+
+## Configuration
+Please view the [config file](./CONFIGURATION.md) for more configuration options.

SECURITY.md

@@ -0,0 +1,23 @@
+# Security Policy
+
+## Supported Versions
+Only the latest version of DobbieBot is supported, older versions are not supported.
+| Version | Support status |
+| ------- | ------------------ |
+| 2.LATEST   | ✅ Active |
+| 1.X   | ❌ EOL |
+
+## Valid Vulnerabilities
+Vulnerabilities in this project mostly fall into one of the following categories:
+- Default Permissions that give users access to something that should probably be private
+- Injecting custom code into the bot
+- Crashing the entire DobbieBot instance
+- Overloading the instance and therefore making the bot unusable on other servers
+
+The following are explicitly not vulnerabilities inside DobbieBot:
+- Poorly configured slash command permissions which allow users to execute privileged commands
+- Issues otherwise specific to a server for example having a public log of deleted messages, moderations etc.
+
+## Reporting a Vulnerability
+Please do not create a public issue about security vulnerabilities. To prevent abuse of the vulnerability
+before a fix is available please create a private report here: https://github.com/Soapy7261/DobbieBot/security/advisories

cogs/botinfo.py

@@ -0,0 +1,30 @@
+from discord import Embed, utils, Color
+from discord.ext.commands import slash_command
+from discord.ext import commands
+class BotInfo(commands.Cog):
+    def __init__(self, bot):
+        self.bot = bot
+
+    @commands.Cog.listener()
+    async def on_ready(self):
+        print('BotInfo cog loaded!')
+
+    @slash_command(description='Get info about the bot')
+    async def botinfo(self, ctx):
+        embed = Embed(
+            title="DobbieBot",
+            description = "The Dobbie bot",
+            timestamp=utils.utcnow(),
+            color=Color.embed_background())
+        embed.add_field(name="Ping:",value=round(self.bot.latency * 1000, 2) + "ms")
+        embed.add_field(name="Info about the bot",
+            value="""this bot is made by Soapy7261#7261
+            and Dobbie#4778. To teach Dobbie how 
+            Discord bots work and how py-cord works!""")
+
+        embed.add_field(name="Main commands", value="/math\n/info")
+        embed.add_field(name="Github", value="https://github.com/Soapy7261/DobbieBot")
+        await ctx.respond(embed=embed)
+
+def setup(bot):
+    bot.add_cog(BotInfo(bot))

cogs/branch.py

@@ -0,0 +1,21 @@
+import discord
+from discord.ext import commands
+from discord.ext.commands import slash_command
+from utils import Utils
+class Branch(commands.Cog):
+    def __init__(self, bot):
+        self.bot = bot
+        self.info = Utils.info()
+
+    @commands.Cog.listener()
+    async def on_ready(self):
+        print('Branch cog loaded!')
+
+    @slash_command(description='Only the owner of the bot can run this command', guild_ids=[955135608228024394])
+    async def branch(self, ctx, branch: discord.Option(autocomplete=Utils.GetBranches, description='What branch to switch to', required=True)):
+        if ctx.interaction.user.id != int(self.info['OwnerID']):
+            return await ctx.respond("You don't have permission to use this command!", ephemeral=True)
+        await ctx.respond(f'You selected {branch}', ephemeral=True)
+
+def setup(bot):
+    bot.add_cog(Branch(bot))

cogs/cogs.py

@@ -0,0 +1,43 @@
+import os
+import discord
+from discord.ext import commands
+from discord.ext.commands import slash_command
+from discord.errors import ExtensionAlreadyLoaded, ExtensionNotLoaded, ExtensionFailed
+from utils import Utils
+class Cogs(commands.Cog):
+    def __init__(self, bot):
+        self.bot = bot
+        self.info = Utils.info()
+
+    @commands.Cog.listener()
+    async def on_ready(self):
+        print('Cogs cog loaded!')
+
+    @slash_command(description='Load, unload, or reload cogs', guild_ids=[955135608228024394])
+    async def cogs(self, ctx, action: discord.Option(choices=["Reload", "Load", "Unload"], description='What action to run', required=True), cog: discord.Option(autocomplete=Utils.get_cogs, description='The cog to run the action on', required=True)):
+        if ctx.author.id != int(self.info['OwnerID']):
+            return await ctx.respond("You don't have permission to use this command!", ephemeral=True)
+        if cog not in [f"{fn[:-3]}" for fn in os.listdir("commands")]:
+            await ctx.respond("That cog doesn't exist!", ephemeral=True)
+            return
+        await ctx.defer(ephemeral=True)
+        try:
+            if action == "Load":
+                self.bot.load_extension(f"commands.{cog}")
+            if action == "Unload":
+                self.bot.unload_extension(f"commands.{cog}")
+            if action == "Reload":
+                self.bot.reload_extension(f"commands.{cog}")
+        except ExtensionAlreadyLoaded:
+            await ctx.respond("Extension already loaded!", ephemeral=True)
+            return
+        except ExtensionNotLoaded:
+            await ctx.respond("Extension not loaded!", ephemeral=True)
+            return
+        except ExtensionFailed as error:
+            await ctx.respond(f"Extension failed to load!```py\n{str(error)}\n```", ephemeral=True)
+            return
+        await ctx.respond(f"{action}ed {cog}", ephemeral=True)
+
+def setup(bot):
+    bot.add_cog(Cogs(bot))

cogs/examples/cogexample.txt

@@ -0,0 +1,16 @@
+from discord import slash_command
+from discord.ext import commands
+class NAME(commands.Cog):
+    def __init__(self, bot):
+        self.bot = bot
+
+    @commands.Cog.listener()
+    async def on_ready(self):
+        print('BLANK cog loaded!')
+
+    @slash_command(description='Your description')
+    async def command(self, ctx):
+        await ctx.respond('Your response')
+
+def setup(bot):
+    bot.add_cog(NAME(bot))

cogs/examples/defaultpermissions.txt

@@ -0,0 +1,16 @@
+from discord import slash_command, commands, default_permissions
+class NAME(commands.Cog):
+    def __init__(self, bot):
+        self.bot = bot
+
+    @commands.Cog.listener()
+    async def on_ready(self):
+        print('BLANK cog loaded!')
+
+    @slash_command(description='Your description')
+    @default_permissions(administrator=True) # Tells discord to make the command admin only, so people without the permission can't see it
+    async def command(self, ctx):
+        await ctx.respond('Your response')
+
+def setup(bot):
+    bot.add_cog(NAME(bot))

cogs/examples/defaultpermissionsgroup.txt

@@ -0,0 +1,17 @@
+from discord import slash_command, commands, discord
+class NAME(commands.Cog):
+    def __init__(self, bot):
+        self.bot = bot
+
+    @commands.Cog.listener()
+    async def on_ready(self):
+        print('BLANK cog loaded!')
+
+    group = discord.SlashCommandGroup("group", "Group description", default_member_permissions=discord.Permissions(PERMISSIONIDHERE))
+
+    @group.command(description='Your description')
+    async def command(self, ctx):
+        await ctx.respond('Your response')
+
+def setup(bot):
+    bot.add_cog(NAME(bot))

cogs/examples/deferexample.txt

@@ -0,0 +1,17 @@
+from discord import slash_command, commands
+class NAME(commands.Cog):
+    def __init__(self, bot):
+        self.bot = bot
+
+    @commands.Cog.listener()
+    async def on_ready(self):
+        print('BLANK cog loaded!')
+
+    @slash_command(description='Your description')
+    async def command(self, ctx):
+        await ctx.defer() #This can also be ephemeral or invisible with parameters, this is mostly useful if what your doing takes a while so discord doesn't think your bot isn't responding
+        #Some code in here
+        await ctx.respond('Done!')
+
+def setup(bot):
+    bot.add_cog(NAME(bot))

cogs/examples/slashcommandgroup.txt

@@ -0,0 +1,17 @@
+from discord import slash_command, commands
+class NAME(commands.Cog):
+    def __init__(self, bot):
+        self.bot = bot
+
+    @commands.Cog.listener()
+    async def on_ready(self):
+        print('BLANK cog loaded!')
+
+    group = discord.SlashCommandGroup("group", "Group description")
+
+    @group.command(description='Your description')
+    async def command(self, ctx):
+        await ctx.respond('Your response')
+
+def setup(bot):
+    bot.add_cog(NAME(bot))

cogs/math.py

@@ -0,0 +1,29 @@
+import discord
+from discord.ext import commands
+from discord.ext.commands import slash_command
+class Math(commands.Cog):
+    def __init__(self, bot):
+        self.bot = bot
+
+    @commands.Cog.listener()
+    async def on_ready(self):
+        print('Math cog loaded!')
+
+    @slash_command(description="Run a calculation")
+    async def math(self, ctx, first: discord.Option(float, description="The first number"), second: discord.Option(float, description="The second number"), operation: discord.Option(description="What operation you want to run", choices=["+", "-", "*", "/"])):
+        if operation == '+':
+            oper = first + second
+        elif operation == '-':
+            oper = first - second
+        elif operation == '*':
+            oper = first * second
+        elif operation == '/':
+            if second == 0:
+                return await ctx.respond("You can't divide by 0!", ephemeral=True)
+            oper = first / second
+        embed=discord.Embed(title='Calculation', timestamp=discord.utils.utcnow(), color=discord.Color.green())
+        embed.add_field(name='Your calculation is here!', value=f"{first}{operation}{second} = {oper}")
+        await ctx.respond(embed=embed)
+
+def setup(bot):
+    bot.add_cog(Math(bot))

cogs/reload.py

@@ -0,0 +1,34 @@
+from asyncio import sleep as asyncsleep
+import discord
+from discord.ext.commands import slash_command
+from discord.ext import commands
+from utils import Utils
+class Reload(commands.Cog):
+    def __init__(self, bot):
+        self.bot = bot
+        self.info = Utils.info()
+
+    @commands.Cog.listener()
+    async def on_ready(self):
+        print('Reload cog loaded!')
+
+    @slash_command(description='Only the owner of the bot can run this command', guild_ids=[955135608228024394])
+    async def reload(self, ctx):
+        if ctx.author.id != int(self.info['OwnerID']):
+            return await ctx.respond("You don't have permission to use this command!", ephemeral=True)
+        await ctx.defer()
+        await self.bot.change_presence(activity=discord.Activity(type=discord.ActivityType.playing, name=f"Reloading commands, bot may be unresponsive | In {len(self.bot.guilds)} servers"), status=discord.Status.dnd)
+        await asyncsleep(1)
+        try:
+            await self.bot.sync_commands()
+        except Exception as error:
+            await ctx.respond ("Failed to reload commands!")
+            await ctx.respond ("```py\n" + str(error) + "\n```", ephemeral=True)
+            await asyncsleep(3)
+            return await self.bot.change_presence(activity=discord.Activity(type=discord.ActivityType.listening, name=f"my creator's keyboard | In {len(self.bot.guilds)} servers"), status=discord.Status.online)
+        await asyncsleep(3)
+        await self.bot.change_presence(activity=discord.Activity(type=discord.ActivityType.listening, name=f"my creator's keyboard | In {len(self.bot.guilds)} servers"), status=discord.Status.online)
+        return await ctx.respond("Finished!", ephemeral=True)
+
+def setup(bot):
+    bot.add_cog(Reload(bot))