Document verbose startup argument
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Bea 2022-08-26 16:30:50 +02:00
parent b3429f9203
commit 2443adfccc

View File

@ -5,9 +5,13 @@ Hideko is a general-purpose Discord bot.
## Startup ## Startup
Download a prebuilt JAR file or build it from source, then run it with: Download a prebuilt JAR file or build it from source, then run it with:
```bash ```bash
java -jar HidekoBot.jar botToken java -jar HidekoBot.jar <botToken> [additional parameters]
``` ```
Where `HidekoBot.jar` is the executable archive and `botToken` is your bot token passed as an argument. Where `HidekoBot.jar` is the executable archive and `<botToken>` is your bot token passed as an argument.
Additionally available parameters are:
- **verbose**: log every message that the bot receives. Very spammy and performance heavy.
*Note: Java 16 or later is required.* *Note: Java 16 or later is required.*
## Initial setup ## Initial setup