shulker

Connects Discord and Minecraft Servers by sending messages back and forth without any mods or plugins.

In Action

Installation and usage

In your Minecraft server.properties, make sure you have:

enable-rcon=true
rcon.password=<your password>
rcon.port=<1-65535>

Run the following on your server hosting (in a screen, and make sure to replace your URL and your log directory location):

tail -F /PATH_TO_MINECRAFT_INSTALL/logs/latest.log | grep --line-buffered ": <" | while read x ; do echo -ne $x | curl -X POST -d @- https://YOUR_URL/minecraft/hook ; done

Clone repository onto a server, edit config.json (see below for more info) and change any options, and then, in the repository folder:

$ npm install
$ npm start

You can also easily Deploy to Heroku or Bluemix.

Configuration

{
    "PORT": 8000, /* Port you want to run the webserver for the hook on */
    "DISCORD_EMAIL": "example@example.com", /* discord email */
    "DISCORD_PASSWORD": "password123", /* discord password */
    "DISCORD_CHANNEL": "general", /* channel for discord bot */
    "MINECRAFT_SERVER_RCON_IP": "example.com", /* minecraft server ip (make sure you have enabled rcon) */
    "MINECRAFT_SERVER_RCON_PORT": <1-65535>, /* minecraft server rcon port */
    "MINECRAFT_SERVER_RCON_PASSWORD": "<your password>", /* minecraft server rcon password */
    "WEBHOOK": "/minecraft/hook", /* web hook, where to send the log to */
    "REGEX_MATCH_CHAT_MC": "\\[Server thread/INFO\\]: <(.*)> (.*)", /* what to match for chat (best to leave as default) */
    "REGEX_IGNORED_CHAT": "packets too frequently", /* what to ignore, you can put any regex for swear words for example and it will  be ignored */
    "DEBUG": false /* dev debugging */
}

Tests

Run the tests with:

$ npm test

Upcoming

• A "merge accounts" function to allow Minecraft players to associate their Discord accounts with their Minecraft accounts so that usernames are accurate
• Ability to post messages to Discord on behalf of Discord users, rather than using a bot user (hopefully after the official API is released)

Suggestions

If you have any suggestions or feature requests, feel free to add an issue and I will take a look and possibly add it to the "Upcoming" section!

Thanks

• hydrabolt for discord.js
• qrush for the idea of this (wither)

License

ISC. See LICENSE.