Add updater and fix doc errors

BattlePlugins · Aug 16, 2019 · 5b10498 · 5b10498
1 parent 72dcff0
commit 5b10498
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 8 deletions.
diff --git a/modules/VirtualPlayers/pom.xml b/modules/VirtualPlayers/pom.xml
@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>mc.alk</groupId>
     <artifactId>VirtualPlayers</artifactId>
-    <version>1.8.2</version>
+    <version>1.8.3</version>
     <packaging>jar</packaging>
     <name>VirtualPlayers</name>
     <url>http://dev.bukkit.org/bukkit-plugins/virtualplayers2/</url>
@@ -293,6 +293,13 @@
             <scope>compile</scope>
             <optional>true</optional>
         </dependency>
+        <dependency>
+            <groupId>mc.alk</groupId>
+            <artifactId>BattlePluginUpdater</artifactId>
+            <version>2.2.0</version>
+            <scope>compile</scope>
+            <optional>true</optional>
+        </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
@@ -364,12 +371,17 @@
                                     <include>mc.euro:Version</include>
                                     <include>mc.euro:BukkitInterface</include>
                                     <include>mc.euro:BukkitAdapter</include>
+                                    <include>mc.alk:BattlePluginUpdater</include>
                                     <include>mc.alk:VirtualPlayersAPI</include>
                                     <include>mc.alk:vp-*</include>
                                     <include>org.bstats:bstats-bukkit</include>
                                 </includes>
                             </artifactSet>
                             <relocations>
+                                <relocation>
+                                    <pattern>mc.alk.battlepluginupdater</pattern>
+                                    <shadedPattern>mc.alk.virtualplayers.zlib.updater</shadedPattern>
+                                </relocation>
                                 <relocation>
                                     <pattern>mc.euro.version</pattern>
                                     <shadedPattern>mc.alk.virtualplayers.zlib.version</shadedPattern>

diff --git a/modules/VirtualPlayers/src/main/java/mc/alk/virtualplayers/VirtualPlayers.java b/modules/VirtualPlayers/src/main/java/mc/alk/virtualplayers/VirtualPlayers.java
@@ -7,6 +7,7 @@
 import java.util.UUID;
 import java.util.logging.Level;
 
+import mc.alk.battlepluginupdater.GitHubUpdater;
 import mc.alk.virtualplayers.api.VirtualPlayer;
 import mc.alk.virtualplayers.api.VirtualPlayerFactory;
 import mc.alk.virtualplayers.api.VirtualPlayersAPI;
@@ -38,6 +39,9 @@ public void onEnable() {
         getCommand("vdc").setExecutor(new PlayerExecutor(this));
         getCommand("virtualplayers").setExecutor(new VPExecutor(this));
 
+        GitHubUpdater updater = new GitHubUpdater(this, "BattlePlugins", getDescription().getName());
+        updater.update();
+
         new Metrics(this);
     }
 

diff --git a/modules/api/src/main/java/mc/alk/virtualplayers/api/VirtualPlayersAPI.java b/modules/api/src/main/java/mc/alk/virtualplayers/api/VirtualPlayersAPI.java
@@ -16,7 +16,7 @@
 public interface VirtualPlayersAPI {
 
     /**
-     * Returns all online players, including api.VirtualPlayers. <br/><br/>
+     * Returns all online players, including api.VirtualPlayers.
      * <pre>
      * VirtualPlayers.getOnlinePlayers() :
      * Using this method has an added bonus: It is backwards compatible.

diff --git a/modules/api/src/main/java/mc/alk/virtualplayers/util/InventoryUtil.java b/modules/api/src/main/java/mc/alk/virtualplayers/util/InventoryUtil.java
@@ -659,8 +659,8 @@ public boolean addAllEnchantments(ItemStack is) {
     /**
      * For Serializing an item or printing
      *
-     * @param is
-     * @return
+     * @param is the item stack
+     * @return the item string
      */
     public static String getItemString(ItemStack is) {
         if (is == null) {

diff --git a/modules/api/src/main/java/mc/alk/virtualplayers/util/Util.java b/modules/api/src/main/java/mc/alk/virtualplayers/util/Util.java
@@ -73,11 +73,11 @@ public static boolean removeListener(VPMessageListener listener) {
     }
 
     /**
-     * Uses the location, chunk, & distance calculations. <br/><br/>
+     * Uses the location, chunk, and distance calculations.
      * 
-     * @param vp 
-     * @param radius 
-     * @return
+     * @param vp the virtual player
+     * @param radius the radius
+     * @return the nearby entities
      */
     public static Collection<Entity> getNearbyEntities(VirtualPlayer vp, int radius) {
         Map<Integer, Entity> emap = new HashMap<Integer, Entity>();