Skip to content
STREAMSIX Documentation

Quick Start

Shows the minimum code required to connect BigScreen, actor, and client.

This sample use scripts from both BigScreen and Client. This is convinent to test end-to-end communication. In practice, BigScreen and Client will be running on different devices.

  • Open QuickStart.scene.
  • Start Play Mode.
  • User gameobject is active and obtains a guest user token.
  • Set BigScreen gameobject to active to create a new session.
  • Once the session is created, set Client gameobject to active to start a client connection.
  • The Client script get the join code directly from BigScreenManager. This is purely for convinence.
  • Clone more Client gameobject to simulate additional clients.

Entity

  • Set Entity gameobject to active to initialize EntityManager. However, this scene does not trigger any EntityManager features at this point.

Leaderboard

  • Set Leaderboard gameobject to active to initialize LeaderboardManager. LeaderboardExample has sample code for init and retrieving leaderboard config.

Push leaderboard score

BigScreen can push leaderboard score through the RMB. User does not have permission to modifying the leaderboard. By going through the RMB, it bypass this restriction and allow BigScreen user to update leaderboard scores.

  • Enable BigScreen gameobject so that it creates a session and connects to RMB
  • Enable UpdateLeaderboardScore gameobject, which update score for a mock player. BigScreen user id is also required as streamer leaderboard is also updated at the same time.