Update README.md
This commit is contained in:
parent
143898753e
commit
e7abbd6012
1 changed files with 29 additions and 1 deletions
30
README.md
30
README.md
|
@ -8,4 +8,32 @@ A multipurpose Discord bot written in Java.
|
||||||
|
|
||||||
### Tested Operating Systems
|
### Tested Operating Systems
|
||||||
- macOS 14.4.1
|
- macOS 14.4.1
|
||||||
- Windows 10 (22H2)
|
- Windows 10 (22H2)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Config file schema
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"token": "your_token",
|
||||||
|
"prefix": "oki!",
|
||||||
|
"mariadb": {
|
||||||
|
"host": "127.0.0.1",
|
||||||
|
"user": "db_user",
|
||||||
|
"password": "db_password",
|
||||||
|
"database": "doki_prod"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
| Command | Description | Arguments | Aliases |
|
||||||
|
|---------------|------------------------------------------------------------------------------|---------------|---------|
|
||||||
|
| `leaderboard` | Gets the leaderboard for the current guild | None | `lb` |
|
||||||
|
| `rank` | Gets the rank of the specified user (message author if none specified) | `[user ping]` | None |
|
||||||
|
| `about` | Gets information about the bot | None | None |
|
||||||
|
| `ping` | Gets the bot's gateway & rest ping | None | None |
|
||||||
|
| `whois` | Gets information about the specified user (message author if none specified) | `[user ping]` | None |
|
Loading…
Reference in a new issue