Welcome to the Unity Multiplayer Networking Documentation. This site includes the MLAPI, Unity Transport Package, Boss Room Sample Coop, and other tools and features.
The documentation site is built using Docusaurus 2 using Yarn and Node.js.
Always cut branches from master branch.
See the Contribution Guide to learn about writing and submitting content, our GitHub labels, and more. A template file (/docs/template.md) is included in the repo to understand markdown formatting and options.
Our site uses Docusaurus with Yarn commands. Always use Yarn commands, to update, build, and serve the server locally. If you need a preview without building locally, the Unity Doc Team can get you a preview!
The first time you clone the repo, run the following command to install required node modules into the local cloned directory. You only need to run this once.
yarn installIf you need to update packages and local plugins, use:
yarn upgradeFor full building content, see Building Locally:
-
Run the build command to generate a site. This command generates static content into the
builddirectory.yarn build -
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
Connect with the Unity Multiplayer team and community on the MLAPI by Unity Discord using channel #documentation. You can also raise threads on the Unity Multiplayer Forum