/com.unity.multiplayer.docs

Open Source documentation for Unity Multiplayer, which includes MLAPI and Transport.

Primary LanguageJavaScriptOtherNOASSERTION

Unity Multiplayer Docs

Welcome to the Unity Multiplayer Technology (MTT) Documentation. This site includes the MLAPI, Unity Transport Package, and other tools and features supporting MTT.

The documentation site is built using Docusaurus 2.

GitHub Release NuGet Release Github All Releases Forums Discord

Contributing Content

See the Contribution Guide for details. A template file (/docs/template.md) is included in the repo to understand markdown formatting and options.

Installation

The first time you clone the repo, run the following command to install in the local cloned directory. You only need to run this once.

yarn install

Building on Local

For full building content, see Building Locally:

  1. Run the build command to generate a site. This command generates static content into the build directory.

    yarn build

  2. Start a local development server and open up a browser window with the following command. Most changes are hot-loaded, displaying without requiring a rebuild and restart.

    yarn start

We recommend running npm update to update your local plugins and packages as needed.

Connect with Unity

Connect with the Unity Multitplayer team and community on the MLAPI by Unity Discord using channel #documentation. You can also raise threads on the Unity Multiplayer Forum