2022-08-25 22:54:08 +02:00
|
|
|
# HidekoBot
|
|
|
|
|
|
|
|
|
|
Hideko is a general-purpose Discord bot.
|
|
|
|
|
|
|
|
|
|
## Startup
|
|
|
|
|
Download a prebuilt JAR file or build it from source, then run it with:
|
|
|
|
|
```bash
|
2022-11-22 00:08:19 +01:00
|
|
|
java -jar HidekoBot.jar [additional parameters]
|
2022-08-25 22:54:08 +02:00
|
|
|
```
|
2022-11-22 00:08:19 +01:00
|
|
|
Where `HidekoBot.jar` is the executable archive and `[additional parameters]` are arguments that you can add to
|
|
|
|
|
make the bot change its behavior.
|
2022-08-26 16:30:50 +02:00
|
|
|
|
|
|
|
|
Additionally available parameters are:
|
2022-11-21 14:44:54 +01:00
|
|
|
- **verbose**: log every message that the bot receives, plus additional debugging messages. Very spammy and performance heavy.
|
2022-11-20 18:54:13 +01:00
|
|
|
- **refresh**: force refresh the bot's commands.
|
2022-08-26 16:30:50 +02:00
|
|
|
|
2022-08-25 22:55:03 +02:00
|
|
|
*Note: Java 16 or later is required.*
|
2022-08-25 22:54:08 +02:00
|
|
|
|
|
|
|
|
## Initial setup
|
|
|
|
|
|
2022-11-22 00:08:19 +01:00
|
|
|
Run the startup command once. The bot will generate a `config.yml` file in the directory you were when you ran it.
|
|
|
|
|
|
|
|
|
|
Edit the configuration file and set all values according to your needs.
|
|
|
|
|
|
|
|
|
|
Save the file and start the bot again. If there are no issues, everything will load and it will print an
|
|
|
|
|
invite-link in your console. Click on the link to add your bot to any server with the correct permissions
|
|
|
|
|
already set-up.
|
