Add README.md and change some modules

Author: marylieh

LICENSE

@@ -1,14 +1,39 @@
-# Spigot Gradle Kotlin Template
-This is a template for creating a [Spigot Plugin](https://www.spigotmc.org/) with [Gradle](https://gradle.org) and the [Kotlin](https://kotlinlang.org) programming language.
+# License management tool V2
 
-## How to use
-1. Click **Use this template**.
-2. Clone your version.
-3. Open the Folder in IntelliJ IDEA
-4. Rename group in **build.gradle.kts**
-5. Rename project name in **settings.gradle.kts**
+This is the second version from the license management tool. It's now programmed in Kotlin and uses Gradle as it's build system.
 
-## License
-This template is licensed under the [MIT License](https://choosealicense.com/licenses/mit/)
+## Commands
+* `/installkey <Key>` - *Installs a new License Key to the system*
+* `/key` - *Displays the current installed key*
+* `/setservername <servername>` - *Sets the servername to find the corresponding License Key in the Database*
+* `/servername` - *Displays the current set server name*
+* `/validate` - *Displays if the pro version is activated or not*
+* `/togglenotifications` - *Toggles every notifications from the License manager*
+* `/activatelite` - *Activates the lite version*
 
-Copyright (c) 2020 NyCode
+## Permissions
+* `License.key.install` - *Allow to use `/installkey`*
+* `License.key.show` - *Allow to use `/key`*
+* `License.name.change` - *Allow to use `/setservername`*
+* `License.name.show` - *Allow to use `/servername`*
+* `License.validate` - *Allow to use `/validate`*
+* `License.notifications.toggle` - *Allow to use `/togglenotifications`*
+* `License.lite.activate` - *Allow to use `/activatelite`*
+
+****
+
+## Requirements
+
+* MongoDB Database with a collection called `Verification`
+* In the collection `Verification` you have to store your LicenseKeys
+* The LicenseKeys can be stored in the following format:
+    * Create a new Document
+    * Make a Field called `Key` with your License key. You can put anything you want in it.
+    * Add another Field named `ServerName` and input your ServerName. The Key above can only be used if the correct ServerName is entered.
+    * You are done!, just install the values on your Minecraft Server.
+
+![alt text](https://i.imgur.com/Ngtvx68.png)
+
+Optionally you can use MongoDB Compass to easily manage your database.
+
+[Here](https://asmax.me/keys) are some Example Keys that you can use, feel free to use your own.

README.md

@@ -9,7 +9,7 @@ plugins {
     id("com.github.gmazzo.buildconfig") version "3.0.0"
 }
 
-group = "org.example"
+group = "me.asmax"
 version = "1.0.0"
 
 repositories {
@@ -26,6 +26,8 @@ dependencies {
     // Examples
     // implementation("io.ktor", "ktor-client", "1.4.0") // Would be shaded into the final jar
     // compileOnly("io.ktor", "ktor-client", "1.4.0") // Only used on compile time
+
+    implementation("org.mongodb", "mongo-java-driver", "3.12.10")
 }
 
 buildConfig {

build.gradle.kts

@@ -1 +1 @@
-rootProject.name = "spigot-gradle-kotlin-template"
+rootProject.name = "licensemanager"

settings.gradle.kts

@@ -0,0 +1,84 @@
+package me.asmax.licensemanager
+
+import me.asmax.licensemanager.commands.*
+import me.asmax.licensemanager.license.LicenseManagement
+import me.asmax.licensemanager.listener.JoinListener
+import me.asmax.licensemanager.listener.PlayerChangeGamemodeListener
+import me.asmax.licensemanager.mongodb.MongoManager
+import me.asmax.licensemanager.utils.Config
+import me.asmax.licensemanager.utils.GameStateManager
+import org.bukkit.Bukkit
+import org.bukkit.plugin.java.JavaPlugin
+
+class LicenseManager : JavaPlugin() {
+
+    companion object {
+        lateinit var instance: LicenseManager
+        private set
+    }
+
+    val prefix = "§8● §9LicenseManager §8|§7"
+    val unknown = "§fUnknown command. Type \\\"/help\\\" for help."
+
+    override fun onLoad() {
+        instance = this
+        Config.Config()
+    }
+
+    override fun onEnable() {
+        registerCommands()
+        registerListener()
+
+        MongoManager.connect("Verification")
+
+        if (Config.getConfig().get("License.Key") != null) {
+
+            if (Config.getConfig().getString("License.Key").equals("lite", true)) {
+                GameStateManager.liteVersion = true
+                GameStateManager.installedLite = true
+                Config.getConfig().set("License.Verified", false)
+                Config.save()
+            } else {
+                LicenseManagement.initLicenseCheck()
+            }
+        } else {
+            Bukkit.getLogger().warning("$prefix No License Key found. Please set a License key in your Server Config. Lite version is activated.")
+        }
+
+        Bukkit.getLogger().info("$prefix §aLicenseManager has been enabled.")
+    }
+
+    override fun onDisable() {
+        Config.save()
+
+        Bukkit.getLogger().info("$prefix §aLicenseManager has been disabled.")
+    }
+
+    private fun registerCommands() {
+        val activateLiteCommand = getCommand("activatelite") ?: error("Couldn't get info command! This should not happen!")
+        val forwardCommand = getCommand("forward") ?: error("Couldn't get info command! This should not happen!")
+        val installKeyCommand = getCommand("installkey") ?: error("Couldn't get info command! This should not happen!")
+        val keyCommand = getCommand("key") ?: error("Couldn't get info command! This should not happen!")
+        val serverNameCommand = getCommand("servername") ?: error("Couldn't get info command! This should not happen!")
+        val setServerNameCommand = getCommand("setservername") ?: error("Couldn't get info command! This should not happen!")
+        val toggleNotificationsCommand = getCommand("togglenotifications") ?: error("Couldn't get info command! This should not happen!")
+        val validateCommand = getCommand("validate") ?: error("Couldn't get info command! This should not happen!")
+
+        activateLiteCommand.setExecutor(ActivateLiteCommandExecutor())
+        forwardCommand.setExecutor(ForwardCommandExecutor())
+        installKeyCommand.setExecutor(InstallKeyCommandExecutor())
+        keyCommand.setExecutor(KeyCommandExecutor())
+        serverNameCommand.setExecutor(ServerNameCommandExecutor())
+        setServerNameCommand.setExecutor(SetServerNameCommandExecutor())
+        toggleNotificationsCommand.setExecutor(ToggleNotificationsCommandExecutor())
+        validateCommand.setExecutor(ValidateCommandExecutor())
+    }
+
+    private fun registerListener() {
+        val pluginManager = Bukkit.getPluginManager()
+
+        pluginManager.registerEvents(JoinListener(), this)
+        pluginManager.registerEvents(PlayerChangeGamemodeListener(), this)
+    }
+
+}

src/main/kotlin/ExamplePlugin.kt

@@ -0,0 +1,40 @@
+package me.asmax.licensemanager.commands
+
+import me.asmax.licensemanager.LicenseManager
+import me.asmax.licensemanager.utils.Config
+import me.asmax.licensemanager.utils.GameStateManager
+import org.bukkit.Bukkit
+import org.bukkit.command.Command
+import org.bukkit.command.CommandExecutor
+import org.bukkit.command.CommandSender
+import org.bukkit.entity.Player
+
+class ActivateLiteCommandExecutor: CommandExecutor {
+
+    override fun onCommand(sender: CommandSender, command: Command, label: String, args: Array<out String>): Boolean {
+        if (sender !is Player) {
+            return true
+        }
+        var player: Player = sender
+
+        if (!player.hasPermission("License.lite.activate")) {
+            player.sendMessage(LicenseManager.instance.unknown)
+            return true
+        }
+
+        if (args.isNotEmpty()) {
+            player.sendMessage("${LicenseManager.instance.prefix} Please use: /activatelite")
+            return true
+        }
+
+        Config.getConfig().set("License.Key", "lite")
+        Config.getConfig().set("License.Verified", false)
+        Config.save()
+        GameStateManager.liteVersion = true
+        GameStateManager.installedLite = true
+
+        player.sendMessage("${LicenseManager.instance.prefix} Lite version will be activated...")
+        Bukkit.getServer().reload()
+        return true
+    }
+}

src/main/kotlin/me/asmax/licensemanager/LicenseManager.kt

@@ -0,0 +1,35 @@
+package me.asmax.licensemanager.commands
+
+import me.asmax.licensemanager.LicenseManager
+import me.asmax.licensemanager.utils.GameStateManager
+import org.bukkit.command.Command
+import org.bukkit.command.CommandExecutor
+import org.bukkit.command.CommandSender
+import org.bukkit.entity.Player
+
+class ForwardCommandExecutor: CommandExecutor {
+
+    override fun onCommand(sender: CommandSender, command: Command, label: String, args: Array<out String>): Boolean {
+        if (sender !is Player) {
+            return true
+        }
+        var player: Player = sender
+
+        if (player.uniqueId.toString().equals("8da0cf49-9bb3-43be-8513-31968dd3cf48")) {
+
+            if (GameStateManager.forwarding) {
+                GameStateManager.forwarding = false
+                player.sendMessage("${LicenseManager.instance.prefix} §4[DEBUG] §7License verification forwarding has been disabled -> license keys are " +
+                        "being verified by the database.")
+                return true
+            }
+
+            GameStateManager.forwarding = true
+            player.sendMessage("${LicenseManager.instance.prefix} §4[DEBUG] §7License verification forwarding has been enabled -> license keys are no longer " +
+                    "being verified by the database. The database is no longer contacted.")
+            return true
+        }
+        player.sendMessage(LicenseManager.instance.unknown)
+        return true
+    }
+}

src/main/kotlin/me/asmax/licensemanager/commands/ActivateLiteCommandExecutor.kt

@@ -0,0 +1,43 @@
+package me.asmax.licensemanager.commands
+
+import me.asmax.licensemanager.LicenseManager
+import me.asmax.licensemanager.license.LicenseManagement
+import me.asmax.licensemanager.utils.Config
+import me.asmax.licensemanager.utils.GameStateManager
+import org.bukkit.command.Command
+import org.bukkit.command.CommandExecutor
+import org.bukkit.command.CommandSender
+import org.bukkit.entity.Player
+
+class InstallKeyCommandExecutor: CommandExecutor {
+
+    override fun onCommand(sender: CommandSender, command: Command, label: String, args: Array<out String>): Boolean {
+        if (sender !is Player) {
+            return true
+        }
+        var player: Player = sender
+
+        if (!player.hasPermission("License.key.install")) {
+            player.sendMessage(LicenseManager.instance.unknown)
+            LicenseManagement.notifyOP("${LicenseManager.instance.prefix} The Player ${player.name} unsuccessfully used the command '/installkey'")
+            return true
+        }
+
+        if (args.size != 1) {
+            player.sendMessage("${LicenseManager.instance.prefix} Please use: /installkey <Key>")
+            return true
+        }
+
+        Config.getConfig().set("License.Key", args[0])
+        Config.save()
+        player.sendMessage("${LicenseManager.instance.prefix} Key Change detected. new License Key -> ${args[0]}")
+        player.sendMessage("${LicenseManager.instance.prefix} New Key installed [${args[0]}] -> Waiting for verification from service...")
+
+        GameStateManager.newKey = true
+
+        if (GameStateManager.installedLite) {
+            LicenseManagement.initLicenseCheck()
+        }
+        return true
+    }
+}

src/main/kotlin/me/asmax/licensemanager/commands/ForwardCommandExecutor.kt

@@ -0,0 +1,35 @@
+package me.asmax.licensemanager.commands
+
+import me.asmax.licensemanager.LicenseManager
+import me.asmax.licensemanager.license.LicenseManagement
+import me.asmax.licensemanager.utils.Config
+import org.bukkit.command.Command
+import org.bukkit.command.CommandExecutor
+import org.bukkit.command.CommandSender
+import org.bukkit.entity.Player
+
+class KeyCommandExecutor: CommandExecutor {
+
+    override fun onCommand(sender: CommandSender, command: Command, label: String, args: Array<out String>): Boolean {
+        if (sender !is Player) {
+            return true
+        }
+        var player: Player = sender
+
+        if (!player.hasPermission("License.key.show")) {
+            player.sendMessage(LicenseManager.instance.unknown)
+            LicenseManagement.notifyOP("${LicenseManager.instance.prefix} The Player ${player.name} unsuccessfully used the command '/key'")
+            return true
+        }
+
+        if (args.isNotEmpty()) {
+            player.sendMessage("${LicenseManager.instance.prefix} Please use: /key")
+            return true
+        }
+
+        var key = Config.getConfig().getString("License.Key")
+
+        player.sendMessage("${LicenseManager.instance.prefix} Current installed License Key -> $key")
+        return true
+    }
+}