Create README.md

This commit is contained in:
overflowerror 2019-07-30 22:28:42 +02:00 committed by GitHub
parent 60f9bd70ec
commit 9eff93dedc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

19
README.md Normal file
View file

@ -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. : )