A game topology where 3 clients and 2 Simulators are connected to a coherence Replication Server
A game topology where 3 clients and 2 Simulators are connected to a coherence Replication Server
| Unity Release Stream | Unity Minimum Version | Remarks |
|---|---|---|
| 6.4 | 6000.4.0f1 | |
| 6.3 LTS | 6000.3.0f1 | |
| 6.0 LTS | 6000.1.17f1 | |
| 2022 LTS | 2022.2.5f1 | |
| 2021 | 2021.3.45f2 | Legacy — works but not actively supported anymore. |
manifest.json{
"dependencies": {
"io.coherence.sdk": "2.2.0",
"com.unity.ugui": "1.0.0",
"com.unity.modules.imgui": "1.0.0",
/* ... */
},
"scopedRegistries": [
{
"name": "coherence",
"url": "https://registry.npmjs.org",
"scopes": [
"io.coherence.sdk"
]
}
]
}
New Authority.mat material, using a bright green color
Reference the materials
The Project Window warns when baking is required.
The Replication Server running in the Terminal
Inspecting a CoherenceSync on a clone
Main Editor and a clone Editor side by side
Inspecting a CoherenceSync on a virtual Player
| Sample Scenes | Included in the SDK, perfect to start | /files/Pw7KMDbXBhcBx9J2tZ6A | /pages/vLtGxOrN3pexllDSRo5Y |
| First Steps | Individual scenes showing coherence features | /files/mTtACXaSp0jGJLUNmz9o | /pages/WEETNIhtrltGwe15MqFo |
| Campfire | A project showing more advanced use of coherence | /files/wWC0EhOLVFch0ytX6JJB | /pages/QSwDpmRrHCHCBYXHJExB |
The Rooms connection dialog
Create room section of the Rooms Connect dialog
The Worlds connect dialog
The Lobbies connect dialog
The Matchmaking connect dialog
WebGL build hosted directly in the coherence Cloud
Testing out 2 builds and the Unity Editor together, while a local Replication Server runs in the console.
Don't forget to bring the scene you're interested in to the top, so it is launched automatically.
A local player meets a network-instantiated player.
coherenceBridge connects, PlayerHandler responds.
The Variables tab of the Configuration window.
The Components tab of the Configuration window.
Player Input and Move have been disabled.
A local player character in one Client exists as a remote character on another Client.
Blue = local, Orange = remote, the rest are non-networked objects.
The parameter MoveSpeed makes the player transition from the Idle state to Running.
The Animator controller of the player.
Two connected players waving at each other.
5 variables are being synced.
Authority Transfer settings for the crate Prefab.
Blue = crates being simulated on this Client, Orange = remote crates.
Lifetime: Persistent, Uniqueness: No Duplicates.
Player2 can see Player1 (because they are within a Live Query), but not the opposite.
A player is riding a moving platform, and its Prefab gets parented to it.
As usual, hitting Tab shows authority. The Client named "player" is currently simulating the platforms.
The icons in the Hierarchy show the GameObjects that contain bindings.
The root syncs only Transform.position (by default) and animation.
The physical base of the arm syncs its rotation
The IK target syncs both position and rotation.
The end point of the arm syncs two variables of its Robot Arm Hand script, useful for the grabbing behavior.
Both the robot arm and the crate are currently simulated on this Client.
A player about to plant a new flower, surrounded by flowers in different stages.
The Flower Prefab's CoherenceSync.
The setup of the Flower Prefab.
The button to clear the flowers.
Enable/disable the Simulator GameObject as needed
The Player Prefab, with its collider capsule, the interaction trigger, and the world-space UI
The three types of interactable objects: trees, chairs, and pick-ups
A player just chopped a tree, and a log has been spawned
The Log Prefab is set to instantiate from a pool
The object pool for logs, ready to use
The ChopTree script referencing the log's CoherenceSyncConfig
The Log's CoherenceSyncConfig
A player about to interact with a remote tree
Some pre-placed objects: the boombox, the banjo, a bin
The anchors, created in Play mode
The Inspector of an anchor holds information about the object it relates to
The robot in the act of recreating an object
The Config panel showing an object with an AudioSource
The Config panel showing an object with a Particle System
Three Animation Events play sounds and particles in the Walk Animation Clip
The chat composer
A chat balloon
CoherenceSync inspector
| https://www.youtube.com/watch?v=oA4vyGgj7ao | /files/aCzVRvsBfHPCQX3svLgG | |
| https://www.youtube.com/watch?v=E0GU-BK27R0 | /files/vmNIhst2P2MIBu3lXzMa | |
| https://youtu.be/RMcJOYjD4jU | /files/Qcff4e127EPEHXtqM9fw |
Picking an interpolation to be used for rotation
Client prediction allows you to roll updates on your own
Configure window: Accessible from CoherenceSync Inspector
Routing mode for a command
private void OnHit()
{
var sync = GetComponent<CoherenceSync>();
sync.SendCommand(TakeDamage, MessageTarget.AuthorityOnly);
}
[Command]
public void TakeDamage()
{
Debug.Log("Ouch!");
}
private void OnHit()
{
this.TakeDamage(MessageTarget.AuthorityOnly);
}
[Command]
public void TakeDamage()
{
Debug.Log("Ouch!");
}
The "Server Side With Client Input" option in CoherenceSync Inspector
The position binding will be predicted only if the object has Input authority
CoherenceSync Inspector
// Instantiates a Prefab and immediately gives authority away
public void SpawnAndTransfer(GameObject prefab, ClientID recipientID)
{
var newGameObject = Instantiate(prefab);
var sync = newGameObject.GetComponent<CoherenceSync>();
sync.TransferAuthority(recipientID);
}
A CoherenceSync for which the Pool instantiator has been selected
Configuration window showing Open Prefab Asset.
A Prefab Stage showing Player, and configuring a child in the hierarchy.
Make sure the child entity is prepared for parenting to another CoherenceSync entity
The PrefabSyncGroup component
Each instance received its own unique ID
Press the button to generate a new unique ID for this instance
Set the state of replicated Rigidbody components to kinematic
Setting Rigidbody Update Mode to Interpolated for advanced physics setup.
Creating a new Interpolation Settings object.
The new Interpolator is available from the Interpolator Type dropdown with the offset field as a configurable parameter.
A CoherenceSyncConfig
CoherenceSyncConfig in CoherenceSync Inspector
Selecting a instantiator or creating your own
Selecting a loader or creating your own
The Inventory component does not expose the inventory items by default.
The Inventory items can now be synced across the network.
Baking via top menu
Baking via coherence Hub
Baking via Project window
Baking via main toolbar — needs to be enabled manually
The Networked Prefabs window offers a holistic view so you can identify issues easily
In coherence, the Replication Server is always at the center of the network
A Replication Server running correctly
The World Connection UI sample
In the left window, Player2 is not visible because it's outside of Player1's LiveQueries
Unity Profiler with Coherence module
Profiler Modules dropdown menu
You can find the coherence + Dissonance integration within coherence > Hub > Samples.
| Class / Unity Component | What it does | How to use it |
|---|---|---|
| CoherenceCommsNetwork | The core of the integration. Runs Dissonance as Server+Client (Host) or Client. To decide in which mode to run, it relies on authority. | Create a networked prefab with this component attached. Whoever has authority over it, will be the server. |
| CoherenceSyncVoice | Defines the networked entity associated with each client. To do this, it relies on Client Connections. | Create a networked prefab with this component attached, and reference it as a Client Connection Prefab on your CoherenceBridge. Each client on the network will send data to the server through this entity. |
| CoherencePlayer | Implements a Dissonance Player, used for 3D and proximity audio processing. | Add to your networked player. |
Fix any problems when referencing a client connection prefab. In this case, it's suggesting to disable authority transfer, since that's not supported by Client Connections (Client Connections are a special kind of entity, handled by the Replication Server).
Settings have descriptive tooltips that help understand what they do.
| Unity Component | Description |
|---|---|
| CoherenceSceneLoader | Handles loading one scene additively, and holds instructions for how that loaded scene should connect to the network. |
| CoherenceScene | Reacts when the scene this component is on is loaded via CoherenceSceneLoader. When it does, establishes a connection using the CoherenceBridge on said scene. The connection data used (EndpointData) is facilitated by the CoherenceSceneLoader that triggered the scene load. |
Creating a GameObject with a Scene Loader component on it
CoherenceSyncLoader Inspector
Values set on the Inspector, as described above
Hierarchy after entering the room — 4 client connections established!
Clicking on the Unity icon on CoherenceScene or CoherenceSceneLoader pings its counterpart
GameObject > coherence > Scene (Listener)
CoherenceScene Inspector
Let's create a Cube
Cube created, now let's network it by clicking Sync with coherence on the Inspector.
All set! Our Cube is now networkable. It's also part of the scene right now.
Keep the Scene view active, we will use it to visualize what's going on
CoherenceBridge Inspector
static class SimulatorUtility
{
public enum Type
{
Undefined = 0,
World = 1,
Rooms = 2
}
public static Type SimulatorType; // Type of simulator: Room / World.
public string Region; // Region where simulator was spawned.
public string Ip; // Ip of the replication server.
public int Port; // UDP port of the replication server.
public int RoomId; // RoomId for current session.
public ulong UniqueRoomId; // Unique RoomId.
public ulong WorldId; // World Id (in worlds mode).
public int HttpServerPort; // Port used for REST commands.
public string AuthToken; // Auth token used for authentication.
public List<string> RoomTags; // Tags for the room.
public Dictionary<string,string> RoomKV; // Key Values for the room.
public bool IsInvokedAsSimulator; // Whether the instance was invoked as a simulator.
public bool IsInvokedInCommandLine; // Whether the instance was invoked on the commandline.
public bool IsSimulator; // Identify whether simulator.
}
Installed modules in the Unity Hub showing Dedicated Server build support for Mac and Windows
Build Local simulator button on a machine running macOS
Use the Simulators tab to specify all Simulator related settings.
coherence Hub Simulator Build Options
A base64 encoded string containing a JSON object literal with key-valure pairs. Example:
{"key1": "value1", "key2": "value2"}
Uncheck the Create Global Query option
using UnityEngine;
using System.Collections.Generic;
using Coherence.Connection;
using Coherence.Toolkit;
public class SimulatorConnectionHandler : MonoBehaviour
{
public CoherenceBridge bridge;
public CoherenceSync liveQueryPrefab;
private Dictionary<ClientID, CoherenceSync> clientQueries = new();
public void Start()
{
bridge.ClientConnections.OnCreated += HandleClientCreated;
bridge.ClientConnections.OnDestroyed += HandleClientDestroyed;
}
public void OnDestroy()
{
bridge.ClientConnections.OnCreated -= HandleClientCreated;
bridge.ClientConnections.OnDestroyed -= HandleClientDestroyed;
}
private void HandleClientCreated(CoherenceClientConnection client)
{
if (client.IsMyConnection)
{
// This example is only creating live queries for other clients.
return;
}
// Create a live query for the client and transfer the input authority so
// they get the benefit of the query, but are not allowed to modify it
// directly.
var clientQuery = Instantiate(liveQueryPrefab);
clientQuery.TransferAuthority(client.ClientId, Coherence.AuthorityType.Input);
clientQueries.Add(client.ClientId, clientQuery);
}
private void HandleClientDestroyed(CoherenceClientConnection client)
{
if (client.IsMyConnection)
{
return;
}
// Destroy the query that belonged to the disconnected client.
var clientQuery = clientQueries[client.ClientId];
Destroy(clientQuery.gameObject);
clientQueries.Remove(client.ClientId);
}
}
The Simulate in field is set to Client Side.
The Inspector of a non-connected CoherenceSync