CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 03:08:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Updated Publishing your cog (markdown)

Twentysix 2016-03-06 17:38:17 +01:00
parent e4f7223ead
commit 01ddf97cb2
1 changed files with 4 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Publishing-your-cog.md

@ -12,27 +12,21 @@ Once you're sure that your cog meets the requirements, this is how you proceed:
* Any data that your cog needs must be in a folder called "data" inside that folder
* If your cog doesn't need additional files in order to work, don't make a data subfolder
* No multiple *.py files in the root folder
* No subfolders inside data folder
Example:
testcog/testcog.py
testcog/data/text.json
testcog/data/text2.json
testcog/data/moredata/text.json
When the user installs your cog, the installer will take care of taking your data files and put them in /data/yourcog/, so you can expect them to be there once your cog gets installed.
Now it's time to make the info.json. This is what the installer uses to get informations about the cog and display them to user before installation (name, author, description...). Also, it lists any file that your cog package contains.
Now it's time to make the info.json. This is what the installer uses to get informations about the cog and display them to user when requested (name, author, description...).
[Download this script](https://gist.githubusercontent.com/Twentysix26/09071dbf2cbacd298fab/raw/788a41852311f7dc03b11c6ec8ee07658c637567/info_maker.py) (CTRL + S) and save it into your folder. Run it and *follow the instructions*. Once you're done, if everything went smooth your folder should contain an info.json. Delete the script "info_maker.py" in case you haven't already.
[Download this script](https://gist.githubusercontent.com/Twentysix26/09071dbf2cbacd298fab/raw/788a41852311f7dc03b11c6ec8ee07658c637567/info_maker.py) (CTRL + S). Run it and *follow the instructions*. Once you're done, if everything went smooth you should have an info.json. Put it into your cog's folder, next to the .py file.
Now, you either:
* **Best way**: [Make a pull request on github](https://github.com/Twentysix26/Red-Cogs), of course by cloning the repo and putting the folder you just created inside the "cogs" folder.
* Or zip the folder and send it to the staff/dev on the server. We will take a look at it and publish it whenever we have time
If your cog package doesn't meet the requirements it will be rejected.
## Updating your published cog
**In case** your folder structure changed (for example, you added another file to the data folder) generate another info.json
Then, if you published it with a pull request, just make another.
Otherwise send another zip to the staff/dev.
If your cog package doesn't meet the requirements it will be rejected.