FastCane

# 🌾 FastCane ### The sugar cane growth controller for Paper servers !(https://i.imgur.com/SzoZGwZ.gif) > **Tired of waiting 3+ minutes for sugar cane to grow one block?** > FastCane gives you full control — from vanilla speed to near-instant, with zero TPS cost. --- ## ✨ Features - 🚀 **Configurable growth speed** — any tick interval from 1 to 100,000 - ⚡ **Zero TPS impact** — event-driven architecture, no chunk scanning loops - 🌿 **Sugar cane only** — every other plant stays 100% vanilla - ⏸ **Stop / Start** — pause and resume growth anytime - 🔄 **Reset** — back to vanilla speed in one command - 🌍 **Multi-language** — English, Français, 中文 - 💾 **Persistent** — your settings survive restarts - 🎯 **Tab completion** — smart presets built into the command --- ## ⚡ Commands | Command | Description | |---|---| | `/cane` | Show current settings panel | | `/cane tick <ticks>` | Set growth speed | | `/cane tick` | Show current speed & tracked canes | | `/cane stop` | Stop all cane growth | | `/cane start` | Resume cane growth | | `/cane reset` | Reset to vanilla speed (4096 ticks) | | `/cane lang <en\|fr\|zh>` | Change language | | `/cane info` | Show info panel | **Aliases:** `/sugarcane`, `/sc` --- ## ⏱ Speed Reference | Command | Interval | Feel | |---|---|---| | `/cane tick 1` | ~0.05s | 🟢 Near-instant | | `/cane tick 20` | 1s | 🟢 Ultra fast | | `/cane tick 100` | 5s | 🟡 Very fast | | `/cane tick 1000` | 50s | 🟡 Fast | | `/cane tick 4096` | ~3.4 min | 🔵 Vanilla | | `/cane tick 10000` | ~8.3 min | ⚪ Default | > 💡 20 ticks = 1 second --- ## 🔐 Permissions | Permission | Description | Default | |---|---|---| | `fastcane.use` | Use `/cane` & view speed | OP | | `fastcane.admin` | Change speed, stop, start, reset, lang | OP | --- ## ⚙️ How It Works Instead of scanning every block in every loaded chunk each tick *(which destroys TPS)*, FastCane uses an **event-driven index**: - 📦 Chunk loads → cane bases indexed **once** - 🌱 Player places cane → added to index - ⛏ Player breaks cane → removed from index - ⏱ Every X ticks → **only indexed bases** are grown The vanilla `BlockGrowEvent` for sugar cane is cancelled — FastCane is the **sole controller** of cane growth speed. --- ## 📁 Configuration The config file is automatically generated at `plugins/FastCane/config.yml` on first launch. You can edit it directly or use the in-game commands — changes made with `/cane tick`, `/cane stop`, `/cane lang`, etc. are saved automatically without needing to touch the file. ```yaml # plugins/FastCane/config.yml # Growth interval in ticks (20 ticks = 1 second) # Vanilla default: ~4096 ticks (~3.4 min per block) # Lower = faster. Range: 1 - 100000 growth-ticks: 10000 # Vanilla tick value — used by /cane reset vanilla-ticks: 4096 # Language: en, fr, zh lang: en # Is growth active? enabled: true ``` --- ## 📋 Requirements | | | |---|---| | 🖥 Server | (https://papermc.io/) 1.21.x | | ☕ Java | 21+ | | 🌍 Environment | Server-side only | --- ## ❓ FAQ **Does this work with piston farms?** Yes — FastCane only controls when cane *grows*, not how it's *harvested*. **Will `/cane tick 1` lag my server?** With thousands of canes it can add up. Test with `/cane tick 20` first and adjust. **Does this affect bamboo or kelp?** No. Only `SUGAR_CANE` is affected. **The speed I set resets after restart?** It shouldn't — the value is saved automatically to `config.yml`. Check that your server has write permissions to the plugins folder. --- ## 🐛 Issues & Suggestions Found a bug? Open an issue and include: - Your Paper version (`/version`) - FastCane version - What you expected vs what happened - Any console errors --- --- <details> <summary>🇫🇷 Voir en Français</summary> # 🌾 FastCane — Version Française > **Fatigué d'attendre 3+ minutes pour que la canne à sucre pousse d'un bloc?** > FastCane te donne le contrôle total — de la vitesse vanilla à quasi-instantané, sans impact sur les TPS. --- ## ✨ Fonctionnalités - 🚀 **Vitesse configurable** — n'importe quel intervalle de 1 à 100 000 ticks - ⚡ **Zéro impact TPS** — architecture event-driven, aucun scan de chunks - 🌿 **Canne à sucre uniquement** — toutes les autres plantes restent en vanilla - ⏸ **Stop / Start** — pause et reprise de la croissance à tout moment - 🔄 **Reset** — retour à la vitesse vanilla en une commande - 🌍 **Multi-langue** — English, Français, 中文 - 💾 **Persistant** — les paramètres survivent aux redémarrages - 🎯 **Tab completion** — suggestions automatiques intégrées --- ## ⚡ Commandes | Commande | Description | |---|---| | `/cane` | Afficher le panneau de paramètres | | `/cane tick <ticks>` | Définir la vitesse de croissance | | `/cane tick` | Voir la vitesse actuelle | | `/cane stop` | Arrêter toute croissance | | `/cane start` | Reprendre la croissance | | `/cane reset` | Réinitialiser au vanilla (4096 ticks) | | `/cane lang <en\|fr\|zh>` | Changer la langue | | `/cane info` | Afficher le panne