https://github.com/phase/ore-shulker
Shulker fork for ORE
https://github.com/phase/ore-shulker
Last synced: 5 months ago
JSON representation
Shulker fork for ORE
- Host: GitHub
- URL: https://github.com/phase/ore-shulker
- Owner: phase
- License: isc
- Created: 2016-01-15T06:31:01.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-01-15T06:31:03.000Z (about 10 years ago)
- Last Synced: 2025-03-18T19:55:10.391Z (12 months ago)
- Language: JavaScript
- Homepage: http://openredstone.org
- Size: 18.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# shulker
[](https://david-dm.org/destruc7i0n/shulker)
[](https://travis-ci.org/destruc7i0n/shulker)
[](https://circleci.com/gh/destruc7i0n/shulker)
> Connects [Discord](https://discordapp.com/) and [Minecraft](https://minecraft.net) 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=
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):
``` sh
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:
```sh
$ npm install
$ npm start
```
You can also easily Deploy to Heroku or Bluemix.
[](https://heroku.com/deploy)
[](https://bluemix.net/deploy?repository=https://github.com/destruc7i0n/shulker)
### Configuration
```js
{
"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": "", /* 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:
```bash
$ 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](https://github.com/hydrabolt) for discord.js
* [qrush](https://github.com/qrush) for the idea of this ([wither](https://github.com/qrush/wither))
## License
ISC. See `LICENSE`.