Configuration

Colours use legacy & codes plus &#RRGGBB hex. Titles, names and values use the normal font; labels and hints use small caps — mix them however you like, it's all plain config text.

License

license:
  key: "YOUR-LICENSE-KEY"

config-version: 5

◆

Don't edit config-version — DexHomes uses it to spot an outdated config.yml and back it up. Your license key is carried across automatically when that happens.

Core settings

prefix: "&#7BFB09&lHomes &8┃ &r"

settings:
  max-slots: 56              # network hard cap = 4 pages of 14
  default-homes: 1           # player with no rank permission

  op-unlocks-all: true
  admin-unlocks-all: true

  default-icon: RED_BED
  default-home-name: "Home %slot%"

  small-font-names: false     # force renames into small caps
  name-max-length: 16
  name-pattern: "^[a-zA-Z0-9 _-]+$"

  rank-fallback: "Default"    # %rank% when LuckPerms is absent

  combat-time: 15
  teleport-warmup: 5
  cancel-on-move: true
  cancel-on-damage: true

  actionbar-messages: true
  sounds: true
  particles: true

◆

op-unlocks-all and admin-unlocks-all give staff every slot. Turn them off if you want staff limited by their rank like everyone else.

Home slot limits

The format is simply tiername: homes. Add, rename or delete tiers freely — the permission nodes follow automatically:

limits:
  vip: 3
  mvp: 5
  elite: 8

Tier in config	Permission generated	Legacy alias
`vip: 3`	`dexhomes.limit.vip`	`dexhomes.rank.vip`
`mvp: 5`	`dexhomes.limit.mvp`	`dexhomes.rank.mvp`
`elite: 8`	`dexhomes.limit.elite`	`dexhomes.rank.elite`

A player holding several tiers gets the highest value — they never stack. Values are capped by settings.max-slots, so raise that before pushing a tier past 56.

◆

Not sure why someone has the slot count they do? Run /dexhomes check <player> — it tells you exactly which rule decided it.

How slots become pages

Slots	Result
14	One page. No next button. Title is just "Homes".
28	Two pages. Title becomes "Homes 1/2".
56	Four pages — the hard cap.

Storage

storage:
  type: SQLITE            # SQLITE or MYSQL
  mysql:
    host: localhost
    port: 3306
    database: dexhomes
    username: root
    password: ""
    table: dexhomes_homes
    useSSL: false

Menus

Five menus, each fully re-skinnable — titles, materials, names and lore:

Config section	Menu
`gui`	Main homes menu — `/home`
`confirm-gui`	Delete confirmation
`edit-gui`	Home editor — right-click a home
`item-gui`	Icon picker with sort, filter and search
`colour-gui`	Colour picker — solid and gradient tabs
`particle-gui` / `sound-gui`	Teleport effect and sound pickers

The info head in the middle of the bottom row wears the player's real skin and renders a live usage bar:

  info:
    name: "&#7BFB09&l%player%"
    bar-length: 12
    bar-filled: "▉"
    bar-empty: "▉"
    bar-filled-colour: "&#7BFB09"
    bar-empty-colour: "&8"

Placeholders in menus

Placeholder	Value
`%player%` · `%rank%`	Player name · their rank (or `rank-fallback`)
`%slot%` · `%name%` · `%icon%`	Home slot number · display name · icon material
`%world%` · `%x%` `%y%` `%z%`	Home location
`%used%` · `%max%` · `%free%` · `%total%`	Slot counts · network max
`%page%` · `%pages%` · `%bar%`	Paging · the rendered usage bar
`%colour%` · `%particle%` · `%sound%`	The home's current styling