Kanium-PUBLIC/KaniumCogs
5
0
Fork 0
Code Issues 6 Pull Requests Packages Projects 1 Releases Wiki Activity

updated readmes

Browse Source
This commit is contained in:
Fadi Atamny 2020-05-03 20:07:03 +03:00
parent dd34e01c57
commit 75d092f2d7
3 changed files with 8 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
trafficTrackerCog/README.md
View File

@ -1,6 +1,5 @@
# WelcomeCog # TrafficTrackerCog
This is the Kanium community/guild welcome cog. it sends a DM to any new user that joins the Kanium discord with a [message](./data/embedded_message.json), which has been templated in a json format. This is the Kanium community/guild welcome cog. monitors the server for activity and logs them to a specific channel using the specific commands.
Furthermore, this cog allows the ability to monitor discord activity and log it into a specific channel using the specific commands.
# How to use: # 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). In order to use our cog you would need to install it onto your instance of [RedBot](https://github.com/Cog-Creators/Red-DiscordBot).
@ -13,24 +12,17 @@ In order to use our cog you would need to install it onto your instance of [RedB
## How to install & load: ## How to install & load:
1. `[PREFIX]repo add [RepoName] https://github.com/Kanium/KaniumCogs [ActiveBranch (EX: Master)] ` 1. `[PREFIX]repo add [RepoName] https://github.com/Kanium/KaniumCogs [ActiveBranch (EX: Master)] `
2. `[PREFIX]cog install [RepoName] welcomeCog` 2. `[PREFIX]cog install [RepoName] trafficTrackerCog`
3. `[PREFIX]load welcomeCog` 3. `[PREFIX]load trafficTrackerCog`
### To update the Cog: ### To update the Cog:
- `[PREFIX]cog uninstall welcomeCog` - `[PREFIX]cog uninstall trafficTrackerCog`
- `[PREFIX]repo update [RepoName]` - `[PREFIX]repo update [RepoName]`
- `[PREFIX]cog install [RepoName] welcomeCog` - `[PREFIX]cog install [RepoName] trafficTrackerCog`
- `[PREFIX]load welcomeCog` - `[PREFIX]load trafficTrackerCog`
### Commands ### Commands
- `[PREFIX]welcomepreview` - sends in the chat a preview of the template message
- `[PREFIX]pullmessage` - allows you to pull the latest version of your message without restarting the bot
- `[PREFIX]setchannel` - allows you to select a channel in your discord to dump logs to - `[PREFIX]setchannel` - allows you to select a channel in your discord to dump logs to
- `[PREFIX]stats` - prints the statistics that the cog has gathered. - `[PREFIX]stats` - prints the statistics that the cog has gathered.
- `[PREFIX]resetstats` - allows for a hard reset of the stats - `[PREFIX]resetstats` - allows for a hard reset of the stats
- `[PREFIX]toggleLogs` - Toggles the logs functionality on or off - `[PREFIX]toggleLogs` - Toggles the logs functionality on or off
### 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.

2
trafficTrackerCog/info.json
View File

@ -6,7 +6,7 @@
"name": "TrafficTracker", "name": "TrafficTracker",
"short": "Tracks daily activity on the server", "short": "Tracks daily activity on the server",
"description": "Tracks incoming and outgoing member activity on the server with daily resets", "description": "Tracks incoming and outgoing member activity on the server with daily resets",
"requirements": ["aiohttp","datetime"], "requirements": ["datetime"],
"tags": [ "tags": [
"Traffic" "Traffic"
] ]

4
welcomeCog/README.md
View File

@ -25,10 +25,6 @@ In order to use our cog you would need to install it onto your instance of [RedB
### Commands ### Commands
- `[PREFIX]welcomepreview` - sends in the chat a preview of the template message - `[PREFIX]welcomepreview` - sends in the chat a preview of the template message
- `[PREFIX]pullmessage` - allows you to pull the latest version of your message without restarting the bot - `[PREFIX]pullmessage` - allows you to pull the latest version of your message without restarting the bot
- `[PREFIX]setchannel` - allows you to select a channel in your discord to dump logs to
- `[PREFIX]stats` - prints the statistics that the cog has gathered.
- `[PREFIX]resetstats` - allows for a hard reset of the stats
- `[PREFIX]toggleLogs` - Toggles the logs functionality on or off
### To modify the sent message: ### To modify the sent message:
If you would like to modify the message to your liking, you can either : If you would like to modify the message to your liking, you can either :