Setup

HuskHomes banner

Setup Guide

This will walk you through installing HuskHomes on either your Spigot server, or proxied network of Spigot servers.

Requirements

  • A Spigot-based Minecraft server (1.16.5 or higher, Java 16+)
  • (For proxy network support) A proxy server (1.16+) and MySQL v8.0+ database
  • (For optional redis support) A Redis database v5.0+

Single-server Setup Instructions

These instructions are for simply installing HuskHomes on one Spigot/Paper server.

1. Install the jar

  • Place the plugin jar file in the /plugins/ directory of your Spigot server.

2. Restart the server and configure

  • Start, then stop your server to let HuskHomes generate the config file.
  • You can now edit the config file to your liking. You may wish to add commands to the β€œdisabled commands” section, or tweak the teleport warmup timing.

3. Turn on your server

  • Start your server again and enjoy HuskHomes!

Multi-server Setup Instructions

These instructions are for installing HuskHomes on multiple Spigot servers and having them network together. A MySQL database (v8.0+) is required.

1. Install the jar

  • Place the plugin jar file in the /plugins/ directory of each Spigot server.
  • You do not need to install HuskHomes as a proxy plugin.

2. Restart the server and configure

  • Start, then stop every server to let HuskHomes generate the config file.
  • Advanced users: If you’d prefer, you can just create one config.yml file and create symbolic links in each /plugins/HuskHomes/ folder to it to make updating it easier.

3. Configure servers to use cross-server mode

  • Navigate to the HuskHomes config file on each server (~/plugins/HuskHomes/config.yml)
  • Under database, set type to MYSQL
  • Under mysql/credentials, enter the credentials of your MySQL database server.
  • Scroll down and look for the cross_server section. Set enabled to true.
  • You can additionally configure a Redis server to use for network messaging, if you prefer.
  • Save the config files. Make sure you have changed the settings on every server.

4. Start every server again

  • Provided your MySQL datbase credentials were correct, your network should now be setup to use HuskHomes!
  • You can delete the HuskHomesData.db SQLite flatfile that was generated, if you would like.