Install Homes

Single server

  1. Place the Homes Paper JAR in the server plugins folder.
  2. Start once to generate the configuration files.
  3. Put your AP key in plugins/Homes/config.yml and restart.
  4. Leave network.mode as single-server. 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 Paper JAR on every backend.
  2. Install the Homes Velocity JAR on each proxy.
  3. Use the same network.mode 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
The source includes a chest GUI fallback for older clients. ViaVersion/ViaBackwards are optional and improve client protocol detection in AUTO mode.