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

docs: more README and Setup clarifications

Browse Source
This commit is contained in:
William278
2024-12-08 14:16:06 +00:00
parent 2d547507d5
commit 2f4eb46456
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -65,7 +65,7 @@ HuskSync is primarily developed against the latest release. Old Minecraft versio
Verify your purchase on Discord and [Download HuskSync](https://william278.net/project/husksync/download) for your server. Verify your purchase on Discord and [Download HuskSync](https://william278.net/project/husksync/download) for your server.
## Setup ## Setup
Requires a MySQL/Mongo/PostgreSQL database, a Redis (v5.0+) server and a network of Spigot or Fabric Minecraft servers (see [Compatibility](#compatibility)). Requires a [MySQL/MariaDB/Mongo/PostgreSQL database](https://william278.net/docs/husksync/database), a [Redis (v5.0+) server]((https://william278.net/docs/husksync/redis)) and a network of [compatible Spigot or Fabric Minecraft servers](https://william278.net/docs/husksync/compatibility).
1. Place the plugin jar file in the `/plugins` or `/mods` directory of each Spigot/Fabric server. You do not need to install HuskSync as a proxy plugin. 1. Place the plugin jar file in the `/plugins` or `/mods` directory of each Spigot/Fabric server. You do not need to install HuskSync as a proxy plugin.
2. Start, then stop every server to let HuskSync generate the config file. 2. Start, then stop every server to let HuskSync generate the config file.

2
docs/Setup.md
View File

@@ -6,7 +6,7 @@ HuskSync requires a Database server, a Redis server, and any number of compatibl
* Any number of [compatible Fabric or Spigot/Paper-based](Compatibility) servers * Any number of [compatible Fabric or Spigot/Paper-based](Compatibility) servers
* Each server must be running the same exact version of Minecraft * Each server must be running the same exact version of Minecraft
* It is not possible to sync data between a mixture of Fabric and Spigot servers * It is not possible to sync data between a mixture of Fabric and Spigot servers
* HuskSync does not need to be installed on your Velocity, BungeeCord, or Waterfall proxy * HuskSync should not be installed on your Velocity, BungeeCord, or Waterfall proxy
* A [[Database]] server running MySQL v8.0+, MariaDB v5.0+, PostgreSQL or MongoDB * A [[Database]] server running MySQL v8.0+, MariaDB v5.0+, PostgreSQL or MongoDB
* A [[Redis]] server running Redis v5.0+ * A [[Redis]] server running Redis v5.0+