amalthea-mc/spigot-tg-bridge
1
0
Fork 0
mirror of https://github.com/amalthea-mc/spigot-tg-bridge.git synced 2024-11-08 19:51:04 +00:00
Code Issues Projects Releases Wiki Activity
3afb144104
spigot-tg-bridge/README.md
kraftwerk28 3afb144104 feature: release 0.0.9 
Changelog:
- message color format
- plugin enable flag
2020-07-18 12:29:11 +03:00

3.1 KiB
Raw Blame History

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
enable If plugin should be enabled boolean ❌ true
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[] or string[] ✔️ []
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
logPlayerDeath If true, plugin will send message to Telegram if player died boolean ❌ false
logPlayerAsleep If true, plugin will send message to Telegram if player fell asleep boolean ❌ false
strings Dictionary of tokens - strings for plugin i18n Map<string, string> ❌ See default config
commands Dictionary of command text used in Telegram bot Map<string, string> ❌ See default config
telegramMessageFormat Format string for TGtoMC chat message string ❌ See default config

Commands:

Commands are customizeable through config, but there are default values for them as well

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

Format string:

Must contain %username% and %message inside. You can customize message color with it. See message color codes.

P. S.: related to this issue