Skip to content
/ mctele Public

Telegram bot that notifies when player joins Minecraft server

License

Notifications You must be signed in to change notification settings

chuahou/mctele

Repository files navigation

mctele

License: MIT Build status

A simple Telegram bot that uses the Minecraft Query protocol to get the list of players on a server, and sends changes in the list to a Telegram chat.

Usage

To use, simply run the built executable with the following environment variables set:

  • MCTELE_BOT_TOKEN: Telegram bot token
  • MCTELE_CHAT_ID: Chat ID to send updates to
  • MCTELE_SERVER_ADDR: (optional) Address with port to query (e.g. 192.168.1.1:25565. Defaults to 127.0.0.1:25565.
  • MCTELE_QUERY_INTERVAL: (optional) Interval in seconds between each query to make. Defaults to 15 seconds.
  • MCTELE_KEEP_OLD: (optional) If set, keep old messages when new one is sent. Otherwise, delete the old message.
  • MCTELE_SILENT: (optional) If set, send messages with silent notifications.

Do not forget to set in the server.properties:

enable-query=true
query.port=<something>