spigot-tg-bridge/README.md

2.2 KiB

Spigot <-> Telegram bridge plugin

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

How to use:

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

  2. Choose one of below to configure plugin:

    1. Run Spigot server, plugin will log "No config file found! Saving default one.". After that, stop server and proceed to 3rd step.

    OR

    1. Copy config.yml to plugins/SpigotTGBridge/ in your server directory.
  3. Modify plugins/SpigotTGBridge/config.yml with text editor, where each field is described in table below.

  4. Run server.

config.yml:

Field Description Type Required Default
botToken Telegram bot token (How to create bot) string ✔️ -
botUsername Telegram bot username string ✔️ -
chats Chats, where bot will work (to prevent using bot by unknown chats) number[] ✔️ []
serverStartMessage What will be sent to chats when server starts string 'Server started.'
serverStopMessage What will be sent to chats when server stops string 'Server stopped.'
logJoinLeave If true, plugin will send corresponding messages to chats, when player joins or leaves server boolean true
logFromMCtoTG If true, plugin will send messages from players on server, to Telegram chats boolean true
logFromTGtoMC If true, plugin will send messages from chats, to Minecraft server boolean true
strings Dictionary of tokens - strings for plugin i18n Map<string, string> See default config

Commands:

Command Description
/online Get players, currently online
/time Get time on server