chore: Added upgrade-guide for 2.X --> 3.X migration - #4153
Conversation
![u-pr[bot]](https://avatars.githubusercontent.com/in/1201017?s=60&v=4){kind=small}
|
|
||
| ## Editor and dependency requirements | ||
|
|
||
| - **Minimum Editor version.** Netcode for GameObjects 3.x requires Unity **6000.7** or later. Projects on earlier Editor versions must either stay on the 2.x series or upgrade the Editor before installing 3.x. |
There was a problem hiding this comment.
The package declares Unity 6000.6 as its minimum and this repository's normal validation configuration runs on 6000.6, so a supported 2.x project on that editor can upgrade. This instruction instead tells those users that they must remain on 2.x or upgrade the editor. Align the guide with the package's actual minimum (or change the package support metadata if 6000.7 is truly required).
🤖 Helpful? 👍/👎
| ## Editor and dependency requirements | ||
|
|
||
| - **Minimum Editor version.** Netcode for GameObjects 3.x requires Unity **6000.7** or later. Projects on earlier Editor versions must either stay on the 2.x series or upgrade the Editor before installing 3.x. | ||
| - **New dependency.** Netcode for GameObjects 3.x depends on the Netcode for Entities package (`com.unity.netcode`), which in turn brings in the Entities packages (`com.unity.entities`, `com.unity.collections`, `com.unity.burst`, `com.unity.mathematics`). Installing 3.x adds these packages to your project. This increases the project's package footprint and build times, and requires an Editor and target platforms that support Burst and Entities. |
There was a problem hiding this comment.
This is not a declared package dependency: the package manifest lists only Mono.Cecil and Transport. com.unity.netcode appears only in the repository's separate unified-test manifest, while a normal project manifest contains NGO without it. Thus upgrading a standard project does not add the listed Entities packages as claimed, and this incorrectly tells ordinary users that their project now requires Burst/Entities platform support. Describe the experimental/editor-bundled unified path accurately, or document any manual dependency installation that is actually required.
🤖 Helpful? 👍/👎
| | --- | --- | | ||
| | `Unity.Netcode.Editor` | `Unity.Netcode.GameObjects.Editor` | | ||
| | `Unity.Netcode.Editor.CodeGen` | `Unity.Netcode.GameObjects.Editor.CodeGen` | | ||
| | `Unity.Netcode.Editor.PackageChecker` | `Unity.Netcode.GameObjects.PackageChecker.Editor` | |
There was a problem hiding this comment.
The previous PackageChecker assembly name is Unity.Netcode.PackageChecker.Editor, not Unity.Netcode.Editor.PackageChecker (the repository's 2.x-to-3.x updater fixture records that mapping). The API updater does not rewrite .asmdef name references, so a project with the real old name will not find a matching row here and will retain an unresolved assembly reference after upgrading. Replace the left-hand name with Unity.Netcode.PackageChecker.Editor.
🤖 Helpful? 👍/👎
1 participant
Purpose of this PR
Adding upgrade-guide in the same way as it was added for N4E. Feel free to make any corrections to it
Jira ticket
N/A
Documentation
Added migration-guide doc
Testing & QA (How your changes can be verified during release Playtest)
N/A
Up-port
N/A
Backports
N/A