NGOtoGo

Quick and easy examples for Unity's Netcode for GameObjects (NGO).

Over the course of several projects, I've developed a variety of tests and examples for Unity's Netcode for GameObjects. I'm gradually adding the most useful ones to this public repository to help others learn and implement NGO in their own projects. More examples will be added over time.

Getting Started

To run the project, clone this repository from GitHub and open it in Unity Hub.

Using ParrelSync for Local Client/Server Testing

The project utilises the ParrelSync package which is already included, making it easy to test multiplayer scenarios locally on a single machine. Here's how to create and use clones for client/server testing:

1. Open Clones Manager:

   • In the Unity Editor, navigate to ParrelSync > Clones Manager from the top menu.

2. Create a Clone:

   • Click the "Add new clone" button in the Clones Manager window. This will create a separate clone of your project in a new folder.

3. Opening the Clone:

   • Once the clone is created, click "Open in New Editor", this will open the cloned instance of the project.
   • Most examples will treat the original project as the server/host and the clone as the client.

Examples

The examples are located in the project hierarchy under Assets/Examples where they're grouped by most relevant category. This is the typical example folder structure:

/AnExample
/-- Controllers
/-─ Entities
/-─ Prefabs
/-─ Scenes

Each example is run as follows:

1. Load the Example Scene:

   • In the original project, open the Scenes folder and select the scene. If there are multiple scenes go with the Start scene.
   • In the clone project, open the scene in the same way.

2. Running the Example:

   • In both projects, hit the Play button.
   • Connection between server/host and client is handled automatically in most examples.

3. What to Expect:

   • Simple examples will just output relevant information to the console, while other more complex examples may require some user interaction.

Included Examples

GetLocalPlayerOnConnection - Gets the local Player object when the client connects.

PassNetworkObjectReferenceByNetworkVariable - Passes a spawned object's network object reference to the client by way of an in-scene network object's network variable field.

PassNetworkBehaviourReferenceByNetworkVariable - Passes a spawned object's network behaviour reference to the client by way of an in-scene network object's network variable field.

SpawnObjectOnRequestAndPassNetworkObjectReferenceByRpc - An RPC is used to spawn a network object on the host and its NetworkObjectReference is then RPC'ed to all connected to provide a reference to it.

ListenForObjectSpawnEvents - Uses an abstract class derived from NetworkBehaviour providing a static Action which is subscribed to by a listener in the scene, when a network object is spawned the Action is invoked.

PassChosenPlayerOnConnection - The client passes the hash for the Player object they wish to use on connection, this is matched and approved in Connection Approval.

DeferApprovalOnClientConnection - Connecting clients approval is set as Pending in Connection Approval, the host decides on allowing the connection in the UI.

SendAndReceiveUnnamedMessages - Send and receive custom unnamed messages by way of the UI.

SendAndReceiveNamedMessages - Send and receive messages on a specific named channel by way of the UI.

SubscribeToNetworkEvents - Subscribes to and logs network events to give an idea of the network lifecycle and sequence of network events.

NetworkVariablePermissions - Demonstrates the behaviour of network variables when using different read and write permissions and changing object ownership.

NetworkVariableDictionary - Shows how to set up a NetworkVariable dictionary, how to modify it and how to determine inside its change event what changes that have been made.

NetworkListEvents - Allows user interaction with a network list to demonstrate the triggering of events.

LimitPlayerObservers - Only the client's Player object is spawned on the client.

PerlinTilemap - Uses a NetworkVariable to share configuration values allowing the host and client to generate identical Perlin-based tilemaps.

Lobby - Creates a lobby type room on the host for other clients to join. Note this does not use Unity's online Lobby service.

Notes

If you are using ParrelSync in your own projects and the clone won't connect due to a NetworkConfig mismatch this is most likely due to the NetworkManager's Network Prefab List not always sync'ing with the clone. A quick fix for this is to untick Force Same Prefabs on the original project's NetworkManager.

---

If you have any comments or suggestions feel free to contact me on the Unity Discussions forum.