Fixed typos and inserted a readme
This commit is contained in:
parent
e5c92da4ee
commit
45d775efb1
@ -1,2 +1,5 @@
|
|||||||
# KanuimCogs
|
# KaniumCogs
|
||||||
cogs made for our Royal butt.
|
cogs made for our Royal butt.
|
||||||
|
|
||||||
|
## Our Cogs:
|
||||||
|
- [WelcomeCog](./welcomeCog)
|
||||||
28
welcomeCog/README.md
Normal file
28
welcomeCog/README.md
Normal file
@ -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.
|
||||||
@ -6,7 +6,7 @@ import json
|
|||||||
from redbot.core import Config, checks, commands
|
from redbot.core import Config, checks, commands
|
||||||
from redbot.core.utils.chat_formatting import box, humanize_list, pagify
|
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 fetchMessage():
|
||||||
async def fetch():
|
async def fetch():
|
||||||
@ -31,8 +31,8 @@ def formatMessage(jsonFormat):
|
|||||||
return message
|
return message
|
||||||
|
|
||||||
except:
|
except:
|
||||||
message=discord.Embed(title="Kanuim", description='', color=0x3399ff)
|
message=discord.Embed(title="Kanium", description='', color=0x3399ff)
|
||||||
message.add_field(name="Welcome", value='Welcome To Kanuim !', inline=True)
|
message.add_field(name="Welcome", value='Welcome To Kanium !', inline=True)
|
||||||
return message
|
return message
|
||||||
|
|
||||||
class WelcomeCog(commands.Cog):
|
class WelcomeCog(commands.Cog):
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user