Starting a Session & Testing

Once your game is submitted and uploaded to our servers, you can test your game with the Crowd Control extension.

To connect to Crowd Control, your game needs to be running and the Crowd Control Manager needs to be initialized. Calling the CrowdControlBehavior.Connect() function on the manager object will attempt to connect to Crowd Control and start a session. You can also enable the "Auto Connect" option in the manager's inspector to automatically connect when the manager is initialized.

When a user attempts to connect to to Crowd Control, they will be first presented with the following confirmation dialog:

Upon confirmation, the user will be asked to login to either Twitch, YouTube, Discord, or TikTok:

The remainder of this documentation will use Twitch login as an example.

Click on the Twitch button, make sure you are logged in and you give Twitch the appropriate permissions if asked.

If your login and permissions are successful, the Crowd Control session will begin!

After successfully connecting for the first time, users will not need to login for 90 days. To log out, the Crowd Control Manager object exposes a CrowdControlBehavior.Disconnect() method that you can call to end the session and disconnect from the server. Keep in mind that, upon disconnection, the session token will be stored and the user will not be reprompted to login until the token expires after 90 days or you clear your token. To clear a login token, the Crowd Control Manager object exposes a CrowdControlBehavior.ClearToken() method that can also be accessed via the inspector for the manager object.

Now that we began our session, click on the "Online Effect Menu" button, which will take you to your game session's effect menu.

If everything is correct, you should see your game and the effects you created.

Click on the effect and click "Order". If an error is thrown or nothing happens, please refer back to the previous section and ensure all steps were completed. If you still need help, please reach out on our Discord.

Congratulations! Your now Crowd Control integration is now complete. You can now stream your game on Twitch and connect to Crowd Control, allowing your audience to run all your effects.

While your game is in-testing, you can also send us usernames of creators you'd like to invite to stream the game and we'll add them to your game pack's whitelist.