Merge pull request #3 from duccss/TestBranch

2.0

Author: duccss

README.md

@@ -1,43 +1,58 @@
 ## PearlPlus
 
-PearlPlus lets you allow players at your base to load pearls through chat whispers without granting any other permissions. You can configure which pearls players can load using commands through discord or console. The config is saved to `plugins/config/pearl-plus.json`
+PearlPlus automatically detects new stasis pearls and registers them with zeniths built in pearl loader. Pearl throwers are then allowed to load these pearls through chat whispers.
+The config is saved to `plugins/config/pearlplus.json`
 
 Download the [lastest build](https://github.com/duccss/PearlPlus/releases/latest) and place the jar file in your proxys plugin folder.
 
 ### Management Commands
 
-#### You can use either `pp` or `pearl+`
+#### You can use either `pp` or `pearlplus`
 
 ```bash
-pearl+ <on/off>
+pearlplus <on/off>
 ```
 ```bash
-pearl+ allow <playerName> <pearlName>
+pearlplus allow/deny playerName pearlID
 ```
 ```bash
-pearl+ deny <playerName> <pearlName>
+pearlplus list
 ```
 ```bash
-pearl+ list
+pearlplus strict on/off
 ```
 ```bash
-pearl+ strict <on/off>
+pearlplus autodetect on/off
+```
+```bash
+pearlplus autodetect temp on/off
 ```
 
 ### Usage
 
-Setup regular pearlloader positions using the built in zenithproxy module. E.g `pearlLoader add <id> <x> <y> <z>`. Add a player to pearl+'s config using `pearl+ allow <username> <id>`. That player can now whisper `load` to the zenith bot and the bot will load the pearl. Players with multiple pearls can add the ID after `load` to have a specific pearl loaded.
+Simply throw a new ender pearl and once it becomes stable the bot will register a pearl loader entry with zenith, setting the pearlID as the throwers name with an incrementing number. That player can now whisper `load` to the zenith bot and the bot will load the pearl. Players with multiple pearls can add the pearlID after `load` to have a specific pearl loaded. Players will recieve the pearlID from a whisper when a new pearl is registered.
 ```bash
 /w <botName> load <optionalID> 
 ```
+Temp mode automatically removes pearl positions where a pearl isnt detected. May be buggy.
+
+Can be enabled with `pearlplus autodetect temp on` 
+
+#### Manual setup
+Setup regular pearlloader positions using the built in zenithproxy module. E.g `pearlLoader add <id> <x> <y> <z>`. Add a player to pearlplus's config using `pearlplus allow <username> <id>`.
+
 #### 2b2t / Anti-spam
 
-On 2b2t or other servers with strict anti-spam plugins you may need to disable strict mode (enabled by default) which then allows you to add a random string after `load` or the `pearlID`.
-```bash
-/w <botName> load <optionalID> <randomString>
-```
+By default the bot checks the nearest player to a new pearl and assumes that player threw it. This might be buggy but might be necessary as it seems Hause has disabled resolving entity owners. Resolving the name is bulletproof but server owners can 'disable' it.
+
+If you aren't playing 2b2t its highly recommended to resolve names, this can be done with `pearlplus 2b2t off`.
+
+By default you can add a random word after `load` or the `pearlID` to get around anti-spam.
+
+This can be disabled using `pearlplus strict on`.
 
 ### Building The Plugin
 
-Clone the repo or download the zip.  
-Run `./gradlew build`
+Clone the repo or download the zip.
+Run `chmod +x gradlew`
+ then `./gradlew build`

gradle.properties

@@ -1,4 +1,4 @@
-plugin_version=1.1.2
+plugin_version=2.0.0
 plugin_name=PearlPlus
 mc=1.21.4
 maven_group=dev.zenith.pearlplus

gradlew

@@ -1,20 +1,41 @@
 package dev.zenith.pearlplus;
 
 import java.util.LinkedHashMap;
-import java.util.List;
 import java.util.Map;
 import java.util.UUID;
 
 public class PearlPlusConfig {
     public final AutoLoadConfig autoLoad = new AutoLoadConfig();
+    public final AutoDetectConfig autoDetect = new AutoDetectConfig();
+
+    public String defaultPearlId = "Base";
+
+    public final Map<UUID, PlayerPearls> players = new LinkedHashMap<>();
+
     public static class AutoLoadConfig {
         public boolean enabled = true;
-        public boolean allowNoiseAfterPearl = false;
-        public Map<UUID, List<String>> allowed = new LinkedHashMap<>();
+        public boolean allowNoiseAfterPearl = true;
+        public boolean returnToStartPos = true;
+        public boolean autoDefaultToPresent = true;
     }
 
-    public final AutoDetectConfig autoDetect = new AutoDetectConfig();
     public static final class AutoDetectConfig {
+        public boolean enabled = true;
+        public boolean temporaryMode = false;
+        public boolean distanceCheck = false;
+        public int temporaryRemovalRange = 32; //blocks
+    }
+
+    public static final class PlayerPearls {
+        public String playerName;
+        public String defaultPearlId;
+        public Map<String, StoredPearl> pearls = new LinkedHashMap<>();
+    }
 
+    public static final class StoredPearl {
+        public String pearlId;
+        public int x;
+        public int y;
+        public int z;
     }
-}
+}

src/main/java/dev/zenith/pearlplus/PearlPlusConfig.java

@@ -4,16 +4,16 @@
 import com.zenith.plugin.api.Plugin;
 import com.zenith.plugin.api.ZenithProxyPlugin;
 import net.kyori.adventure.text.logger.slf4j.ComponentLogger;
-import dev.zenith.pearlplus.command.AutoLoadCommand;
-import dev.zenith.pearlplus.module.AutoLoadModule;
+import dev.zenith.pearlplus.command.*;
+import dev.zenith.pearlplus.module.*;
 
 @Plugin(
-    id = "pearl-plus",
+    id = "pearlplus",
     version = BuildConstants.VERSION,
-    description = "Load pearls through whispers without whitelist.",
-    url = "https://github.com/duccss/",
+    description = "Slightly better pearl loading module.",
+    url = "https://github.com/duccss/pearlplus/",
     authors = {"duccss"},
-    mcVersions = {"1.21.0", "1.21.4", "1.21.5", "1.21.7", "1.21.8"}
+    mcVersions = {"1.21.0", "1.21.4", "1.21.5", "1.21.7", "1.21.8", "1.21.10"}
 )
 
 public class PearlPlusPlugin implements ZenithProxyPlugin {
@@ -25,10 +25,12 @@ public class PearlPlusPlugin implements ZenithProxyPlugin {
     public void onLoad(PluginAPI pluginAPI) {
         API = pluginAPI;
         LOG = pluginAPI.getLogger();
-        LOG.info("Pearl+ Plugin loading...");
-        PLUGIN_CONFIG = API.registerConfig("pearl-plus", PearlPlusConfig.class);
-        API.registerCommand(new AutoLoadCommand());
+        LOG.info("PearlPlus Plugin loading...");
+        PLUGIN_CONFIG = API.registerConfig("pearlplus", PearlPlusConfig.class);
+        API.registerCommand(new PearlPlusCommand());
         API.registerModule(new AutoLoadModule());
-        LOG.info("Pearl+ Plugin loaded!");
+        API.registerModule(new AutoDetectModule());
+
+        LOG.info("PearlPlus Plugin loaded!");
     }
 }