3e400cc4a9
Co-authored-by: Amy Reeve <amy.reeve@unity3d.com> |
||
|---|---|---|
| .github | ||
| config | ||
| docs | ||
| mppm | ||
| mppm_versioned_docs | ||
| mppm_versioned_sidebars | ||
| src | ||
| static | ||
| tools | ||
| tools_versioned_docs | ||
| tools_versioned_sidebars | ||
| transport | ||
| transport_versioned_docs | ||
| transport_versioned_sidebars | ||
| versioned_docs | ||
| versioned_sidebars | ||
| .eslint.rc | ||
| .gitignore | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| Jenkinsfile | ||
| LICENSE.md | ||
| README.md | ||
| babel.config.js | ||
| config.json | ||
| docusaurus.config.js | ||
| mppm_versions.json | ||
| package.json | ||
| sidebars.js | ||
| sidebarsMPPM.js | ||
| sidebarsTools.js | ||
| sidebarsTransport.js | ||
| tools_versions.json | ||
| transport_versions.json | ||
| vercel.json | ||
| versions.json | ||
| yarn.lock | ||
README.md
Unity Multiplayer Networking Docs
Welcome to the Unity Multiplayer Networking Documentation. This site includes the Netcode for GameObjects, Unity Transport, Boss Room Sample Co-op, Bitesize samples, and other tools and features.
The documentation site is built using Docusaurus 2 using Yarn and Node.js.
Contributing Content
Always cut branches from main 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.
Installation
You can install and build docs on Mac and Windows environments. The doc site is built on Docusaurus, which requires NodeJS and Yarn installed for your OS.
- Install NodeJS.
- Install Yarn.
- Install Docusaurus to a temp location:
yarn global add docusaurus-init. You can delete the temp project. - Install all packages:
yarn install
Building on Local
For 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 Unity
Connect with the Unity Multiplayer Solution Architect team and community on the Unity Multiplayer Networking and for documentation team using channel #documentation. You can also raise threads on the Unity Multiplayer Forum
Tools Used
Our site uses Docusaurus with Yarn commands. Always use Yarn commands, to update, build, and serve the server locally. Our search uses Algolia for Open Source.