Skip to content

Briancoughlin patch 2 #256

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Apr 6, 2021
Merged

Briancoughlin patch 2 #256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b324c9f
quick fix for missing TGA
SamuelBellomo Apr 6, 2021
a1fcf3f
Update README.md
Briancoughlin Apr 6, 2021
1ebb622
Update README.md
Briancoughlin Apr 6, 2021
0e8f9f8
Update README.md
Briancoughlin Apr 6, 2021
4db657e
Update README.md
Briancoughlin Apr 6, 2021
de40d38
Update README.md
Briancoughlin Apr 6, 2021
724ae8a
Update README.md
Briancoughlin Apr 6, 2021
cac93bb
Update README.md
Briancoughlin Apr 6, 2021
3d42892
Update README.md
Briancoughlin Apr 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@
*.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

# Unity
*.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
*.anim filter=lfs diff=lfs merge=lfs -text
19 changes: 12 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ 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).
> - Boss Room is compatible with Unity 2020.3 and later.
> - Make sure to include standalone support for Windows/Mac in your installation.


```
Platforms : Windows, Mac
Expand Down Expand Up @@ -45,20 +50,20 @@ 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`

---------------
**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.

Expand All @@ -67,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 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.
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.

Expand Down