An open API service indexing awesome lists of open source software.

https://github.com/enginehub/enginehub-bot

EngineHub Bot - Discord bot to make software support slightly more tolerable
https://github.com/enginehub/enginehub-bot

bot discord discord-bot enginehub gradle java moderation support

Last synced: 7 months ago
JSON representation

EngineHub Bot - Discord bot to make software support slightly more tolerable

Awesome Lists containing this project

README

          

EngineHub Bot
=============
EngineHub Bot is the Discord bot to assist in moderating and providing support in the EngineHub Discord.

Downloading
-----------
The bot can be downloaded from EngineHub's CI: [![TeamCity build status](https://ci.enginehub.org/app/rest/builds/buildType:id:EngineHubBot_EngineHubBotBuild/statusIcon.svg)](https://ci.enginehub.org/buildConfiguration/EngineHubBot_EngineHubBotBuild)

Compiling
---------
The project is written for Java 19 and our build process makes use of [Gradle](http://gradle.org/).
simply run:

gradlew build

Dependencies are automatically handled by Gradle.

Running
-------
The main class is `org.enginehub.discord.EngineHubBot`.

The following is an example script, that will automatically update the bot during the automated restart.

```bash
#!/bin/bash

while true
do
wget --timestamping https://ci.enginehub.org/guestAuth/app/rest/builds/buildType:EngineHubBot_EngineHubBotBuild,count:1,branch:master,status:SUCCESS/artifacts/content/EngineHubBot-1.0-SNAPSHOT.jar -O Me4Bot.jar
java -cp EngineHub-Bot.jar org.enginehub.discord.EngineHubBot
sleep 10
done
```

Configuring
-----------
Upon initial startup, the program will generate multiple configuration files.
The most important setting to modify is `token` in `settings.conf`.
This should be set to a Discord bot token, obtainable from the Discord website.

Contributing
------------
We happily accept contributions. The best way to do this is to fork the project
on GitHub, add your changes, and then submit a pull request. We'll look at it,
make comments, and merge it into the project if everything works out.

In addition, please ensure your code is compliant with the [Google Java
Conventions](https://google.github.io/styleguide/javaguide.html) to keep things neat and readable.

By submitting code, you agree to place to license your code under the [GPL License](https://raw.githubusercontent.com/EngineHub/EngineHub-Bot/master/LICENSE.txt).