DerpBot

DerpBot is a multi-purpose Matrix/IRC bot.

Dependencies:

• Maven (For building from sources)
• JDK17 (For building from sources, JRE17 enough for just running the built JAR)

Building

Execute

mvn clean package

Docker

DerpBot can be built and run using docker.

Building using Docker:

docker build .

An example docker-compose (docker-compose.example.yml) is provided as a base for using docker-compose to run DerpBot. Create your compose-file and build DerpBot using:

docker-compose build

And run it with:

docker-compose docker-compose up -d

/derpbot/config is the location for config-files when using Docker. DerpBot can be combined with Pantalaimon (https://github.com/matrix-org/pantalaimon/) to support channels using end-to-end encryption in Matrix.

"Installation"

• Create directory /opt/derpbot/ and place the built JAR file as /opt/derpbot/DerpBot.jar
• Create a configuration file as /opt/derpbot/derpbot.properties (see derpbot.properties.example for reference)
• Create a (system)user for DerpBot:

useradd -s /bin/false -r -M -d /opt/derpbot derpbot

• The initscript contains a sysvinit initscript, copy it as /etc/init.d/derpbot and execute

update-rc.d derpbot defaults

Note: DerpBot will look for derpbot.properties configuration file in the directory where the JAR file itself is, and one directory above that. This means, during development, you can have your local derpbot.properties file in the "root" of the project and execute the JAR directly from the Maven target directory.

Running

For "installed" version:

service derpbot start

For built version (while in the "root" of the project):

java -jar target/DerpBot.jar

Easily compile and run while developing:

mvn compile exec:java

Developing additional features

The basic concept of creating a new feature is to create a new class under fi.derpnet.derpbot.handler.impl and implement one of the following interfaces (which ever suits your needs best), and add the class to HandlerRegistry. (This could be replaced with some sort of dynamic scanning of the classpath for compatible interfaces...)

• RawMessageHandler - handles any RAW message that comes from the Matrix/IRC server
• SimpleMessageHandler - handles regular PRIVMSG messages (both on channels and in queries and sends a single-line response
• SimpleMultiLineMessageHandler - same as above but is capable of sending multiple lines of response