Setup

This page contains a guide on installing HuskTowns for either single servers or across a bungee network.

⚠️ Before you start, make sure you're running a Spigot/Paper (or other fork) Minecraft Server, running Minecraft version 1.16.5+. HuskTowns does not support versions before 1.16.5 as it heavily relies on custom chat colours which aren't supported in older versions.

Setup For a single server

  1. Download HuskTowns.jar from the resource page
  2. Place HuskTowns.jar in your server's plugin folder
  3. (re)Start the server, then stop it again
  4. Make configuration changes to the HuskTowns/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 HuskTowns!

Setup on a bungee network

⚠️ You will need a mySQL Database setup to enable Bungee features

  1. Download HuskTowns.jar from the resource page
  2. Place the plugin in the plugin folders of all the servers you wish to run HuskTowns on
  3. (re)Start all the servers you added the HuskTowns.jar to, then turn them off again
  4. For each server, navigate to HuskTowns/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)
    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 HuskTowns on and you should be good to go!