From 91bc28252a0d7e6a091db17d86f0d9fe1e85bce1 Mon Sep 17 00:00:00 2001 From: "M. Fatih MAR" Date: Thu, 5 Aug 2021 14:14:20 +0100 Subject: [PATCH 1/5] chore: replace MLAPI with Netcode in Markdown files --- .github/ISSUE_TEMPLATE/bug_report.md | 4 +-- .github/ISSUE_TEMPLATE/feedback.md | 4 +-- .github/ISSUE_TEMPLATE/support.md | 2 +- CONTRIBUTING.md | 6 ++--- .../Documentation~/Manual.md | 25 ++++++++++--------- .../Documentation~/Manual.md | 5 ++-- .../Runtime/MultiprocessRuntime/readme.md | 2 +- 7 files changed, 24 insertions(+), 24 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d3f04caf89..02fad77915 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -29,8 +29,8 @@ If applicable, add screenshots to help explain your problem. **Environment (please complete the following information):** - OS: [e.g. Windows 10] - Unity Version: [e.g. 2019.1] - - MLAPI Version: [e.g. v6.0.1] - - MLAPI Commit: [e.g. https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi/commit/c102935df1d7e0928283b48948fe96e5d96dd961] + - Netcode Version: [e.g. v6.0.1] + - Netcode Commit: [e.g. https://github.com/Unity-Technologies/com.unity.multiplayer.mlapi/commit/c102935df1d7e0928283b48948fe96e5d96dd961] **Additional context** Add any other context about the problem here. Logs, code snippets would be useful here but please also consider attaching a minimal Unity project that reproduces the issue. diff --git a/.github/ISSUE_TEMPLATE/feedback.md b/.github/ISSUE_TEMPLATE/feedback.md index 04dbcbd9b4..30aad2a683 100644 --- a/.github/ISSUE_TEMPLATE/feedback.md +++ b/.github/ISSUE_TEMPLATE/feedback.md @@ -1,6 +1,6 @@ --- 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: '' @@ -8,7 +8,7 @@ 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. diff --git a/.github/ISSUE_TEMPLATE/support.md b/.github/ISSUE_TEMPLATE/support.md index 4576a7849f..0033a651de 100644 --- a/.github/ISSUE_TEMPLATE/support.md +++ b/.github/ISSUE_TEMPLATE/support.md @@ -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/). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e36561e6cc..edf43e8bcf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,11 +14,11 @@ Here are our guidlines for contributing: ## Code of Conduct -Please help us keep MLAPI open and inclusive. Read and follow our [Code of Conduct](CODE_OF_CONDUCT.md). +Please help us keep Unity Netcode for GameObjects open and inclusive. Read and follow our [Code of Conduct](CODE_OF_CONDUCT.md). ## Ways to Contribute -There are many ways in which you can contribute to the MLAPI. +There are many ways in which you can contribute to the Netcode for GameObjects. ### Issues and Bugs @@ -46,7 +46,7 @@ When you open a pull request, you will be asked to enter into Unity's License Ag ## Pull Request Submission Guidelines -We use the [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for the development of MLAPI. This means development happens on the **develop branch** and Pull Requests should be submited to it. +We use the [Gitflow Workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for the development of the Netcode for GameObjects. This means development happens on the **develop branch** and Pull Requests should be submited to it. ### Commit Message Guidelines We have very precise rules over how our git commit messages can be formatted. This leads to **more diff --git a/com.unity.multiplayer.mlapi/Documentation~/Manual.md b/com.unity.multiplayer.mlapi/Documentation~/Manual.md index 6df5d6fc72..66e933e997 100644 --- a/com.unity.multiplayer.mlapi/Documentation~/Manual.md +++ b/com.unity.multiplayer.mlapi/Documentation~/Manual.md @@ -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) # 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| \ No newline at end of file +|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| diff --git a/com.unity.multiplayer.transport.utp/Documentation~/Manual.md b/com.unity.multiplayer.transport.utp/Documentation~/Manual.md index 624857922d..f4704311af 100644 --- a/com.unity.multiplayer.transport.utp/Documentation~/Manual.md +++ b/com.unity.multiplayer.transport.utp/Documentation~/Manual.md @@ -1,6 +1,5 @@ -# **Unity MLAPI Manual** - +# **Unity Transport for Netcode for GameObjects Manual** # Getting Started -Fill this in \ No newline at end of file +todo: Fill this in diff --git a/testproject/Assets/Tests/Runtime/MultiprocessRuntime/readme.md b/testproject/Assets/Tests/Runtime/MultiprocessRuntime/readme.md index ca9c451eb6..7a7e8ea8fc 100644 --- a/testproject/Assets/Tests/Runtime/MultiprocessRuntime/readme.md +++ b/testproject/Assets/Tests/Runtime/MultiprocessRuntime/readme.md @@ -2,7 +2,7 @@ ## Why Multiprocess testing can be used for different use cases like -- integration tests (MLAPI + actual transport or multi-scene testing for example) +- integration tests (Netcode + actual transport or multi-scene testing for example) - performance testing. - Anything requiring a more realistic environment for testing that involves having a full client and server, communicating on a real network interface using real transports in separate Unity processes. From dac2a9e1d40872cf7bddeaa48fae0f12bc7213a3 Mon Sep 17 00:00:00 2001 From: "M. Fatih MAR" Date: Thu, 5 Aug 2021 14:29:00 +0100 Subject: [PATCH 2/5] fix grammar Co-authored-by: Luke Stampfli <43687322+LukeStampfli@users.noreply.github.com> --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index edf43e8bcf..19ee708325 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ Please help us keep Unity Netcode for GameObjects open and inclusive. Read and f ## Ways to Contribute -There are many ways in which you can contribute to the Netcode for GameObjects. +There are many ways in which you can contribute to Netcode for GameObjects. ### Issues and Bugs @@ -108,4 +108,4 @@ Always write a clear log message for your commits. One-line messages are fine fo $ git commit -m "A brief summary of the commit > - > A paragraph describing what changed and its impact." \ No newline at end of file + > A paragraph describing what changed and its impact." From 0f05f97a1ddef6dad7112a8ec94a6305a96b283d Mon Sep 17 00:00:00 2001 From: "M. Fatih MAR" Date: Thu, 5 Aug 2021 16:14:57 +0100 Subject: [PATCH 3/5] add todo and tbd notes into changelog files --- com.unity.multiplayer.mlapi/CHANGELOG.md | 4 ++++ com.unity.multiplayer.transport.utp/CHANGELOG.md | 5 ++++- com.unity.multiplayer.transport.utp/README.md | 2 +- 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/com.unity.multiplayer.mlapi/CHANGELOG.md b/com.unity.multiplayer.mlapi/CHANGELOG.md index 2bf42510d5..77a0a4df2a 100644 --- a/com.unity.multiplayer.mlapi/CHANGELOG.md +++ b/com.unity.multiplayer.mlapi/CHANGELOG.md @@ -1,6 +1,10 @@ # Changelog This file documents all notable changes to this package. Additional documentation and release notes are available at [Multiplayer Documentation](https://docs-multiplayer.unity3d.com). +## [1.0.0] - tbd + +todo @mfatihmar + ## [0.2.0] - 2021-06-03 WIP version increment to pass package validation checks. Changelog & final version number TBD. diff --git a/com.unity.multiplayer.transport.utp/CHANGELOG.md b/com.unity.multiplayer.transport.utp/CHANGELOG.md index ec3479e4e9..b4b2d6ce8e 100644 --- a/com.unity.multiplayer.transport.utp/CHANGELOG.md +++ b/com.unity.multiplayer.transport.utp/CHANGELOG.md @@ -1,6 +1,9 @@ # 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/) +## [1.0.0] - tbd + +todo @andrews-unity ## [0.0.1-preview.1] - 2020-12-20 -This is the first release of Unity MLAPI Package \ No newline at end of file +This is the first release of Unity MLAPI Package diff --git a/com.unity.multiplayer.transport.utp/README.md b/com.unity.multiplayer.transport.utp/README.md index e1797a7ee5..f073e97721 100644 --- a/com.unity.multiplayer.transport.utp/README.md +++ b/com.unity.multiplayer.transport.utp/README.md @@ -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. \ No newline at end of file From 6da8c2837209f50c97825007dbbe0e55bb401256 Mon Sep 17 00:00:00 2001 From: "M. Fatih MAR" Date: Thu, 5 Aug 2021 16:16:22 +0100 Subject: [PATCH 4/5] another todo note for utp package --- com.unity.multiplayer.transport.utp/Documentation~/Manual.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/com.unity.multiplayer.transport.utp/Documentation~/Manual.md b/com.unity.multiplayer.transport.utp/Documentation~/Manual.md index f4704311af..662f90a152 100644 --- a/com.unity.multiplayer.transport.utp/Documentation~/Manual.md +++ b/com.unity.multiplayer.transport.utp/Documentation~/Manual.md @@ -2,4 +2,4 @@ # Getting Started -todo: Fill this in +todo @andrews-unity - fill this in From 8ad70a574ab4d767556eaef8e5cdcae8e90ee84b Mon Sep 17 00:00:00 2001 From: "M. Fatih MAR" Date: Thu, 5 Aug 2021 18:47:40 +0100 Subject: [PATCH 5/5] delete tbd notes from changelogs --- com.unity.multiplayer.mlapi/CHANGELOG.md | 4 ---- com.unity.multiplayer.transport.utp/CHANGELOG.md | 4 ---- 2 files changed, 8 deletions(-) diff --git a/com.unity.multiplayer.mlapi/CHANGELOG.md b/com.unity.multiplayer.mlapi/CHANGELOG.md index 77a0a4df2a..2bf42510d5 100644 --- a/com.unity.multiplayer.mlapi/CHANGELOG.md +++ b/com.unity.multiplayer.mlapi/CHANGELOG.md @@ -1,10 +1,6 @@ # Changelog This file documents all notable changes to this package. Additional documentation and release notes are available at [Multiplayer Documentation](https://docs-multiplayer.unity3d.com). -## [1.0.0] - tbd - -todo @mfatihmar - ## [0.2.0] - 2021-06-03 WIP version increment to pass package validation checks. Changelog & final version number TBD. diff --git a/com.unity.multiplayer.transport.utp/CHANGELOG.md b/com.unity.multiplayer.transport.utp/CHANGELOG.md index b4b2d6ce8e..02f0a7a072 100644 --- a/com.unity.multiplayer.transport.utp/CHANGELOG.md +++ b/com.unity.multiplayer.transport.utp/CHANGELOG.md @@ -1,9 +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/) -## [1.0.0] - tbd - -todo @andrews-unity - ## [0.0.1-preview.1] - 2020-12-20 This is the first release of Unity MLAPI Package