diff options
Diffstat (limited to '')
| -rw-r--r-- | README.md | 45 |
1 files changed, 25 insertions, 20 deletions
diff --git a/README.md b/README.md index a03ba9d..08594dd 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,19 @@ > Connects [Discord](https://discordapp.com/) and [Minecraft](https://minecraft.net) Servers by sending messages back and forth without any mods or plugins. -## Notice -This project has recently gone under a rewrite and the format for `config.json` is not directly backwards compatible with previous versions. -See [below](#upgrade-instructions) for details. - ## In Action  ## Features - Sends message to and from Vanilla Minecraft servers - Can send messages regarding advancements, when players join and leave, and player deaths +- Can be run on a remote machine or locally on the same machine (see `IS_LOCAL_FILE` in the options below) - Allows admins to send commands to Minecraft through Discord ## Installation and usage +Ensure you have Node v16.6+ installed. You can check the version you have installed with `node -v` in your terminal or command prompt. + Create a Discord bot here: https://discordapp.com/developers/applications/me Then, add the bot to your Discord server using the following link, replace the Client ID with that of your bot. @@ -30,11 +29,13 @@ rcon.password=<your password> rcon.port=<1-65535> ``` -Clone repository onto a server, edit ```config.json``` (see below for more info) and change any options. +Clone repository onto a server, copy ```config.example.json``` to ```config.json```, and edit it to enter your Discord bot details and to change any options (see below for details on the config file). + Then, in the repository folder: ```sh -$ yarn -$ yarn build && yarn start +yarn # or npm install +yarn build # or npm run build +yarn start # or npm run start ``` If you are running this on the same server as the MC server, enable the `IS_LOCAL_FILE` flag and update related options below. @@ -43,35 +44,34 @@ Otherwise, perform the following command on the server hosting (in a screen/tmux ``` 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. - -[](https://heroku.com/deploy) - +(The above command will also be given to you if you are not using a local file when you first start up Shulker) ### Configuration ```js { "PORT": 8000, /* Port you want to run the webserver for the hook on */ + "DEBUG": false, /* Dev debugging */ - "USE_WEBHOOKS": true, /* If you want to use snazzy webhooks */ + "USE_WEBHOOKS": true, /* If you want to use webhooks rather than the Discord bot sending the messages (recommended) */ "WEBHOOK_URL": "DISCORD_WEBHOOK_URL_HERE", /* Be sure to create a webhook in the channel settings and place it here! */ + "IGNORE_WEBHOOKS": true, /* Ignore any messages that are sent by webhooks. If disabled, then all webhooks but those sent from the configured webhook will be handled as well */ + "DISCORD_TOKEN": "<12345>", /* Discord bot token. [Click here](https://discordapp.com/developers/applications/me) to create you application and add a bot to it. */ "DISCORD_CHANNEL_ID": "<channel>", /* Discord channel ID for for the discord bot. Enable developer mode in your Discord client, then right click channel and select "Copy ID". */ "DISCORD_CHANNEL_NAME": "#<channel name>" /* The Discord channel name. It is recommended to use the ID if the bot is in multiple servers. The ID will take precedence. */ "DISCORD_MESSAGE_TEMPLATE": "`%username%`:%message%", /* Message template to display in Discord */ - + "MINECRAFT_SERVER_RCON_IP": "127.0.0.1", /* 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 */ "MINECRAFT_TELLRAW_TEMPLATE": "[{\"color\": \"white\", \"text\": \"<%username%> %message%\"}]", /* Tellraw template to display in Minecraft */ "MINECRAFT_TELLRAW_DOESNT_EXIST": false, /* Minecraft doesn't have the tellraw command (<1.7.2), use say instead. !this may be dangerous! */ "MINECRAFT_TELLRAW_DOESNT_EXIST_SAY_TEMPLATE": "<%username%> %message%", /* used when MINECRAFT_TELLRAW_DOESNT_EXIST is set to true. say template to display on minecraft, same as MINECRAFT_TELLRAW_TEMPLATE. */ - - "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 */ + + "IS_LOCAL_FILE": true, /* tail the local file specified at `LOCAL_FILE_PATH` */ + "LOCAL_FILE_PATH": "/usr/home/minecraft_server/logs/latest.log", /* the path to the local file if `IS_LOCAL_FILE` is set */ + "FS_WATCH_FILE": false, /* use node's watchFile rather than watch. see FAQ for more details */ "SHOW_INIT_MESSAGE": true, /* Sends the message on boot if not a local file of what command to run */ @@ -85,11 +85,12 @@ You can also easily Deploy to Heroku and the like, just be sure to edit `YOUR_UR "REGEX_MATCH_CHAT_MC": "^<([^>]*)> (.*)", /* What to match for chat (best to leave as default) */ "REGEX_DEATH_MESSAGE": "^[\w_]+ (died|...)", /* What to match for death messages (best leave this default too) */ "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 */ "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_SERVER_STATUS: false, /* Shows when the server turns on and off e.g., Server - Shulker : Server is online */ + "HEAD_IMAGE_URL": "https://mc-heads.net/avatar/%uuid%/256", /* Url to get the heads for the webhook, %uuid% is replaced with the uuid of the player */ + "DEFAULT_PLAYER_HEAD": "c06f89064c8a49119c29ea1dbd1aab82", /* UUID of player with the default head to use (currently is MHF_Steve) */ + "SHOW_SERVER_STATUS": false, /* Shows when the server turns on and off e.g., Server - Shulker : Server is online */ "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 advancements in chat, e.g., Server - Shulker : TheMachine has made the advacement [MEME - Machine] */ "SHOW_PLAYER_DEATH": false, /* Shows when players die in chat, e.g., Server - Shulker : TheMachine was blown up by creeper */ @@ -105,6 +106,10 @@ You can also easily Deploy to Heroku and the like, just be sure to edit `YOUR_UR - 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"]` +* I am using a local file and no messages are being sent! + - Enable `DEBUG` in the config to check for any errors. + - If you are on Windows, try enabling `FS_WATCH_FILE`. + ## Upgrade Instructions From version 2 to version 3: - The main change is that you need to split your `REGEX_MATCH_CHAT_MC` to both `REGEX_MATCH_CHAT_MC` and `REGEX_SERVER_PREFIX`. |