A friendly general-purpose Discord bot

Go to file

Beatrice Dellacà f5a8c2af48 Mitigate potential RCE from SnakeYaml (CVE-2022-1471) This vulnerability is very unlikely to ever happen, since the only way to modify the YAML file is to edit it yourself, and it would be useless for a bot owner to RCE their own bot. No other person can edit the configuration file remotely (eg. with bot commands), so realistically, this could not happen.		2022-12-28 05:41:23 +01:00
src/main	Mitigate potential RCE from SnakeYaml (CVE-2022-1471)	2022-12-28 05:41:23 +01:00
.drone.yml	Enable JavaDocs generation in Drone CI	2022-08-26 16:27:04 +02:00
.gitignore	Ignore SQLite database	2022-11-21 00:28:29 +01:00
pom.xml	Mitigate potential RCE from SnakeYaml (CVE-2022-1471)	2022-12-28 05:41:23 +01:00
README.MD	Update README with new bot startup guide	2022-11-22 00:08:19 +01:00

README.MD

HidekoBot

Hideko is a general-purpose Discord bot.

Startup

Download a prebuilt JAR file or build it from source, then run it with:

java -jar HidekoBot.jar [additional parameters]

Where HidekoBot.jar is the executable archive and [additional parameters] are arguments that you can add to make the bot change its behavior.

Additionally available parameters are:

verbose: log every message that the bot receives, plus additional debugging messages. Very spammy and performance heavy.
refresh: force refresh the bot's commands.

Note: Java 16 or later is required.

Initial setup

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.