2020-02-13 15:12:50 +00:00
# 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 ](https://github.com/kraftwerk28/spigot-tg-bridge/releases ), 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.
2020-02-13 15:15:34 +00:00
2020-02-13 15:12:50 +00:00
**OR**
2020-02-13 15:15:34 +00:00
2020-02-13 15:12:50 +00:00
2. Copy [config.yml ](https://raw.githubusercontent.com/kraftwerk28/spigot-tg-bridge/master/src/main/resources/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 |
2020-03-09 14:15:18 +00:00
|:-----:|:------------|:----:|:--------:|:-------:|
2020-07-18 09:29:11 +00:00
| enable | If plugin should be enabled | `boolean` | :x: | `true` |
| botToken | Telegram bot token ([How to create bot](https://core.telegram.org/bots#3-how-do-i-create-a-bot)) | `string` | :heavy_check_mark: | - |
2020-07-19 16:34:12 +00:00
| botUsername | Telegram bot username | `string` | :heavy_check_mark: | - |
2020-07-18 09:29:11 +00:00
| chats | Chats, where bot will work (to prevent using bot by unknown chats) | `number[] or string[]` | :heavy_check_mark: | `[]` |
| serverStartMessage | What will be sent to chats when server starts | `string` | :x: | `'Server started.'` |
| serverStopMessage | What will be sent to chats when server stops | `string` | :x: | `'Server stopped.'` |
| logJoinLeave | If true, plugin will send corresponding messages to chats, when player joins or leaves server | `boolean` | :x: | `true` |
| logFromMCtoTG | If true, plugin will send messages from players on server, to Telegram chats | `boolean` | :x: | `true` |
| logFromTGtoMC | If true, plugin will send messages from chats, to Minecraft server | `boolean` | :x: | `true` |
| logPlayerDeath | If true, plugin will send message to Telegram if player died | `boolean` | :x: | `false` |
| logPlayerAsleep | If true, plugin will send message to Telegram if player fell asleep | `boolean` | :x: | `false` |
| strings | Dictionary of tokens - strings for plugin i18n | `Map<string, string>` | :x: | See default config |
| commands | Dictionary of command text used in Telegram bot | `Map<string, string>` | :x: | See default config |
| telegramMessageFormat | Format string for TGtoMC chat message | `string` | :x: | See default config |
2020-02-13 15:12:50 +00:00
2020-07-19 16:34:12 +00:00
## Telegram bot commands:
2020-07-11 16:22:11 +00:00
Commands are customizeable through config, but there are default values for them as well
2020-03-09 14:15:18 +00:00
| Command | Description |
|:-------:|:------------|
2020-02-13 15:12:50 +00:00
| `/online` | Get players, currently online |
2020-03-09 14:15:18 +00:00
| `/time` | Get [time ](https://minecraft.gamepedia.com/Day-night_cycle ) on server |
2020-07-20 16:42:43 +00:00
| `/chat_id` | Get current chat ID (in which command was run) for config.yml |
2020-07-18 09:29:11 +00:00
## Format string:
Must contain `%username%` and `%message` inside.
You can customize message color with it. See [message color codes ](https://www.digminecraft.com/lists/color_list_pc.php ).
2020-07-19 16:34:12 +00:00
P. S.: related to [this issue ](https://github.com/kraftwerk28/spigot-tg-bridge/issues/6 )
## Plugin commands:
| Command | Description |
|:-------:|:------------|
| `/tgbridge_reload` | Reload plugin configuration w/o need to stop the server. Works only through server console |
