jiekezhu / com.unity.netcode.gameobjects Goto Github PK

View Code? Open in Web Editor NEW

Netcode for GameObjects is a high-level netcode SDK that provides networking capabilities to GameObject/MonoBehaviour workflows within Unity and sits on top of underlying transport layer.

License: MIT License

Shell 0.01% Python 0.07% C# 99.91%

com.unity.netcode.gameobjects's Introduction

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.

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 targets the following Unity versions:

Unity 2020.3(LTS), 2021.3(LTS), and 2022.2

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.