The NeoEssentials home system allows players to set personal teleportation locations on your server.

The home system provides:

• Multiple homes per player (permission-based)
• Custom home names
• Teleport cooldowns
• Cost-based teleportation (optional)
• Group-specific home limits

Configure the home system in config/neoessentials/homes.toml:

[homes]
# Enable the home system
enabled = true

# Default maximum homes per player (if no permission)
defaultMaxHomes = 1

# Home teleport cooldown (in seconds, 0 to disable)
cooldown = 5

# Warmup time before teleport (in seconds, 0 to disable)
warmup = 3

# Cancel warmup if player moves
cancelWarmupOnMove = true

# Economy integration
[homes.economy]
# Enable economy costs for homes
enableCosts = false

# Cost to set a home
setHomeCost = 100.0

# Cost to teleport to a home
teleportCost = 10.0

# Storage settings
[homes.storage]
# Storage type: "json", "sqlite", or "mysql"
type = "json"

# Storage location (for JSON)
location = "data/neoessentials/homes"

1. Enable the home system in configuration:

   [homes]
   enabled = true
   defaultMaxHomes = 1

2. Set up permissions for different player groups:

   # Default group (1 home)
   /lp group default permission set neoessentials.command.home true
   /lp group default permission set neoessentials.command.sethome true
   /lp group default permission set neoessentials.limit.homes.1 true
   
   # VIP group (5 homes)
   /lp group vip permission set neoessentials.limit.homes.5 true
   
   # Admin group (unlimited homes, no cooldowns)
   /lp group admin permission set neoessentials.limit.homes.unlimited true
   /lp group admin permission set neoessentials.bypass.cooldown.home true
   

To enable home costs:

1. Update the configuration:

   [homes.economy]
   enableCosts = true
   setHomeCost = 100.0
   teleportCost = 10.0

2. Ensure the economy system is enabled:

   # In economy.toml
   [economy]
   enabled = true

Players can set homes using:

/sethome
/sethome <name>

The first command sets the default home, while the second creates a named home.

To teleport to a home:

/home
/home <name>

The first command teleports to the default home, while the second teleports to a named home.

Players can view their homes:

/homes

This shows a list of all their homes with coordinates.

To delete a home:

/delhome <name>

For safety, teleporting to homes with potential hazards (like lava or void) will require confirmation:

/home dangerous_home
[Warning] This location may be dangerous. Type /confirm to teleport anyway.

Players can share homes with others:

/home share <name> <player>

This gives another player access to one of your homes.

Create homes that anyone can visit:

/home public <name>
/home private <name>

Public homes appear in the server's public home list:

/homes public

The home system works alongside the Warp System for public teleportation points.

For more information about the home system:

• Check the Commands Reference for detailed command usage
• See the Permissions Guide for permission setup
• Visit our Discord server for support