Homes

modules/homes.yml

Naming#

With no name, /home and /sethome use homes.default-name, which ships as home.

homes:
  default-name: home
  fallback-to-only-home: true
  max-name-length: 16

fallback-to-only-home sends a player with exactly one home there on a bare /home, whatever it is called. Off means a bare /home always looks for the home named home.

Names accept letters, numbers, hyphens and underscores, up to max-name-length.

Limits#

homes:
  default-limit: 3
  world-limits:
    world_nether: 1
    world_the_end: 1

default-limit is what a player with no limit permission gets. Raise it per rank:

lp group vip permission set chorus.home.limit.10
lp group mvp permission set chorus.home.limit.25

The highest number a player holds wins. A wildcard such as chorus.home.limit.* carries no number and cannot raise the cap — use chorus.home.unlimited for no cap at all.

world-limits caps one world on top of the overall limit, for the worlds where homes should be rare. A world that is not listed has no cap of its own.

What a home costs#

Two numbers add up:

# the flat price, like every other command
commands:
  sethome:
    price: 100.0

# and a surcharge per home already owned
homes:
  price-per-home: 250.0

A player with three homes setting a fourth pays 100 + 3 × 250. price-per-home: 0 turns the surcharge off.

Moving a home you already have is never surcharged — it is the same home, not a new one.

The menu#

/homes opens a clickable grid.

homes:
  menu:
    enabled: true
    rows: 3
    icon: LIME_BED
    filler: ''
    navigation-filler: GRAY_STAINED_GLASS_PANE
    previous-page: ARROW
    next-page: ARROW
    close: BARRIER

enabled: false goes back to printing the names. What the screen says is in menus.yml under menu.homes — see Menus.

/homeicon <home> <item> sets what one home looks like in the grid, overriding icon. /homeicon <home> with no item puts it back.

Renaming or moving a home keeps its icon and the day it was made.

Staff#

/home Notch:base

Takes staff to another player's home, and needs chorus.home.others.

It only reaches a player who is online. Homes are held in memory for whoever is here and nowhere else while they are not, which is what keeps /home instant.

Confirmations#

/delhome asks to be run a second time before it deletes. So does /sethome over a home that already exists, before it moves it.

The window is confirmations.seconds in config.yml; chorus.bypass.confirm skips both.

Config reference#

enabled: true

homes:
  default-name: home
  fallback-to-only-home: true
  default-limit: 3
  max-name-length: 16
  price-per-home: 0.0
  world-limits:
    world_nether: 1
    world_the_end: 1
  menu:
    enabled: true
    rows: 3
    icon: LIME_BED
    filler: ''
    navigation-filler: GRAY_STAINED_GLASS_PANE
    previous-page: ARROW
    next-page: ARROW
    close: BARRIER

commands:
  defaults: ...
  home: ...
  sethome: ...
  delhome: ...
  homes: ...
  renamehome: ...
  homeicon: ...

The commands half is the same in every module — see Per-command rules.

Permissions#