Added documentation for plugin implementation

miopowered · Jun 24, 2021 · 1909915 · 1909915
1 parent e6239bf
commit 1909915
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 21 deletions.
diff --git a/plugin/src/main/java/eu/miopowered/nickapi/plugin/NickPlugin.java b/plugin/src/main/java/eu/miopowered/nickapi/plugin/NickPlugin.java
@@ -24,6 +24,9 @@
 import java.util.List;
 import java.util.UUID;
 
+/**
+ * This is a proof of concept
+ */
 @Accessors(fluent = true)
 public class NickPlugin extends JavaPlugin implements Listener {
 

diff --git a/plugin/src/main/java/eu/miopowered/nickapi/plugin/NickPluginImplementationTest.java b/plugin/src/main/java/eu/miopowered/nickapi/plugin/NickPluginImplementationTest.java
@@ -8,13 +8,14 @@
 import org.bukkit.command.Command;
 import org.bukkit.command.CommandSender;
 import org.bukkit.entity.Player;
-import org.bukkit.event.EventHandler;
 import org.bukkit.event.Listener;
-import org.bukkit.event.player.PlayerJoinEvent;
 import org.bukkit.plugin.java.JavaPlugin;
 
 import java.util.UUID;
 
+/**
+ * The actually implementation of the nick api
+ */
 @Accessors(fluent = true)
 public class NickPluginImplementationTest extends JavaPlugin implements Listener {
 
@@ -27,32 +28,20 @@ public void onEnable() {
         Bukkit.getPluginManager().registerEvents(this, this);
     }
 
-    @EventHandler
-    public void handle(PlayerJoinEvent event) {
-    }
-
     @Override
     public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
         if (command.getName().equals("nick")) {
-//            NickUser nickUser = NickUser.builder(((Player) sender))
-//                    .username("PluginStubeNET")
-//                    .uniqueId(UUID.fromString("34e57efa-5783-46c7-a9fc-890296aaba1f"))
-//                    .skin(new Skin("ewogICJ0aW1lc3RhbXAiIDogMTYyNDQwOTYxNDczMSwKICAicHJvZmlsZUlkIiA6ICI0M2ZiZjA1MWZkZTk0YjMwYjkyZWZlNDgwNGI4YWIwNSIsCiAgInByb2ZpbGVOYW1lIiA6ICJ3ZWViIiwKICAic2lnbmF0dXJlUmVxdWlyZWQiIDogdHJ1ZSwKICAidGV4dHVyZXMiIDogewogICAgIlNLSU4iIDogewogICAgICAidXJsIiA6ICJodHRwOi8vdGV4dHVyZXMubWluZWNyYWZ0Lm5ldC90ZXh0dXJlLzFkODZjMWY3NGI0YjFiYjgwZTI3YzUxOTdlMWE4ZDlhYjRlNDY4M2FiMDMzZmU0MGFkYmU0ZmZiMWY0NWQxNDgiLAogICAgICAibWV0YWRhdGEiIDogewogICAgICAgICJtb2RlbCIgOiAic2xpbSIKICAgICAgfQogICAgfQogIH0KfQ==",
-//                            "ZgB4RDHiU8cDzs3NTZAvMh1/06Py9BEEmlNy/pNjp02QiBy8QsYziQcPRAELqkQWpBM5ArAjToUFZfaMQy1ej5/P8N9S89xM0lD9Mho2cF23nfMVQY53+S4tAFuKKQ1IU7+EyWYxuCLq2vS7w1ENiOxcKXW3hW97snKlQVPP3DyZKyt07HjvlHOJlQb7KYg+cRK7f++K2qFTjcbUtubrVQRRpWdFisOwKjLqGLiQA1JTG18QXjQH5kIwAVIg5hCkrq5jgRzd3DvA6O1UvU3+pePh+QLqUwVBZV27Jpe6NVzwT9iHdcgpCKkku9Aehs/ff8UI3BqBdFI+4sQtMcAtBxqiLITPH+zeeb5EQnnS7sZE8caRT2U6GHXra2ZX81oNULspQBIe/5CrawMRpnzGZ17NS0ux7vR2pRBzfuqGdPhKbrajEFqq9WRXAzEki8DJNGt/DvFHrIn2ltdffm2ECMqQ6Bq9Kk0XE3bTK4sopKNST9R49KdBBDOLoY7YqXy4u4I9Wm5JjDTnVz8hZwUUseuXKquqHBqoG8bczxck3fzehUnEC647sbegcmAcZl35ND7OxfBispOCXFNuFrQcRDhyANIZp+RxnuBsWo6gMKqijbFfVoQLq14p/fRzaUQauTAe6wFveHuYRBatMr6Ej75cA9n9566XqCoAhvVbor8="
-//                    ))
-////                    .filter(player -> player.getName().equals(sender.getName()))
-//                    .build();
             NickUser nickUser = NickUser.builder(((Player) sender))
-                    .username("WackMySackyy")
-                    .uniqueId(UUID.fromString("6834c5de-35c7-4686-b717-47d0d1b2fd67"))
-                    .skin(new Skin("ewogICJ0aW1lc3RhbXAiIDogMTYyNDQ0MDcyNjkxMywKICAicHJvZmlsZUlkIiA6ICI2ODM0YzVkZTM1Yzc0Njg2YjcxNzQ3ZDBkMWIyZmQ2NyIsCiAgInByb2ZpbGVOYW1lIiA6ICJXYWNrTXlTYWNreXkiLAogICJzaWduYXR1cmVSZXF1aXJlZCIgOiB0cnVlLAogICJ0ZXh0dXJlcyIgOiB7CiAgICAiU0tJTiIgOiB7CiAgICAgICJ1cmwiIDogImh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNDRiYWU3MTJmMmY4NTcwZjFmYjc1ZWEyZDQ3MTdhNDY0YjIxOTU5YTcwNzdkOTIzNjc1ZDllOWI1M2M0YWQ4YSIsCiAgICAgICJtZXRhZGF0YSIgOiB7CiAgICAgICAgIm1vZGVsIiA6ICJzbGltIgogICAgICB9CiAgICB9CiAgfQp9",
-                            "IxOyAzbTEkJFo2BiBJ87zaw+cLVC/9iCaXWDuHKeBM6xN2vhHZWhgny3ceWlwlxP7nJ3AYgMATU6cEjKCQ2MQlk8A18U0FnPDtMS45chExhUWl1hRb/87MOIBUCr6Pn5yeaNyfFljNvl65py9DjWuNoAZt1YjBT7hLIiGNd5vNkqWFN3lh9s9d0wvvfAqjGkx0Sz5xW1c3QOBZaZBQqgI+XwHIEUK6lTsmcZkG8UES9JTT8X7wEO9TpIQftLqV1k2zqHExfVKTeNf0mSOw3AQtmNxFkbm9DDVyaYdRBZjhvl0ImYxf5Hyb0r+2DDXIwORQgrxOuTMYnb1LwK2M9QAzRh9fgkUksPXyTN2HTJe0Ekv8+mIbWDcUh32sEL4ODZ6VfuG6O57JxqYGLh892X7IU+YZ1yIl69zYWf/Lggy487uEpel3OeVQhxmKZSZ4IYJ9Z+kbF+jlI31hMcomD51BjQgvwcRcC8Sz+CnfBlCqxOoNZhJv5PhG4PwMnfGj12jU5MS9d5I3NNZGRbSq45eC2svQeljR1lxf+ne37t2lG1rB7n0eu7VZy557/s85/b+h4LGSr5Ngh9SFwL0SNpb/DPZVaOLMSGpLdneUqyNVzIDWbjNmtVroC/iFm4bnItSfynVFRVVK/DMtQAVx4O7qGBHALZn7D+Db+LMz0nUwE="
+                    .username("PluginStubeNET")
+                    .uniqueId(UUID.fromString("34e57efa-5783-46c7-a9fc-890296aaba1f"))
+                    .skin(new Skin("ewogICJ0aW1lc3RhbXAiIDogMTYyNDQwOTYxNDczMSwKICAicHJvZmlsZUlkIiA6ICI0M2ZiZjA1MWZkZTk0YjMwYjkyZWZlNDgwNGI4YWIwNSIsCiAgInByb2ZpbGVOYW1lIiA6ICJ3ZWViIiwKICAic2lnbmF0dXJlUmVxdWlyZWQiIDogdHJ1ZSwKICAidGV4dHVyZXMiIDogewogICAgIlNLSU4iIDogewogICAgICAidXJsIiA6ICJodHRwOi8vdGV4dHVyZXMubWluZWNyYWZ0Lm5ldC90ZXh0dXJlLzFkODZjMWY3NGI0YjFiYjgwZTI3YzUxOTdlMWE4ZDlhYjRlNDY4M2FiMDMzZmU0MGFkYmU0ZmZiMWY0NWQxNDgiLAogICAgICAibWV0YWRhdGEiIDogewogICAgICAgICJtb2RlbCIgOiAic2xpbSIKICAgICAgfQogICAgfQogIH0KfQ==",
+                            "ZgB4RDHiU8cDzs3NTZAvMh1/06Py9BEEmlNy/pNjp02QiBy8QsYziQcPRAELqkQWpBM5ArAjToUFZfaMQy1ej5/P8N9S89xM0lD9Mho2cF23nfMVQY53+S4tAFuKKQ1IU7+EyWYxuCLq2vS7w1ENiOxcKXW3hW97snKlQVPP3DyZKyt07HjvlHOJlQb7KYg+cRK7f++K2qFTjcbUtubrVQRRpWdFisOwKjLqGLiQA1JTG18QXjQH5kIwAVIg5hCkrq5jgRzd3DvA6O1UvU3+pePh+QLqUwVBZV27Jpe6NVzwT9iHdcgpCKkku9Aehs/ff8UI3BqBdFI+4sQtMcAtBxqiLITPH+zeeb5EQnnS7sZE8caRT2U6GHXra2ZX81oNULspQBIe/5CrawMRpnzGZ17NS0ux7vR2pRBzfuqGdPhKbrajEFqq9WRXAzEki8DJNGt/DvFHrIn2ltdffm2ECMqQ6Bq9Kk0XE3bTK4sopKNST9R49KdBBDOLoY7YqXy4u4I9Wm5JjDTnVz8hZwUUseuXKquqHBqoG8bczxck3fzehUnEC647sbegcmAcZl35ND7OxfBispOCXFNuFrQcRDhyANIZp+RxnuBsWo6gMKqijbFfVoQLq14p/fRzaUQauTAe6wFveHuYRBatMr6Ej75cA9n9566XqCoAhvVbor8="
                     ))
 //                    .filter(player -> player.getName().equals(sender.getName()))
                     .build();
             this.nickAPI.register(nickUser
             );
-            sender.sendMessage("du bist genickt.");
+            sender.sendMessage("You're nicked.");
             this.nickAPI.updater().update(nickUser, nickUser.fakeIdentity());
             return true;
         }
@@ -63,10 +52,9 @@ public boolean onCommand(CommandSender sender, Command command, String label, St
                     .findAny()
                     .ifPresent(nickUser -> {
                         this.nickAPI.unregister(((Player) sender));
-                        sender.sendMessage("du bist unnickt.");
+                        sender.sendMessage("You're unnicked");
                         this.nickAPI.updater().update(nickUser, nickUser.realIdentity());
                     });
-
             return true;
         }
         return super.onCommand(sender, command, label, args);