NexaHomes Documentation

Main runtime settings, license, modules, limits, storage and feature behavior.

# ...
# Short documentation excerpt from config.yml.
# This is not the complete YAML file.
# Lines before and after this preview are omitted from the docs.
# ...
license-key: "LICENSE"

server:
  id: "survival-1"

features:
  gui: true
  rename: true
  favorites: true
  recently-visited: true
  public-homes: true
  sharing: true
  team-homes: true
  private-vaults: true
  vouchers: true
  protection: true

language:
  default: en
  per-player: true
  supported:
    - en
    - tr
    - es
    - de
    - pt
    - fr

theme:
  primary: "<#7C3AED>"
  secondary: "<#EC4899>"
  error: "<#EF4444>"
  success: "<#22C55E>"

# ...
# More options continue in the generated plugin YAML file.
# Open plugins/<plugin-folder>/config.yml to review every setting.
# ...

# ...
# Short documentation excerpt from messages.yml.
# This is not the complete YAML file.
# Lines before and after this preview are omitted from the docs.
# ...
prefix: "<gray>[<gold>NexaHomes</gold>]</gray> "
missing-message: "<red>Missing message: <key></red>"

player-only: "<red>Only players can use this command.</red>"
no-permission: "<red>You do not have permission.</red>"
usage-home: "<yellow>Usage: <gold>/home [name|number]</gold> or <gold>/home lang [code]</gold></yellow>"
usage-sethome: "<yellow>Usage: <gold>/sethome <name></gold></yellow>"
usage-delhome: "<yellow>Usage: <gold>/delhome <name></gold></yellow>"
usage-renamehome: "<yellow>Usage: <gold>/renamehome <old> <new></gold></yellow>"
usage-homeinfo: "<yellow>Usage: <gold>/homeinfo <name></gold></yellow>"
usage-homefavorite: "<yellow>Usage: <gold>/homefavorite [name]</gold></yellow>"
usage-home-lang: "<yellow>Usage: <gold>/home lang [code]</gold>. Available: <gold><languages></gold></yellow>"
usage-homepublic: "<yellow>Usage: <gold>/homepublic [list]</gold>, <gold>/homepublic <home> <on|off></gold>, <gold>/homepublic whitelist <home> <add|remove|list> [player]</gold>, <gold>/homepublic favorite <player> <home></gold>, or <gold>/homepublic rate <player> <home> <1-5></gold></yellow>"
usage-homeshare: "<yellow>Usage: <gold>/homeshare <home> <player> [visit|edit|full] [30m|1h|7d]</gold></yellow>"
usage-homeshare-remove: "<yellow>Usage: <gold>/homeshare remove <home> <player></gold></yellow>"
usage-homevisit: "<yellow>Usage: <gold>/homevisit <player> <home></gold></yellow>"
usage-homereport: "<yellow>Usage: <gold>/homereport <player> <home> <reason></gold></yellow>"
usage-teamhome: "<yellow>Usage: <gold>/teamhome [list|<name>|set <name>|delete <name>]</gold></yellow>"
usage-setteamhome: "<yellow>Usage: <gold>/setteamhome <name></gold></yellow>"
usage-delteamhome: "<yellow>Usage: <gold>/delteamhome <name></gold></yellow>"
usage-admin: "<yellow>Usage: <gold>/nexahomes <reload|license|debug|hooks|view|tp|delete|restore|transfer|approvepublic|audit|migrate|vault></gold></yellow>"
usage-admin-view: "<yellow>Usage: <gold>/nexahomes view <player> [active|deleted]</gold></yellow>"
usage-admin-tp: "<yellow>Usage: <gold>/nexahomes tp <player> <home></gold></yellow>"
usage-admin-delete: "<yellow>Usage: <gold>/nexahomes delete <player> <home></gold></yellow>"
usage-admin-restore: "<yellow>Usage: <gold>/nexahomes restore <player> <home></gold></yellow>"
usage-admin-transfer: "<yellow>Usage: <gold>/nexahomes transfer <player> <home> <newOwner></gold></yellow>"
usage-admin-approvepublic: "<yellow>Usage: <gold>/nexahomes approvepublic <player> <home></gold></yellow>"
usage-admin-audit: "<yellow>Usage: <gold>/nexahomes audit [player] [limit]</gold></yellow>"
usage-admin-migrate: "<yellow>Usage: <gold>/nexahomes migrate <status|backup|restore latest [dry-run]|essentials [dry-run]|modernhomes [dry-run]|litehome [dry-run]|ultrahomes [dry-run]|yaml [dry-run]|database <SQLITE|MYSQL|MARIADB> [dry-run]></gold></yellow>"
usage-admin-vault: "<yellow>Usage: <gold>/nexahomes vault <player> <home></gold></yellow>"
usage-homevoucher: "<yellow>Usage: <gold>/homevoucher give <player> <extra_slot|temporary_slot|free_rename|public_listing|teleport_bypass|cooldown_bypass> <amount> [duration]</gold></yellow>"
usage-homevault: "<yellow>Usage: <gold>/homevault <home></gold> or <gold>/homevault <player> <home></gold></yellow>"

