SimpleCrawling

---

📖 OVERVIEW & HOW IT WORKS

SimpleCrawling adds manual crawling to your server in a clean and intuitive way. It works perfectly for survival, roleplay, adventure maps, stealth systems, minigames, and any server that wants a manual crawling mechanic without unnecessary complexity.

How Does It Work?
SimpleCrawling listens for a quick double sneak (shift) input. When a player triggers crawling, the plugin places them into a crawl state and keeps that state active while they move. If the player toggles crawling off, disconnects, or the plugin is disabled, the crawling session is stopped safely.

No bloated setup, no unnecessary complexity, just a practical crawling mechanic with useful API support.

---

✨ PLUGIN FEATURES

• Double-Shift Activation: Quick double-shift to start crawling.
• Toggle-Based System: Players remain in crawl mode until intentionally stopped.
• Highly Configurable: Reload command, customizable messages, and configurable hitbox offsets.
• Robust Developer API: Methods for starting, stopping, and checking crawl state.
• Custom Events: Cancellable events for easy integration.
• Optimized: Lightweight and simple to use.

---

⚙️ COMMANDS & PERMISSIONS

---

🛠️ CONFIGURATION

The configuration is straightforward and gives you full control:

• hitbox-offset: Controls the vertical offset used by the crawling system.
• Messages: Fully customize all plugin messages through a separate messages file.

---

💻 DEVELOPER API

SimpleCrawling includes a robust API for plugin developers who want to control crawling through code or restrict it in certain areas.

Methods:

plugin.startCrawling(player);
plugin.stopCrawling(player);
plugin.isCrawling(player);

plugin.forceStartCrawling(player);
plugin.forceStopCrawling(player);

Events:

• PlayerStartCrawlingEvent
• PlayerStopCrawlingEvent

Both events are cancellable, meaning other plugins can easily prevent a player from starting or stopping a crawl when needed.

Example Usage:

@EventHandler
public void onStart(PlayerStartCrawlingEvent event) {
    if (event.getPlayer().hasPermission("crawl.blocked")) {
        event.setCancelled(true);
    }
}

---

🔗 LINKS & SUPPORT

---