- Make sure you have either Go or Docker installed for running channeld.
- Check out channeld
- To run channeld, either navigate to
cmdfolder and executego run ., or use Docker Compose
- Create an Unity project. Copy the content of this repo into the project
- In the Unity Editor, open the
Assets/channeld/Examples/Tanks/Scene/TankChanneldscene. The scene uses Mirror's Tanks example and has everything integrated with channeld - Launch channeld, and then the Unity server (Play -> Server only), and lastly the Unity client. Do not use the Host mode as it's not supported by channeld yet
- Use W key to move forward; A/D to rotate the tank; mouse wheel to zoom in/out the camera
- You can add AI-controlled tanks by clicking "Spawn Tanks" button on the server
Tip: to test the server and client in different Unity session, you can create a new Unity project that has symlink to the Assets folder of your Mirror project.
ChanneldTransport is the core component that integrates Mirror with channeld. For both server and client, ChanneldTransport creates a connection to channeld, and do a couple of certain things to make sure the connection flow (authentication, scene loading, player spawning, etc.) happens correctly.
To use it, simply replace the Transport you are using in your Mirror project (KcpTransport by default) with ChanneldTransport:
The Tanks is highly recommended for testing, as it's been primarily used for developing and debuging this project.
By default, ChanneldTransport does nothing more than forwarding the Mirror messages in game. To utilize channeld's data pub/sub and fan-out feature, the developer need to define the structure of the channel data with Protobuf.
The tank demo's proto defines two types of sub-state: TransformState and TankState. They are corresponding to ChanneldNetworkTransform and TankChanneld scripts.
ChanneldNetworkTransform is the replacement of Mirror's NetworkTransform. It replaces the RPCs with sending the TransformState update to channeld. Similarly, TankChanneld overrides the SerializeSyncVars to send the TankState update.
Notice: [SyncVar] hooks is not implemented yet.
GameState is the abstract class that manages the channel data. For every type of channel data, the developer needs to implement a subclass of GameState where T is the Protobuf-generated ChannelData class. For example, the TankGameState class uses TankGameChannelData as the type parameter. Then TankGameState implemented the GetChannelDataUpdateFromTransform, GetTransformUpdateFromChannelData and Merge methods to speicify how to convert between the transform update and the channel data update message, and how should two channel updates be merged, especially when there are maps involved.
To use a GameState, create a GameObject in the scene with the GameState subclass attached, and set its Channel Type properly. You can have multiple GameState instances in your scene, but each Channel Type should only have one instance (except for the Spatial channels)!
For the final step, attach the ChanneldInterestManagement script to your NetowrkManager. Now you are ready to go!
[TODO]
Since channeld supports having multiple game servers connected to form one game world, sometimes the developer needs different transport configurations for different game servers. For example, in an MMO with many separate scenes, the master server's Server Channel Type should be Global, and the scene server's Server Channel Type should be Subworld. To achieve that, use the -sc argument to launch the headless server:
MyServer.exe -batchmode -sc Subworld
To run some of the examples of Mirror(e.g. the Tank demo) with channeld properly, you'll need to use the client authoritative configuration, otherwise the game state will be not synchronized across the clients.
By default, channeld uses the client non-authoritative configuration. To replace it, use the -cfsm argument to launch channeld:
go run . -cfsm ../config/client_authoratative_fsm.json