diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 77af4e23d..5f6d58245 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,7 +38,7 @@ If you would like to implement a new feature then consider what kind of change i ### Documentation -We accept changes and improvements to our documentation. Just submit a Pull Request with your proposed changes as described in the [Pull Request Submission Guidelines](#submit-pr). +We accept changes and improvements to our documentation through the [MLAPI Documentation repo](https://github.com/Unity-Technologies/com.unity.multiplayer.docs). ## Contributor License Agreements diff --git a/Packages/com.unity.multiplayer.samples.coop/CHANGELOG.md b/Packages/com.unity.multiplayer.samples.coop/CHANGELOG.md index 24fde3b47..e97877e69 100644 --- a/Packages/com.unity.multiplayer.samples.coop/CHANGELOG.md +++ b/Packages/com.unity.multiplayer.samples.coop/CHANGELOG.md @@ -1,9 +1,35 @@ -# Changelog -All notable changes to this project template will be documented in this file. - -The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) -and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). +# Multiplayer Samples Co-op Changelog ## [0.1.0] - 2021-04-07 -### This is the early access release of *Boss Room: Small scale co-op sample*. +v0.1.0 is an Early Access release for Multiplayer Samples Co-op. + +It requires and supports Unity v2020.3 and later and Unity MLAPI v0.1.0. For additional information on MLAPI, see the changelog and release notes for the Unity MLAPI package. + +### New features + +Boss Room is a small-scale cooperative game sample project built on top of the new experimental netcode library. The release provides example code, assets, and integrations to explore the concepts and patterns behind a multiplayer game flow. It supports up to 8 players for testing multiplayer functionality. + +* See the README for installation instructions, available in the downloaded [release](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/releases/latest) and [GitHub](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop). +* Learn with Unity using the Boss Room source code, project files, and assets which include: 1 populated dungeon level, 4 character classes with 2 genders, combatant imps and boss, and a simple collaborative puzzle. +* Test co-op games by running multiple instances of the game locally or connecting to a friend over the internet. + +### Known issues + +* Sometimes when the host leaves the Boss Room, not all clients will return to the Main Menu, but will remain stuck in the Boss Room scene. +* Sometimes after completing a match and the host starts a new match from the Victory or Loss screen, connected players may have no visible interactions to join or select characters. +* A player may encounter a rare exception when the Tank character uses her Shield Aura ability. This issue may be due to intercepting the Boss charge attack. +* If two players in the Character Select **Ready** for the same hero at the same time, the UI will update to *Readied* on both clients, but only one will have actually selected the hero on the Host. This issue blocks Character Select from proceeding. +* Any player that plays the game and then returns to the Main Menu may be unable to Start or Join properly again, requiring you to restart the client. +* Green quads may show on impact when the Archer arrow strikes enemies. This issue may only occur in the editor. +* You may encounter a game error due to a Unity MLAPI exception. Not all MLAPI exceptions are fully exposed few informing users. +* The Photon Transport currently generates some errors in the Player log related to the `PhotonCryptoPlugin`. +* The welcome player message in the lobby indicates P2 (player 2) regardless of your generated name. Currently the Character Select scene displays “Player1” and “P1” in two locations, where it is intended that the user’s name be displayed. +* The spawner portal does not work in this release. +* Players may not reliably play another match when selecting **Return to Main Menu** during the post-game scene. This may be due to states not properly clearing. +* Some actions may feel unresponsive and require action anticipation animations. +* In some degraded network conditions, a replicated entity on a client can vanish from that client, creating the effect of being assailed by an invisible enemy. +* Boss collisions with a Pillar may not correctly apply a stun effect and shatter the pillar when using the Trample attack. +* The displayed graphical affects for casting and blocking a Bolt do not correctly match the caster and target. +* Some areas of the Boss Room require updates to geometry seams and collisions, for short walls and lava pits. + diff --git a/Packages/com.unity.multiplayer.samples.coop/Third Party Notices.md b/Packages/com.unity.multiplayer.samples.coop/Third Party Notices.md new file mode 100644 index 000000000..e99fdae65 --- /dev/null +++ b/Packages/com.unity.multiplayer.samples.coop/Third Party Notices.md @@ -0,0 +1,37 @@ +This package contains third-party software components governed by the license(s) indicated below: +--------- + +## Package: + +--------- + +Component Name: UnityToonShader + +License Type: Unlicense + +https://github.com/IronWarrior/UnityToonShader + +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or +distribute this software, either in source code form or as a compiled +binary, for any purpose, commercial or non-commercial, and by any +means. + +In jurisdictions that recognize copyright laws, the author or authors +of this software dedicate any and all copyright interest in the +software to the public domain. We make this dedication for the benefit +of the public at large and to the detriment of our heirs and +successors. We intend this dedication to be an overt act of +relinquishment in perpetuity of all present and future rights to this +software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR +OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. + +For more information, please refer to \ No newline at end of file