From 05fdecf2ce8b70bb8b04c0acdcf0063db3b6c5af Mon Sep 17 00:00:00 2001 From: Twentysix Date: Sun, 6 Mar 2016 20:58:29 +0100 Subject: [PATCH] Updated Publishing your cog (markdown) --- Publishing-your-cog.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Publishing-your-cog.md b/Publishing-your-cog.md index 7a91e88..51d79da 100644 --- a/Publishing-your-cog.md +++ b/Publishing-your-cog.md @@ -3,8 +3,9 @@ In order to be published, your cog must: * Not conflict with any of the standard modules * Not be too heavy -* Have decent instructions +* Have clear instructions / list of commands (or at least a `see !help Category`) * Not generate/tamper with any data outside its own subfolder in data +* Not be malicious Once you're sure that your cog meets the requirements, this is how you proceed: * Make a folder with the same name as the cog. (example.py -> example) @@ -23,7 +24,7 @@ When the user installs your cog, the installer will take care of taking your dat 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 the user when requested (name, author, description...). -[Download this script](https://gist.githubusercontent.com/Twentysix26/73a2a09238d6875b5cb7/raw/ab4d1e45e293730c358c3e441f502bb99e8f183d/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. +[Download this script](https://gist.githubusercontent.com/Twentysix26/73a2a09238d6875b5cb7/raw/ab4d1e45e293730c358c3e441f502bb99e8f183d/info_maker.py) (CTRL + S). Run it and *follow the instructions*. Once you're done, if everything went smoothly 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.