minecraft-discord-webhook

A small, server agnostic, way to push your Minecraft server updates to Discord

This script will push your easily push:

• Server joins and leaves
• Deaths
• Advancements, challenges and goals

to a Discord Webhook easily, with minimal configuration, and without needing server-side mods or plugins such as Spigot, Paper, etc (although it works with those servers as well!), meaning it also works with a vanilla server.

This script works by reading your server log file, parsing and formatting it using Discord rich embeds, and pushing it to the webhook endpoint.

Usage

With Docker

There's an image avaible on Docker Hub!

Docker run

docker run --name minecraft-discord-webhook -v /path/to/server/logs:/app/logs:ro --env WEBHOOK_URL=https://discord.com/api/webhooks/111222333/aaabbbccc --env FOOTER=Optional\ Footer\ Text --env LANGUAGE=en-US saadbruno/minecraft-discord-webhook:latest

Note: FOOTER and LANGUAGE are optional

Docker Compose

version: '3.3'
services:
    minecraft-discord-webhook:
        container_name: minecraft-discord-webhook
        volumes:
            - '/path/to/server/logs:/app/logs:ro'
        environment:
            - 'WEBHOOK_URL=https://discord.com/api/webhooks/111222333/aaabbbccc'
            - 'FOOTER=Optional Footer Text'
            - 'LANGUAGE=en-US'
        image: 'saadbruno/minecraft-discord-webhook:latest'
        restart: unless-stopped

Note: FOOTER and LANGUAGE are optional

Without Docker

• Clone the repo
• run WEBHOOK_URL=<discord webhook> SERVERLOG=</path/to/server/logs> FOOTER=<optional footer> LANGUAGE=<optional language> ./minecraft-discord.webook.sh

Variables

• WEBHOOK_URL: it's the discord webhook you want the notifications posted to. Read more at Discord Support
• LANGUAGE: The language of the notifications. This only supports joins and leaves. Advancements and death messages are posted "as is", meaning they'll be posted using the language of your server. Check the lang directory for currently supported languages. Contributions are welcome!
• FOOTER: An optional footer text that will be included with the notifications, you can put your server name, server address or anything else. You can also ommit this for a more compact notification.
• AVATAR: URL of an image to use as the bot-avatar. Defaults to https://www.minecraft.net/etc.clientlibs/minecraft/clientlibs/main/resources/android-icon-192x192.png
• BOTNAME: Name of the bot in the Discord channel. Defaults to "Minecraft"
• PREVIEW: If set - will also add a preview of the message in the Discord channel

Notes on logs

You have to pass the entire logs diretory path to the script, rather than just the latest.log. This is due to how Docker volumes work. If we're mounting just the latest.log file, when the Minecraft server rotates that log, Docker will not mount the new file automatically.