Skip to main content

Getting Started with Boss Room

Banner

important

This project is currently in early-access.

Boss Room is a fully functional Multiplayer Co-op Sample game made with Unity and MLAPI. We are building the sample to serve as an educational showcase of specific typical gameplay patterns frequently featured in similar games.

The intention is that you can use everything in this project as a starting point or as bits and pieces in your own Unity games.

Get the project files#

  • A release version can be downloaded from the Latest Releases at GitHub.
  • Unzip the archive file.
    Windows users

    Using Windows' built-in extracting tool may generate an "Error 0x80010135: Path too long" error window which can invalidate the extraction process. As a workaround, shorten the zip file to a single character (for example c.zip) and move it to the shortest path on your computer (such as in root C:) and retry. If that solution fails, another workaround is to extract the downloaded zip file using an application like 7zip.

  • You are now ready to add the project to Unity Hub.
Compatibility
  • Boss Room supports those platforms supported by MLAPI (Windows, MacOS, Ubuntu 20.4 LTS, Ubuntu 18.04 LTS and CentOS 7).
  • Boss Room is compatible with Unity 2020.3 and later.
  • Make sure to include standalone support for Windows/Mac/Linux in your installation.

Add the project with Unity Hub#

  1. Open Unity Hub.
  2. Click Add.
  3. Select the root folder of the downloaded project.
note

The first time you open the project, Unity will import all assets, which will take longer than usual - this is normal. The Unity MLAPI v0.1.0 package will also be installed with Boss Room.

Issues with importing due to parental control software: If you have issues with importing you may want to check your DNS settings as some ISP parental controls may block GitHub access. For example, see this information on WebSafe.

Open the project#

To open the project for the first time:

  1. In Unity Hub, double-click the project.
  2. Navigate to the Project window.
  3. Open the Assets folder.
  4. Open the Scene folder.
  5. Click the Startup scene.
  6. Click Play.

Test multiplayer#

In order to see the multiplayer functionality in action, you can either run multiple instances of the game locally on your computer or choose to connect through the internet.

Local multiplayer setup#

Build an Executable#

  1. Click File.
  2. Click Build Settings.
  3. Click Build.
  4. Name the binary Boss Room.

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#

tip

In contrast to running a local setup, when playing over internet we do not necessarily need a built executable. You can run the game in editor.

Running the game over internet currently requires either setting up a Photon Transport for MLAPI or using Port Forwarding.

Photon Transport#

Photon Transport for MLAPI uses Photon relay server to facilitate communication between clients and server living on different networks.

Learn More

See the Boss Room Photon Setup Guide for details.

Port Forwarding#

The Portforward 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.

Troubleshooting#

Errors finding Git installation

If you receive an OS or Unity error trying to locate Git after updating or installing Git, you need to fully restart your computer. Restarting only Unity may not fully update system information to correctly locate the install.

Windows Error 0x80010135: Path too long

Using Windows' built-in extracting tool may generate an "Error 0x80010135: Path too long" error window which can invalidate the extraction process. As a workaround, shorten the zip file to a single character (for example c.zip) and move it to the shortest path on your computer (such as in root C:) and retry. If that solution fails, another workaround is to extract the downloaded zip file using an application like 7zip.

Run builds on Mac OSX gives "unidentified developer"

If you attempt to run a build on OSX and receive a warning dialog mentioning an "unidentified developer", you may need to override your security settings for this application:

  1. In the Finder on your Mac, locate the application you want to open.

    note

    Do not use Launchpad, it does not allow you to access the shortcut menu.

  2. Control-click the app icon, then choose Open from the shortcut menu.

  3. Click Open.

  4. The app is saved as an exception to your security settings. You can open it in the future by double-clicking it just as you can any registered app.

See Apple Support for details.