Install Homes

Single server

  1. Place the Homes plugin JAR in the plugins folder of your Paper/Folia/Canvas server.
  2. Start once to generate the configuration files.
  3. Put your license key in plugins/Homes/config.yml and restart.
  4. Leave mode: single-server under network:. The default SQLite storage requires no external database.
  5. Open /homes and verify that creating, renaming and teleporting to a home works.

Networked setup

  1. Install the Homes plugin JAR on every Paper/Folia/Canvas backend.
  2. Install the Homes Velocity JAR on each proxy.
  3. Use the same mode: single-server under network: everywhere and give each backend a server-name matching velocity.toml.
  4. Use shared MySQL, MariaDB or MongoDB storage. SQLite cannot be shared between servers.
  5. For cross-proxy mode, enable Redis and configure each proxy public host/port so clients can be transferred.
Client compatibility
Homes includes a chest GUI fallback for older clients. ViaVersion/ViaBackwards are optional and improve client protocol detection in AUTO mode.