goldy-bot / goldy-bot-v4

(LEGACY) BIG rewrite of Goldy Bot V3 but it's open source

Goldy Bot V4 (Modern Rewrite)

⚠️ IS NOW DEPRECATED! _{Switch to Goldy Bot V5. 👋}

What is this!

Goldy Bot V4 is yet another rewrite of Goldy Bot, a discord bot that I develop for FUN. This is the third rewrite but the first rewrite to become open source, I've done this to allow developers across the world to create add-ons/extenstions for my bot that I can then add to the official production bot.

Feel free to use this module to develop your extenstions.

[⭐The Future of this Project.] ‎ [📘Docs]

Install/Set Up

1. Install package from pip.

⚠️ THIS IS THE LAST VERSION OF V4 - Every other version above is V5

#Windows/Linux

pip install GoldyBot==4.0.dev25

2. Download MongoDB Community. (You'll need this!) >>> https://www.mongodb.com/try/download/community

After finishing the install progress the MongoDB compass should open, copy the local host url and click connect. You'll need the url later!

3. Now create a run.py file, type this and run it.

import GoldyBot

goldy = GoldyBot.Goldy()

goldy.start()

Goldy Bot should shut itself down and create a config folder containing a 'bot token' text file.

4. Enter your discord bot token in the bot_token.txt file.

{ENTER BOT TOKEN HERE}

Save that! Make sure you pasted it WITHOUT the curly brackets ({}).

5. Then in goldy.json edit the following for Goldy Bot to start functioning.

"database_name" : "",

"allowed_guilds" : {
}

Give the database a name and add your bot testing guild id to "allowed_guilds" or else Goldy Bot will refuse to work.

So like this! (This is just an example!)

"database_name" : "members_data",

"allowed_guilds" : {
    "863416692083916820" : "bot_test_server"
}

6. Now run Goldy Bot. It will create another txt file and stop running. This is your database url, remember the url I told you to copy, paste that in this text file WITHOUT the curly brackets ({}).

7. Then run Goldy Bot once again.

python run.py

Now you should see a folder being created for your guild and also a database folder in your MongoDB database.

8. Now your all set for development!

More Docs Here

© Copyright (C) 2022 Dev Goldy (Under the GPL-3.0 License)

goldy-bot-v4's Issues

Create reload() function within GoldyBot.modules.Module class.

• Remove commands in each extenstion in the module.
• Load the module again.

Loop through all internal cogs and add a folder for external extenstions/add-ons.

add guilds_allowed_in method in command class for "guild_ids=".

        #TODO: add guilds_allowed_in method in command class for "guild_ids=".

Goldy-Bot-V4/src/GoldyBot/objects/command.py

Line 227 in b2c4e9b

Extensions will have to be initialised in the load() function of a module.

- Extension files will now become packages.

Don't forget to change this disgusting command.

            #TODO: Don't forget to change this disgusting command.

Goldy-Bot-V4/src/GoldyBot/internal_modules/v4/admin.py

Line 34 in 078449a

await ctx.send(f"Reloaded {module.name}!")

help command

coming soon...

Add method to database to allow for creating collections.

        self.database #TODO: Add method to database to allow for creating collections.

Goldy-Bot-V4/src/GoldyBot/utility/guilds/guild.py

Line 38 in a95add3

add guilds_allowed_in method in command class for "guild_ids=".

        #TODO: add guilds_allowed_in method in command class for "guild_ids=".

Goldy-Bot-V4/src/GoldyBot/objects/command.py

Line 227 in b2c4e9b

Add permissions to commands.

add required_roles

Add slash commands is not fully support embed when using slash commands.

Goldy Bot thinks arguments are missing whenever a type error occurs within a command.

                    #TODO: Goldy Bot thinks arguments are missing whenever a type error occurs within a command.

Goldy-Bot-V4/src/GoldyBot/ext/commands.py

Line 56 in 33afbad

GoldyBot.logging.log("error", e)

Don't forget to add text to this.

        #TODO: Don't forget to add text to this.

https://github.com/Goldy-Bot/Goldy-Bot-V4/blob/686cce34679e214116d43eb211a4a4fe758f56d5/src/GoldyBot/utility/goldy/slash.py#L35

After creating a guild config JSON edit the ID and name.

Add logging to the guild config class.

    #TODO: Add logging to the guild config class.

https://github.com/Goldy-Bot/Goldy-Bot-V4/blob/ca8a8766b6a3c55d1e485fe4dd30a19da671f0e9/src/GoldyBot/utility/guilds/config.py#L19

Add return None if guild is not found.

        #TODO: Add return None if guild is not found.

Goldy-Bot-V4/src/GoldyBot/cache.py

Line 40 in 078449a

return guild_object

Add ``GoldyBot.command()`` option to toggle slash and normal commands .

Make Goldy Bot extenstions create nextcord cogs and load the commands into that cog.

Create a goldy bot restart command.

#TODO: Create a goldy bot restart command.

https://github.com/Goldy-Bot/Goldy-Bot-V4/blob/33afbad8716c20ed44665bdf75af29dd41c53f50/src/GoldyBot/bot.py#L61

Slash commands are showing paramaters that are not set in commands with variables.

@GoldyBot.command()
async def cache(self:Admin, ctx):
    cache_embed = GoldyBot.utility.goldy.embed.Embed(title=self.msg.cache.Embed.title)
    cache_embed.color = GoldyBot.utility.goldy.colours.BLUE

    cache_string = str(GoldyBot.cache.main_cache_dict)

    if len(cache_string) >= 5000:
        cache_embed.description = "Oh oh, the cache is way too long to display in an embed right now. I'll print it in the console instead."
        await ctx.send(embed=cache_embed)

        GoldyBot.logging.log("info", cache_string)
    else:
        cache_embed.description = f"```{GoldyBot.cache.main_cache_dict}```"
        await ctx.send(embed=cache_embed)

New reload mechanism

• When we reload we change the slash command execute function.

• When we unload just hide the slash command.

Fix embed issue!

        #TODO: Fix embed issue!

https://github.com/Goldy-Bot/Goldy-Bot-V4/blob/61750656be38cab9e08d91d413bb5edc59ea5c65/src/GoldyBot/utility/goldy/slash.py#L9

Raise a Goldy Bot error here.

                #TODO: Raise a Goldy Bot error here.

Goldy-Bot-V4/src/GoldyBot/modules.py

Line 80 in 078449a

GoldyBot.logging.log("error", f"[{MODULE_NAME}] The internal module '{self.module_file_name[:-3]}' failed to load because it did not contain the 'load()' function.")

Create goldy bot method to find roles in guild config with code_name.

            #TODO: Create goldy bot method to find roles in guild config with code_name.

undefined

'interaction.message' is always none.

        #TODO: 'interaction.message' is always none.

Goldy-Bot-V4/src/GoldyBot/utility/goldy/slash.py

Line 17 in 59a7008

return self.interaction.message.author

add support for loading folder modules with "__init__.py".

not all commands are showing in cache

Goldy Bot creates guild config even when guild is not in allowed list.

Add ramdom heart function.

add sub commands functionality