From 9eff93dedc82731858361a8b648011b15c562428 Mon Sep 17 00:00:00 2001 From: overflowerror Date: Tue, 30 Jul 2019 22:28:42 +0200 Subject: [PATCH] Create README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7eead50 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Minecraft Matrix Bridge + +This is a small bukkit plugin I wrote to connect a Minecraft server to a Matrix chat. + +## Build + +Just: +``` +mvn package +``` + +## Deployment + +After building just copy the file `target/matrixbridge-1.0-SNAPSHOT-jar-with-dependencies.jar` (make sure to get file that says "with-dependencies") and copy it into the `plugins` directory of your Minecraft server. + +Rename the configuration file `matrixbridge.properties.template` to `matrixbridge.properties` and change the settings accordingly. Then copy it into the directory of your Minecraft server (not in the plugins folder). +If the file is missing the server will create it for you on the next restart with some default values. + +That should be it. Have fun. : )