Escape Rope : Quick Exit a Cave

🧗 Escape Rope : Quick Exit a Cave

**Escape Rope** is a **simple** and **configurable** mod that lets players teleport to the surface from caves. Use the rope, wait the cast, and escape safely.

🚀 How it works ?

1. Craft the Escape Rope (if crafting is enabled).

2. Use it with Right click to start casting.

3. Teleport to the surface if a safe spot is found.

4. The rope is consumed

   

---

✨ Features

• 🧗 Quick escape to the surface from caves
• ⏱️ Configurable cast time
• 🛑 Optional cancel on damage
• 🧭 Layer limit check (only works below a configurable height, can be disable)
• ✅ Safe landing checks (air at feet/head, solid below, no fluids)
• 🧪 Configurable crafting recipe and bench tier
• 📦 Configurable max stack size
• ✨ Particles effects
• 🧩 Usable with a command, admin command to escape someone with permission

---

🧰 Command

Command	Description
/escape	Triggers the teleport (debug, no item required)
/escape reload	Reloads the plugin configuration
/escape [player]	Teleports another player

---

🔐 Permissions (defaults)

Feature	Permission
Use /escape	escaperope.use
Use /escape [player]	escaperope.other
Use /escape reload	escaperope.reload

Permissions are fully editable in the config.

---

⚙️ Configuration

The configuration file is generated on server startup.

main

Key	Description	Default
LayerLimitEnabled	Enable the layer height check	true
LayerLimit	Maximum Y level for rope use	115
CastTimeSeconds	Cast duration in seconds	2.0
CancelOnDamage	Cancel if the player takes damage	true
ConsumeOnUse	Consumes item in Adventure	true
EscapeCommandAllowedForEveryone	Allow everyone to use /escape	false
MessagePrefix	Prefix for all messages	[Escape Rope]
CraftEnabled	Enable crafting for the item	true

🧰 commands

Key	Description	Default
Enabled	Register the main command	true
Name	Main command name	escape
Aliases	Aliases for the main command	[]
ReloadName	Subcommand name for reload	reload
ReloadAliases	Aliases for reload	[]

🔐 permissions

Key	Description	Default
EscapeSelf	Permission for /escape	minibox.escaperope.command.escape
EscapeOther	Permission for /escape <player>	minibox.escaperope.command.escape.other
EscapeReload	Permission for /escape reload	minibox.escaperope.command.escape.reload

📦 item

Key	Description	Default
MaxStack	Max stack size	1
undefined

🧪 overrideRecipe

Only used when CraftEnabled = true. If Enabled = false, the default recipe values are used (no override).

Key	Description	Default
Enabled	Enable recipe generation	false
TimeSeconds	Crafting duration in seconds	1.0
OutputQuantity	Output amount	1
BenchId	Workbench id	Workbench
BenchType	Workbench type	Crafting
BenchCategories	Workbench categories	[ "Workbench_Tools" ]
BenchRequiredTierLevel	Required bench tier	0
Input	Ingredients list	see below

Default ingredients

• 3 * Fibers
• 1 * Light Hide
• 50 * Life Essences

---

🌍 Language Files

The plugin provides localized item names and messages.

Current languages: EN, FR, ES, PT, IT, DE, TR, UA, RU, AR. (translated by ChatGPT sorry)

---