paper-telegram-bridge

Paper telegram bridge

A fork from spigot-tg-bridge with some new features. Also available on modrinth.

This plugin will send chat messages from Minecraft to Telegram, and from Telegram to Minecraft.

How to use:

1. Download .jar file and put it in plugins/ directory on your server OR clone this repo and run gradle inside repo's directory.

2. If you already have telegram bot, skip this step. Otherwise, create it through BotFather. You'll go through step-by-step instructions, give a bot username and most importantly, obtain a bot token. Save this token for future use. Note: in order to make your bot hear raw text messages (not commands), you must disable privacy mode option which is on by default. Go through bot's settings: Bot Settings -> Group Privacy and click Turn Off.

3. Next, you need to tell plugin about your new bot. You can either:

   • Run Paper server, plugin will log "No config file found! Saving default one.". After that, stop server and proceed to 4th step.
   • Copy config.yml to plugins/PaperTelegramBridge/ in your server directory.

4. A config.yml is just a valid YAML file, alternative for JSON, but more human-readable. Now, take bot's token which you got in 2nd step and paste them into config.yml, so it looks like this:

   botToken: abcdefghijklmnopq123123123
   # other configuration values...
   

5. Run Paper server.

6. Add you bot to chats, where you plan to use it. In each of them, run /chat_id command. The bot should respond and give special value - chat id. Now, open config.yml and paste this ID under chats section, so it will look like this:

   botToken: abcdefghijklmnopq123123123
   chats: [
       -123456789,
       987654321,
       # other chat id's...
     ]
   

7. (Optional) To enable admin commands like /whitelist, you need to add Telegram user IDs to the admins list in config.yml.

   admins: [
       123456789,
       987654321,
       # other admin user ids...
     ]
   

8. You can extend config.yml with more tweaks, which are described in the table below, but it's not necessary, plugin will use default values instead, if they're missing. Also, check out the example.

9. Re-run server or type tgbridge_reload into server's console.

Plugin configuration:

Telegram bot commands:

Commands are customizable through config. If command doesn't exist in config, it will be disabled

Format string:

+--------+ >--minecraftMessageFormat(message)-> +--------------+
| Paper |                                      | Telegram bot |
+--------+ <--telegramMessageFormat(message)--< +--------------+

Applies to telegramMessageFormat and minecraftMessageFormat configurations. Must contain %username% and %message% inside. You can customize message color with it (coloring works only for telegramMessageFormat). You can customize bold/italics/strikethrough formatting (works only for minecraftMessageFormat). See Minecraft message color codes and Telegram message formatting for more information. This feature is related to this issue

Plugin commands:

Permissions

Inventory

Similar behavior as InteractiveChat plugin (not a dependency!). Commands implemented:

• [inv]
• [item]
• [ender]

Whitelist Management

Server admins can manage the whitelist directly from Telegram using the /whitelist command:

• /whitelist - List all whitelisted players
• /whitelist <player_name> - Toggle whitelist status for a player (add if not whitelisted, remove if already whitelisted)

This command is only available to users listed in the admins configuration field. The plugin will also send notifications when players try to join but are kicked due to not being whitelisted (configurable via logWhitelistKick).

Minecraft assets

In this repository won't include the minecraft icons required to build the plugin for the inventory and advancements rendering features. This icons can be generated using the mod IconExporter and running in-game this command:

/iconexporter export 64

Some icons, like potions, require renaming. The resulting .png files need to be placed src/main/resources/textures.