# Homes

Every player can create named homes, up to their individual limit. Homes persist across restarts. Home teleports run through the [teleport engine](teleport.html): warmup, cooldown, cost, safety check and combat lock apply just like for any other teleport.

## Commands

| Command | Syntax | Permission | Default | Description |
|---|---|---|---|---|
| `/home` | `/home [name]` | `home.use` | `true` | Teleports to a home (default name `home`) |
| `/sethome` | `/sethome [name]` | `home.set` | `true` | Sets a home at your position |
| `/delhome` | `/delhome <name>` | `home.delete` | `true` | Deletes a home |
| `/homes` | `/homes` (alias `/homelist`) | `home.list` | `true` | Lists your homes, clickable |
| `/homeof` | `/homeof <player> [name]` | `home.admin` | `false` | Admin: list another player's homes or teleport instantly |

## Additional permissions

| Permission | Default | Description |
|---|---|---|
| `home.bypass.worldblacklist` | `false` | Ignores the world blacklist for homes |
| `home.limit.<n>` | `false` | Raises the home limit to n (highest value wins) |
| `home.limit.unlimited` | `false` | Removes the home limit entirely |

> **Tip:** `/homeof` without a home name only lists the target's homes (works offline), teleporting happens only with a name. Overwriting an existing home does not count against the limit.

## Configuration (modules/homes.yml)

```yaml
# Enables or disables the homes module.
enabled: true

homes:
  # Homes without extra permissions. More via home.limit.<n>.
  default-limit: 3
  # Maximum home name length.
  max-name-length: 32
  # Worlds where /sethome and /home are blocked. Name, world blacklist and
  # limit are checked BEFORE charging, a failure costs nothing.
  world-blacklist: []

cooldown:
  # Wait time in seconds. 0 = no cooldown.
  commands:
    home: 5

cost:
  # Price per use. 0 = free.
  commands:
    home: 0
    sethome: 0

warmup:
  # Countdown before the teleport. Missing options inherit warmup.default
  # from config.yml.
  commands:
    home:
      duration: 3
```

## Complete example config

```yaml
enabled: true

homes:
  default-limit: 5
  max-name-length: 24
  world-blacklist:
    - world_nether
    - arena

cooldown:
  commands:
    home: 10

cost:
  commands:
    home: 15.0
    sethome: 100.0

warmup:
  commands:
    home:
      duration: 5
```