feature-not-ready: "<yellow>That feature is currently disabled or unavailable.</yellow>"
# ...
# More options continue in the generated plugin YAML file.
# Open plugins/<plugin-folder>/messages.yml to review every setting.
# ...

Purpose: Provides economy withdrawals, deposits, prices, banks or metadata through Vault.

Troubleshooting: If balances, rewards or banks do not work, confirm Vault has an active economy provider and that no economy plugin loads after this product.

1. Install Vault and one compatible economy or permission provider.
2. Restart the server and confirm Vault reports a provider in console.
3. Enable prices, banks, rewards or currency features that depend on Vault.
4. Test one deposit and one withdrawal with a non-op account.

Purpose: Registers or consumes PlaceholderAPI values for scoreboards, formats and external displays.

Troubleshooting: If values stay blank, reload expansions and verify the identifier exactly matches the placeholder shown in this docs page.

1. Install PlaceholderAPI or the listed placeholder provider.
2. Install required expansions when the provider uses external expansions.
3. Use the exact placeholder identifiers documented in this page.
4. Reload the display plugin after changing scoreboard, tablist, menu or chat format files.

Purpose: Provides migration support for existing EssentialsX homes or user data.

Troubleshooting: If migration misses homes, check EssentialsX data format, offline UUID mode and whether the import ran on a copy of the correct userdata folder.

1. Keep a backup of existing EssentialsX user data.
2. Enable migration only on a staging copy first.
3. Run the migration/import flow documented by the product.
4. Check imported home names, worlds and coordinates before enabling it on production.

Purpose: Connects this product to another Nexa plugin so team, chat, combat, shop or vault state can be reused.

Troubleshooting: If the Nexa bridge does not react, confirm both plugin versions are compatible and that the shared module/hook is enabled on the same server.

1. Install both Nexa plugins on the same server or network target.
2. Confirm both products load successfully before testing the bridge.
3. Enable the related hook or module in config when available.
4. Test the shared workflow, such as team checks, chat metadata, combat restrictions, shop transactions or vault access.

1. Enable team hook and create/edit/delete permissions.
2. Create a test team and run /setteamhome.
3. Test /teamhome as owner/member.
4. Run /delteamhome, disband and verify cleanup.
5. Test costs, cooldowns and relations.

Check safe-location scanning, blocked materials, world restrictions and whether another teleport plugin changes the destination after NexaHomes validates it.

Review cancel-on-move, cancel-on-damage and combat checks. Test with bypass permissions removed so the player follows the normal warmup path.

Verify LuckPerms inheritance, limit permission weights and whether admin/bypass permissions are accidentally assigned to the player.

Confirm the home is marked public, visibility filters allow the world/category and storage has saved the public-home index.

Verify host, port, database name, credentials, firewall access and the storage type in the generated YAML file.