-
Notifications
You must be signed in to change notification settings - Fork 459
chore: replace MLAPI with Netcode in Markdown files #1025
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
91bc282
chore: replace MLAPI with Netcode in Markdown files
0xFA11 dac2a9e
fix grammar
0xFA11 08b655d
Merge branch 'develop' into chore/md-files
0xFA11 0f05f97
add todo and tbd notes into changelog files
0xFA11 6da8c28
another todo note for utp package
0xFA11 8ad70a5
delete tbd notes from changelogs
0xFA11 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,14 @@ | ||
| --- | ||
| name: Feedback | ||
| about: Provide feedback to the MLAPI team | ||
| about: Provide feedback to the Netcode for GameObjects team | ||
| title: '' | ||
| labels: stat:awaiting triage, type:feedback | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| **Feedback** | ||
| Enter your feedback to the MLAPI team here. Please keep in mind that our teams focus is on multiplayer development. For other non-networking related feedback towards Unity please use the Forums. | ||
| Enter your feedback to the Netcode for GameObjects team here. Please keep in mind that our teams focus is on multiplayer development. For other non-networking related feedback towards Unity please use the Forums. | ||
|
|
||
| **Suggested Changes** | ||
| If you think we could do something better, please let us know here what you would like us to change. Concrete and constructive suggestions are welcome and will help us to prioritize and act on feedback. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,4 +9,4 @@ assignees: '' | |
|
|
||
| Post your questions or problems here. | ||
|
|
||
| For general questions, networking advice or discussions about MLAPI, you can also reach us on our [Discord Community](https://discord.gg/FM8SE9E) or create a post in the [Unity Multiplayer Forum](https://forum.unity.com/forums/multiplayer.26/). | ||
| For general questions, networking advice or discussions about the Netcode for GameObjects, you can also reach us on our [Discord Community](https://discord.gg/FM8SE9E) or create a post in the [Unity Multiplayer Forum](https://forum.unity.com/forums/multiplayer.26/). | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. IIRC, we have a new sub-forum for the SDK, should we update the forum link here? |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,30 @@ | ||
| # About MLAPI | ||
| # About Netcode for GameObjects | ||
|
|
||
| Unity MLAPI is a high level networking library built for the Unity game engine to abstract networking. This allows developers to focus on the game rather than low level protocols and networking frameworks. | ||
| Unity Netcode for GameObjects is a high-level networking library built to abstract networking. This allows developers to focus on the game rather than low level protocols and networking frameworks. | ||
|
|
||
| ## Unity MLAPI | ||
| ## Guides | ||
|
|
||
| See this guide to install Unity MLAPI, set up your project, and get started with your first networked game. | ||
| See guides below to install Unity Netcode for GameObjects, set up your project, and get started with your first networked game: | ||
|
|
||
| * [MLAPI Documentation](https://docs-multiplayer.unity3d.com/docs/getting-started/about-mlapi) | ||
| * [Install MLAPI](https://docs-multiplayer.unity3d.com/docs/migration/install) | ||
| * [First Steps with Unity MLAPI](https://docs-multiplayer.unity3d.com/docs/tutorials/helloworldintro) | ||
| * [MLAPI API Reference](https://docs-multiplayer.unity3d.com/docs/mlapi-api/introduction) | ||
| * [Documentation](https://docs-multiplayer.unity3d.com/docs/getting-started/about-mlapi) | ||
| * [Installation](https://docs-multiplayer.unity3d.com/docs/migration/install) | ||
| * [First Steps](https://docs-multiplayer.unity3d.com/docs/tutorials/helloworldintro) | ||
| * [API Reference](https://docs-multiplayer.unity3d.com/docs/mlapi-api/introduction) | ||
|
Comment on lines
+9
to
+12
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. links may or may not change, but they're here — FYI @Briancoughlin |
||
|
|
||
| # Technical details | ||
|
|
||
| ## Requirements | ||
|
|
||
| This version of MLAPI is compatible with the following versions of the Unity Editor: | ||
| This version of Netcode for GameObjects is compatible with the following Unity versions and platforms: | ||
|
|
||
| * 2020.3 and later | ||
| * Windows, Mac, Linux platforms are supported by MLAPI | ||
| * Windows, Mac, Linux platforms | ||
|
|
||
| ## Document revision history | ||
|
|
||
| |Date|Reason| | ||
| |---|---| | ||
| |March 10, 2021|Document created. Matches package version 0.1.0| | ||
| |June 1, 2021| Updated and added links for additional content. Matches patch version 0.1.0 and hotfixes.| | ||
| |June 3, 2021| Update document to acknowledge Unity min version change. Matches package version 0.2.0| | ||
| |June 1, 2021|Update and add links for additional content. Matches patch version 0.1.0 and hotfixes.| | ||
| |June 3, 2021|Update document to acknowledge Unity min version change. Matches package version 0.2.0| | ||
| |August 5, 2021|Update product/package name| | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| # Changelog | ||
| All notable changes to this package will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) | ||
|
|
||
|
|
||
| ## [0.0.1-preview.1] - 2020-12-20 | ||
| This is the first release of Unity MLAPI Package | ||
| This is the first release of Unity MLAPI Package |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| # **Unity MLAPI Manual** | ||
|
|
||
| # **Unity Transport for Netcode for GameObjects Manual** | ||
|
|
||
| # Getting Started | ||
|
|
||
| Fill this in | ||
| todo @andrews-unity - fill this in |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| com.unity.transport transport for MLAPI | ||
| com.unity.transport transport for Netcode for GameObjects | ||
|
|
||
| WIP: This is not a functional transport just a work in progress and should not be used as any measure of current state a very early proof of concept and place holder package. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we'll come back to this link (
com.unity.multiplayer.mlapi) after we rename this repository.