Repo-Mirror/HuskSync
9
0
Fork 0
mirror of https://github.com/WiIIiam278/HuskSync.git synced 2025-12-19 14:59:21 +00:00
Code Issues Releases Activity
Files
cae17f6e68898fb6235d912bec95bd54eb1b429a
HuskSync/docs/Setup.md
William cae17f6e68 Introduce new lockstep syncing system, modularize sync modes (#178) 
* Start work on modular sync systems

* Add experimental lockstep sync system, close #69

* Refactor RedisMessageType enum

* Fixup lockstep syncing

* Bump to 3.1

* Update docs with details about the new Sync Modes

* Sync mode config key is `mode` instead of `type`

* Add server to data snapshot overview

* API: Add API for setting data syncers

* Fixup weird statistic matching logic
2023-10-05 18:05:02 +01:00

2.1 KiB
Raw Blame History

This will walk you through installing HuskSync on your network of Spigot servers.

Requirements

  • A MySQL Database (v8.0+)
  • A Redis Database (v5.0+) — see FAQs for more details.
  • Any number of Spigot servers, connected by a BungeeCord or Velocity-based proxy (Minecraft v1.16.5+, running Java 16+)

Setup Instructions

1. Install the jar

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

2. Restart servers

  • Start, then stop every server to let HuskSync generate the config file.
  • HuskSync will throw an error in the console and disable itself as it is unable to connect to the database. You haven't set the credentials yet, so this is expected.
  • Advanced users: If you'd prefer, you can just create one config.yml file and create symbolic links in each /plugins/HuskSync/ folder to it to make updating it easier.

3. Enter MySQL & Redis database credentials

  • Navigate to the HuskSync config file on each server (~/plugins/HuskSync/config.yml)
  • Under credentials in the database section, enter the credentials of your MySQL Database. You shouldn't touch the connection_pool properties.
  • Under credentials in the redis section, enter the credentials of your Redis Database. If your Redis server doesn't have a password, leave the password blank as it is.
  • Unless you want to have multiple clusters of servers within your network, each with separate user data, you should not change the value of cluster_id.

4. Set server names in server.yml files

  • Navigate to the HuskSync server name file on each server (~/plugins/HuskSync/server.yml)
  • Set the name: of the server in this file to the ID of this server as defined in the config of your proxy (e.g., if this is the "hub" server you access with /server hub, put 'hub' here)

5. Start every server again

  • Provided your MySQL and Redis credentials were correct, synchronization should begin as soon as you start your servers again.
  • If you need to import data from HuskSync v1.x or MySQLPlayerDataBridge, please see the guides below: