Allow specification of the channel name rather than id

5 files changed, 44 insertions, 10 deletions

diff --git a/README.md b/README.md
index 3cd1a99..64abf69 100644
--- a/README.md
+++ b/README.md
@@ -26,14 +26,15 @@ 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, and then, in the repository folder:
+Clone repository onto a server, edit ```config.json``` (see below for more info) and change any options.
+Then, in the repository folder:
 ```sh
 $ yarn
 $ yarn build && yarn start
 ```
 
-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/`):
+If you are running this on the same server as the MC server, enable the `IS_LOCAL_FILE` flag and update related options below.
+Otherwise, perform the following command on the 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
@@ -54,6 +55,7 @@ You can also easily Deploy to Heroku and the like, just be sure to edit `YOUR_UR
     "WEBHOOK_URL": "DISCORD_WEBHOOK_URL_HERE", /* Be sure to create a webhook in the channel settings and place it here! */
     "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) */
diff --git a/config.json b/config.json
index 2179402..43d7140 100644
--- a/config.json
+++ b/config.json
@@ -4,7 +4,8 @@
     "USE_WEBHOOKS": true,
     "WEBHOOK_URL": "DISCORD_WEBHOOK_URL_HERE",
     "DISCORD_TOKEN": "TOKEN_HERE",
-    "DISCORD_CHANNEL_ID": "1234",
+    "DISCORD_CHANNEL_ID": "",
+    "DISCORD_CHANNEL_NAME": "#bot",
     "DISCORD_MESSAGE_TEMPLATE": "`%username%`: %message%",
 
     "MINECRAFT_SERVER_RCON_IP": "127.0.0.1",
diff --git a/src/Config.ts b/src/Config.ts
index 77fefd2..ce59ed2 100644
--- a/src/Config.ts
+++ b/src/Config.ts
@@ -5,6 +5,7 @@ export interface Config {
   WEBHOOK_URL: string
   DISCORD_TOKEN: string
   DISCORD_CHANNEL_ID: string
+  DISCORD_CHANNEL_NAME: string
   DISCORD_MESSAGE_TEMPLATE: string
 
   MINECRAFT_SERVER_RCON_IP: string
diff --git a/src/Discord.ts b/src/Discord.ts
index a0a3498..97722c2 100644
--- a/src/Discord.ts
+++ b/src/Discord.ts
@@ -1,4 +1,4 @@
-import { Client, Message, TextChannel } from 'discord.js'
+import {Client, Message, Snowflake, TextChannel} from 'discord.js'
 
 import emojiStrip from 'emoji-strip'
 import axios from 'axios'
@@ -11,26 +11,47 @@ class Discord {
   config: Config
   client: Client
 
+  channel: Snowflake
+
   constructor (config: Config, onReady?: () => void) {
     this.config = config
 
     this.client = new Client()
     if (onReady) this.client.once('ready', () => onReady())
     this.client.on('message', (message: Message) => this.onMessage(message))
+
+    this.channel = config.DISCORD_CHANNEL_ID || ''
   }
 
-  async init () {
+  public async init () {
     try {
       await this.client.login(this.config.DISCORD_TOKEN)
+      if (this.config.DISCORD_CHANNEL_NAME) this.getChannelIdFromName(this.config.DISCORD_CHANNEL_NAME)
     } catch (e) {
       console.log('[ERROR] Could not authenticate with Discord: ' + e)
       if (this.config.DEBUG) console.error(e)
     }
   }
 
+  private getChannelIdFromName (name: string) {
+    // remove the # if there is one
+    if (name.startsWith('#')) name = name.substring(1, name.length)
+    // @ts-ignore
+    const channel: TextChannel = this.client.channels.find((c: TextChannel) => c.type === 'text' && c.name === name && !c.deleted)
+    if (channel) {
+      this.channel = channel.id
+      console.log(`[INFO] Found channel #${channel.name} (id: ${channel.id}) in the server "${channel.guild.name}"`)
+    } else {
+      console.log(`[INFO] Could not find channel ${name}! Check that the name is correct or use the ID of the channel instead (DISCORD_CHANNEL_ID)!`)
+      process.exit(1)
+    }
+  }
+
   private async onMessage (message: Message) {
+    // no channel, done
+    if (!this.channel) return
     // don't want to check other channels
-    if (message.channel.id !== this.config.DISCORD_CHANNEL_ID || message.channel.type !== 'text') return
+    if (message.channel.id !== this.channel || message.channel.type !== 'text') return
     // if using webhooks, ignore this!
     if (this.config.USE_WEBHOOKS && message.webhookID) return
     // if the same user as the bot, ignore
diff --git a/src/MinecraftHandler.ts b/src/MinecraftHandler.ts
index 20bccf5..0e4e5d7 100644
--- a/src/MinecraftHandler.ts
+++ b/src/MinecraftHandler.ts
@@ -44,8 +44,10 @@ class MinecraftHandler {
     const logLineData = data.match(logLineDataRegex)
 
     if (!logLineDataRegex.test(data) || !logLineData) {
-      console.log('[ERROR] Regex could not match the string! Please verify it is correct!')
-      console.log('Received: "' + data + '", Regex matches lines that start with: "' + this.config.REGEX_SERVER_PREFIX + '"')
+      if (this.config.DEBUG) {
+        console.log('[DEBUG] Regex could not match the string:')
+        console.log('Received: "' + data + '", Regex matches lines that start with: "' + this.config.REGEX_SERVER_PREFIX + '"')
+      }
       return null
     }
 
@@ -164,7 +166,14 @@ class MinecraftHandler {
 
         mcPath = (defaultPath ? '/' : '') + path.join(mcPath, '/logs/latest.log')
 
-        console.log(`  \`tail -F ${mcPath} | grep --line-buffered ": <" | while read x ; do echo -ne $x | curl -X POST -d @- http://${url}:${port}${this.config.WEBHOOK} ; done\``)
+        let grepMatch = ': <'
+        if (this.config.SHOW_PLAYER_DEATH || this.config.SHOW_PLAYER_ME || this.config.SHOW_PLAYER_ADVANCEMENT || this.config.SHOW_PLAYER_CONN_STAT) {
+          grepMatch = this.config.REGEX_SERVER_PREFIX
+        }
+        console.log(`  \`tail -F ${mcPath} | grep --line-buffered "${grepMatch}" | while read x ; do echo -ne $x | curl -X POST -d @- http://${url}:${port}${this.config.WEBHOOK} ; done\``)
+        if (grepMatch !== ': <') {
+          console.log('       Please note that the above command can send a lot of requests to the server. Disable the non-text messages (such as "SHOW_PLAYER_CONN_STAT") to reduce this if necessary.')
+        }
       }
     })
   }