add: README

chore(build.gradle): refactor & output directory
chore: rename packages

.idea/misc.xml

@@ -6,6 +6,9 @@
     </list>
   </component>
   <component name="ExternalStorageConfigurationManager" enabled="true" />
+  <component name="JavaScriptSettings">
+    <option name="languageLevel" value="ES6" />
+  </component>
   <component name="ProjectRootManager" version="2" languageLevel="JDK_13" project-jdk-name="13" project-jdk-type="JavaSDK">
     <output url="file://$PROJECT_DIR$/out" />
   </component>

.idea/spigot-tg-bridge.iml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4" />

README.md

@@ -0,0 +1,36 @@
+# 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.
+    
+    **OR**
+    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 |
+| --- | --- | --- | --- | --- |
+| botToken | Telegram bot token ([How to create bot](https://core.telegram.org/bots#3-how-do-i-create-a-bot)) | string | :heavy_check_mark: | - |
+| botUsername | Telegram bot username | string | :heavy_check_mark: | - |
+| chats | Chats, where bot will work (to prevent using bot by unknown chats) | number[] | :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 |
+| strings | Dictionary of tokens - strings for plugin i18n | Map<string, string> | :x: | See default config |
+
+## Commands:
+| Command | description |
+| --- | --- |
+| `/online` | Get players, currently online |
+| `/time` | Get [time](https://minecraft.gamepedia.com/Day-night_cycle) on server |

build.gradle

@@ -5,9 +5,10 @@ plugins {
 }
 
 group 'org.kraftwerk28'
-version '1.0-SNAPSHOT'
-rootProject.libsDirName =
-        "$System.env.HOME/MinecraftServers/spigot_1.15.2/plugins/"
+version '0.0.4-SNAPSHOT'
+
+def defaultOutDir = "$System.env.HOME/MinecraftServers/spigot_1.15.2/plugins/"
+rootProject.libsDirName = System.getenv("OUT_DIR") ?: defaultOutDir
 
 sourceCompatibility = 1.8
 targetCompatibility = 1.8

gradle.properties

@@ -1 +1 @@
-kotlin.code.style=official
+kotlin.code.style=official

settings.gradle

@@ -1 +1 @@
-rootProject.name = 'rzcraft-bridge'
+rootProject.name = 'spigot-tg-bridge'

src/main/kotlin/org/kraftwerk28/spigot_tg_bridge/Bot.kt

@@ -1,4 +1,4 @@
-package org.kraftwerk28.rzcraft_bridge
+package org.kraftwerk28.spigot_tg_bridge
 
 import org.telegram.telegrambots.bots.TelegramLongPollingBot
 import org.telegram.telegrambots.meta.api.methods.ParseMode

src/main/kotlin/org/kraftwerk28/spigot_tg_bridge/Plugin.kt

@@ -1,4 +1,4 @@
-package org.kraftwerk28.rzcraft_bridge
+package org.kraftwerk28.spigot_tg_bridge
 
 import com.vdurmont.emoji.EmojiParser
 import org.bukkit.event.EventHandler

src/main/resources/config.yml

@@ -1,7 +1,7 @@
 botToken: abcdef123456789
 botUsername: sample_username
 chats:
-  - -1001281720535
+  - -1234567890123
 serverStartMessage: 'Server started.'
 serverStopMessage: 'Server stopped.'
 logJoinLeave: true

src/main/resources/plugin.yml

@@ -1,6 +1,6 @@
-name: RZCraftBridge
+name: SpigotTGBridge
 version: 0.0.4
 api-version: '1.15'
-main: org.kraftwerk28.rzcraft_bridge.Plugin
-description: Telegram <-> Minecraft communication plugin for RzaszkówCraft.
+main: org.kraftwerk28.spigot_tg_bridge.Plugin
+description: Telegram <-> Minecraft communication plugin for Spigot.
 load: STARTUP