com.unity.services.samples.game-lobby/README.md

Lobby Rooms

com.unity.services.samples.lobby-rooms

A Unity Project Sample showing how to integrate Rooms and Relay into a typical Lobby experience use case.

Features Covered:
- Lobby Creation
- Lobby Query
- Lobby Data Sync
  - Emotes
  - Player Names
  - Player Ready Check State  
- Lobby Join
- Relay Server Creation
- Relay Code Generation
- Relay Server Join

Service Setup

** Create an organization.

Follow the attached guide to set up your cloud organization:

Organization Tutorial

In the project, navigate to Edit => Project Settings => Services

Select your organization from the drop-down, and push Create Project ID.

In the end your Service window should look like this!

Lobby:

We use the lobby service to create a space that our users can join and share data through.

Lobby Overview

Relay:

We use the Relay service to obfuscate the Hosts' IP, while still allowing them to locally host strangers.

Relay Overview

Navigate to https://dashboard.unity3d.com/landing

Select Relay from the drop-down list

Select your project

In the bottom left, select "Get Started"

Follow the steps until you hit "Relay On" (For this project, you can skip downloading the Transport)

Solo Testing

Create a new Unity Build of the project in the OS of your choice. Because the Authentication service creates a unique ID for builds, you will need to host a lobby in Build and join in Editor or vice versa.

1. Start the game, and hit start to enter the Room List. This Queries the rooms service for available Lobbies, there wont be any right now.

2. The Create Menu Lets you make a new Lobby.

3. This is the Lobby, It has a Room code for you to share with your friends to allow them to join. For demonstration purposes we also show the Relay Code, which will be passed to all users in the Lobby.

4. Open the second game instance in Editor or in Build, you should now see your Lobby in the list.

5. The Lobby holds up to 4 players and will pass the Relay code once all the players are ready.

6. The countdown will start after the rooms data synch has completed. (It is a little slow due to our refresh rate being low at the moment)

7. The relay service IP gets passed to all users in the lobby, and this is where you would connect to a server, if you had one.