Skip to content

JackSun1995/com.unity.multiplayer.docs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Unity Multiplayer Networking Docs

Welcome to the Unity Multiplayer Networking Documentation. This site includes the MLAPI, 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.

Website Build Status Forums Discord

Contributing Content

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.

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.

  1. Install NodeJS.
  2. Install Yarn.
  3. Install Docusaurus to a temp location: yarn global add docusaurus-init. You can delete the temp project.

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

Connect with Unity

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

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. For details on tools, see this blog post. If you need a preview without building locally, the Unity Doc Team can get you a preview!

About

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

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 77.1%
  • SCSS 18.3%
  • TypeScript 3.5%
  • CSS 1.1%