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: Document updated default sync mode

Browse Source
This commit is contained in:
William
2023-12-21 19:04:22 +00:00
parent 2aa33b2f2c
commit e7078c9542
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Sync-Modes.md
View File

@@ -3,7 +3,7 @@ HuskSync offers two built-in **synchronization modes** that utilise Redis and My
![Overall architecture of the synchronisation systems](https://raw.githubusercontent.com/WiIIiam278/HuskSync/master/images/system-diagram.png) ![Overall architecture of the synchronisation systems](https://raw.githubusercontent.com/WiIIiam278/HuskSync/master/images/system-diagram.png)
## Available Modes ## Available Modes
* The `LOCKSTEP` sync mode is the default sync mode. It uses a data checkout system to ensure that all servers are in sync regardless of network latency or tick rate fluctuations. This mode was introduced in HuskSync v3.1 * The `LOCKSTEP` sync mode is the default sync mode. It uses a data checkout system to ensure that all servers are in sync regardless of network latency or tick rate fluctuations. This mode was introduced in HuskSync v3.1, and was made the default in v3.2.
* The `DELAY` sync mode uses the `network_latency_miliseconds` value to apply a delay before listening to Redis data * The `DELAY` sync mode uses the `network_latency_miliseconds` value to apply a delay before listening to Redis data
You can change which sync mode you are using by editing the `sync_mode` setting under `synchronization` in `config.yml`. You can change which sync mode you are using by editing the `sync_mode` setting under `synchronization` in `config.yml`.