From 45d775efb134cdf672056431244c50909689dffe Mon Sep 17 00:00:00 2001 From: Fadi Atamny Date: Fri, 10 Apr 2020 13:56:56 +0300 Subject: [PATCH 1/3] Fixed typos and inserted a readme --- README.md | 5 ++++- welcomeCog/README.md | 28 ++++++++++++++++++++++++++++ welcomeCog/welcome.py | 6 +++--- 3 files changed, 35 insertions(+), 4 deletions(-) create mode 100644 welcomeCog/README.md diff --git a/README.md b/README.md index a318071..4d5ce1c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,5 @@ -# KanuimCogs +# KaniumCogs cogs made for our Royal butt. + +## Our Cogs: +- [WelcomeCog](./welcomeCog) \ No newline at end of file diff --git a/welcomeCog/README.md b/welcomeCog/README.md new file mode 100644 index 0000000..702db8f --- /dev/null +++ b/welcomeCog/README.md @@ -0,0 +1,28 @@ +# WelcomeCog +this is the kanium guild welcome cog. it sends a direct message to a user who has joined the kanium discord with a [message](./data/embedded_message.json) thats been templated in a json format. + +# How to use: + +in order to use our cog you would need to install it onto your instance of [RedBot](https://github.com/Cog-Creators/Red-DiscordBot). + + +## requirments: + +- Instance of [RedBot](https://github.com/Cog-Creators/Red-DiscordBot) +- Downloader cog has to be loaded. to load: + ```[Prefix]load downloader``` + +## The commands: + +1. ```[PREFIX]repo add [RepoName] https://github.com/Kanium/KaniumCogs [ActiveBranch (EX: Master)] ``` +2. ```[PREFIX]cog install [RepoName] welcomeCog``` +3. ```[PREFIX]load welcomeCog``` + +### To update the Cog: +- ```[PREFIX]repo update [RepoName]``` + +### To modify the sent message: + +if you would like to modify the message to your liking, you can either : +- fork the bot. change the [message](./data/embedded_message.json) and [welcome.py](./welcome.py) line 9 to your repo. +- fork the bot. update the [welcome.py](./welcome.py) line 9 to be directed to your message.json file that you like without having it hosted on github with your repo. diff --git a/welcomeCog/welcome.py b/welcomeCog/welcome.py index 5a3ddbc..1d11a12 100644 --- a/welcomeCog/welcome.py +++ b/welcomeCog/welcome.py @@ -6,7 +6,7 @@ import json from redbot.core import Config, checks, commands from redbot.core.utils.chat_formatting import box, humanize_list, pagify -url = 'https://raw.githubusercontent.com/Kanium/KanuimCogs/master/welcomeCog/data/embedded_message.json' +url = 'https://raw.githubusercontent.com/Kanium/KaniumCogs/master/welcomeCog/data/embedded_message.json' async def fetchMessage(): async def fetch(): @@ -31,8 +31,8 @@ def formatMessage(jsonFormat): return message except: - message=discord.Embed(title="Kanuim", description='', color=0x3399ff) - message.add_field(name="Welcome", value='Welcome To Kanuim !', inline=True) + message=discord.Embed(title="Kanium", description='', color=0x3399ff) + message.add_field(name="Welcome", value='Welcome To Kanium !', inline=True) return message class WelcomeCog(commands.Cog): From 65e37b3ae2f0704bb9c1ea56f724558101fcb5a3 Mon Sep 17 00:00:00 2001 From: Hattenburg Date: Fri, 10 Apr 2020 13:26:58 +0200 Subject: [PATCH 2/3] Update README.md --- welcomeCog/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/welcomeCog/README.md b/welcomeCog/README.md index 702db8f..dbf758a 100644 --- a/welcomeCog/README.md +++ b/welcomeCog/README.md @@ -6,7 +6,7 @@ this is the kanium guild welcome cog. it sends a direct message to a user who ha in order to use our cog you would need to install it onto your instance of [RedBot](https://github.com/Cog-Creators/Red-DiscordBot). -## requirments: +## Requirments: - Instance of [RedBot](https://github.com/Cog-Creators/Red-DiscordBot) - Downloader cog has to be loaded. to load: From 1b7186490843cb8c0956425b327e36d3be06c3cf Mon Sep 17 00:00:00 2001 From: Hattenburg Date: Fri, 10 Apr 2020 13:32:30 +0200 Subject: [PATCH 3/3] Update README.md --- welcomeCog/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/welcomeCog/README.md b/welcomeCog/README.md index dbf758a..8a0a678 100644 --- a/welcomeCog/README.md +++ b/welcomeCog/README.md @@ -1,5 +1,5 @@ # WelcomeCog -this is the kanium guild welcome cog. it sends a direct message to a user who has joined the kanium discord with a [message](./data/embedded_message.json) thats been templated in a json format. +this is the kanium guild welcome cog. it sends a direct message to a user who has joined the kanium discord with a [message](./data/embedded_message.json) thats been templated in a json format. Note: This is All the cog does, there are no commands to operate the cog (potentially: yet) # How to use: @@ -12,7 +12,7 @@ in order to use our cog you would need to install it onto your instance of [RedB - Downloader cog has to be loaded. to load: ```[Prefix]load downloader``` -## The commands: +## How to install & load: 1. ```[PREFIX]repo add [RepoName] https://github.com/Kanium/KaniumCogs [ActiveBranch (EX: Master)] ``` 2. ```[PREFIX]cog install [RepoName] welcomeCog```