Skip to content
This repository was archived by the owner on Jul 23, 2025. It is now read-only.

Commit c25748c

Browse files
authored
Update README.md
1 parent 90fd13e commit c25748c

File tree

1 file changed

+2
-47
lines changed

1 file changed

+2
-47
lines changed

README.md

Lines changed: 2 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,3 @@
1-
# Unity Multiplayer Networking Docs
1+
# Unity Multiplayer documentation
22

3-
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.
4-
5-
The documentation site is built using [Docusaurus 2](https://v2.docusaurus.io/) using [Yarn](https://yarnpkg.com/en/) and [Node.js](https://nodejs.org/en/download/).
6-
7-
[![Website](https://img.shields.io/website?url=https%3A%2F%2Fdocs-multiplayer.unity3d.com%2F)](https://docs-multiplayer.unity3d.com/)
8-
[![Forums](https://img.shields.io/badge/unity--forums-multiplayer-blue)](https://forum.unity.com/forums/multiplayer.26/)
9-
[![Discord](https://img.shields.io/discord/449263083769036810.svg?label=discord&logo=discord&color=informational)](https://discord.gg/FM8SE9E)
10-
11-
## Contributing Content
12-
13-
Always cut branches from **main** branch.
14-
15-
See the [Contribution Guide](https://github.com/Unity-Technologies/com.unity.multiplayer.docs/wiki) to learn about writing and submitting content, our GitHub labels, and more. A [template file](https://github.com/Unity-Technologies/com.unity.multiplayer.docs/blob/master/docs/template.md) (/docs/template.md) is included in the repo to understand markdown formatting and options.
16-
17-
## Installation
18-
19-
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.
20-
21-
1. Install [NodeJS](https://nodejs.org/en/download/).
22-
2. Install [Yarn](https://yarnpkg.com/en/).
23-
3. Install Docusaurus to a temp location: `yarn global add docusaurus-init`. You can delete the temp project.
24-
4. Install all packages: `yarn install`
25-
26-
## Building on Local
27-
28-
For full building content, see [Building Locally](https://github.com/Unity-Technologies/com.unity.multiplayer.docs/wiki/Building-Locally):
29-
30-
1. Run the build command to generate a site. This command generates static content into the `build` directory.
31-
32-
```console
33-
yarn build
34-
```
35-
36-
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.
37-
38-
```console
39-
yarn start
40-
```
41-
42-
## Connect with Unity
43-
44-
Connect with the Unity Multiplayer Solution Architect team and community on the [Unity Multiplayer Networking](http://discord.gg/unity-multiplayer-network) and for documentation team using channel #documentation. You can also raise threads on the [Unity Multiplayer Forum](https://forum.unity.com/forums/multiplayer.26/)
45-
46-
## Tools Used
47-
48-
Our site uses [Docusaurus](https://docusaurus.io/) with Yarn commands. Always use Yarn commands, to update, build, and serve the server locally. Our search uses Algolia for Open Source.
3+
This repository and the associated website have been archived. For Unity multiplayer documentation, please refer to the [Unity Manual](https://docs.unity3d.com/Manual/multiplayer.html), or the relevant package site for [Netcode for GameObjects](https://docs.unity3d.com/Packages/com.unity.netcode.gameobjects@latest?subfolder=/manual/index.html), [Unity Transport](https://docs.unity3d.com/Packages/com.unity.transport@latest?subfolder=/manual/index.html), [Multiplayer Tools](https://docs.unity3d.com/Packages/com.unity.multiplayer.tools@latest?subfolder=/manual/index.html), or [Multiplayer Play Mode](https://docs.unity3d.com/Packages/com.unity.multiplayer.playmode@latest?subfolder=/manual/index.html).

0 commit comments

Comments
 (0)