ButtomHome

# ButtonHome 🏠✨ ButtonHome is a next-generation, premium home management plugin designed exclusively for modern **Paper servers (1.21.x – 1.22.x)**. By abandoning traditional, outdated chest-inventory-based GUIs and chat message spam, ButtonHome leverages modern Paper **Native Dialog UIs**, rich **Kyori MiniMessage formatting**, integrated **3D audio cue chimes**, and an interactive, **Searchable Paginated Icon Picker** to provide an unmatched, highly immersive player experience without requiring any client-side mods, textures, or resource pack overlays. --- ## 🌟 Core Features * 🖥️ **Native Paper Dialogs UI**: Displays elegant, client-side dialogue cards directly in the player's viewport. Emojis and visual indicators are rendered directly on the first-page slots for effortless, high-contrast navigation. * 🔍 **Searchable Icon Picker**: Lists hundreds of valid Minecraft materials as selectable icons with real-time text query filtering and alpha-sorted pagination. * ⏳ **Action Bar Warmup HUD**: Renders active teleport countdown timers cleanly on the player's action bar, completely avoiding chat window spam. * 🔊 **Synthesized Sound Effects**: Incorporates delightful sound schemes (such as Enderman teleports, level-up chimes, and chimes) for interactive UI actions. * 🛡️ **Movement & Damage Checks**: Aborts pending warmups instantly if the player takes damage or moves away from their original coordinate block. * ❌ **Seamless Navigation**: Handlers for escape keys and dedicated exit buttons are accessible on all dialogue screens for natural closure. * 👑 **Operator Inspection Panel**: Administrators can view any player's slot grid using administrative commands and execute direct teleports. --- ## 🛠️ Command Reference ButtonHome features a clean command architecture designed for high-performance tab-completion: | Command | Syntax | Description | Default Permission | | :--- | :--- | :--- | :--- | | `/home` | `/home ` | Opens the native Dialog grid or teleports directly to a home. | `buttonhome.use` | | `/sethome` | `/sethome ` | Triggers the creation input Dialog or saves current coordinates. | `buttonhome.use` | | `/delhome` | `/delhome <name>` | Permanently removes the selected home and vacates the slot. | `buttonhome.use` | | `/homes` | `/homes ` | Opens the paginated home slot grid index or shows a plain list. | `buttonhome.use` | | `/homecancel` | `/homecancel` | Aborts a pending teleportation warmup sequence. | `buttonhome.use` | | `/adminhome` | `/adminhome <player>` | Inspect and manage the active homes grid of a target player. | `buttonhome.admin` | | `/buttonhome` | `/buttonhome <reload>` | Reloads the configuration file and database structures. | `buttonhome.admin` | --- ## 🔑 Permissions & LuckPerms Limit Nodes The plugin supports modern permission managers, with a soft dependency on **(https://modrinth.com/plugin/luckperms)** for handling dynamic home slot limit calculations: * **`buttonhome.use`** *(Default: true)* — Allows access to basic home commands and interface interactions. * **`buttonhome.admin`** *(Default: op)* — Grants access to target grid inspection and admin commands. * **`buttonhome.bypass.warmup`** *(Default: false)* — Bypasses teleport warmups for instant travel. * **`buttonhome.bypass.cooldown`** *(Default: false)* — Bypasses active teleportation cooldown timers. ### 📊 Dynamic Limits (1 to 50) Configure custom player rank limits smoothly. ButtonHome parses and awards the highest numerical limit: * `buttonhome.limit.1` — Restricts the player or group to 1 home slot. * `buttonhome.limit.5` — Restricts the player or group to 5 home slots. * `buttonhome.limit.10` — Restricts the player or group to 10 home slots. * `buttonhome.limit.25` — Restricts the player or group to 25 home slots. * `buttonhome.limit.50` — Grants full access to all 50 available home slots. --- ## ⚙️ Configuration (`config.yml`) The primary configuration file supports rich MiniMessage styling, RGB hex color tags, and custom settings: ```yaml # Home limit for players without a specific permission node default-max-homes: 2 # Warmup time (seconds) standing still before teleporting warmup-seconds: 5 # Cancel teleport if the player moves or takes damage cancel-on-move: true cancel-on-damage: true teleport-cooldown-seconds: 0 # Player-facing messages (formatted with MiniMessage) messages: no-permission: "<#ef4444>You do not have permission to use this command!</#ef4444>" invalid-name: "<#ef4444>Invalid name! Use only letters, numbers, hyphens, and underscores.</#ef4444>" home-set: "<#10b981>Home <#f9fafb>%home%</#f9fafb> has been set at your current location!</#10b981>" home-deleted: "<#ef4444>Home <#f9fafb>%home%</#f9fafb> has been deleted.</#ef4444>" warmup-start: "<#f59e0b>⏳ Teleporting to %home% in %seconds% seconds. Do not move!</#f59e0b>" teleport-success: "<#10b