Merge branch 'develop'

Author: Vic-Cooper

docusaurus.config.js

@@ -389,9 +389,13 @@ module.exports = {
         lastVersion: "current",
         versions: {
           current: {
-            label: "1.4.0",
+            label: "1.5.0-exp.1",
             path: "current",
           },
+          "1.4.0": {
+            label: "1.4.0",
+            path: "1.4.0",
+          },
           "1.3.3": {
             label: "1.3.3",
             path: "1.3.3",

mppm/release-notes/mppm-release-notes.md

@@ -0,0 +1,303 @@
+---
+id: mppm-release-notes
+title: Release notes
+description: Release notes for Multiplayer Play Mode including new features, updates, bug fixes, and known issues.
+---
+
+## [1.5.0-exp.1] - 2025-03-06
+
+### Fixed
+- Fixed and exception that was thrown when you start a scenario with no instances.
+- When a stop is requested during a domain reload, the scenario now exits Play Mode.
+- The launching scenario progress bar transition animation now appears correctly.
+- Reduced the number of errors that appear in the log when you rename the project.
+- Deleting Player Tags from Project Settings no longer removes them from existing Scenarios.
+- The editor window controls or widgets in Clone Editor instances now display correctly.
+- The launching scenario window UI is now ready during the build process.
+
+### Added
+- Added Android mobile support to playmode scenarios.
+
+## [1.4.0-pre.2] - 2025-01-10
+
+### Added
+- Added `CurrentPlayer.IsMainEditor` to the API to check if the current Player is the Main Editor instance.
+- Added a Main Editor label to the scenario launch window.
+
+### Fixed
+- Fixed an `ArgumentNullException` issue that occurs across an Multiplayer Play Mode upgrade with an actively set playmode Scenario configuration.
+- Fixed an issue where project settings were not getting propagated to Virtual Players when entering Playmode via the play button.
+- Fixing the issue where the launching scenario window persists when domain/scene reload is enabled in the project settings.
+
+### Changed
+- Moved the warning helpbox in Multiplayer Play Mode window to the bottom of the VP list during VP activation.
+
+### Fixed
+- Virtual players can now be muted and mute all virtual player setting only mutes players at launch
+## [1.4.0-pre.1] - 2024-12-05
+
+### Fixed
+- Virtual Player windows correctly update and stay in sync when you enter and exit Play mode.
+- Removed instances of outdated internal build profile API functions.
+
+### Added
+- Added a Scenario launch pop-up window that shows the scenario stages, progress bars, and configuration details.
+- Added the Entities Hierarchy window to Virtual Players. To enable this window, go to **Layout** > **Entities Hierarchy**.
+
+## [1.3.3] - 2024-12-17
+
+### Added
+- Fixed an `ArgumentNullException` issue that occurs across an Multiplayer Play Mode upgrade with an actively set Play Mode Scenario configuration.
+
+### Fixed
+- Fixed an issue where project settings were not getting propagated to Virtual Players when entering Play mode via the play button.
+
+## [1.3.2] - 2024-11-14
+
+### Fixed
+- Fixed clones so that they correctly deactivate when you stop a play mode scenario during the clone activation.
+- Fixed the clone editor's layout configuration so that it displays correctly when you enable Playmode Tools.
+- Fixed the compilation error "'UnityPlayer' does not contain a definition for 'Role'" when the Dedicated Server package version doesn't match.
+
+### Added
+- On Windows devices, the Virtual Player window now remains anchored when you use the same layout in Play mode and Edit mode.
+
+## [1.3.1] - 2024-10-21
+
+### Fixed
+
+- Fixed an issue where the "Player [X] failed to sync" window appeared without a synchronization issue.
+- The Virtual Player folder now refreshes when you update the package, Unity Editor, or Editor changeset version.
+
+### Added
+
+- Added a help box to the Multiplayer window to stop package imports while the virtual player(s) are activating. The help box remains visible until all virtual player(s) are ready.
+- Added Multiplayer Menu links to the **Scenario Configuration** and the **Scenarios** status in **Windows** > **Multiplayer**.
+
+## [1.3.0] - 2024-09-26
+
+### Changed
+
+- Updated `com.unity.services.multiplayer` to release version 1.3.0.
+
+### Fixed
+
+- Increased the minimum Engine version to 6000.0.22f1 to fix a crash that happened when you use virtual players and a build profile.
+
+## [1.3.0-pre.3] - 2024-09-20
+
+### Changed
+
+- Replaced the **Original Name** property in the **Remote Instances** > **Advance Configuration** section with the **Identifier** property. The **Identifier** string field creates a unique name for the Multiplay Build, Build Configuration, and Fleet. This name uses the format `CreatedFromTheUnityEditor-[identifier]-[username]`.
+
+### Added
+
+- Added stream logs to main editor option for additional editor instances.
+- Fixed an issue where domain reloads caused streaming logs from local instances to stop.
+- Added a percentage progress to the Play mode Status Window for the preparing, deploying, and launching stages.
+
+### Fixed
+
+- Removed the compilation warning "This async method lacks 'await' operators and will run synchronously".
+- Enabled log streaming from remote instances.
+- Code changes now sync consistently between the Main editor and the virtual player when you use Rider.
+- Fixed the "Asset out of sync" error that appeared when the virtual player didn't start in the correct build target.
+
+## [1.3.0-pre.2] - 2024-08-14
+
+### Fixed
+- Fixed an issue where the virtual player called `OpenScene()` and `CloseScene()` during Play mode when multiple scenes existed in the project.
+- Fixed the error "Type is not a supported string value" that appeared when you add a tag to the Main editor instance.
+- Tags now persist in the **Tag** dropdown after you navigate away from the **Scenario configuration** window.
+- Fixed the error "Multiplayer Play Mode can't spawn virtual player" in Play mode.
+
+### Changed
+- The Multiplayer Play Mode Window is now disabled when you select a Play Mode Scenario.
+
+## [1.3.0-pre.1] - 2024-07-26
+
+### Changed
+- Reduced the time it takes to enter Play mode with remote instances on consecutive runs that create the same build files.
+- Added the **Editor** property to the **Play mode scenario** window that you can use to disable the Main editor instance.
+- Updated the remote deployment dependency to `[email protected]`.
+- Removed UPM from the clones to improve performance and so clones rely on library redirect as originally intended.
+
+### Fixed
+- Added a window that gives you the option to **Save**, **Don’t Save**, or **Cancel** when you initiate a virtual player with an unsaved scene.
+- Fixed the "Asset database is out of sync" error that appeared when virtual player opened.
+
+## [1.3.0-exp.4] - 2024-07-16
+
+### Changed
+- Updated the remote deployment dependency to `[email protected]`.
+
+## [1.3.0-exp.3] - 2024-07-11
+
+### Changed
+- Moved the Multiplayer Window from **Window** > **Multiplayer Playmode** to **Window** > **Multiplayer** > **Multiplayer Playmode** to ensure consistency with the other Multiplayer packages.
+- Scenario status popup title changed from **Connection Status** to **Instances Status**.
+
+### Added
+- Added the Playmode Status Window that gives more information about each instance in the scenario
+
+### Fixed
+- Removed warning log when the multiplay package is not installed. Information message now appears only in the UI in the "configure play mode scenarios" window.
+- Fixed remote instances default arguments from `-log` to `-logFile`.
+
+## [1.3.0-exp.2] - 2024-07-03
+
+### Fixed
+- Fixed an issue to make the **Stream logs to main editor** property work in local instances.
+
+## [1.3.0-exp.1] - 2024-06-24
+
+### Added
+- Added the Playmode Scenarios window that you can use to configure Editor, local and remote instances.
+
+### Fixed
+- No longer hit an exception when launching the standalone profiler.
+
+## [1.2.0] - 2024-06-04
+
+### Added
+- Added tooltips to the preferences window
+
+### Fixed
+- Fixed an issue that hid Multiplayer roles when you reinstalled the Dedicated Server Package.
+- Fixed the main view window so that when you make it smaller the UI is not affected.
+
+## [1.1.0] - 2024-04-24
+
+### Added
+- Added a new layout option to each Multiplayer Play Mode clone in projects that include the Netcode For Entities package.
+- Updated the **Close** button to display a warning dialog prompt that deactivates a Virtual Player.
+- Added the mute setting to mute specific users.
+- Added a setting that changes the Asset Database refresh timeout.
+- Updated the focus shortcut behavior to focus on other individual Virtual Player windows from inside an individual Player.
+- Updated the message that appears when a Symlink failure (on FAT32) happens because it isn't supported.
+
+### Fixed
+- The local clone cache clears automatically when you update the Multiplayer Play Mode package.
+- Fixed a crash caused by devices set to certain regions.
+- Changed the default multiplayer role of Player clones to Client and Server.
+- Added a minimum width for the main view of the Multiplayer Play Mode window.
+- The escape key no longer closes Virtual Player windows on Windows devices.
+- Fixed issues with heartbeat timeout.
+- Removed the forward slash **/** character from tags because it's for drop-down behavior only.
+
+## [1.0.0] - 2024-03-12
+
+### Added
+
+- A Multiplayer development workflow aiming to offer a more efficient development cycle for multiplayer games. The tool enables opening multiple Unity Editor instances simultaneously on the same development device, using the same source assets on disk.
+
+## [1.0.0-pre.2] - 2023-12-21
+
+### Fixed
+
+- Better handling of custom implicit packages on the clones.
+
+## [1.0.0-pre.1] - 2023-11-17
+
+### Fixed
+
+- Some compatibility fixes with Dedicated Server.
+
+## [0.6.0] - 2023-11-08
+
+### Fixed
+
+- Some fixes for Clone heartbeats.
+- More fixes for persistent window layouts.
+
+### Features
+
+- Can now focus Player with hotkeys (CTRL+F9-F12).
+- Just show the layout view toggles as disabled during playmode.
+- Automatically focus Players after activating.
+
+## [0.5.0] - 2023-09-27
+
+### Fixed
+
+- Fix broken links in documentation.
+
+### Features
+
+- Moved PlayerTags to the project settings window.
+- Players can now have multiple PlayerTags.
+- Updated `CurrentPlayer.ReadOnlyTag` to be `CurrentPlayer.ReadOnlyTags`.
+
+## [0.4.0] - 2023-08-26
+
+### Fixed
+
+- Fixed an issue where a Player could still show up as active after it had exited.
+- Fixed an issue where you could have multiple add tag views.
+- Fixed an issue where `CurrentPlayer.ReadOnlyTag` would not return the correct value when domain reload on play mode is disabled.
+- Fixed an issue where clones were crashing when scrolling mouse over menu top bar
+
+### Features
+
+- Debug workflows now has dynamic layouts that persist between runs.
+- Players that are unresponsive will now result in a prompt appearing in the main Editor Player asking if they should be restarted. (Only on Windows for now.)
+- Now support for content selection in your Players (Requires dedicated server package to be installed).
+
+## [0.3.0] - 2023-07-26
+
+### Fixed
+
+- Fixed PlayerTags starting and ending with whitespace.
+- Fixed handling of relative paths in the package.json of a Player.
+
+### Features
+
+- Can now have your Players reboot if they fail to import or stop unexpectedly (e.g. crash). A prompt will appear asking what action to take.
+- Debugging workflows is now enabled (giving users more access to the editor in Players). It can be accessed by using the Layout Dropdown in the top left of a Player to enable more views (Scene, Game, etc).
+- Can disable Multiplayer Play Mode in settings.
+- Updated Tag to be ReadOnlyTag to better communicate how tags as a feature works.
+
+## [0.2.0] - 2023-06-26
+
+### Fixed
+
+* Fixed null exception when loading into a new scene with unsaved changes.
+* Fixed exception triggered on Players when changing scene in play mode.
+* Updated text to "Show in Finder" on MacOS for revealing Players location on disk.
+* Fixed issues with the Asset Database syncing.
+
+### Features
+
+* Display a message to the console log when opening Clones that don't have the required symlinked folders.
+* Trigger play mode for clones before main Editor Player starts entering play mode.
+* Clone Players will have the same behaviour as the main Editor Player regarding the "Stop playing and compile" option.
+
+## [0.1.1] - 2023-01-26
+
+### Fixed
+
+- Reduced GC allocations in the messaging system loop.
+- Fixed CurrentPlayer.ReadOnlyTags() returning "Untagged" instead of an empty string if a tag is not assigned.
+- Fixed bug where pressing Return or Enter would not submit a created tag to the UI.
+- Fixed missing XMLDoc for CurrentPlayer API.
+- Fixed broken links in the package documentation.
+
+### Features
+
+* Added support for additive scenes.
+
+## [0.1.0] - 2022-11-15
+
+This release adds the Multiplayer Play Mode, which is a multiplayer development workflow aiming to offer a more efficient and quick development cycle of multiplayer games. The tool enables opening multiple Unity Editor instances simultaneously on the same development device, using the same source assets on disk.
+
+### Known issues
+
+* Player windows can't be reopened if they're closed during Play Mode
+* Virtual Players can remain in Play Mode after the main Editor Player has exited in certain circumstances, such as if script changes are made during Play Mode and the “Stop Playing and Recompile” option is active.
+* Entering Play Mode with multiple scenes open isn't currently supported
+* Virtual Players lose some Game view settings, such as Aspect Ratio, when exiting and entering Play Mode
+* Opening a Virtual Player with unresolved script updater issues will cause an API Update prompt to appear
+* Scripts won't be reloaded correctly in Virtual Players with “Enter Play Mode” settings set with “Reload Domain” disabled
+* In some cases, an error may appear in Virtual Player windows indicating that assets were imported when they weren't supposed to be
+* Non-Prefab assets like Scriptable Objects aren't synced to Virtual Players unless you save your scene or invoke the Save Project command
+* Authentication with UGS won't work without manually overriding configuration values at runtime

mppm_versioned_docs/version-1.4.0/about.md

@@ -0,0 +1,37 @@
+---
+id: about
+title: About Multiplayer Play Mode
+description: Overview of Multiplayer Play Mode
+---
+
+Use Multiplayer Play Mode to test multiplayer functionality within the Unity Editor. You can simulate up to four Players (the main Editor Player and three Virtual Players) simultaneously on the same development device while using the same source assets on disk. Multiplayer Play Mode can help you create multiplayer development workflows that reduce project build times, run it locally, and test the server-client relationship.
+
+## Compatibility
+
+Multiplayer Play Mode version 1.4.0-pre is compatible with Unity Editor versions 6000.0.22f1 or later.
+
+## Multiplayer Play Mode terminology
+
+The following have specific meaning in relation to Multiplayer Play Mode:
+
+* main Editor Player: The original instance of the project in the Unity Editor. This is the only instance with full authoring capabilities.
+* Virtual Players: Simulated Players created with Multiplayer Play Mode. These Players open in a separate window with limited authoring capabilities when you enter [Play mode](https://docs.unity3d.com/Manual/GameView.html).
+* Players: All Player instances, including the main Editor Player and all Virtual Players.
+
+## Limitations
+
+Multiplayer Play Mode has some inherent technical limitations, specifically around [scale](#scale) and [authoring](#authoring).
+
+### Scale
+
+The Unity Editor and Virtual Players require a lot of system resources, so you shouldn't use Multiplayer Play Mode at scale. Multiplayer Play Mode is designed for small-scale, local testing environments that can only support up to four total Players (the main Editor Player and three Virtual Players).
+
+### Authoring
+You can't create or change the properties of GameObjects in a Virtual Player. Instead, use the main Editor Player to make changes and a Virtual Player to test multiplayer functionality. Any changes you make in Play Mode in the main Editor Player reset when you exit Play Mode.
+:::note
+You can't access any main Editor Player functionality from Virtual Players.
+:::
+
+## Performance impact
+
+To reduce the demand on system resources caused by each Virtual Player instance, Multiplayer Play Mode shares specific resources, such as the artifact database and imports between the main Editor Player and each Virtual Player.

mppm_versioned_docs/version-1.4.0/dedicated-server/multiplayer-role.md

@@ -0,0 +1,27 @@
+---
+id: multiplayer-role
+title: Assign Virtual Players to a Multiplayer Role
+description: Learn how to use the dedicated server package to assign Virtual Players to a Multiplayer Role.
+---
+
+Install the [Dedicated Server package](https://docs.unity3d.com/Packages/[email protected]/manual/index.html) with Multiplayer Play Mode to switch Players between the server and client role without a script.
+
+::: Important
+To avoid errors, install the Dedicated Server package version that is the same as the Multiplayer Play mode version that exists in your project.
+:::
+
+## Set the main Editor Player Multiplayer Role
+
+To set the role of a the main Editor Player, do the following:
+
+1. Open the Multiplayer Play Mode inspector (**Multiplayer** > **Multiplayer Play Mode**).
+2. In the **main Editor Player** section, expand the **Multiplayer Role** dropdown.
+3. Select the [Multiplayer Role](https://docs.unity3d.com/Packages/[email protected]/manual/multiplayer-roles.html) you want the main Editor Player to use.
+
+## Set the Multiplayer Role of a Virtual Player
+
+To set the role of a [Virtual Player](../../virtual-players), do the following:
+
+ 1. Open the Multiplayer Play Mode inspector (**Multiplayer** > **Multiplayer Play Mode**).
+ 2. In the **Virtual Players** section, expand a Virtual Player's **Multiplayer Role** dropdown.
+ 3. Select the [Multiplayer Role](https://docs.unity3d.com/Packages/[email protected]/manual/multiplayer-roles.html) you want this Player to use.