HomePlugin

<div align="center"> # 🏡 HomePlugin **A lightweight, flexible home & teleport management plugin for Paper/Spigot servers** (https://jitpack.io/v/fuzeblocks/HomePlugin.svg)](https://jitpack.io/#fuzeblocks/HomePlugin) (https://img.shields.io/discord/1394947383560900618?color=5865F2&logo=discord&logoColor=white&label=Discord)](https://discord.gg/5zJyKz6Nfm) (https://img.shields.io/badge/license-Apache--2.0-orange.svg)](https://github.com/fuzeblocks/HomePlugin?tab=Apache-2.0-1-ov-file) **Stable • Fast • Modular • API-Driven** (#-features) • (#%EF%B8%8F-installation) • (#-commands) • (#%EF%B8%8F-configuration) • (https://fuzeblocks.github.io/HomePlugin/) !(https://bstats.org/signatures/bukkit/HomePlugin.svg) </div> --- ## ✨ Features ### 🏠 **Core Functionality** - **Named Homes** - Set multiple homes with custom names and optional metadata - **Global Spawn** - Server-wide spawn point management - **Teleport Requests (TPA)** - Request to teleport to other players with configurable timeout - **Random Teleport (RTP)** - Random teleport with cooldown and radius controls - **Back Command** - Return to your previous location ### 🗄️ **Flexible Storage** - **YAML** (default) - Simple file-based storage - **MySQL** - Full database support for larger servers - **Redis Caching** - Optional cross-instance cache synchronization ### 🎮 **Player Experience** - **Interactive GUI** - Visual home management interface - **Multiple Languages** - French, English, Spanish, Russian, Ukrainian, German, Turkish - **Teleport Warmup** - Configurable delays with titles, messages, and particles - **Permission-Based Limits** - Dynamic home limits via permissions ### 🔌 **Integrations** - **PlaceholderAPI** - Rich placeholders for homes, counts, and locations - **Vault Economy** - Optional costs for home creation, teleportation, TPA, and RTP ### 🛠️ **Administration** - **Admin Tools** - Manage other players' homes, spawn points, and cache - **World Restrictions** - Block home creation in specific worlds - **Location Validation** - Prevent unfair placements - **Modular Architecture** - Extensible plugin loader for custom modules --- ## ⬇️ Installation 1. **Download** the latest release from (https://github.com/fuzeblocks/HomePlugin/releases) or build from source 2. **Place** the JAR file into your server's `plugins/` folder 3. **Start** your server to generate default configuration files 4. **Configure** `plugins/HomePlugin/config.yml` to your preferences 5. **Restart** or reload your server ### Quick Configuration Tips - ✅ Works out-of-the-box with YAML storage - 🗄️ For MySQL: Configure credentials in `config.yml` before restarting - 🚀 For Redis: Set `Use-Redis: true` and ensure Redis server is accessible --- ## 🧾 Commands ### Player Commands | Command | Description | Permission | |---------|-------------|------------| | `/sethome ` | Create or update a home | `homeplugin.command.sethome` | | `/home ` | Teleport to a home (opens GUI if no name) | `homeplugin.command.home` | | `/delhome <name>` | Delete a home | `homeplugin.command.delhome` | | `/listhome` (`/homes`) | List all your homes | `homeplugin.command.listhome` | | `/renamehome <old> <new>` | Rename an existing home | `homeplugin.command.renamehome` | | `/relocatehome <name>` | Move a home to your current location | `homeplugin.command.relocatehome` | | `/back` | Return to your previous location | `homeplugin.command.back.use` | | `/spawn` | Teleport to server spawn | `homeplugin.command.spawn` | | `/tpa <player>` | Request to teleport to a player | `homeplugin.command.tpa.use` | | `/tpaccept <player>` | Accept a teleport request | `homeplugin.command.tpa.use` | | `/tpdeny <player>` | Deny a teleport request | `homeplugin.command.tpa.use` | | `/rtp` | Random teleport (if enabled) | `homeplugin.command.rtp` | | `/warp <name>` | Teleport to a predefined warp | `homeplugin.command.warp.use` | ### Admin / Utility Commands | Command | Description | Permission | |---------|-------------|------------| | `/setspawn` | Set the global spawn point for the current world | `homeplugin.admin` (or `homeplugin.admin.spawn.set`) | | `/delspawn` | Remove the global spawn point for the current world | `homeplugin.admin` (or `homeplugin.admin.spawn.delete`) | | `/homeadmin <player>` | Manage another player's homes (create/delete/edit) | `homeplugin.admin` (or `homeplugin.admin.home.manage`) | | `/cache view` | View cache statistics | `homeplugin.admin` (or `homeplugin.admin.cache.view`) | | `/cache clearall` | Clear all plugin caches | `homeplugin.admin` (or `homeplugin.admin.cache.clear`) | | `/cache player <name>` | Clear cache for a specific player | `homeplugin.admin` (or `homeplugin.admin.cache.player`) | | `/lang set <code>` | Set the active language (e.g. `en`, `fr`) | `homeplugin.command.lang` | | `/lang update` | Update/merge language fil