Netcode for GameObjects

Welcome!

Welcome to the Netcode for GameObjects repository.

Netcode for GameObjects is a Unity package that provides networking capabilities to GameObject & MonoBehaviour workflows. The framework is interoperable with many low-level transports, including the official Unity Transport Package.

Getting Started

Visit the Multiplayer Docs Site for package & API documentation, as well as information about several samples which leverage the Netcode for GameObjects package.

You can also jump right into our Hello World guide for a taste of how to use the framework for basic networked tasks.

Netcode for GameObjects v2

The most recent version of Netcode for GameObjects (v2) includes several improvements along with the more recent distributed authority network topology feature. You can find the source code for this on the develop-2.0.0 branch.

• The develop-2.0.0 branch incudes additional examples:
  • Netcode for GameObjects Smooth Transform Space Transitions
    • This example has plenty of parenting examples, parenting under moving bodies, smooth transitioning between two parents, and a basic example of path defined motion.
  • Ping Tool
    • This includes a custom Runtime Netwokr Stats Monitor that includes client to client message processing ping times.

Community and Feedback

For general questions, networking advice or discussions about Netcode for GameObjects, please join our Discord Community or create a post in the Unity Multiplayer Forum.

Compatibility

Netcode for GameObjects v1.x.x targets the following Unity versions:

• Unity 2021.3(LTS), 2022.3(LTS), and is Unity 6 compatible.

Netcode for GameObjects v2.x.x targets the following Unity versions:

• Unity 6 (LTS)

On the following runtime platforms:

• Windows, MacOS, and Linux
• iOS and Android
• Most closed platforms, such as consoles. Contact us for more information about specific closed platforms.

Development

This repository is broken into multiple components, each one implemented as a Unity Package.

    .
    ├── com.unity.netcode.gameobjects           # The core netcode SDK unity package (source + tests)
    └── testproject                             # A Unity project with various test implementations & scenes which exercise the features in the above packages.

Contributing

We are an open-source project and we encourage and welcome contributions. If you wish to contribute, please be sure to review our contribution guidelines.

Issues and missing features

If you have an issue, bug or feature request, please follow the information in our contribution guidelines to submit an issue.

You can also check out our public roadmap to get an idea for what we might be working on next!