From 24e1491f4e8f0dbc56768cc25ca97672fcf4695c Mon Sep 17 00:00:00 2001 From: Vsevolod Date: Mon, 27 Jul 2020 10:49:34 +0300 Subject: [PATCH 1/8] chore: update readme --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1cf6a49..16d91e7 100644 --- a/README.md +++ b/README.md @@ -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` | :x: | See default config | | commands | Dictionary of command text used in Telegram bot | `Map` | :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) From 29af44e91b1ea0f5e3f296e4aa85647588db8691 Mon Sep 17 00:00:00 2001 From: Vsevolod Date: Mon, 27 Jul 2020 10:49:55 +0300 Subject: [PATCH 2/8] chore: update readme --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 16d91e7..ee73fe1 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,7 @@ Commands are customizeable through config. If command doesn't exist in config, i +--------+ >--minecraftMessageFormat(message)-> +--------------+ | Spigot | | Telegram bot | +--------+ <--telegramMessageFormat(message)--< +--------------+ +``` Applies to `telegramMessageFormat` and `minecraftMessageFormat` configurations. Must contain `%username%` and `%message%` inside. From 94c4d135b6641c2f17eae50c63522f9cee2d2159 Mon Sep 17 00:00:00 2001 From: Vsevolod Date: Mon, 27 Jul 2020 10:52:29 +0300 Subject: [PATCH 3/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ee73fe1..bb7b8f1 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ Commands are customizeable through config. If command doesn't exist in config, i 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. +You can customize message color with it (coloring works only for `telegramMessageFormat`). You can customize bold/italics/stirethrough formatting (works only for `minecraftMessageFormat`). See [Minecraft message color codes](https://www.digminecraft.com/lists/color_list_pc.php) and [Telegram message formatting](https://core.telegram.org/bots/api#html-style) for more information. This feature is related to [this issue](https://github.com/kraftwerk28/spigot-tg-bridge/issues/6) From 4156c7e75f4943d1af6c657cc8fae5a6060470b2 Mon Sep 17 00:00:00 2001 From: Vsevolod Date: Sat, 17 Oct 2020 23:48:19 +0300 Subject: [PATCH 4/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bb7b8f1..687cc57 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ 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. If you already have telegram bot, skip this step. Otherwise create it through [BotFather](https://t.me/BotFather). You'll go through step-by-step instructions, give a bot __username__ and most importanrly, obtain a bot __token__. Save this token. +2. If you already have telegram bot, skip this step. Otherwise create it through [BotFather](https://t.me/BotFather). You'll go through step-by-step instructions, give a bot __username__ and most importantly, obtain a bot __token__. Save this token for future use. 3. Next, we need to tell plugin about your new bot. You can either: - Run Spigot server, plugin will log `"No config file found! Saving default one."`. After that, stop server and proceed to 4th step. From a00a158994daa39e3a68043feb27c325530dad60 Mon Sep 17 00:00:00 2001 From: Vsevolod Date: Sat, 17 Oct 2020 23:49:21 +0300 Subject: [PATCH 5/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 687cc57..ca85ba0 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ 2. If you already have telegram bot, skip this step. Otherwise create it through [BotFather](https://t.me/BotFather). You'll go through step-by-step instructions, give a bot __username__ and most importantly, obtain a bot __token__. Save this token for future use. -3. Next, we need to tell plugin about your new bot. You can either: +3. Next, you need to tell plugin about your new bot. You can either: - Run Spigot server, plugin will log `"No config file found! Saving default one."`. After that, stop server and proceed to 4th step. - Copy [config.yml](https://raw.githubusercontent.com/kraftwerk28/spigot-tg-bridge/master/src/main/resources/config.yml) to `plugins/SpigotTGBridge/` in your server directory. From cc1fff9393b875b4d2f52cdb5e58bc378cc33945 Mon Sep 17 00:00:00 2001 From: Vsevolod Date: Wed, 4 Nov 2020 21:11:03 +0200 Subject: [PATCH 6/8] Update README.md --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index ca85ba0..c0d762d 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,6 @@ 8. Re-run server or type `tgbridge_reload` into server's console. -P. S. You can always update plugin configuration without restarting the server. Just edit `config.yml` in the `plugins/` directory, save it, then type `tgbridge_reload` into server's console. Beware, that plugin reload takes some time (usually up to 30 secs), and I work on it right now. - - ## Plugin configuration: | Field | Description | Type | Required | Default | From 16f155c5b066b33f4ba77094eb7e504ae684ee30 Mon Sep 17 00:00:00 2001 From: Vsevolod Date: Tue, 8 Dec 2020 00:41:27 +0200 Subject: [PATCH 7/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c0d762d..78f37d6 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ 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. If you already have telegram bot, skip this step. Otherwise create it through [BotFather](https://t.me/BotFather). You'll go through step-by-step instructions, give a bot __username__ and most importantly, obtain a bot __token__. Save this token for future use. +2. If you already have telegram bot, skip this step. Otherwise create it through [BotFather](https://t.me/BotFather). You'll go through step-by-step instructions, give a bot __username__ and most importantly, obtain a bot __token__. Save this token for future use. **Note:** in order to make your bot hear raw text messages (not commands), you must disable [privacy mode](https://core.telegram.org/bots#privacy-mode) option which is on by default. Go through bot's settings: **Bot Settings -> Group Privacy** and click **Turn Off**. 3. Next, you need to tell plugin about your new bot. You can either: - Run Spigot server, plugin will log `"No config file found! Saving default one."`. After that, stop server and proceed to 4th step. From dc712d00e5fa8abe5e7cd9080443765c3f12d1a0 Mon Sep 17 00:00:00 2001 From: Vsevolod Date: Tue, 8 Dec 2020 00:46:23 +0200 Subject: [PATCH 8/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 78f37d6..df58cf8 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ # other chat id's... ``` -7. You can extend `config.yml` with more tweaks, which are described in the table below, but it's not nesessary, plugin will use default values instead, if they're missing. +7. You can extend `config.yml` with more tweaks, which are described in the table below, but it's not nesessary, plugin will use default values instead, if they're missing. Also, check out the [example](src/main/resources/config.yml). 8. Re-run server or type `tgbridge_reload` into server's console.