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

chore: update readme

Browse Source
This commit is contained in:
Vsevolod 2020-07-27 10:49:34 +03:00 committed by GitHub
parent b99748f96b
commit 24e1491f4e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -59,6 +59,7 @@ P. S. You can always update plugin configuration without restarting the server.
| 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>` | :heavy_check_mark: | See below |
| telegramMessageFormat | Format string for TGtoMC chat message | `string` | :x: | See default config |
| minecraftMessageFormat | Format string for MCtoTG chat message | `string` | :x: | See default config |
## Telegram bot commands:
@ -74,8 +75,14 @@ Commands are customizeable through config. If command doesn't exist in config, i
## 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) for more information.
```
+--------+ >--minecraftMessageFormat(message)-> +--------------+
| Spigot | | Telegram bot |
+--------+ <--telegramMessageFormat(message)--< +--------------+
Applies to `telegramMessageFormat` and `minecraftMessageFormat` configurations.
Must contain `%username%` and `%message%` inside.
You can customize message color with it (only for `telegramMessageFormat`. See [message color codes](https://www.digminecraft.com/lists/color_list_pc.php) for more information.
This feature is related to [this issue](https://github.com/kraftwerk28/spigot-tg-bridge/issues/6)