diff options
| -rw-r--r-- | README.md | 41 | ||||
| -rw-r--r-- | package.json | 2 | ||||
| -rw-r--r-- | src/MinecraftHandler.ts | 2 |
3 files changed, 38 insertions, 7 deletions
diff --git a/README.md b/README.md index 5917a3c..68d7555 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,12 @@ ## In Action  +## Features +- Sends message to and from Vanilla Minecraft servers +- Can send messages regarding advancements, when players join and leave, and player deaths +- Allows admins to send commands to Minecraft through Discord + + ## Installation and usage Create a Discord bot here: https://discordapp.com/developers/applications/me @@ -24,15 +30,16 @@ rcon.port=<1-65535> Clone repository onto a server, edit ```config.json``` (see below for more info) and change any options, and then, in the repository folder: ```sh $ yarn -$ yarn start +$ yarn build && yarn start ``` -If you are running this locally, check the `IS_LOCAL_FILE` flag and related options below. Otherwise, perform the following command: +If you are running this locally, enable the `IS_LOCAL_FILE` flag and related options below. Otherwise, perform the following command: On your server hosting (in a screen/tmux session or background process, make sure to replace your `YOUR_URL` with whatever URL you're using (`localhost:8000` if running on the same server and default config) and `PATH_TO_MINECRAFT_SERVER_INSTALL` with the path to the Minecraft server installation, such as `/usr/home/minecraft_server/`): ``` sh tail -F /PATH_TO_MINECRAFT_SERVER_INSTALL/logs/latest.log | grep --line-buffered ": <" | while read x ; do echo -ne $x | curl -X POST -d @- http://YOUR_URL/minecraft/hook ; done ``` +(The above command will also be given to you if you are not using a local file when you start up Shulker) You can also easily Deploy to Heroku and the like, just be sure to edit `YOUR_URL` in the command to match accordingly. @@ -57,25 +64,49 @@ You can also easily Deploy to Heroku and the like, just be sure to edit `YOUR_UR "IS_LOCAL_FILE": false, /* should tail the local file, may be a little buggy. please report any you find */ "LOCAL_FILE_PATH": "/usr/home/minecraft_server/logs/latest.log", /* the path to the local file if specified */ + + "SHOW_INIT_MESSAGE": true, /* Sends the message on boot if not a local file of what command to run */ + "ALLOW_USER_MENTIONS": false, /* should replace @mentions with the mention in discord */ + "ALLOW_HERE_EVERYONE_MENTIONS": false, /* replaces @everyone and @here with "@ everyone" and "@ here" respectively */ + "ALLOW_SLASH_COMMANDS": false, /* whether to allow users to run slash commands from discord */ + "SLASH_COMMAND_ROLES": [], /* if the above is enabled, the names of the roles which can run slash commands */ "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_SERVER_PREFIX": "\\[Server thread/INFO\\]:", /* What the lines of the log should start with */ + "REGEX_MATCH_CHAT_MC": "^<([^>]*)> (.*)", /* 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 */ + "DEBUG": false, /* Dev debugging */ + + "SERVER_NAME" : "Shulker", /* The username used when displaying any server information in chat, e.g., Server - Shulker : Server message here*/ + "SERVER_IMAGE": "", /* Image for the server when sending such messages (if enabled below). Only for WebHooks. */ + "SHOW_PLAYER_CONN_STAT" : false, /* Shows player connection status in chat, e.g., Server - Shulker : TheMachine joined the game */ + "SHOW_PLAYER_ADVANCEMENT" : false, /* Shows when players earn achievements in chat, e.g., Server - Shulker : TheMachine has earned the achievement [MEME - Machine] */ + "SHOW_PLAYER_DEATH" : false, /* Shows when players die in chat, e.g., Server - Shulker : TheMachine was blown up by creeper */ + "SHOW_PLAYER_ME" : false, /* Shows when players use the /me command, e.g. **destruc7i0n** says hello */ + "DEATH_KEY_WORDS" : ["shot", "fell", "etc".] /* Key words to look for when trying to identify a death message. (As of 3/11/2019 this list is up to date) */ } ``` +## FAQ +* How do I make this work on a modded server? + - Try replacing `REGEX_SERVER_PREFIX` with `"\\[Server thread/INFO\\] \\[.*\\]:"` + +* Why can't I send commands even if I have the option enabled? + - Make sure that you have a role on the server which is put in the array `SLASH_COMMAND_ROLES` case-sensitive. + - e.g. `"SLASH_COMMAND_ROLES": ["Admin"],` + ## Upcoming None ## 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! +If you have any suggestions or feature requests, feel free to add an issue and I will take a look. ## 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)) * [SecretOnline](https://github.com/secretonline) for Rcon reconnecting and for making it only send messages in specified channel +* [TheZackCodec](https://github.com/TheZackCodec/) for the updates in server based messages ## License diff --git a/package.json b/package.json index 7da3554..e4b799c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "shulker", - "version": "2.1.0", + "version": "3.0.0", "description": "A Discord to Minecraft Chat Gateway", "main": "build/index.js", "scripts": { diff --git a/src/MinecraftHandler.ts b/src/MinecraftHandler.ts index 79ad81b..aa4f2f7 100644 --- a/src/MinecraftHandler.ts +++ b/src/MinecraftHandler.ts @@ -149,7 +149,7 @@ class MinecraftHandler { console.log('[INFO] Please enter the following command on your server running the Minecraft server.') console.log(' Replace "PATH_TO_MINECRAFT_SERVER_INSTALL" with the path to your Minecraft server install') console.log(' and "YOUR_URL" with the URL/IP of the server running Shulker!') - console.log(` \`tail -F /PATH_TO_MINECRAFT_SERVER_INSTALL/logs/latest.log | grep --line-buffered "${this.config.REGEX_SERVER_PREFIX}" | while read x ; do echo -ne $x | curl -X POST -d @- http://YOUR_URL:${port}${this.config.WEBHOOK} ; done\``) + console.log(` \`tail -F /PATH_TO_MINECRAFT_SERVER_INSTALL/logs/latest.log | grep --line-buffered ": <" | while read x ; do echo -ne $x | curl -X POST -d @- http://YOUR_URL:${port}${this.config.WEBHOOK} ; done\``) } }) } |