Setup

Setup

This page outlines how to install HuskHomes. HuskHomes was developed for Minecraft 1.16.4 and runs on Spigot and Paper (recommended). HuskHomes is designed to work on both a single spigot server and a network of spigot servers. When bungee mode is enabled, the plugin communicates with itself on other servers through the plugin messaging channel to allow for teleports, teleport requests, homes and more to be handled cross-server.

Setup for a single server

1. Download HuskHomes.jar from the resource page
2. Place HuskHomes.jar in your server's plugin folder
3. (re)Start the server, then stop it again
4. Make configuration changes to the HuskHomes/config.yml file as neccessary
5. If you're using a permissions plugin, ensure permissions are set correctly
6. Start the server again and you are good to start using HuskHomes!

Setup for a Bungee network

You will need a mySQL Database setup to enable Bungee features

1. Download HuskHomes.jar from the resource page
2. Place the plugin in the plugin folders of all the servers you wish to run HuskHomes on
3. (re)Start all the servers you added the HuskHomes.jar to, then turn them off again
4. For each server, navigate to HuskHomes/config.yml and change the following settings
   1. Under data_storage_options, change the storage_type from SQLite to mySQL
   2. Fill in your mySQL credentials under mysql_credentials
   3. Under bungee_options:, set enable_bungee_mode to true and change the server_id to match the name of that server on the bungee network (e.g if you move to it using /server lobby, put "lobby" there). You don't need to change cluster_id, unless you are planning on having multiple "clusters" of servers using HuskHomes.
   4. Modify other settings as appropriate
5. If you're using a permissions plugin, ensure permissions are set correctly
6. Start the servers you installed HuskHomes on and you should be good to go!