From b324c9f6ba34515a0139070d51b5d8b76e82f2d0 Mon Sep 17 00:00:00 2001 From: Samuel Bellomo Date: Tue, 6 Apr 2021 10:39:00 -0400 Subject: [PATCH 1/9] quick fix for missing TGA --- .gitattributes | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitattributes b/.gitattributes index a7c1fa5fa..02663bbf7 100644 --- a/.gitattributes +++ b/.gitattributes @@ -45,7 +45,7 @@ *.pict filter=lfs diff=lfs merge=lfs -text *.png filter=lfs diff=lfs merge=lfs -text *.psd filter=lfs diff=lfs merge=lfs -text -*.tga filter=lfs diff=lfs merge=lfs -text +*.[tT][gG][aA] filter=lfs diff=lfs merge=lfs -text *.tif filter=lfs diff=lfs merge=lfs -text *.tiff filter=lfs diff=lfs merge=lfs -text @@ -53,4 +53,4 @@ *.unity filter=lfs diff=lfs merge=lfs text *.prefab binary *.asset filter=lfs diff=lfs merge=lfs -text -*.anim filter=lfs diff=lfs merge=lfs -text \ No newline at end of file +*.anim filter=lfs diff=lfs merge=lfs -text From a1fcf3f42763a43e6801d37ea7708d88ea5924b8 Mon Sep 17 00:00:00 2001 From: Briancoughlin <76997526+Briancoughlin@users.noreply.github.com> Date: Tue, 6 Apr 2021 15:44:48 +0100 Subject: [PATCH 2/9] Update README.md --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3601e75bf..2d17f3b76 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,17 @@ | 🛑 IMPORTANT - Early Access 🛑 | | -- | -| Boss Room: Small Scale Co-op Sample is built on top of the MLAPI package. The MLAPI package is on the road to being a fully featured solution. We have solutions architects available on Discord and forums to help you work through issues you encounter. | +| Boss Room: Small Scale Co-op Sample is built on top of the MLAPI package. Boss Room is a fully functional co-op multiplayer RPG made with Unity MLAPI. It is built to serve as an educational sample that showcases certain typical gameplay patterns that are frequently featured in similar games. 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.md](LICENSE.md) for more legal information. +> __IMPORTANT__: +- Boss Room supports all major Unity platforms. To use the WebGL platform a custom WebGL transport based on web sockets is needed. +- Boss Room is compatible with Unity 2020.3.0f1. +- Make sure to include standalone support for Windows/Mac in your installation. + ``` Platforms : Windows, Mac From 1ebb6226a6062231bb38641404b3c1f70ca41218 Mon Sep 17 00:00:00 2001 From: Briancoughlin <76997526+Briancoughlin@users.noreply.github.com> Date: Tue, 6 Apr 2021 16:01:04 +0100 Subject: [PATCH 3/9] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2d17f3b76..3b662ba16 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,9 @@ Boss Room is a fully functional co-op multiplayer RPG made with Unity MLAPI. It 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.md](LICENSE.md) for more legal information. > __IMPORTANT__: -- Boss Room supports all major Unity platforms. To use the WebGL platform a custom WebGL transport based on web sockets is needed. -- Boss Room is compatible with Unity 2020.3.0f1. -- Make sure to include standalone support for Windows/Mac in your installation. +> - Boss Room supports all major Unity platforms. To use the WebGL platform a custom WebGL transport based on web sockets is needed. +> - Boss Room is compatible with Unity 2020.3.0f1. +> - Make sure to include standalone support for Windows/Mac in your installation. ``` @@ -50,12 +50,12 @@ In order to see the multiplayer functionality in action we can either run multip --------------- **Local multiplayer setup** -First we would need a built executable. +First we need to build an executable. -To make a build in the menu bar press _File/Build Settings_ and then press **Build**. +To build an executable press _File/Build Settings_ in the menu bar, 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. +Once the build has completed you can launch several instances of the built executable in order 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` @@ -63,7 +63,7 @@ After the build has completed you can launch several instances of the built exec --------------- **Multiplayer over internet** -In order to play over internet, we need to have a built executable that is shared between all players. See the previous section. +To play over internet, we need to build an executable that is shared between all players. See the previous section. It is possible to connect between multiple instances of the same executable OR between executables and the editor that produced said executable. @@ -72,14 +72,14 @@ Running the game over internet currently requires setting up a [Photon Transport > Checkout our Photon-Realtime setup guide, here: > [Boss Room Photon Setup Guide](Documentation/Photon-Realtime/Readme.md) -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. Boss Room uses `UDP` and needs a `9998` external port to be open. +Alternatively you can use Port Forwarding. The https://portforward.com/ site has guides on how to enable port forwarding on a huge number of routers. Boss Room uses `UDP` and needs an `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. +BossRoom is an eight-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. +One of the eight 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. From 0e8f9f8fc3938c1a983ed5316e3cd2e85e781df1 Mon Sep 17 00:00:00 2001 From: Briancoughlin <76997526+Briancoughlin@users.noreply.github.com> Date: Tue, 6 Apr 2021 16:16:20 +0100 Subject: [PATCH 4/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b662ba16..388ccdc69 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Our intention is that you can use everything in this project as a starting point > __IMPORTANT__: > - Boss Room supports all major Unity platforms. To use the WebGL platform a custom WebGL transport based on web sockets is needed. -> - Boss Room is compatible with Unity 2020.3.0f1. +> - Boss Room is compatible with Unity 2020 LTS onwards. > - Make sure to include standalone support for Windows/Mac in your installation. From 4db657e9886682a1ba0ad246393c0a21e8eb7409 Mon Sep 17 00:00:00 2001 From: Briancoughlin <76997526+Briancoughlin@users.noreply.github.com> Date: Tue, 6 Apr 2021 16:49:06 +0100 Subject: [PATCH 5/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 388ccdc69..9b831378f 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Our intention is that you can use everything in this project as a starting point > __IMPORTANT__: > - Boss Room supports all major Unity platforms. To use the WebGL platform a custom WebGL transport based on web sockets is needed. -> - Boss Room is compatible with Unity 2020 LTS onwards. +> - Boss Room is compatible with Unity 2020.3 onwards. > - Make sure to include standalone support for Windows/Mac in your installation. From de40d3857566f6a9736d577f561d16697dc23d38 Mon Sep 17 00:00:00 2001 From: Briancoughlin <76997526+Briancoughlin@users.noreply.github.com> Date: Tue, 6 Apr 2021 17:22:51 +0100 Subject: [PATCH 6/9] Update README.md Co-authored-by: Lori Krell <76010626+lkrell@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b831378f..cac19c6f5 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ Running the game over internet currently requires setting up a [Photon Transport > Checkout our Photon-Realtime setup guide, here: > [Boss Room Photon Setup Guide](Documentation/Photon-Realtime/Readme.md) -Alternatively you can use Port Forwarding. The https://portforward.com/ site has guides on how to enable port forwarding on a huge number of routers. Boss Room uses `UDP` and needs an `9998` external port to be open. +Alternatively you can use Port Forwarding. The https://portforward.com/ site has guides on how to enable port forwarding on a huge number of routers. Boss Room uses `UDP` and needs a `9998` external port to be open. ------------------------------------------ From 724ae8a40a4e9dfd0bbdb2239418eec92695fe2c Mon Sep 17 00:00:00 2001 From: Briancoughlin <76997526+Briancoughlin@users.noreply.github.com> Date: Tue, 6 Apr 2021 17:25:07 +0100 Subject: [PATCH 7/9] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cac19c6f5..717b3fb79 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,14 @@ | 🛑 IMPORTANT - Early Access 🛑 | | -- | -| Boss Room: Small Scale Co-op Sample is built on top of the MLAPI package. +| Boss Room: Small Scale Co-op Sample is built on top of the MLAPI package. The MLAPI package is on the road to being a fully featured solution. We have solutions architects available on Discord and forums to help you work through issues you encounter. | Boss Room is a fully functional co-op multiplayer RPG made with Unity MLAPI. It is built to serve as an educational sample that showcases certain typical gameplay patterns that are frequently featured in similar games. 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.md](LICENSE.md) for more legal information. > __IMPORTANT__: -> - Boss Room supports all major Unity platforms. To use the WebGL platform a custom WebGL transport based on web sockets is needed. +> - Boss Room supports those platforms supported by MLAPI (Windows and Mac). To use the WebGL platform a custom WebGL transport based on web sockets is needed. > - Boss Room is compatible with Unity 2020.3 onwards. > - Make sure to include standalone support for Windows/Mac in your installation. From cac93bb6f6092f326d8faaef3095c2889c3b750e Mon Sep 17 00:00:00 2001 From: Briancoughlin <76997526+Briancoughlin@users.noreply.github.com> Date: Tue, 6 Apr 2021 17:30:35 +0100 Subject: [PATCH 8/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 717b3fb79..e6db60503 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Our intention is that you can use everything in this project as a starting point > __IMPORTANT__: > - Boss Room supports those platforms supported by MLAPI (Windows and Mac). To use the WebGL platform a custom WebGL transport based on web sockets is needed. -> - Boss Room is compatible with Unity 2020.3 onwards. +> - Boss Room is compatible with Unity 2020.3 and later. > - Make sure to include standalone support for Windows/Mac in your installation. From 3d42892c65736007e96b66894cc7767f035f34d6 Mon Sep 17 00:00:00 2001 From: Briancoughlin <76997526+Briancoughlin@users.noreply.github.com> Date: Tue, 6 Apr 2021 17:38:53 +0100 Subject: [PATCH 9/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e6db60503..da848ead0 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Boss Room is a fully functional co-op multiplayer RPG made with Unity MLAPI. It 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.md](LICENSE.md) for more legal information. > __IMPORTANT__: -> - Boss Room supports those platforms supported by MLAPI (Windows and Mac). To use the WebGL platform a custom WebGL transport based on web sockets is needed. +> - Boss Room supports those platforms supported by MLAPI (Windows and Mac). > - Boss Room is compatible with Unity 2020.3 and later. > - Make sure to include standalone support for Windows/Mac in your installation.