Install Homes
Single server
- Place the Homes plugin JAR in the plugins folder of your Paper/Folia/Canvas server.
- Start once to generate the configuration files.
- Put your license key in
plugins/Homes/config.ymland restart. - Leave
mode: single-serverundernetwork:. The default SQLite storage requires no external database. - Open /homes and verify that creating, renaming and teleporting to a home works.
Networked setup
- Install the Homes plugin JAR on every Paper/Folia/Canvas backend.
- Install the Homes Velocity JAR on each proxy.
- Use the same
mode: single-serverundernetwork:everywhere and give each backend a server-name matching velocity.toml. - Use shared MySQL, MariaDB or MongoDB storage. SQLite cannot be shared between servers.
- 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.