Replication server CLI

How to use the Replication server in the command-line

To start a local Replication Server yourself, you can copy the command to clipboard from within the Replication Server tab in coherence Hub.

Pasting this command into a terminal allows you to launch a Replication Server with specific settings.

Scripts holding these command can be also found at:

<project-path>/Library/coherence/run-replication-server-[rooms|worlds].[bat|sh]

To see a full list of flags available:

path/to/replication-server rooms --help
path/to/replication-server world --help

Minimal working example

For worlds, --schema must be provided:

path/to/replication-server world --schema "<sdk-path>/Coherence.Toolkit/Toolkit.schema,<project-path>/Assets/coherence/Gathered.schema"

For rooms, --default-schema must be provided:

path/to/replication-server rooms --default-schema "<sdk-path>/Coherence.Toolkit/Toolkit.schema,<project-path>/Assets/coherence/Gathered.schema"

Substitute <sdk-path> with the path to a coherence package installation, and <project-path> is the path to your Unity project root.

If you installed coherence through the Asset Store, check <project-path>/Packages/io.coherence.sdk. If you installed through the Scoped Registry, check <project-path>/Library/PackageCache/io.coherence.sdk@<hash>.

Toolkit.schema and Gathered.schema must be provided.

Allowing connections from other machines

By default, the Replication Server binds to 127.0.0.1, which means only connection from within the local machine will be accepted. To accept connections from any other machine, use --local-ip-override "0.0.0.0".