Skip to content

Commit 06f378f

Browse files
authored
chore: update links (#1889)
1 parent 5cb72fd commit 06f378f

File tree

5 files changed

+51
-39
lines changed

5 files changed

+51
-39
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11
# Netcode for GameObjects
22

33
[![Forums](https://img.shields.io/badge/unity--forums-multiplayer-blue)](https://forum.unity.com/forums/multiplayer.26/) [![Discord](https://img.shields.io/discord/449263083769036810.svg?label=discord&logo=discord&color=informational)](https://discord.gg/FM8SE9E)
4-
[![Website](https://img.shields.io/badge/docs-website-informational.svg)](https://docs-multiplayer.unity3d.com/) [![Api](https://img.shields.io/badge/docs-api-informational.svg)](https://docs-multiplayer.unity3d.com/docs/api/introduction)
4+
[![Manual](https://img.shields.io/badge/docs-manual-informational.svg)](https://docs-multiplayer.unity3d.com/netcode/current/about) [![API](https://img.shields.io/badge/docs-api-informational.svg)](https://docs-multiplayer.unity3d.com/netcode/current/api/introduction)
55

66
[![GitHub Release](https://img.shields.io/github/release/Unity-Technologies/com.unity.netcode.gameobjects.svg?logo=github)](https://github.com/Unity-Technologies/com.unity.netcode.gameobjects/releases/latest)
77

88
### Welcome!
99

1010
Welcome to the Netcode for GameObjects repository.
1111

12-
Netcode for GameObjects is a Unity package that provides networking capabilities to GameObject & MonoBehaviour workflows. The framework is interoperable with many low-level transports, including the official [Unity Transport Package](https://docs-multiplayer.unity3d.com/transport/1.0.0/introduction).
12+
Netcode for GameObjects is a Unity package that provides networking capabilities to GameObject & MonoBehaviour workflows. The framework is interoperable with many low-level transports, including the official [Unity Transport Package](https://docs-multiplayer.unity3d.com/transport/current/about).
1313

1414
### Getting Started
15+
1516
Visit the [Multiplayer Docs Site](https://docs-multiplayer.unity3d.com/) for package & API documentation, as well as information about several samples which leverage the Netcode for GameObjects package.
1617

17-
You can also jump right into our [Hello World](https://docs-multiplayer.unity3d.com/docs/tutorials/helloworld/helloworldintro/index.html) guide for a taste of how to use the framework for basic networked tasks.
18+
You can also jump right into our [Hello World](https://docs-multiplayer.unity3d.com/netcode/current/tutorials/helloworld/helloworldintro) guide for a taste of how to use the framework for basic networked tasks.
1819

1920
### Community and Feedback
21+
2022
For general questions, networking advice or discussions about Netcode for GameObjects, please join our [Discord Community](https://discord.gg/FM8SE9E) or create a post in the [Unity Multiplayer Forum](https://forum.unity.com/forums/multiplayer.26/).
2123

2224
### Compatibility
@@ -30,7 +32,6 @@ On the following runtime platforms:
3032
- Most closed platforms, such as consoles. Contact us for more information about specific closed platforms.
3133

3234
### Development
33-
We follow the [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). The master branch contains our latest stable release version while the develop branch tracks our current work.
3435

3536
This repository is broken into multiple components, each one implemented as a Unity Package.
3637
```
@@ -40,8 +41,11 @@ This repository is broken into multiple components, each one implemented as a Un
4041
```
4142

4243
### Contributing
43-
We are an open-source project and we encourage and welcome contributions. If you wish to contribute, be sure to review our [contribution guidelines](CONTRIBUTING.md).
44+
45+
We are an open-source project and we encourage and welcome contributions. If you wish to contribute, please be sure to review our [contribution guidelines](CONTRIBUTING.md).
4446

4547
#### Issues and missing features
48+
4649
If you have an issue, bug or feature request, please follow the information in our [contribution guidelines](CONTRIBUTING.md) to submit an issue.
50+
4751
You can also check out our public [roadmap](https://unity.com/roadmap/unity-platform/multiplayer-networking) to get an idea for what we might be working on next!

com.unity.netcode.gameobjects/Documentation~/Index.md

Lines changed: 0 additions & 31 deletions
This file was deleted.
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# About Netcode for GameObjects
2+
3+
Netcode for GameObjects is a Unity package that provides networking capabilities to GameObject & MonoBehaviour workflows.
4+
5+
## Guides
6+
7+
See guides below to install Unity Netcode for GameObjects, set up your project, and get started with your first networked game:
8+
9+
- [Documentation](https://docs-multiplayer.unity3d.com/netcode/current/about)
10+
- [Installation](https://docs-multiplayer.unity3d.com/netcode/current/migration/install)
11+
- [First Steps](https://docs-multiplayer.unity3d.com/netcode/current/tutorials/helloworld/helloworldintro)
12+
- [API Reference](https://docs-multiplayer.unity3d.com/netcode/current/api/introduction)
13+
14+
# Technical details
15+
16+
## Requirements
17+
18+
Netcode for GameObjects targets the following Unity versions:
19+
- Unity 2020.3, 2021.1, and 2021.2
20+
21+
On the following runtime platforms:
22+
- Windows, MacOS, and Linux
23+
- iOS and Android
24+
- Most closed platforms, such as consoles. Contact us for more information about specific closed platforms.
25+
26+
## Document revision history
27+
28+
|Date|Reason|
29+
|---|---|
30+
|March 10, 2021|Document created. Matches package version 0.1.0|
31+
|June 1, 2021|Update and add links for additional content. Matches patch version 0.1.0 and hotfixes.|
32+
|June 3, 2021|Update document to acknowledge Unity min version change. Matches package version 0.2.0|
33+
|August 5, 2021|Update product/package name|
34+
|September 9,2021|Updated the links and name of the file.|
35+
|April 20, 2022|Updated links|

com.unity.netcode.gameobjects/Editor/NetworkManagerEditor.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ private static void DrawInstallMultiplayerToolsTip()
363363
const string getToolsText = "Access additional tools for multiplayer development by installing the Multiplayer Tools package in the Package Manager.";
364364
const string openDocsButtonText = "Open Docs";
365365
const string dismissButtonText = "Dismiss";
366-
const string targetUrl = "https://docs-multiplayer.unity3d.com/docs/tools/install-tools";
366+
const string targetUrl = "https://docs-multiplayer.unity3d.com/netcode/current/tools/install-tools";
367367
const string infoIconName = "console.infoicon";
368368

369369
if (PlayerPrefs.GetInt(InstallMultiplayerToolsTipDismissedPlayerPrefKey, 0) != 0)
Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
# Netcode for GameObjects
22

33
[![Forums](https://img.shields.io/badge/unity--forums-multiplayer-blue)](https://forum.unity.com/forums/multiplayer.26/) [![Discord](https://img.shields.io/discord/449263083769036810.svg?label=discord&logo=discord&color=informational)](https://discord.gg/FM8SE9E)
4-
[![Website](https://img.shields.io/badge/docs-website-informational.svg)](https://docs-multiplayer.unity3d.com/) [![Api](https://img.shields.io/badge/docs-api-informational.svg)](https://docs-multiplayer.unity3d.com/docs/mlapi-api/introduction)
4+
[![Manual](https://img.shields.io/badge/docs-manual-informational.svg)](https://docs-multiplayer.unity3d.com/netcode/current/about) [![API](https://img.shields.io/badge/docs-api-informational.svg)](https://docs-multiplayer.unity3d.com/netcode/current/api/introduction)
55

6-
Netcode for GameObjects provides networking capabilities to GameObject & MonoBehaviour Unity workflows. The framework is interoperable with many low-level transports, including the official [Unity Transport Package](https://docs-multiplayer.unity3d.com/transport/1.0.0/introduction).
6+
Netcode for GameObjects is a Unity package that provides networking capabilities to GameObject & MonoBehaviour workflows. The framework is interoperable with many low-level transports, including the official [Unity Transport Package](https://docs-multiplayer.unity3d.com/transport/current/about).
77

88
### Getting Started
9+
910
Visit the [Multiplayer Docs Site](https://docs-multiplayer.unity3d.com/) for package & API documentation, as well as information about several samples which leverage the Netcode for GameObjects package.
1011

12+
You can also jump right into our [Hello World](https://docs-multiplayer.unity3d.com/netcode/current/tutorials/helloworld/helloworldintro) guide for a taste of how to use the framework for basic networked tasks.
13+
1114
### Community and Feedback
15+
1216
For general questions, networking advice or discussions about Netcode for GameObjects, please join our [Discord Community](https://discord.gg/FM8SE9E) or create a post in the [Unity Multiplayer Forum](https://forum.unity.com/forums/multiplayer.26/).

0 commit comments

Comments
 (0)