Introduction

YuanshistOnline, a real-time synchronization component based on WebSocket, provides a simple, fast, and flexible networking solution. If not otherwise specified, YuanshistOnline component, hereinafter referred to as "this component".

Dependencies:

• * SocketIoClientDotNet V1.0.7
• * Newtonsoft.Json V11.0.2

Building a WebSocket service

The WebSocket server supported by this component is Node.js + Express + Socket.io

Node.js : V13.9.0

Express : V4.14.0

socket.io : V2.3.0

Download and Install

Run the Node.js installation file and wait for the installation to complete.

Runtime

Open a Command window and move to the ServerEnd directory of this component.

Wait for the task to complete.

Port

Default，Web Port：1337，Web socket Port：3000

The following content of this article will use the default port to demonstrate.

Start Server

If all goes well, you will see the following information

Quick Start

This example will use YuanshistOnline to quickly build a small ball synchronization example.

Main: position synchronization, color synchronization

A synchronized ball

• 1、Create a Unity3d project and import YuanshistOnlin.unitypackage

  Asset Store : https://assetstore.unity.com/packages/tools/network/yuanshionlinelib-websocket-165460

• 2、Drag YuanshistOnline Prefab into the scene.

  

• 3、Create a file named YuanshistOnlineEventsManagerTest.cs and make it inherit the "YuanshistOnlineEventsManager" Class.

  
  Specific implementation can be viewed: Sample\Scripts\YuanshistOnlineEventsManagerTest.cs

• 4、Create a GameObject in the scene and name it: EventsManager.

  

• Add Class for EventsManager: YuanshistOnlineEventsManagerTest.cs

  

• 5、Select YuanshistOnline, modify the server configuration in the Inspector, and drag EventsManager into the "Event Class" item

  At this time, if you have started the Server, click the "Verify Events Implement" button to verify whether the related events have been implemented. The specific content of the panel will be explained in detail in the Editor section.

  

  

• 6、Create a file named BaseInfo.cs to set the color of the balls.

  

• 7、Create a Sphere named "player" and add two cs files, BaseInfo.cs and SyncObj.cs

  SyncObj.cs is included in YuanshistOnlineLib. The specific settings of SyncObj.cs are as follows:

  

• 8、Create a Sphere again and name it "OtherPlayer". Also add two cs files, BaseInfo.cs and SyncObj.cs

  The specific settings of SyncObj.cs are as follows:

  

• 9、Select EventManager, drag player and OtherPlayer into the corresponding properties

  The specific settings are as follows

  

• Complete implementation:

  Scenes：YuanshistOnlin\Sample\Scenes\TestSample

  Prefab：YuanshistOnlin\Sample\Prefab\Sample

  Scripts：YuanshistOnlin\Sample\Scripts\Sample

A small ball that fires bullets

• This example rewrites the basic API in order to bring a more flexible implementation to the user, including the synchronization of the ball position, the synchronization of bullets, etc.

• Complete implementation:

  Scenes：YuanshistOnlin\Sample\Scenes\TestAdvanced

  Prefab：YuanshistOnlin\Sample\Prefab\Advanced

  Scripts：YuanshistOnlin\Sample\Scripts\Advanced

  In this example, WebServer builds two APIs

  • All events：http://localhost:1337/lib
  • All rooms：http://localhost:1337/rooms

API

This section describes the classes used and some usage methods

YuanshistOnline Class

Basic connection class

YuanshistOnlineEventsManager Class

Event management class

SyncObj Class

Component synchronization class

Editor

This section will introduce the use of the Editor of each class

YuanshistOnline Editor

Divided into four parts: basic settings, server-side listening events, client-side system events, and client-side custom events。

Basic settings

• Verify Events Implement(Button) : Used to get the event list from WebServer and verify if the event is implemented
• The other settings have the same meaning as the YuanshistOnline class

Sever side custom event list

TellServerCreateRoom	Use when creating or modifying room information
JoinRoom	Add client to room
TellServerAddPlayer	Notify other users that a player has joined, and return all users in the current room.
TellServerSlowUpdate	Persistent session save data,must have name property.
TellServerPositonRotation	Notify all users in the room, mainly used for synchronization of Postion and Rotation.
TellServerEnvInfo	Notify all users in the room that the current environment has changed. Generally used for randomly created objects, such as Prefab in the YuanshistOnlineEventsManager.spawnablePrefabs list.

These events are for reference only and are used to demonstrate examples.

Refer to the event processing code：ServerEnd/socketLib/ServerLib.js

Event Design Purpose:

• Separate frequent triggers (such as position changes) from infrequent triggers (such as color changes)
• Separation of non-persistence (such as bullets) from persistence (such as players)

Client-side system event list

Refer to API/YuanshistOnlineEventsManager/公共方法

  Indicates that this method is implemented in the class identified by the "Event Class" property.

Client-side custom event list

TellClientCreateRoom	Receive room modification events.
TellClient_connected	Triggered when the connection is successful. return： { "clientid": "sjbbQgy1acBmPDaZAAAM" }
TellClient_JoinRoomed	Triggered when the room is successfully added. return： { "clientid": "sjbbQgy1acBmPDaZAAAM", "room": { "name": "room1", "id": "jh567e3u2g8" } }
TellClientAddPlayer	Triggered when a local player is connected to Sever, when a new player joins.
TellClientAllPlayerStatus	Triggered when the local player is connected to the server, synchronizing the existing player.
TellClientUpdateAllPlayerStatus	Triggered when remote player information is modified.
TellClientSlowUpdate	Triggered when other players persist data.
TellClientPositonRotation	Triggered when the Player's Postion or Rotation changes. Generally used for frequent data interactions..
TellClientEnvInfo	Triggered when other players change their environment, such as firing bullets.
TellClientOtherDisconnect	Triggered when other players exit or disconnect.

  Indicates that this method is implemented in the class identified by the "Event Class" property.

These events are for reference only and are used to demonstrate examples.

Refer to the event processing code:

• YuanshistOnlineLib/Sample/Scripts/Sample/YuanshistOnlineEventsManagerTest.cs
• YuanshistOnlineLib/Sample/Scripts/Advanced/YuanshistOnlineEventsManagerTestSphere.cs

Event design purpose:

• Separate frequent triggers (such as position changes) from infrequent triggers (such as color changes)
• Separation of non-persistence (such as bullets) from persistence (such as players)

YuanshistOnlineEventsManager Editor

Basic settings

Refer to: Api/YuanshistOnlineEventsManager/Public property

Spawnable Prefabs List

Refer to: Api/YuanshistOnlineEventsManager/Public property

Suggest:

• This is a shared list of Prefab
• Dynamic creation, which only needs to be synchronized once, has little effect on the entire game environment, such as bullets
• Dynamic creation, relatively low synchronization frequency, such as blood volume

SyncObj Editor

Basic settings

Refer to: Api/YuanshistOnlineEventsManager/Public property

Spawnable Prefabs List

Refer to: Api/YuanshistOnlineEventsManager/Public property