add more docs, add fromEntity method

pom.xml

@@ -6,14 +6,14 @@
 
     <groupId>me.youhavetrouble</groupId>
     <artifactId>Entiddy</artifactId>
-    <version>1.0</version>
+    <version>1.2.0</version>
     <packaging>jar</packaging>
 
-    <name>EnTiddy</name>
+    <name>Entiddy</name>
 
     <description>A very serious library concerning entities</description>
     <properties>
-        <java.version>1.8</java.version>
+        <java.version>17</java.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
 

readme.md

@@ -0,0 +1,41 @@
+Guys, I swear this is a serious library.
+
+## Dependency
+
+Current version: [![](https://jitpack.io/v/YouHaveTrouble/Entiddy.svg)](https://jitpack.io/#YouHaveTrouble/Entiddy)
+
+### Maven
+
+```xml
+<repositories>
+    <repository>
+		<id>jitpack.io</id>
+		<url>https://jitpack.io</url>
+	</repository>
+</repositories>
+```
+
+```xml
+<dependency>
+	<groupId>com.github.YouHaveTrouble</groupId>
+	<artifactId>Entiddy</artifactId>
+	<version>VERSION</version>
+</dependency>
+```
+
+### Gradle
+
+```
+allprojects {
+	repositories {
+		...
+		maven { url 'https://jitpack.io' }
+	}
+}
+```
+
+```
+dependencies {
+    implementation 'com.github.YouHaveTrouble:Entiddy:VERSION'
+}
+```

src/main/java/me/youhavetrouble/entiddy/Entiddy.java

@@ -4,6 +4,7 @@ package me.youhavetrouble.entiddy;
 import me.youhavetrouble.entiddy.SpecialEntities.JebSheep;
 import me.youhavetrouble.entiddy.SpecialEntities.Johnny;
 import me.youhavetrouble.entiddy.SpecialEntities.KillerBunny;
+import me.youhavetrouble.entiddy.SpecialEntities.Toast;
 import org.bukkit.entity.EntityType;
 import org.bukkit.entity.LivingEntity;
 import org.bukkit.entity.Player;
@@ -11,9 +12,28 @@ import org.jetbrains.annotations.NotNull;
 
 public enum Entiddy {
 
+    /**
+     * Killer bunny that attacks players monthy python style
+     */
     KILLER_BUNNY(EntityType.RABBIT, new KillerBunny()),
+
+    /**
+     * Its wool cycles with interpolation through all dye colors
+     * Sheep with rgb lighting
+     */
     JEB_SHEEP(EntityType.SHEEP, new JebSheep()),
-    JOHNNY(EntityType.VINDICATOR, new Johnny());
+
+    /**
+     * Johnny is hostile to basically every mob with few exceptions
+     * HERE'S JOHNNY
+     */
+    JOHNNY(EntityType.VINDICATOR, new Johnny()),
+
+    /**
+     * Toast has the appearance of a black dutch, with a large black and white patch and more black fur around the face
+     * than the natural black and white spotted rabbit.
+     */
+    TOAST(EntityType.RABBIT, new Toast());
 
     private final EntityType entityType;
     private final EntiddyInterface entiddy;
@@ -40,12 +60,26 @@ public enum Entiddy {
         entity.setCustomName("Grumm");
     }
 
+    /**
+     * @return True if entity is one of special/easter egg entities
+     */
     public static boolean isSpecialEntity(@NotNull LivingEntity entity) {
         if (entity instanceof Player) return false;
-        for (Entiddy enTiddy: Entiddy.values()) {
+        for (Entiddy entiddy: Entiddy.values()) {
-            if (enTiddy.entiddy().isInstance(entity)) return true;
+            if (entiddy.entiddy().isInstance(entity)) return true;
         }
         return false;
     }
 
+    /**
+     * @return Special entity type or null
+     */
+    public static Entiddy fromEntity(@NotNull LivingEntity entity) {
+        if (entity instanceof Player) return null;
+        for (Entiddy entiddy: Entiddy.values()) {
+            if (entiddy.entiddy().isInstance(entity)) return entiddy;
+        }
+        return null;
+    }
+
 }

src/main/java/me/youhavetrouble/entiddy/EntiddyInterface.java

@@ -15,6 +15,9 @@ public interface EntiddyInterface {
      */
     Entity spawn(@NotNull Location location, @NotNull CreatureSpawnEvent.SpawnReason spawnReason);
 
-    boolean isInstance(LivingEntity entity);
+    /**
+     * @return True if the entity is an instance of the specific special/easter egg type
+     */
+    boolean isInstance(@NotNull LivingEntity entity);
 
 }

src/main/java/me/youhavetrouble/entiddy/SpecialEntities/JebSheep.java

@@ -20,7 +20,7 @@ public class JebSheep implements EntiddyInterface {
     }
 
     @Override
-    public boolean isInstance(LivingEntity entity) {
+    public boolean isInstance(@NotNull LivingEntity entity) {
         if (!(entity instanceof Rabbit)) return false;
         return entity.getCustomName() != null && entity.getCustomName().equals("jeb_");
     }

src/main/java/me/youhavetrouble/entiddy/SpecialEntities/Johnny.java

@@ -22,7 +22,7 @@ public class Johnny implements EntiddyInterface {
     }
 
     @Override
-    public boolean isInstance(LivingEntity entity) {
+    public boolean isInstance(@NotNull LivingEntity entity) {
         if (!(entity instanceof Vindicator)) return false;
         return ((Vindicator) entity).isJohnny();
     }

src/main/java/me/youhavetrouble/entiddy/SpecialEntities/KillerBunny.java

@@ -23,7 +23,7 @@ public class KillerBunny implements EntiddyInterface {
     }
 
     @Override
-    public boolean isInstance(LivingEntity entity) {
+    public boolean isInstance(@NotNull LivingEntity entity) {
         if (!(entity instanceof Rabbit)) return false;
         return ((Rabbit) entity).getRabbitType().equals(Rabbit.Type.THE_KILLER_BUNNY);
     }

src/main/java/me/youhavetrouble/entiddy/SpecialEntities/Toast.java

@@ -20,7 +20,7 @@ public class Toast implements EntiddyInterface {
     }
 
     @Override
-    public boolean isInstance(LivingEntity entity) {
+    public boolean isInstance(@NotNull LivingEntity entity) {
         if (!(entity instanceof Rabbit)) return false;
         return entity.getCustomName() != null && entity.getCustomName().equals("Toast");
     }