2023-01-15 01:04:55 +01:00
# HidekoBot
2023-01-16 00:33:52 +01:00
[](https://sonar.beatrice.wtf/dashboard?id=HidekoBot_AYWyYHsvX-1Ma0D4pJ59)
[](https://sonar.beatrice.wtf/dashboard?id=HidekoBot_AYWyYHsvX-1Ma0D4pJ59)
[](https://sonar.beatrice.wtf/dashboard?id=HidekoBot_AYWyYHsvX-1Ma0D4pJ59)
[](https://drone.beatrice.wtf/bea/HidekoBot)
[](https://sonar.beatrice.wtf/dashboard?id=HidekoBot_AYWyYHsvX-1Ma0D4pJ59)
2022-08-25 22:54:08 +02:00
2023-01-16 00:33:52 +01:00
Hideko is a general-purpose Discord bot.
2023-01-15 22:08:45 +01:00
## Download
The latest stable version is always uploaded automatically to the [Maven repository](https://nexus.beatrice.wtf/#browse/browse:maven-releases:wtf%2Fbeatrice%2Fhidekobot%2FHidekoBot).
You can download the JAR directly by clicking [here](https://nexus.beatrice.wtf/service/rest/v1/search/assets/download?sort=version&repository=maven-releases&maven.groupId=wtf.beatrice.hidekobot&maven.artifactId=HidekoBot&maven.extension=jar).
2022-08-25 22:54:08 +02:00
## 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-12-28 05:25:44 +01:00
- **refresh**: force refresh the slash commands. This is useful in case there was a simple update to a command that did not drastically change it, so no changes are found at bootup (eg: fixing a typo in the command description).
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
2023-01-15 22:14:08 +01:00
Run the startup command once. The bot will generate a `config.yml` file in your current directory (`$PWD` on GNU/Linux).
2022-11-22 00:08:19 +01:00
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
2022-12-28 05:25:44 +01:00
already set-up. The bot supports both slash commands and message commands, with prefix `hideko`. Most
2022-12-28 05:27:16 +01:00
commands support both systems, but some of them are limited in one way or another.
The bot currently supports SQLite as a database backend. A database file will be created after the first boot
2023-01-15 22:14:08 +01:00
in your current directory. Do not delete the database file to avoid corruption and unpredictable
2023-01-15 23:02:13 +01:00
behavior.
# Development
## Versioning
This project uses the `x.y.z-releaseType` schema for releases.
Development builds are tagged as `x.y.z-SNAPSHOT` and sometimes pushed to the snapshots Maven repository.
Stable builds are tagged as `x.y.z` and always pushed to the releases Maven repository, by promoting the build on
[Drone](https://drone.beatrice.wtf/). Currently, promoting stable builds is a manual process.
