Run local Simulators

Before deploying a Simulation Server, testing and debugging locally can significantly improve development and iteration times. There are a few ways of accomplishing this.

Running the Editor as a Simulator

Using the Unity Editor as a Simulator allows us to easily debug the Simulator. This way we can see logs, examine the state of scenes and GameObjects and test fixes very rapidly.

To run the Editor as a Simulator, run the Editor from the command line with the proper parameters:

  • --coherence-simulation-server: used to specify that the program should run as a coherence Simulator.

  • --coherence-simulator-type: tells the Simulator what kind of connection to make with the Replication Server, can be Rooms or World.

  • --coherence-region: tells the Simulator which region the Replication Server is running in: EU, US or local.

  • --coherence-ip: tells the Simulator which IP it should connect to. Using will connect the Simulator to a local server, if one is running.

  • --coherence-port: specifies the port the Simulator will use.

  • --coherence-world-id: specifies the World ID to connect to, used only when set to Worlds.

  • --coherence-room-id: specifies the Room ID to connect to, used only when set to Rooms.

  • --coherence-unique-room-id: specifies the unique Room ID to connect to, used only when set to Rooms.

For example:

<Editor path> -projectPath <project path>
--coherence-simulator-type rooms
--coherence-region local
--coherence-port 32001 
--coherence-room-id [room-id]
--coherence-unique-room-id [room-uid]

Keep in mind that all regular Unity arguments are supported. You can see the full list here: Unity Editor command line arguments.

If you're not sure which values should be used, adding a COHERENCE_LOG_DEBUG define symbol will let you see detailed logs. Among them are logs that describe which IP, port and such the Client is connecting to. This can be done in the Player settings: Project Settings > Player > Other Settings > Script Compilation > Scripting Define Symbols.

To learn more about Simulators, see Simulators.

Running a Simulator build locally from the command line

Another option is making a Simulator build and running it locally. This option emulates more closely what will happen when the Simulator is running after being uploaded.

You can run a Simulator executable build in the same way you run the Editor.

"simulator build path"
--coherence-port 32001 
--coherence-world-id 0 
--coherence-room-id [room-id]
--coherence-unique-room-id [room-uid]

This allows you to test a Simulator build before it is uploaded or if you are having trouble debugging it.

Running a Simulator build locally from the Unity Editor

You can also run existing Simulator build from coherence Hub > Simulators > Run local simulator build.

Use the Fetch Last Endpoint button to autofill the required fields.

Connecting a Simulator to a Room

When using a Rooms-based setup, you first have to create a Room in the local Replication Server (e.g. by using the connect dialog in the Client).

The local Replication Server will print out the Room ID and unique Room ID that you can use when connecting the Simulator.

To learn more about creating a Simulator build, see SIMULATORS: Build and Deploy.

Last updated