style: clean up unused config options and add extensive comments

Author: synkfr

docs/CONFIGURATION.md

@@ -39,13 +39,6 @@ Permission overrides: `landclaim.limit.<n>`, `landclaim.warps.limit.<n>`
 If you disable `multiProfilesEnabled` after players have already created multiple profiles, they will lose access to all secondary profiles. This setting should be treated as permanent once enabled.
 :::
 
-### Auto-Claim Defaults
-
-| Key | Type | Default | Description |
-|-----|------|---------|-------------|
-| `autoClaimDefault` | Boolean | `false` | Auto-claim enabled by default for new players |
-| `autoUnclaimDefault` | Boolean | `false` | Auto-unclaim enabled by default |
-
 ### World & Command Blocking
 
 | Key | Type | Default | Description |

src/main/java/org/ayosynk/landClaimPlugin/config/PluginConfig.java

@@ -5,111 +5,163 @@
 
 import java.util.List;
 
-@Header("LandClaimPlugin - Main Configuration")
+@Header({
+    "===========================================================",
+    "              LandClaimPlugin - Main Configuration          ",
+    "==========================================================="
+})
 public class PluginConfig extends OkaeriConfig {
 
-    @Comment("Messages Prefix (MiniMessage format)")
+    @Comment({
+        "Messages Prefix (MiniMessage format)",
+        "This prefix will appear before all chat messages sent by the plugin."
+    })
     public String prefix = "<dark_gray>[<gold>LandClaim<dark_gray>]</gold> ";
 
-    @Comment("The item used as the Claim Wand (Material name)")
-    public String claimWandItem = "GOLDEN_SHOVEL";
-
-    @Comment("The default language file to load from the locales folder (e.g., en-US, es-ES)")
+    @Comment({
+        "The default language/locale file to load from the locales folder (e.g., en-US, es-ES).",
+        "Make sure the corresponding file exists in the plugins/LandClaimPlugin/locales/ directory."
+    })
     public String language = "en-US";
 
+    @Comment({
+        "Adjacent Claim Connection Check",
+        "If true, players can only claim new chunks that are directly adjacent to their existing claims.",
+        "If false, players can claim chunks anywhere in the world."
+    })
     public boolean requireConnectedClaims = false;
+
+    @Comment({
+        "Diagonal Chunk Connection Check",
+        "If requireConnectedClaims is true, this determines whether diagonal chunks count as connected (true)",
+        "or only orthogonal (north/south/east/west) chunks count as connected (false)."
+    })
     public boolean allowDiagonalConnections = true;
 
-    @Comment("Blocked worlds for claiming")
+    @Comment({
+        "Blocked Worlds for Claiming",
+        "Players will be unable to claim any land inside the worlds listed below."
+    })
     public List<String> blockWorld = List.of("world_nether", "world_the_end");
 
+    @Comment({
+        "Blocked Commands in Claims",
+        "List of commands that players are strictly blocked from executing while standing inside other players' claims.",
+        "Use this to prevent unauthorized warping, setting homes, or teleportation in claimed territories."
+    })
     public List<String> blockCmd = List.of("setwarp", "warp", "sethome");
 
     @Comment({
         "Multi-Profile System",
-        "Enable to allow players to manage multiple claims via an active profile selector.",
+        "Enable to allow players to manage multiple separate claim profiles via an active profile selector GUI.",
         "WARNING: If you disable this after players have already created multiple profiles, ",
-        "they will lose access to all but their primary profile! (Unless they switch back)",
+        "they will lose access to all secondary profiles! Switch back to enable them again.",
         "Use with caution."
     })
     public boolean multiProfilesEnabled = false;
-    @Comment("Maximum number of profiles a single player is allowed to create (own)")
+
+    @Comment("Maximum number of separate claim profiles a single player is allowed to own/create.")
     public int maxProfilesPerPlayer = 2;
 
+    @Comment("Cooldown in seconds for the /claim unstuck command to prevent spamming.")
     public int cooldownUnstuck = 30;
 
-    @Comment("Map Integration")
+    @Comment("Integration settings for web-based live maps (Dynmap, BlueMap, Squaremap, Pl3xmap).")
     public MapConfig dynmap = new MapConfig();
     public MapConfig bluemap = new MapConfig();
     public MapConfig squaremap = new MapConfig();
     public MapConfig pl3xmap = new MapConfig();
 
     public static class MapConfig extends OkaeriConfig {
+        @Comment("Enable/disable this specific map integration.")
         public boolean enabled = true;
+        @Comment("Fill color for the claim areas on the map (Hex color code without #).")
         public String fillColor = "3366FF";
+        @Comment("Fill opacity for the claim areas on the map (0.0 = fully transparent, 1.0 = fully solid).")
         public double fillOpacity = 0.3;
+        @Comment("Border color for the claim areas on the map (Hex color code without #).")
         public String borderColor = "3366FF";
+        @Comment("Border opacity for the claim areas on the map (0.0 = fully transparent, 1.0 = fully solid).")
         public double borderOpacity = 0.8;
     }
 
-    public boolean autoClaimDefault = false;
-    public boolean autoUnclaimDefault = false;
+    @Comment("Default maximum number of chunks a player is allowed to claim (can be bypassed with landclaim.limit.X permission).")
     public int chunkClaimLimit = 5;
 
-    @Comment("Maximum number of claims a player can be a member of (default: 1)")
+    @Comment("Maximum number of claims a player is allowed to join as a trusted member (default: 1).")
     public int maxMemberships = 1;
 
-    @Comment("Database Settings (Supported: MYSQL, SQLITE)")
+    @Comment("Database connection and backend settings (Supported backends: SQLITE, MYSQL, MARIADB).")
     public DatabaseConfig database = new DatabaseConfig();
 
     public static class DatabaseConfig extends OkaeriConfig {
-        @Comment("Database type: SQLITE or MYSQL")
+        @Comment("Database type: SQLITE, MYSQL, or MARIADB")
         public String type = "SQLITE";
-        @Comment("MySQL/MariaDB host (ignored for SQLite)")
+        @Comment("MySQL/MariaDB host address (ignored for SQLite)")
         public String host = "localhost";
         @Comment("MySQL/MariaDB port (ignored for SQLite)")
         public int port = 3306;
         @Comment("Database name")
         public String databaseName = "landclaim";
         @Comment("MySQL/MariaDB username (leave empty for SQLite)")
         public String username = "";
-        @Comment({"MySQL/MariaDB password (leave empty for SQLite)",
-            "Can also be set via LANDCLAIM_DB_PASSWORD environment variable for security"})
+        @Comment({
+            "MySQL/MariaDB password (leave empty for SQLite)",
+            "For improved security, this can also be set via the LANDCLAIM_DB_PASSWORD environment variable."
+        })
         public String password = "";
-        @Comment("Table prefix for all plugin tables")
+        @Comment("Table prefix for all plugin tables in the database")
         public String tablePrefix = "lc_";
-        @Comment("Maximum number of database connections in the pool")
+        @Comment("Maximum number of active database connections in the HikariCP pool")
         public int maximumPoolSize = 10;
-        @Comment("Minimum number of idle connections in the pool")
+        @Comment("Minimum number of idle connections to maintain in the pool")
         public int minimumIdle = 2;
-        @Comment("Connection timeout in milliseconds")
+        @Comment("Maximum connection timeout in milliseconds before failing")
         public long connectionTimeout = 30000;
     }
 
-    @Comment("Redis Cross-Server Sync Settings")
+    @Comment("Redis settings for cross-server synchronization (useful for BungeeCord/Velocity proxy networks).")
     public RedisConfig redis = new RedisConfig();
 
     public static class RedisConfig extends OkaeriConfig {
+        @Comment("Enable/disable Redis synchronization.")
         public boolean enabled = false;
+        @Comment("Redis server host address.")
         public String host = "localhost";
+        @Comment("Redis server port.")
         public int port = 6379;
+        @Comment("Redis server password (leave empty if no authentication is required).")
         public String password = "";
+        @Comment("Redis Pub/Sub channel name used for synchronization messages.")
         public String channel = "landclaim:sync";
     }
 
+    @Comment({
+        "WorldGuard Adjacency Protection Gap",
+        "Minimum distance in chunks that must be maintained between a player claim and any WorldGuard region.",
+        "Set to 0 to disable this gap restriction."
+    })
     public int worldguardGap = 0;
+
+    @Comment({
+        "Claim Adjacency Protection Gap",
+        "Minimum distance in chunks that must be maintained between claims owned by different players.",
+        "Set to 0 to allow players to claim chunks adjacent to other players' claims."
+    })
     public int minClaimGap = 0;
 
+    @Comment("Interval in server ticks (20 ticks = 1 second) for updating the player action bar display (boundary titles, claim status, etc.).")
     public int actionbarUpdateInterval = 20;
 
-    @Comment("Default maximum warps per player (bypass with landclaim.warps.limit.X)")
+    @Comment("Default maximum claim warps a player can set (can be bypassed with landclaim.warps.limit.X permission).")
     public int maxWarps = 3;
 
     @Comment({
-        "LuckPerms / Bukkit Permissions",
+        "LuckPerms / Bukkit Permissions Bypass",
         "If true, separate permissions like landclaim.menu.<menu>, landclaim.menu.*, ",
         "and command-specific permissions (e.g., landclaim.unstuck) will be checked.",
-        "If false, separate permissions are bypassed so you don't have to configure a permission system."
+        "If false, these separate permissions are bypassed. This is ideal for friendly/vanilla SMP ",
+        "servers where players don't want to set up an elaborate permission group system."
     })
     public boolean useSeparatePremission = false;
 

tasks/todo.md

@@ -11,7 +11,15 @@
 - [x] Document the new config option in `docs/CONFIGURATION.md` <!-- id: 7 -->
 - [x] Create logical git commits for the changes <!-- id: 8 -->
 
+# Follow-up: Make config more understandable and remove unused things
+- [x] Clean up `PluginConfig.java` by removing unused fields (`claimWandItem`, `autoClaimDefault`, `autoUnclaimDefault`) <!-- id: 9 -->
+- [x] Add detailed, readable comments/descriptions to all configuration fields in `PluginConfig.java` <!-- id: 10 -->
+- [x] Remove unused settings from `docs/CONFIGURATION.md` and update documentation for clarity <!-- id: 11 -->
+- [x] Verify compilation succeeds with Maven <!-- id: 12 -->
+- [x] Commit the changes <!-- id: 13 -->
+
 ## Review
-- [x] Centralized checks correctly handle separate permissions or bypass them when disabled.
-- [x] Documentation is complete.
-- [x] Changes are committed.
+- [x] Unused configuration parameters are removed cleanly from source code and docs.
+- [x] Detailed Okaeri comments are added to all configuration fields.
+- [x] Project compiles and builds successfully.
+- [x] Changes are logically committed.