Skip to content

Adding a cog to the server

LyricLy edited this page Jun 17, 2017 · 4 revisions

You want to upload your custom cog to the cog server, to be installed easily by others? This is the place to be!

Creating a JSON file for your cog

The first step to adding your cog to the server is creating a JSON file for it. This JSON file will store data about your cog, as well as the direct link to the cog. The JSON file format looks like this:

{
    "title": "My Custom Cog",
    "description": "A custom cog.",
    "author": "Me",
    "link": "https://raw.githubusercontent.com/mememe/mycog/master/my_cog.py"
}

The title is just that, a title of your cog. It doesn't even have to describe it at all, it's just a name.

The description is a simple description of your cog that users will see before installing it. Make sure you make the function of your cog clear!

The author part is just your name, along with the name of anybody else who worked on your cog.

Finally, the link. This should be a direct, raw link to your cog. Don't link to a download page, link straight to the cog. Make sure that you use a link that won't change often and is easy for you to change. Raw GitHub, Gist or Pastebin links work well here.

Uploading your JSON file

Once you're done creating your JSON file, it's time to upload it!

Go to here.

Write a filename such as "my_cog.json" in the "Name your file..." box. The part before the ".json" will be what users have to enter in to install your cog. Paste your JSON code into the box, then press the "Propose new file" button. Press "New pull request" then "Done"

You're done!

And that's it! Once you've uploaded your JSON file, your code will be reviewed and (hopefully) accepted within a few hours!

Clone this wiki locally