Mater_Home

# Home插件 - 家庭传送系统 ## English ### 📋 Description A lightweight and feature-rich home management system for Minecraft servers running Bukkit/Paper 1.17+. Players can set multiple homes, teleport with GUI or commands, fully configurable with cooldown system and PlaceholderAPI support. ### ✨ Features - **Multiple Homes** - Set unlimited homes with custom names - **Dual Interface** - Choose between GUI menu or text commands - **Cooldown System** - Configurable teleport cooldown (default 3s) - **Cross-World Support** - Teleport between different worlds - **Fully Configurable** - Customize messages, limits, and more - **PlaceholderAPI** - Support for placeholders like %home_count% - **YAML Storage** - Lightweight and reliable data storage ### 📋 Commands | Command | Description | Permission | |---------|-------------|------------| | `/sethome ` | Set a home (default: "home") | home.set | | `/home ` | Teleport to home (default: "home") | home.use | | `/delhome <name>` | Delete a home | home.delete | | `/homes` | Open GUI to choose home | home.use | | `/homelist` | View all homes as text list | home.use | ### 🔐 Permissions | Permission | Description | Default | |------------|-------------|---------| | `home.use` | Basic teleport permission | `true` | | `home.set` | Set home permission | `true` | | `home.delete` | Delete home permission | `true` | | `home.multiple` | Multiple homes permission | `true` | | `home.bypass.cooldown` | Bypass cooldown | `false` | | `home.*` | All permissions | `op` | ### ⚙️ Configuration File location: `plugins/Home/config.yml` ```yaml # Cooldown settings (seconds) cooldown: enabled: true time: 3 # Cross-world teleport cross-world: enabled: true # Home limit (-1 = unlimited) home-limit: -1 # Customize all messages with color codes messages: prefix: "&8 &r" home-set: "&aSuccessfully set home &e{name}&a!" home-teleport: "&aTeleporting to home &e{name}&a..." home-cooldown: "&cPlease wait &e{time}&c seconds!" # ... more messages ``` ### 🎮 Usage Examples ```minecraft # Set default home /sethome # Set a named home /sethome base # Teleport to default home /home # Teleport to named home /home base # Open GUI to choose home /homes # View all homes as text list /homelist # Delete a home /delhome base ``` ### 🔌 PlaceholderAPI Variables | Variable | Description | |----------|-------------| | `%home_count%` | Number of homes | | `%home_limit%` | Home limit | | `%home_cooldown%` | Remaining cooldown | | `%home_has_<name>%` | Check if has specific home | ### 📦 Installation 1. Download `home-plugin-1.0.0.jar` 2. Place it in your server's `plugins` folder 3. Restart the server or use `plugman load Home` 4. Configure in `plugins/Home/config.yml` ### 💾 Data Storage - Player data stored in `plugins/Home/playerdata/` - Each player has a YAML file named by UUID - Contains home name, world, coordinates, yaw, pitch - Auto-save and auto-load ### 📌 Notes - Default teleport cooldown is 3 seconds (configurable) - Default home limit is unlimited (configurable) - Cross-world teleport enabled by default (configurable) - Console cannot use these commands --- ## 中文 ### 📋 插件介绍 一个轻量级且功能丰富的家庭管理系统，适用于运行 Bukkit/Paper 1.17+ 的 Minecraft 服务器。玩家可以设置多个家，通过 GUI 或命令传送，支持冷却系统、跨世界传送和 PlaceholderAPI。 ### ✨ 功能特点 - **多家庭支持** - 可设置无限数量的命名家 - **双界面选择** - 支持 GUI 菜单和文本命令两种方式 - **冷却系统** - 可配置的传送冷却时间（默认3秒） - **跨世界传送** - 支持在不同世界之间传送 - **完全可配置** - 自定义消息、数量限制等 - **PlaceholderAPI** - 支持占位符如 `%home_count%` - **YAML存储** - 轻量可靠的数据存储方式 ### 📋 命令列表 | 命令 | 描述 | 权限 | |------|------|------| | `/sethome ` | 设置家（默认："home"） | home.set | | `/home ` | 传送到家（默认："home"） | home.use | | `/delhome <名称>` | 删除家 | home.delete | | `/homes` | 打开 GUI 选择家 | home.use | | `/homelist` | 文本列表查看所有家 | home.use | ### 🔐 权限节点 | 权限 | 描述 | 默认值 | |------|------|--------| | `home.use` | 基础传送权限 | `true` | | `home.set` | 设置家权限 | `true` | | `home.delete` | 删除家权限 | `true` | | `home.multiple` | 多家庭功能权限 | `true` | | `home.bypass.cooldown` | 绕过冷却权限 | `false` | | `home.*` | 所有权限 | `op` | ### ⚙️ 配置说明 配置文件位置：`plugins/Home/config.yml` ```yaml # 冷却时间设置（秒） cooldown: enabled: true time: 3 # 跨世界传送设置 cross-world: enabled: true # 家庭数量限制（-1 表示无限制） home-limit: -1 # 所有消息都可以自定义颜色 messages: prefix: "&8 &r" home-set: "&a成功设置家 &e{name}&a！" home-teleport: "&a正在传送到家 &e{name}&a..." home-cooldown: "&c请等待 &e{time}&c 秒！" # ... 更多消息 ``` ### 🎮 使用示例 ```minecraft # 设置默认家 /sethome # 设置命名家 /sethome 基地 # 传送到默认家 /home # 传送到命名家 /home 基地 # 打开 GUI 选择家 /homes # 文本列表查看所有家 /homelist # 删除家 /delhome 基地 ``` ### 🔌 PlaceholderAPI 变量 | 变量 | 说明 | |------|------| | `%home_count%` | 家庭数量 | | `%home_limit%` | 家庭上限 | | `%home_cooldown%` | 剩余冷却时间 | | `%home_has_<名称>%` | 检查是否有指定家 | ### 📦 安装方法 1. 下载 `home-plugin-1.0.0.jar` 2. 放入服务器的 `plugins` 文件夹 3. 重启服务器或使用 `plugman load Home` 4. 配置文件在 `plugins/Home/config.yml` ### 💾 数据存储 - 玩家数据保存在 `plugins/Home/playerdata/` 目录 - 每个玩家一个 YAML 文件，以 UUID 命名 - 包含家名称、世界、坐标、朝向