-
-
Notifications
You must be signed in to change notification settings - Fork 78
Setup
William edited this page Nov 21, 2022
·
25 revisions
This will walk you through installing HuskHomes on either your Spigot server, or proxied network of Spigot servers.
- 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+
These instructions are for simply installing HuskHomes on one Spigot/Paper server.
- Place the plugin jar file in the
/plugins/
directory of your Spigot server.
- 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.
- Start your server again and enjoy HuskHomes!
These instructions are for installing HuskHomes on multiple Spigot servers and having them network together. A MySQL database (v8.0+) is required.
- Place the plugin jar file in the
/plugins/
directory of each Spigot server. - You do not need to install HuskHomes as a proxy plugin.
- 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.
- Navigate to the HuskHomes config file on each server (
~/plugins/HuskHomes/config.yml
) - Under
database
, settype
toMYSQL
- Under
mysql
/credentials
, enter the credentials of your MySQL database server. - Scroll down and look for the
cross_server
section. Setenabled
totrue
. - 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.
- 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.
This documentation is available via william278.net |
---|
- 📚 Setup
- 📊 Importing Data
- 📄 Config Files
- ⛔ Managing Access
- 🖥️ Commands
- 📜 Command Conflicts
- 📁 Database
- ⛅ Redis Support
- 📝 Translations
- 🟩 Plan Hook
- 🗺️ Map Hooks
- ⏰ Cooldowns
- 💵 Economy Hook
⚠️ Strict Tpahere- 🚫 Restricted Warps
- 🛏️ Global Respawning
- 🌎 Global Spawn
- ✍️ Placeholders
- ⭐ GUI Add-on
- 🕸️ Legacy Migration (v2 → v3)
- 📦 API
- 💻 GitHub
- 📂 Downloads
- 🔧 Modrinth
- 🚰 Spigot
- 🛒 Polymart
- 🛫 Hangar
- 🔥 CurseForge
- 💬 Discord Support