Skip to content

Commit 5d8cf6d

Browse files
Update readme (#256)
1 parent b324c9f commit 5d8cf6d

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ Boss Room is a fully functional co-op multiplayer RPG made with Unity MLAPI. It
99

1010
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.
1111

12+
> __IMPORTANT__:
13+
> - Boss Room supports those platforms supported by MLAPI (Windows and Mac).
14+
> - Boss Room is compatible with Unity 2020.3 and later.
15+
> - Make sure to include standalone support for Windows/Mac in your installation.
16+
1217

1318
```
1419
Platforms : Windows, Mac
@@ -45,20 +50,20 @@ In order to see the multiplayer functionality in action we can either run multip
4550
---------------
4651
**Local multiplayer setup**
4752

48-
First we would need a built executable.
53+
First we need to build an executable.
4954

50-
To make a build in the menu bar press _File/Build Settings_ and then press **Build**.
55+
To build an executable press _File/Build Settings_ in the menu bar, and then press **Build**.
5156
![](Documentation/Images/BuildProject.png)
5257

53-
After the build has completed you can launch several instances of the built executable to be able to both host and join a game.
58+
Once the build has completed you can launch several instances of the built executable in order to both host and join a game.
5459

5560
> Mac users: to run multiple instances of the same app, you need to use the command line.
5661
> Run `open -n BossRoom.app`
5762
5863
---------------
5964
**Multiplayer over internet**
6065

61-
In order to play over internet, we need to have a built executable that is shared between all players. See the previous section.
66+
To play over internet, we need to build an executable that is shared between all players. See the previous section.
6267

6368
It is possible to connect between multiple instances of the same executable OR between executables and the editor that produced said executable.
6469

@@ -67,14 +72,14 @@ Running the game over internet currently requires setting up a [Photon Transport
6772
> Checkout our Photon-Realtime setup guide, here:
6873
> [Boss Room Photon Setup Guide](Documentation/Photon-Realtime/Readme.md)
6974
70-
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.
75+
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.
7176

7277
------------------------------------------
7378

7479
## Exploring the project
75-
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.
80+
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.
7681

77-
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.
82+
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.
7883

7984
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.
8085

0 commit comments

Comments
 (0)