Перейти к содержимому
Mineforgian

zHomes

A powerful home management plugin for spigot/paper servers.

Загрузки
4K
Подписчики
5
Обновлён
30 апреля 2026 г.
Лицензия
MIT

Опубликован 3 января 2024 г.

Исходный кодСообщить об ошибке

zHomes Banner

Modrinth Hangar SpigotMC bStats

Discord Build Status Latest Release

About the Project zHomes is a modern, fast and fully-configurable homes plugin for Spigot/Paper/Purpur/PufferFish servers. It focuses on simplicity, speed and customization so server owners can give players a familiar — but powerful — teleportation experience.

Some features:

  • Create, delete and list homes
  • Admin tools for managing and converting homes
  • PlaceholderAPI support for message placeholders
  • MiniPlaceholders support for minimessage placeholders
  • Vault support for economy/command-costs
  • GriefPrevention and WorldGuard integration for region checks
  • Teleport warmup and safe-teleport checks
  • Configurable commands, messages and permissions
  • 100% configurable menus
  • Uses SQL (H2/SQLite/MariaDB/MySQL) for storage (no local data/ directory)

Maintained by yL3oft. This project is free and open-source.

Quick Setup

Requirements

  • Java 17+ (check release notes for exact JDK requirement)
  • Paper, Spigot or a compatible fork

Installation

  1. Download the latest JAR from Releases / Modrinth / Hangar / Spigot.
  2. Place the JAR in your server's plugins/ folder.
  3. Start the server once to generate config files (src/main/resources/config.yml defaults).
  4. You're done!

Quick test

  • As a player: /sethome home1 then /home home1
  • As an admin: /zhomes reload

Commands

Admin

  • /zhomes info — Shows plugin info and stats.
  • /zhomes reload — Reloads plugin configuration and messages.
  • /zhomes version <update> — Checks the plugin version and updates if <update> is specified.
  • /zhomes nearhomes [radius] <-u <user> -h <home>> — Check for homes near a location (your location by default). Admins can specify a user and home to check near that home.
  • /zhomes parse <player> <string> - Parse a string with Plugin Placeholders & PlaceholderAPI placeholders for a specific player.
  • /zhomes export — Export all homes to a .json.gz file in the plugin folder.
  • /zhomes import <file> — Import homes from a .json.gz file exported by /zhomes export.
  • /zhomes converter <type> — Inline converter tool to import homes from other plugins (example: /zhomes converter ultimatehomes). See detailed converter docs: https://docs.yleoft.me/zhomes/commands-and-permissions/zhomes-converter-less-than-type-greater-than

Player / Home commands

  • /sethome [name] — Create a home (default name if omitted).
  • /delhome [name] — Delete a home. Admins can use /delhome <player:home>.
  • /home [name] — Teleport to a home. Admins can use /home <player:home>.
  • /homes [player] — List homes. Admins can use /homes <player>.
  • /home rename [oldName] [newName] — Rename a home

Notes

  • Command costs and vault integration require Vault to be installed.
  • Some commands have admin-only variants (see Permissions below).

Full command list and usage: https://docs.yleoft.me/zhomes/commands-and-permissions

Permissions

Below are the permission nodes and their default intent as defined in the plugin configuration (zHomes/config.yml). Use your permissions plugin to grant or deny these.

Command permissions

  • zhomes.command.main — Main command (True by default)
    • zhomes.command.main.help — Help SubCommand (Only OP by default)
    • zhomes.command.main.version — Version SubCommand (True by default)
    • zhomes.command.main.info — Info SubCommand (Only OP by default)
    • zhomes.command.main.reload — Reload SubCommand (Only OP by default)
    • zhomes.command.main.nearhomes - Nearhomes SubCommand (Only OP by default)
    • zhomes.command.main.parse — Parse SubCommand (Only OP by default)
    • zhomes.command.main.converter — Converter SubCommand (Only OP by default)
    • zhomes.command.main.importexport — Import & Export SubCommand (Only OP by default)
  • zhomes.command.sethome — /sethome (True by default)
  • zhomes.command.delhome — /delhome (True by default)
    • zhomes.command.delhome.others — /delhome <player:home> (Only OP by default)
  • zhomes.command.homes — /homes (True by default)
    • zhomes.command.homes.others — /homes <player> (Only OP by default)
  • zhomes.command.home — /home (True by default)
    • zhomes.command.home.others — /home <player:home> (Only OP by default)
    • zhomes.command.home.rename — /home rename (True by default)

