Configure native session sync
Last updated on October 24, 2024
Overview
AccelByte Gaming Services (AGS) Session allows you to configure sessions to sync with first-party platforms such as Steam, Xbox, and PlayStation. This article covers how to do that.
Prerequisites
- Access to the AGS Admin Portal
- A game namespace
- A familiarity with configuring AGS sessions
Configure session sync for Steam
- Log in to the AGS Admin portal and choose your game namespace.
- On the sidebar menu, go to Game Setup > 3rd Party Configuration > Auth & Account Linking.
- On the Login Methods page, click on the + Add New button. The Login Platform Configuration page appears.
- From the available login platforms, click on Steam Web. The Create Configuration form appears.
- Fill in the Steam Web API key.
- Fill in the Redirect URI.
- Click Create.
Configure session sync for Xbox
- Log in to the AGS Admin portal and choose your game namespace.
- On the sidebar menu, go to Game Setup > 3rd Party Configuration > Auth & Account Linking.
- On the Login Methods page, click on the + Add New button. The Login Platform Configuration page appears.
- From the available login platforms, click on XBox Web. The Create Configuration form appears.
- Fill in the Client ID and Client Secret (obtained from your app on your Xbox developer dashboard).
- Fill in the Redirect URI.
- Click Create.
- In the AGS Admin Portal, go to 3rd Party Store Integrations.
- Select the Xbox tab and click Add configuration.
- Upload the business partner certificate (BPC) and then click Create.
- Create a new Xbox session template via
https://partner.microsoft.com/en-US/xboxconfig/sessiontemplates/index?
. - Create a new session template in the Admin Portal and enable session sync.
- Fill in the Xbox Template Name and Config ID at the end of the session template creation process.
note
You can adjust readyRemovalTimeout
(how long until "ready" members are reverted to inactive) and sessionEmptyTimeout
(how long until a session is deleted after it becomes empty) as desired. See the Microsoft documentation for multiplayer sessions for more information.
Configure session sync for PlayStation
- Log in to the AGS Admin portal and choose your game namespace.
- On the sidebar menu, go to Game Setup > 3rd Party Configuration > Auth & Account Linking.
- On the Login Methods page, click on the + Add New button. The Login Platform Configuration page appears.
- From the available login platforms, click on PSN 5 SDK. The Create Configuration form appears.
- Fill the Client ID and Client Secret from the PSN product page, and select the environment that you want to use.
- Fill in the Redirect URI.
- Click Create.
- Go to the 3rd Party Store Integrations page. On the Admin Portal sidebar, go to Game Setup > 3rd Party Configuration > Multiplayer Session.
- On the Multiplayer Session page, click on the Create new button and fill in the Client ID, Client Secret, and Scope as follows:
- ClientID: Auth Server (Client Credential) ClientID
- Client Secret: Auth Server (Client Credential) Secret
- Scope:
psn:s2s.service
(For syncing non-PSN members to PSN sessions)
- Create a new session template and enable session sync.
- Fill in the Session title, PSN Base URL, Supported Platform, and Service Label.
- Click Add.