HidekoBot/README.MD

21 lines
754 B
Plaintext
Raw Normal View History

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-08-26 16:30:50 +02:00
java -jar HidekoBot.jar <botToken> [additional parameters]
2022-08-25 22:54:08 +02:00
```
2022-08-26 16:30:50 +02:00
Where `HidekoBot.jar` is the executable archive and `<botToken>` is your bot token passed as an argument.
Additionally available parameters are:
2022-11-20 18:54:13 +01:00
- **verbose**: log every message that the bot receives. Very spammy and performance heavy.
- **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-08-25 22:59:47 +02:00
After successfully starting the bot up, it will print an invite-link in your console. Click on the link to add your bot
2022-08-25 22:54:08 +02:00
to any server with the correct permissions already set-up.