Quick start

Standard usage (recommended)

Server

Put ServerSync.jar or ServerSyncServer.exe in the root Minecraft folder e.g. Minecraft/ServerSync.jar. This will be the same level that the mods/ folder exists at.

Starting the server (JAR)

Create a batch/shell script that starts ServerSync like so: java -jar serversync-{version}.jar --server.

Starting the server (EXE)

Either run the exe as normal or start it in a script like so: START ServerSyncServer.exe.

Example script for windows

@echo off
SETLOCAL

rem Configuration...
SET server_name=Example server name
SET forge_java_arguments=-Xms2g -Xmx2g
SET serversync_java_arguments=-Xms512m -Xmx1g

rem Find things...
for %%f in (forge*.jar) do (SET forge=%%~nxf)
for %%f in (serversync*.jar) do (SET serversync=%%~nxf)

rem Start the things...
START "Forge - %server_name%" java %forge_java_arguments% -jar %forge% nogui
START "ServerSync - %server_name%" java %serversync_java_arguments% -jar %serversync% --server

ENDLOCAL

Client

Put ServerSync.jar or ServerSyncClient.exe in the root Minecraft folder e.g. Minecraft/ServerSync.jar. This will be the same level that the mods/ folder exists at.

Running the client

Run the jar or exe file as you normally would, configure the details of the server you are connecting to and press Sync.

What's the difference between the jar and exe files?

Pretty icons 👍.

Non-standard usage (forge 1.14 +)

Server

1. Put ServerSync Forge Loader in your servers mods
2. Put ServerSync.jar or ServerSyncServer.exe in the root Minecraft folder e.g. Minecraft/ServerSync.jar. This will be the same level that the mods/ folder exists at.

The forge loader mod will start ServerSync for you after the normal Minecraft server has finished starting.

Client

Put ServerSync.jar or ServerSyncClient.exe in the root Minecraft folder e.g. Minecraft/ServerSync.jar. This will be the same level that the mods/ folder exists at.

Non-standard usage (forge 1.12 and below)

Server

1. Put ServerSync.jar in your servers mods

Forge will start ServerSync for you after the normal Minecraft server has finished starting.

Client

Put ServerSync.jar or ServerSyncClient.exe in the root Minecraft folder e.g. Minecraft/ServerSync.jar. This will be the same level that the mods/ folder exists at.