Cog Manager UI¶
This is the cog guide for the core cog. You will find detailed docs about usage and commands.
[p] is considered as your prefix.
This cog is not like the other cogs. It is loaded by default, not included in the cogs paths and it cannot be unloaded. It contains needed commands for cog management.
This cog allows you to manage your cogs and where you can install them. Unlike
V2, which had a
cogs folder where everything was installed, you can
install V3 cogs everywhere, and also make them cross-compatible with other
If you want to install your cogs using a Github repo (usually what you will always be looking for), you need to use the downloader cog. However, if you have the files of a cog or want to code one, this cog is what you should be looking for.
The most basic command is paths, which will list you all of the currently set paths.
How to install a local package without using downloader¶
Let’s suppose you made a cog request on the cog board and now you want to add your own cog to Red. You should have a folder that looks like this:
You will first need to add a cog path to your instance. For that, use the addpath command with a new directory.
Create a folder somewhere (should stay accessible) and copy its path. A path looks like this:
You can now use the command we talked about before: type
A path shouldn’t have spaces in it. If it does, add quotation marks around the path, or a backslash before the space.
MyCogs folder, you can drop your cog folder. You should now have
something that looks like this:
Now if you type
[p]cogs, your new cog should be listed, and you will be
able to load it!
The whole cog is locked to the bot owner. If you are not the owner of the instance, you can ignore this.
Returns a list of loaded and unloaded cogs on the bot.
Cogs are unloaded by default. This is where you can find your cogs if you installed some recently.
All of the cogs located inside a cog path will be listed here. You can see a list of the paths with the paths command.
Lists the registered cog paths, with the install path for the downloader and the core path for the core cogs.
You can use the reorderpath command to reorder the listed paths.
The number before a cog path can be used for the removepath command.
Adds a path to the list of available cog paths. This means that all valid cogs under the path will be added to the list of available cogs, listed in cogs.
<path>: A path that should look like this and point to a folder:
Try to avoid paths with spaces. If there are spaces, add a backslash before the space on Linux. Add quotation marks around the path if needed.
Removes a path from the list of available paths. Its cogs won’t be accessible anymore.
<path_number>: The number of the path to remove. You can get it with the paths command.
[p]reorderpath <from_> <to>
Reorders the paths listed with the paths command. The goal of this command is to allow the discovery of different cogs. If there are multiple packages with the same names, the one that is inside the highest folder in the list will be kept and the other ones will be ignored.
For example, let’s suppose this is the output of paths:
The folders 2 and 3 both have a package named
leveler while being different
cogs, and you want to load the one located in the 3rd folder. To do that, you
have to put the 3rd path higher than the 2nd path, let’s swap them! Type
[p]reorderpath 2 3 and the output of
paths will then be the following:
<from_>: The index of the path you want to move.
<to>: The location where you want to insert the path.
Shows the install path, or sets a new one. If you want to set a new path, the same rules as for addpath applies.
If you edit the install path, the cogs won’t be transfered.
[path]: The absolute path to set. If omitted, the current path will be returned instead.