Bypass / misc permissions (as defined in config.yml)

  • zhomes.bypass.limit — Bypass home limits (Only OP by default)
  • zhomes.bypass.dimensionalteleportation — Bypass dimension restriction (Only OP by default)
  • zhomes.bypass.safeteleport — Bypass safe-teleport checking (False by default)
  • zhomes.bypass.warmup — Bypass teleport warmup (Only OP by default)
  • %command_permission%.bypass.command-cost — Bypass command-cost (Only OP by default). Command-specific bypass permission is generated from the command permission string (see config.yml)
  • %command_permission%.bypass.command-cooldown — Bypass commands cooldown (Only OP by default). Command-specific bypass permission is generated from the command permission string (see config.yml)

If you want to see the authoritative defaults and change them, open src/main/resources/config.yml in the repo or check the live docs: https://docs.yleoft.me/zhomes/commands-and-permissions

Migration

zHomes contains an inline converter to import homes from well-known plugins. The converter runs in-chat (not a GUI). See full converter details here: https://docs.yleoft.me/zhomes/commands-and-permissions/zhomes-converter-less-than-type-greater-than

Integrations

Supported integrations:

  • PlaceholderAPI — Message placeholders supported & custom placeholders provided by zHomes.
  • MiniPlaceholders - MiniMessage placeholders supported for advanced message formatting & custom placeholders provided by zHomes.
  • Vault — for economy-based command-costs.
  • GriefPrevention — region checks integration.
  • WorldGuard — region and flag checks.
  • MiniMessage — advanced message formatting.
  • bStats — anonymous metrics (configurable).

Enable or disable integrations from config and ensure the third-party plugins are installed on the server when you expect integration behavior.

Support & Community

If you find zHomes helpful or need assistance:

Support the project by starring the repo and joining the Discord!

bStats Graph

Ченджлог

3.0.4Релиз26.1, 26.1.1, 26.1.2 · 30 апреля 2026 г.

Dependency Changes

General Changes

  • Added support for 26.1.2
  • Fixed a bug where players with "_" in their name wouldn't see the homes menu

Full Changelog: https://github.com/yL3oft/zHomes/compare/3.0.3...3.0.4

3.0.3Релиз1.21.11, 26.1, 26.1.1 · 7 апреля 2026 г.

Dependency Changes

General Changes

  • Added support for 26.1.1 and 26.1
  • New regex detection system when setting new home, now supports more formats and is more accurate
  • Better coding practices and code organization
  • New checks for database connection and queries, to ensure better stability and error handling
  • Fixed issues related to database connection and queries, improving overall performance and reliability

Config & Language Changes

  • New configurations related to sethome regex detection
  • Update version from both config & language files to 1.0.2

Full Changelog: https://github.com/yL3oft/zHomes/compare/3.0.2...3.0.3

3.0.2Релиз1.21.9, 1.21.10, 1.21.11 · 14 февраля 2026 г.

Dependency Changes

General Changes

  • New purge subcommand to /zhomes to purge data from the database, with alot of filters to choose from, you can read more about it in the wiki.
  • Fixed permissions not registering bug in 3.0.1
  • New permission to announce version updates to players, can be configured in the config.yml

Language Changes

  • Added new messages for the purge subcommand.
  • And removed old keys from 3.0.0 that are no longer used.

Full Changelog: https://github.com/yL3oft/zHomes/compare/3.0.1...3.0.2

3.0.1Релиз1.21.9, 1.21.10, 1.21.11 · 14 февраля 2026 г.

Dependency Changes

