Feature/template cleanup (#177)

Author: fernando-cortez

Packages/com.unity.multiplayer.samples.coop/CHANGELOG.md

@@ -4,8 +4,6 @@ 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).
 
-## [0.1.0] - 2020-10-09
+## [0.1.0-experimental] - 2021-04-07
 
-### This is the first release of *Unity Package com.unity.template.mytemplate*.
-
-*Short description of this release*
+### This is the experimental release of *Boss Room: Small scale coop sample*.

Packages/com.unity.multiplayer.samples.coop/Documentation~/Boss Room.md

@@ -0,0 +1,5 @@
+**_Boss Room documentation_**
+
+This sample project is an educational template that, alongside tutorials, teaches a specific approach to creating and networking in Unity. Boss Room has tools to help you learn how to build and network a small-scale cooperative game.
+
+For further, more in-depth documentation, please refer to this project's README.md.

Packages/com.unity.multiplayer.samples.coop/Documentation~/images/example.png

@@ -1,5 +1,5 @@
-com.unity.multiplayer.samples.coop copyright © 2020 Unity Technologies ApS
+Boss Room: Small scale coop sample © 2021 Unity Technologies
 
-Licensed under the Unity Companion License for Unity-dependent projects--see [Unity Companion License](http://www.unity3d.com/legal/licenses/Unity_Companion_License). 
+Licensed under the Unity Companion License for Unity-dependent projects (see https://unity3d.com/legal/licenses/unity_companion_license); otherwise licensed under the Unity Package Distribution License (see https://unity3d.com/legal/licenses/Unity_Package_Distribution_License).
 
-Unless expressly provided otherwise, the Software under this license is made available strictly on an “AS IS” BASIS WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. Please review the license for details on these and other terms and conditions.
+Unless expressly provided otherwise, the Software under this license is made available strictly on an “AS IS” BASIS WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. Please review the license for details on these and other terms and conditions.

Packages/com.unity.multiplayer.samples.coop/Documentation~/images/gitlab_ci_secret_variables.png

@@ -1,39 +1,86 @@
-# TODOs (trimmed down version of tasks listed at: https://github.cds.internal.unity3d.com/unity/com.unity.template-starter-kit)
+![Banner](Documentation/Images/Banner.png)
+# BossRoom - co-op multiplayer RPG built with Unity MLAPI
 
-##### Fill in your project template's package information
+>**IMPORTANT**: This project is currently experimental.
 
-	Update the following required fields in `Packages/com.unity.template.mytemplate/package.json`:
-	- `name`: Project template's package name, it should follow this naming convention: `com.unity.template.[your-template-name]`
-    (Example: `com.unity.template.3d`)
-	- `displayName`: Package user friendly display name. (Example: `"First person shooter"`). <br>__Note:__ Use a display name that will help users understand what your project template is intended for.
-	- `version`: Package version `X.Y.Z`, your project **must** adhere to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
-	- `unity`: Minimum Unity Version your project template is compatible with. (Example: `2018.3`)
-	- `description`: This is the description for your template which will be displayed to the user to let them know what this template is for. This description shouldn't include anything version-specific and should stay pretty consistent across template versions.
-	- `dependencies`: Specify the dependencies the template requires. If you add a package to your project, you should also add it here. We try to keep this list as lean as possible to avoid conflicts as much as possible.
+BossRoom is a fully functional co-op multiplayer RPG made in Unity and MLAPI. It is built to serve as an educational sample that showcases certain typical gameplay patterns that are frequently featured in similar games.
 
-##### Update **README.md**
+Our intention is that you can use everything in this project as a starting point or as bits and pieces in your own Unity games. The project is licensed under the Unity Companion License. See [LICENSE](LICENSE) for more legal information.
 
-    The README.md file should contain all pertinent information for template developers, such as:
-	* Prerequisites
-	* External tools or development libraries
-	* Required installed Software
 
-The Readme file at the root of the project should be the same as the one found in the template package folder. 
+```
+Platforms : Windows, Mac
+```
 
-##### Prepare your documentation
+## Getting the project
+ - A release version can be downloaded from the [Releases](https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop/releases) page. 
+ - Alternatively: click the green `Code` button and then choose to download the zip archive. Remember, that you would download the branch that you are currently viewing in Github.
 
-    Rename and update **Packages/com.unity.template.mytemplate/Documentation~/your-package-name.md** documentation file.
 
-    Use this documentation template to create preliminary, high-level documentation for the _development_ of your template's package. This document is meant to introduce other developers to the features and sample files included in your project template.
+## Opening the project for the first time
 
-    Your template's documentation will be made available online and in the editor during publishing to guide our users.
+Once you have downloaded the project the steps below should get you up and running:
+ - Make sure you have installed the version of Unity that is listed above in the prerequisites section.
+ 	- Make sure to include standalone support for Windows/Mac in your installation. 
+ - Add the project in _Unity Hub_ by clicking on **Add** button and pointing it to the root folder of the downloaded project.
+ 	- The first time you open the project Unity will import all assets, which will take longer than usual - it is normal.
+ - Once the editor is ready, navigate to the _Project_ window and open the _Project/Startup_ scene.
+![](Documentation/Images/StartupScene.png)
+ - From there you can click the **Play** button. You can host a new game or join an existing game using the in-game UI.
 
-##### Update the changelog   
 
-    **Packages/com.unity.template.mytemplate/CHANGELOG.md**.
+## Testing multiplayer
 
-	Every new feature or bug fix should have a trace in this file. For more details on the chosen changelog format, see [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
+In order to see the multiplayer functionality in action we can either run multiple instances of the game locally on our computer or choose to connect to a friend over the internet.
 
-	Changelogs will be made available online to inform users about the changes they can expect when downloading a project template. As a consequence, the changelog content should be customer friendly and present clear, meaningful information.
+---------------
+**Local multiplayer setup**
 
-#### Complete the rest of the steps in the link regarding Legal & Testing
+First we would need a built executable.
+
+To make a build in the menu bar press _File/Build Settings_ and then press **Build**.
+![](Documentation/Images/BuildProject.png)
+
+After the build has completed you can launch several instances of the built executable to be able to both host and join a game.
+
+> Mac users: to run multiple instances of the same app, you need to use the command line.
+> Run `open -n BossRoom.app`
+
+---------------
+**Multiplayer over internet**
+
+In contrast to running a local setup, when playing over internet we don't neccessarily need a built executable. We can just run the game in editor. 
+
+Running the game over internet currently requires setting up a [Photon Transport for MLAPI](https://github.com/Unity-Technologies/mlapi-community-contributions), which uses Photon relay server to facilitate communication between clients and server living on different networks.  
+
+Alternatively you can use Port Forwarding. The wonderful https://portforward.com/ site has guides on how to enable port forwarding on a huge number of routers. BossRoom uses `UDP` and needs a `9998` external port to be open. 
+
+------------------------------------------
+
+## Exploring the project
+BossRoom is an 8-player co-op RPG game experience, where players collaborate to take down some minions, and then a boss. Players can select between classes that each have skills with didactically interesting networking characteristics. Control model is click-to-move, with skills triggered by mouse button or hotkey. 
+
+One of the 8 clients acts as the host/server. That client will use a compositional approach so that its entities have both server and client components.
+
+The game is server-authoritative, with latency-masking animations. Position updates are done through NetworkedVars that sync position, rotation and movement speed. NetworkedVars and Remote Procedure Calls (RPC) endpoints are isolated in a class that is shared between the server and client specialized logic components. All game logic runs in FixedUpdate at 30 Hz, matching our network update rate. 
+
+Code is organized into three separate assemblies: **Client**, **Shared** and **Server** which reference each other when appropriate.
+
+For an in-depth overview of the project's architecture please check out our [ARCHITECTURE.md](ARCHITECTURE.md).
+
+
+## Contributing
+
+> __IMPORTANT__: 
+> This project uses Git Large Files Support (LFS). See the [link with Git LFS installation options](https://git-lfs.github.com/).
+
+The project uses the `git-flow` branching strategy, as such:
+ - `develop` branch contains all active development
+ - `master` branch contains release versions
+
+To get the project on your machine you need to clone the repository from GitHub using the following command-line command:
+```
+git clone https://github.com/Unity-Technologies/com.unity.multiplayer.samples.coop.git
+```
+
+Please check out [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on submitting issues and PRs to BossRoom!