# Essential Utils<\/p>\n
   <\/p>\n
> A **Folia-optimized survival convenience plugin** for Paper\/Folia 1.21.8.
\n> Adds smooth, lag-free mechanics like tree chopping, vein mining, and auto-farming.<\/p>\n
—<\/p>\n
## \u2728 Features<\/p>\n
– **\ud83c\udf32 Tree Assist (axe)**
\n – Incrementally chops connected logs with **per-block delay** (smooth, no spikes).
\n – **Leaf checks** to avoid cutting adjacent trees.
\n – **Optional auto-replant** (saplings\/propagules), retries with cooldown until successful.
\n – Durability decreases **once per N blocks**, not per block.<\/p>\n
– **\u26cf Vein Mine (pickaxe)**
\n – Incrementally mines connected ore veins.
\n – Enforces **Minecraft tool tier rules**:
\n – If tier too low \u2192 **no break**, **alert shown** (rate-limited).
\n – Delay per block scales with vein size.
\n – Durability decreases once per N blocks.<\/p>\n
– **\ud83c\udf3e Auto Farm (hoe)**
\n – Harvests **only mature crops** in a radius.
\n – No auto-replant (intentional).
\n – Optimized for local chunk scans.<\/p>\n
– **\u2699 Activation**
\n – **Hold Shift for 5 seconds** \u2192 arms tool (progress bar shown).
\n – Once armed, stays armed even after releasing Shift.
\n – **Deactivates only when item is changed** or player quits.<\/p>\n
– **\ud83d\udee1 Safety**
\n – Respects protections (future: WorldGuard\/GriefDefender hooks).
\n – Requires loaded chunks.
\n – Folia region-safe scheduling only (no async hacks).<\/p>\n
– **\ud83d\udcca Performance**
\n – Centralized per-player tick budget.
\n – Strict per-feature caps.
\n – Smooth staggered breaking.<\/p>\n
—<\/p>\n
## \ud83d\udcc2 Project Structure<\/p>\n
“`
\nsrc\/main\/java\/net\/ppekkungz\/essentialUtils\/
\n\u251c\u2500\u2500 EssentialUtils.java
\n\u251c\u2500\u2500 config\/PluginConfig.java
\n\u251c\u2500\u2500 state\/StateManager.java
\n\u251c\u2500\u2500 listener\/ActivationListener.java
\n\u251c\u2500\u2500 work\/
\n\u2502 \u251c\u2500\u2500 WorkService.java
\n\u2502 \u251c\u2500\u2500 WorkItem.java
\n\u2502 \u2514\u2500\u2500 WorkQueue.java
\n\u251c\u2500\u2500 features\/
\n\u2502 \u251c\u2500\u2500 Feature.java
\n\u2502 \u251c\u2500\u2500 tree\/TreeAssistFeature.java
\n\u2502 \u251c\u2500\u2500 vein\/VeinMineFeature.java
\n\u2502 \u2514\u2500\u2500 farm\/AutoFarmFeature.java
\n\u251c\u2500\u2500 util\/
\n\u2502 \u251c\u2500\u2500 HarvestUtil.java
\n\u2502 \u251c\u2500\u2500 Materials.java
\n\u2502 \u2514\u2500\u2500 Ores.java
\n\u2514\u2500\u2500 indicator\/
\n \u251c\u2500\u2500 BossBarIndicator.java
\n \u2514\u2500\u2500 ActionBarIndicator.java
\n“`<\/p>\n
—<\/p>\n
## \u26a1 Usage<\/p>\n
1. Drop `EssentialUtils-x.x.x.jar` into your `plugins\/` folder.
\n2. Run with **Paper 1.21.8+** and **Folia**.
\n3. Config (`config.yml`) is generated on first run.<\/p>\n
### Commands
\n“`bash
\n\/eutils reload # reloads config.yml
\n“`<\/p>\n
### Permission
\n“`
\nessentialutils.admin # required for \/eutils reload (default: op)
\n“`<\/p>\n
—<\/p>\n
## \u2699 Config Highlights<\/p>\n
“`yaml
\nactivation:
\n holdSneakSeconds: 5
\n requireToolWhileHold: true<\/p>\n
features:
\n treeAssist:
\n breakDelayTicks: 2
\n durabilityPerNBlocks: 8
\n replant:
\n enabled: true
\n retryCooldownTicks: 5
\n maxRetries: 10<\/p>\n
veinMine:
\n breakDelayBaseTicks: 1
\n breakDelayExtraPer16: 1
\n durabilityPerNBlocks: 10
\n alertOnInsufficientTier: true<\/p>\n
autoFarm:
\n replant: false
\n“`<\/p>\n
—<\/p>\n
## \ud83d\udee0 Build<\/p>\n
Requires:
\n– JDK **21**
\n– Gradle (wrapper included)<\/p>\n
Build with:
\n“`bash
\n.\/gradlew build
\n“`<\/p>\n
Jar output: —<\/p>\n ## \u2705 TODO \/ Roadmap<\/p>\n – [x] Tree Assist (incremental, replant, durability-per-N) —<\/p>\n ## \ud83d\udcdc License<\/p>\n MIT \u00a9 2025 ppekkungz<\/p>\n","protected":false},"excerpt":{"rendered":" tree chopping, vein mining, and auto-farming.<\/p>\n","protected":false},"featured_media":65493,"template":"","meta":{"_minecraft_slug":"essentialutils","_minecraft_project_id":"zbPvI2b0","_minecraft_author":"PPekKunGz","_minecraft_license":"MIT","_minecraft_downloads":198,"_minecraft_follows":2,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"essentialutils.zip","_minecraft_size_bytes":34892,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-16T12:44:55.650525Z","_minecraft_date_created":"2025-11-13T00:31:15.114246Z","_minecraft_date_modified":"2025-11-09T14:53:19.642742Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/essentialutils","_minecraft_icon_attachment_id":65493,"_minecraft_imported_at":"2026-06-03T18:22:22+00:00","_minecraft_import_hash":"859480221b67423c5d95cdb17b42f767","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[124,88,125,90,127,129,123,92],"mod_loader":[130,131,132,134],"minecraft_version":[62,37,40,73,74,38,78,79,80,81,82],"class_list":["post-65492","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-bukkit","mod_category-equipment","mod_category-folia","mod_category-optimization","mod_category-paper","mod_category-spigot","mod_category-technology","mod_category-utility","mod_loader-bukkit","mod_loader-folia","mod_loader-paper","mod_loader-spigot","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9"],"yoast_head":"\n
\n“`
\nbuild\/libs\/essential-utils-
\n“`<\/p>\n
\n– [x] Vein Mine (incremental, tier alerts, delay scaling, durability-per-N)
\n– [x] Auto Farm (mature crops only, no replant)
\n– [x] Activation (Shift-hold progress, persists armed, deactivates on item change)
\n– [x] Config reload (`\/eutils reload`)
\n– [x] Folia-safe scheduling
\n– [x] Strict per-feature caps
\n– [ ] Protection hooks (WorldGuard\/GriefDefender)
\n– [ ] BossBar indicators during ACTIVE
\n– [ ] Configurable durability rules per tool type
\n– [ ] Additional auto-farm crops (bamboo, sugarcane, kelp)
\n– [ ] Multi-language messages
\n– [ ] Metrics toggle (bStats)
\n– [ ] Per-player toggle commands (enable\/disable features individually)<\/p>\n