General Changes

  • Plugin changed to paper plugin, it will no longer work on spigot or bukkit servers, if you are using spigot or bukkit, please update to paper for better performance and stability.
  • Fix folia compatibility for long distance traveling.
  • Removed support for Minecraft 1.18 and below. Minimum supported version is now Minecraft 1.19.
  • Added MiniPlaceholders support, more info in the wiki
  • New parameter for command /homes: type - This parameter allows you to specify the type of homes output to text or menu, usage: /homes -type <text|menu>, if not specified, it will default to the one in config.yml.
  • /zhomes parse can now be parsed with MiniPlaceholders, allowing you to use placeholders from both MiniPlaceholders and PlaceholderAPI at the same time, without any issues. Also you can now parse without specifing the player.
  • config.yml comments are now translated with the language file (If it's a custom language file, it will fallback to english)
  • Changed the way languages are loaded.
  • Updated the database to have 1 extra column: NAME, this column is used to store the name of the player, it helps with the offline player getter, allowing you to get the name of the player even if they are offline, and also helps with the performance of the plugin, as it reduces the number of queries to the database when getting the name of the player.
  • Auto update is no longer supported, due to the plugin now being a paper plugin.

Language Changes

  • Added new 2 options for /homes:
    • home-string - The string that will be used to display the home in the list of homes, it supports placeholders, you can use %home% to display the name of the home and also supports MiniPlaceholders placeholders.
    • others.home-string - The string that will be used to display the home in the list of homes when the player is viewing other player's homes, it supports placeholders, you can use %home% to display the name of the home, and %player% to display the owner of the home and also supports MiniPlaceholders placeholders.
  • Since the plugin now accepts MiniMessage, /zhomes nearhomes & /homes default home-strings now have hover & click effects to teleport to the home. And /zhomes nearhomes has a click effect on the player name to filter the search to the player's homes.

Full Changelog: https://github.com/yL3oft/zHomes/compare/3.0.0...3.0.1

3.0.0Релиз1.21.9, 1.21.10, 1.21.11 · 30 января 2026 г.

ALERT: This is a major release. Please read the changelog carefully before updating. Specially if you are updating from version 2.x.x.

Dependency Changes

General Changes

  • The whole plugin has been migrated to use zAPI 2.0.0 as a base. This includes changes to how commands, events, and configurations are handled.
  • Refactored codebase for better readability and maintainability.
  • Removed support for Minecraft versions below 1.18.2.
  • Migrated from old coloring system (ChatColor) to more modern text components using MiniMessage for better text formatting and color handling.
  • New subcommand added to /zhomes: /zhomes parse (player) (string) - Parses a string for a specific player's placeholders with the plugin placeholder system.
  • A lot of new features to menus and GUI handling, including better pagination and item management:
  • Improved database connections and query handling for better performance.
  • Rework on dependency management & automatic download system.
  • Rework on how config.yml & languages are handled (This also includes migration to zAPI's new configuration system).
  • A lot of new options in config.yml and in languages (I really don't want to list them all here, go check yourself!)
  • Improved hook detection and management for better compatibility with other plugins.
  • Updated license year to 2026.

What will happen if I update from 2.x.x?

  • The plugin is going to migrate colors from ChatColor to MiniMessage format. If you have custom colors in your config or language files, they will be converted automatically, but it's recommended to review them after the update.
  • The configuration file (config.yml) and language files have been restructured. It's recommended to back them up before updating, as some settings may have changed or been removed.
  • The plugin no longer supports Minecraft versions below 1.18.2. Ensure your server is running a compatible version
  • The menu system for homes has been 100% reworked, and because of that the file of the menu is renamed to "homes-menu.yml", that also means that your old menu file will be ignored. Make sure to back it up if you want to reuse some settings.

Full Changelog: https://github.com/yL3oft/zHomes/compare/2.2.3...3.0.0

2.2.3Релиз1.21.9, 1.21.10, 1.21.11 · 12 декабря 2025 г.

Dependency Changes

General Changes

  • Update to 1.21.11
  • Fix bypass for restricted worlds

Full Changelog: https://github.com/yL3oft/zHomes/compare/2.2.2...2.2.3

2.2.2Релиз1.21.8, 1.21.9, 1.21.10 · 1 декабря 2025 г.

General Changes

  • Fix thread safery & memory leak
  • Quick change in language for restricted-worlds
  • Add limit configuration for nearhomes command and improve radius validation
  • Minor bug fixes and optimizations

Full Changelog: https://github.com/yL3oft/zHomes/compare/2.2.1...2.2.2

2.2.1Релиз1.21.8, 1.21.9, 1.21.10 · 27 ноября 2025 г.

General Changes

  • Added new command to lookup nearby homes: /zhomes nearhomes [<radius>]
  • Added delay to update messages upon joining (Cuz it was annoying)
  • Improved information from /zhomes info command
  • Fix converter for older versions
  • Added a way to export/import data via /zhomes export and /zhomes import <data>
  • Fix events loading more than one time in /zhomes reload
  • Added a new section to the config.yml to restrict homes in certain worlds: restricted-worlds
  • Added new internal placeholder for /homes: %amount% - Shows the amount of homes the player has

Full Changelog: https://github.com/yL3oft/zHomes/compare/2.2.0...2.2.1

Комментарии

Загружаем…