doki/README.md

32 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2024-08-26 20:00:46 +00:00
<img src="https://git.frzn.dev/fwoppydwisk/doki/raw/branch/master/assets/logo.svg" alt="" height="100"/>
2024-08-15 16:54:57 +00:00
<hr>
2024-08-26 19:23:49 +00:00
A multipurpose Discord bot written in Java.
2024-08-15 19:20:34 +00:00
2024-08-26 19:23:49 +00:00
## Tested Environments
- Java 21+ (May work on older versions but untested)
2024-08-15 20:45:54 +00:00
- Maven
### Tested Operating Systems
2024-08-16 08:19:48 +00:00
- macOS 14.4.1
2024-09-05 03:18:36 +00:00
- Windows 10 (22H2)
---
## Config file schema
```json
{
"token": "your_token",
2024-10-24 23:43:05 +00:00
"prefix": "oki!"
2024-09-05 03:18:36 +00:00
}
```
---
## Commands
2024-10-24 23:43:05 +00:00
| Command | Description | Arguments | Aliases |
|---------|------------------------------------------------------------------------------|-------------------------------------|---------|
| `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 |
| `mute` | Mutes a member for a specified amount of time | `[user ping]`, `[timeout duration]` | None |