Update README.md

This commit is contained in:
floppydiskette 2024-09-05 04:18:36 +01:00
parent 143898753e
commit e7abbd6012
Signed by: fwoppydwisk
SSH key fingerprint: SHA256:Hqn452XQ1ETzUt/FthJu6+OFkS4NBxCv5VQSEvuk7CE

View file

@ -9,3 +9,31 @@ A multipurpose Discord bot written in Java.
### Tested Operating Systems
- macOS 14.4.1
- 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 |