fwoppydwisk/doki
fwoppydwisk/doki
1
1
Fork 0
Code Issues Pull requests Projects Releases 9 Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
floppydiskette 2024-11-30 16:15:52 +00:00
parent 9f784d83eb
commit cf947432bb
Signed by: fwoppydwisk
SSH key fingerprint: SHA256:Hqn452XQ1ETzUt/FthJu6+OFkS4NBxCv5VQSEvuk7CE
1 changed files with 13 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -7,13 +7,14 @@
<br>
A multipurpose Discord bot written in Java.
## Tested Environments
- Java 21+ (May work on older versions but untested)
## Required Environment
- Java 17+ (May work on older versions but untested)
- Maven
### Tested Operating Systems
- macOS 14.4.1
- Windows 10 (22H2)
- macOS 14 & 15 (arm64)
- Windows 10 22H2 (x86_64)
- Debian 12 (x86_64)
---
@ -28,9 +29,11 @@ A multipurpose Discord bot written in Java.
## Commands
| 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 |
| Command | Description | Arguments |
|-------------------|------------------------------------------------------------------------------|-----------------------------------------------------------|
| `/ping` | Gets the bot's gateway & rest ping | None |
| `/whois` | Gets information about the specified user (message author if none specified) | `[member]` |
| `/timeout set` | Times out a member for a specified amount of time | `[member]`, `[duration]`, `(reason)` |
| `/timeout get` | Gets the current timeout status of the specified member | `[member]` |
| `/timeout cancel` | Cancels the specified users timeout | `[member]`, `(reason)` |
| `/poll` | Creates a poll | `[title]`, `[duration]`, `[options]`, `(multiple-choice)` |