amalthea-mc/spigot-tg-bridge
1
0
Fork 0
mirror of https://github.com/amalthea-mc/spigot-tg-bridge.git synced 2024-11-09 12:11:06 +00:00
Code Issues Projects Releases Wiki Activity
Connect Telegram chats and Minecraft servers seamlessly
8 Commits 2 Branches 15 Tags 222 KiB
Kotlin 100%
98dbfc8c02
Go to file
kraftwerk28 98dbfc8c02 chore: update readme
2020-03-09 16:15:18 +02:00
.idea add: README 2020-02-13 17:12:50 +02:00
gradle/wrapper add: project files 2020-02-09 02:53:17 +02:00
src/main add: README 2020-02-13 17:12:50 +02:00
.gitignore release(0.0.3): add gradle build support 2020-02-10 14:04:06 +02:00
build.gradle add: README 2020-02-13 17:12:50 +02:00
gradle.properties add: README 2020-02-13 17:12:50 +02:00
gradlew add: project files 2020-02-09 02:53:17 +02:00
gradlew.bat add: project files 2020-02-09 02:53:17 +02:00
LICENSE add: LICENSE 2020-02-13 17:20:02 +02:00
README.md chore: update readme 2020-03-09 16:15:18 +02:00
settings.gradle add: README 2020-02-13 17:12:50 +02:00

README.md

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 2. 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