ZX HomeSystem – Documentation
Welcome to the official documentation for ZX HomeSystem, an advanced Minecraft home management plugin by ZX Studio.

This guide covers everything from installation to advanced configuration.

Installation

1. Download the latest ZXHomeSystem.jar file.
   
   
2. Place it into your server’s /plugins folder.
   
   
3. Restart or reload your server.
   
   
4. A new folder /ZXHomeSystem/ will be created with config.yml.

⚙️ Configuration
The plugin is fully customizable through the config.yml.

Example config.yml:
# ZX HomeSystem - Configuration

teleport:
delay: 5 # Seconds before teleporting
cooldown: 30 # Cooldown time in seconds
cancel-on-move: true
effects:
sound: true
particles: true

homes:
default-limit: 3 # Default max homes per player
rank-limits: # Override limits per permission
vip: 5
elite: 10
legend: 20

economy:
enabled: true # Requires Vault
set-home-cost: 50 # Cost for setting a new home
teleport-cost: 20 # Cost for teleporting to a home

world-restrictions:
enabled: false
blocked-worlds:
- "world_nether"
- "world_the_end"

autosave:
interval: 300 # Seconds between automatic data saves

Commands

Command Description Permission
/zxhome help Shows help menu all players
/zxhome set <name> Set a new home zxhome.set
/zxhome go <name> Teleport to a home zxhome.go
/zxhome del <name> Delete a home zxhome.del
/zxhome list List all homes zxhome.list
/zxhome gui Open home management GUI zxhome.gui
/zxhome rename <old> <new> Rename a home zxhome.rename
/zxhome share <home> <player> Share a home zxhome.share
/zxhome public <name> Make a home public zxhome.public
/zxhome near Find nearest home zxhome.near
/zxhome reload Reload config zxhome.admin
️ Permissions

Permission Description
zxhome.set Allows setting homes
zxhome.go Allows teleporting to homes
zxhome.del Allows deleting homes
zxhome.list Allows listing homes
zxhome.gui Allows GUI access
zxhome.rename Allows renaming homes
zxhome.share Allows sharing homes
zxhome.public Allows making homes public
zxhome.near Allows using nearest home
zxhome.admin Access to reload command
zxhome.limit.<number> Sets max homes a player can have
Economy Integration
If you have Vault + an economy plugin (EssentialsX, CMI, etc.), ZX HomeSystem can charge players for:

• Setting homes
  
  
• Teleporting to homes

Disable costs by setting them to 0 in config.yml.

World Restrictions

• You can block specific worlds from allowing homes.
  
  
• Example: Prevent players from setting homes in the Nether or End.

Data & Saving

• Player homes are saved automatically every X seconds (default: 300).
  
  
• Data is stored in /ZXHomeSystem/data/.
  
  
• Supports manual reload with /zxhome reload.

❓ FAQ
Q: Can players have unlimited homes?
A: Yes, if you give them zxhome.limit.* permission.

Q: Does it work with BungeeCord?
A: Currently no, but multi-world support is fully included.

Q: Can I disable teleport costs?
A: Yes, just set the cost to 0 in config.

❤️ Credits

• Developed by ZX Studio
  
  
• Inspired by the community, made for modern Minecraft servers