Skip to main content
Version: 1.1.0

Install Netcode for GameObjects

Use this guide to install Unity Netcode for GameObjects (NGO) 1.0.0 and later.

Prerequisites​

Before installing Netcode, you should ensure you have:

  • An active Unity account with a valid license.
  • A Netcode-supported installation of Unity. See Netcode's requirements for full details.
  • An existing Unity project. If you don't have a project yet, see Get started with NGO.

Netcode Installation Requirements​

Netcode supports the following Unity versions:

Netcode supports the following platforms:

  • Windows, MacOS, and Linux
  • iOS and Android
  • XR platforms running on Windows, Android, and iOS operating systems
  • Most closed platforms, such as consoles. Contact the NGO development team for more information about specific closed platforms.
    • When working with consoles (such as PlayStation, Xbox, or Nintendo Switch), there might be Netcode-specific policies you should be aware of while testing and before launching your game live. Refer to the console's internal documentation for more information. This content is typically protected by NDA.
Using WebGL

Netcode doesn't support the WebGL platform because it doesn't allow access to IP Sockets.

There are third party transports provided by the community that might enable you to use Netcode on WebGL platforms. You can find a list of these transports here.

However, you should use these transports with caution:

  • You might encounter bugs and issues while using Netcode on WebGL, and the Netcode development won't prioritize fixing those issues.
  • The server or host can't be a WebGL client; It must be a Desktop or Mobile build.
  • You might experience increased latency and jitter because of the TCP protocol used by WebSockets.

Installing with the Package Manager​

Install the Netcode for GameObjects package:

  1. From the Unity Editor, select Window > Package Manager.
  2. From the Package Manager, select Add (+) > Add package by name…
  3. Type (or copy and paste) com.unity.netcode.gameobjects into the package name field, then select Add.
note

If you're using Unity Editor version 2020.3 LTS or earlier, there's no option to add a package by name. In this case, use Add package from git URL instead:

  1. From the Unity Editor, select Window > Package Manager.
  2. From the Package Manager, select Add (+) > Add package by git URL…
  3. Type (or copy and paste) chttps://github.com/Unity-Technologies/com.unity.netcode.gameobjects into the git URL field, then select Add.

Next Steps​

See the following content to continue your journey using Netcode: