djmattyg007 / minecraft-telegram-gateway

Bukkit/Spigot plugin integrates Minecraft chat with a Telegram group

minecraft-telegram-gateway

A Bukkit/Spigot plugin that integrates Minecraft chat with a Telegram group.

Setting up

Building

• Install Maven
• Install JDK for java 17 (e.g. OpenJDK 17)
• Run mvn package in the root of this project
• Maven creates a target folder and puts the compiled TelegramGateway.jar there.

Alternatively, run this:

docker run --rm -ti -v "${PWD}:/data" -w /data -u "$(id -u):$(id -g)" maven:3.8-openjdk-17 mvn package

Initial plugin setup

• Copy TelegramGateway.jar to the plugins folder in your Bukkit/Spigot/Paper server
• Run the server (or reload the plugins) and it will create plugins/TelegramGateway/config.yml.
• You will see a warning in the console that Telegram access token is not configured.

Configuring Telegram

• Create the group that you want to use for integrating with Minecraft if it does not exist already.
• Create a Telegram bot for this plugin with BotFather. If you have multiple Minecraft severs that use this plugin, each one will need it's own bot.
  • Suggested name for the bot: the hostname/ip of your Minecraft server
• Add the bot to your group chat.
• Set the privacy mode of your new bot to Disabled. Otherwise the bot will not be able to see messages in the group chat. Say /setprivacy to BotFather.

Configuring this plugin

• Copy–paste the HTTP API access token from BotFather to config.yml.
• Reload the Minecraft server.
• If you have set up everything else, the bot should shout the chat id to the Telegram group.
• Put the chat id to config.yml.
• Reload the Minecraft server.
• It should be good to go now. If you have any trouble, just create a new issue to the issue tracker.

Vision

Most of my philosophy boils down to this: everything should be transparent or loveable. In other words, things should just work and go unnoticed, but when that’s not possible, the noticing should bring joy and delight.

The idea started from the motivation to make playing Minecraft less lonely and not playing Minecraft less fearing-of-missing-out. So, ...

• Maximum integration. It’s not enough that the Minecraft and Telegram chats are linked, it should feel like they are the same chat. Of course, Minecraft and Telegram support a bit different message types, so the integration can’t be perfect. However, both ends should do their best to keep their people in the loop. Minecraft is just one client for Telegram and vice versa.
• Respect conventions. The Telegram side should feel as ”telegrammy” as possible and Minecraft as ”minecrafty” as possible. Furthermore, the bridge should try to bring the ”telegramminess” to Minecraft and the ”minecraftiness” to Telegram. That might sound like repetition but actually each combination brings its own challenges.
• Ease of administration. The gateway should use standard practises where applicable. The plugin should also be robust, even over cool features. This also means assisted setup.
• Zero configuration for participation. You are just playing Minecraft, why would you care about Telegram? Never underestimate the power of laziness. Client-side mods are out of question.
• Simplicity is king. Simplicity over flexibility.

Things I would love to do if they were technically possible

• Custom pixel graphics for all the emojis.
  • Bring Telegram to Minecraft in a Minecraft-y way.
• Possibility to send screenshots directly to Telegram with a press of a key. (”Whoa, this Pillager came out of nowhere!”)
  • Bring Minecraft to Telegram in a Telegram-y way.