Aurailus
/
k9
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add Badges

master
Nicole Collings 2019-08-21 15:39:01 -07:00
parent e8dc998d1e
commit 4543394882
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,11 +1,15 @@
# k9
[![Codacy Rating](https://img.shields.io/codacy/grade/a3bc75897a9c4553a320b2745a8f7f9f.svg?logo=codacy)](https://app.codacy.com/app/Aurailus/Zeus_cpp?utm_source=github.com&utm_medium=referral&utm_content=Aurailus/Zeus_cpp&utm_campaign=Badge_Grade_Settings)
[![Discord Badge](https://img.shields.io/discord/416379773976051712.svg?color=7289DA&label=discord&logo=discord&logoColor=white)](https://discord.gg/sT7APUG)
[![GitHub Commit](https://img.shields.io/github/commit-activity/m/aurailus/k9.svg?logo=github&label=commit%20activity)](https://github.com/Aurailus/k9/commits/master)
k9 is a minimalist level tracker bot for discord, used in Auri's Den. It tracks user's post frequency in a persistent database, assigning XP to posts which contributes to a total user level. The user level is used to apply custom roles to active users.
**Copyright 2019 Nicole Collings**
[Official Discord Server](https://discord.gg/sT7APUG)
k9 is a minimalist level tracker bot for discord, used in Auri's Den. It tracks user's post frequency in a persistent database, assigning XP to posts which contributes to a total user level. The user level is used to apply custom roles to active users.
## Dependencies
* NodeJS 6+
* NPM
@ -15,7 +19,7 @@ k9 is a minimalist level tracker bot for discord, used in Auri's Den. It tracks
2) Install node dependencies: `npm install`
3) Create `data/conf.json` and `data/db.json` files.
4) Put valid discord token and other configuration details in `data/conf.json`.
5) Run the bot `npm start`
5) Run the bot: `npm start`
## Configuration
To allow the bot to start and track levels, it needs some configuration information, which goes in `data/conf.json`. An example of the parameters required is below.
@ -23,11 +27,11 @@ To allow the bot to start and track levels, it needs some configuration informat
**Example:**
```json
{
"token": "VALID_DISCORD_TOKEN",
"xp_properties": {
"level_base_cost": 15,
"level_multiplier": 0.4
}
"token": "VALID_DISCORD_TOKEN",
"xp_properties": {
"level_base_cost": 15,
"level_multiplier": 0.4
}
}
```
@ -45,7 +49,7 @@ In the future, role rewards will be configured within the bot. As of now to set
"10": "role_id_for_level_10",
...
},
...
...
```
The key is the level which the role applies to, the value is the **role id** (found by right clicking the role in the Server Settings and pressing `Copy ID` with developer mode enabled.)