Version: 1.0.0.0 Updated: 2023-11-29 16:56:05
Summary
Documentation for the Game Config schema
Game Config Schema
| Name | Type | Required | Description |
|---|
| last_modified_account_id | string | No | Account ID of the user who last modified the resource |
| last_modified_timestamp | string | No | Timestamp of when the resource was last modified |
| created_timestamp | string | No | Timestamp of when the resource was created |
| social | object | No | See schema |
| basic | object | No | See schema |
| anon | object | No | See schema |
| epic | object | No | See schema |
| steam | object | No | See schema |
| playstation | object | No | See schema |
| nintendo | object | No | See schema |
| twitch | object | No | See schema |
| amazon | object | No | See schema |
| google | object | No | See schema |
| apple | object | No | See schema |
| xbox | object | No | See schema |
| vivox | object | No | See schema |
| legacy | object | No | See schema |
| default_role_id | string | No | Default role ID for players without a role |
| inventory_session_loot | array | No | List of loot IDs to grant to players when they start a new inventory session |
| allow_client_to_update_inventory | boolean | No | Whether or not to allow the client source to update inventory |
| email_reward_loot | array | No | List of loot IDs to grant to players when they have an email |
| coupon_enable | boolean | No | Are coupons allowed to be used for purchasing Loot? |
| coupon_vendor_id | string | No | Vendor ID that lists all enabled coupons |
| legacy_id_generation | object | No | See schema |
| enable_legacy_setting_types | boolean | No | Whether or not to enable legacy setting types |
Social Schema
| Name | Type | Required | Description |
|---|
| friend_limit | integer | No | Maximum allowed friends per player |
| block_limit | integer | No | Maximum allowed outgoing blocks per player |
Basic Schema
| Name | Type | Required | Description |
|---|
| enable_login | boolean | No | Whether or not to enable basic logins |
Anon Schema
| Name | Type | Required | Description |
|---|
| enable_login | boolean | No | Whether or not to enable anonymous login |
Epic Schema
| Name | Type | Required | Description |
|---|
| enable_login | boolean | No | Whether or not to enable Epic logins |
| client_id | string | Yes | Epic Online Services client ID. Client tokens are validated against this ID |
| product_id | string | Yes | Epic Online Services product ID. Client tokens are validated against this ID |
| sandbox_id | string | Yes | Epic Online Services sandbox ID. Client tokens are validated against this ID |
| scopes | array | No | Epic Online Services scopes to request |
Steam Schema
| Name | Type | Required | Description |
|---|
| enable_login | boolean | No | Whether or not to enable Steam |
| wallet_refunds_trigger_ban | boolean | No | Whether or not to ban players who refund their wallet purchases |
| enforce_vac_bans | boolean | No | Whether or not to enforce VAC bans |
| enforce_publisher_bans | boolean | No | Whether or not to enforce publisher bans |
| appid | integer | Yes | Steam app ID for the game |
Playstation Schema
| Name | Type | Required | Description |
|---|
| enable_login | boolean | No | Whether or not to enable Playstation logins |
| environment | object | No | See schema |
| ps4_use_entitlements_v1_api | boolean | No | Whether or not to use the old entitlements API for PS4 |
| ps5_use_entitlements_v1_api | boolean | No | Whether or not to use the old entitlements API for PS5 |
| ps4_use_auth_v1_api | boolean | No | Whether or not to use the old auth API for PS4 |
| ps5_use_auth_v1_api | boolean | No | Whether or not to use the old auth API for PS5 |
| psn_web_client_id | string | Yes | Playstation web client ID. Client tokens are validated against this ID |
| ps4_client_id | string | Yes | Playstation PS4 client ID. Client tokens are validated against this ID |
| ps5_client_id | string | Yes | Playstation PS5 client ID. Client tokens are validated against this ID |
| ps4_v1_portal_token_details_enable | boolean | No | Whether or not to enable the PS4 V1 portal token details |
| ps4_v3_portal_token_details_enable | boolean | No | Whether or not to enable the PS4 V3 portal token details |
| ps5_v3_portal_token_details_enable | boolean | No | Whether or not to enable the PS5 V3 portal token details |
| eu_service_labels | array | No | EU Service Labels |
| na_service_labels | array | No | NA Service Labels |
| | | |
Environment Enum Values
| Value | Description |
|---|
| sp-int | Sony Development environment. This is the common environment for development |
| prod-qa | Sony Internal Test environment. This is used when a game is handed to Sony Certification for testing |
| np | Sony Production environment. This is the environment that is used when a game goes live |
Nintendo Schema
| Name | Type | Required | Description |
|---|
| environments | object | Yes | See schema |
| active_envs | array | No | List of active/enabled nintendo environments for this sandbox |
| app_id | string | Yes | Nintendo app ID. Client tokens are validated against this ID |
Environments Schema
Dd1 Schema
| Name | Type | Required | Description |
|---|
| enable_login | boolean | No | Whether or not to enable Nintendo logins |
| client_id | string | Yes | Nintendo client ID. Client tokens are validated against this ID |
| auth_key | string | Yes | Nintendo auth key |
Twitch Schema
| Name | Type | Required | Description |
|---|
| enable_login | boolean | No | Whether or not to enable Twitch logins |
| client_id | string | Yes | Twitch client ID. Client tokens are validated against this ID |
| game_id | string | Yes | Twitch game ID. |
Amazon Schema
| Name | Type | Required | Description |
|---|
| enable_login | boolean | No | Whether or not to enable Amazon logins |
| client_id | string | Yes | Epic Online Services client ID. Client tokens are validated against this ID |
| scopes | array | No | Amazon OAuth scopes to request |
Google Schema
| Name | Type | Required | Description |
|---|
| enable_login | boolean | No | Whether or not to enable Google logins |
| client_id | string | Yes | Google client ID. Client tokens are validated against this ID |
Apple Schema
| Name | Type | Required | Description |
|---|
| enable_login | boolean | No | Whether or not to enable Apple logins |
| web_client_id | string | Yes | Apple web client ID. Client tokens are validated against this ID |
| web_auth_key_id | string | Yes | Apple web auth key ID. Client tokens are validated against this ID |
Xbox Schema
| Name | Type | Required | Description |
|---|
| enable_login | boolean | No | Whether or not to enable Xbox logins |
| web_client_id | string | Yes | Xbox Online Services client ID. Client tokens are validated against this ID |
Vivox Schema
| Name | Type | Required | Description |
|---|
| enable | boolean | No | Whether or not to enable Vivox logins |
| server | string | Yes | Vivox server URL (e.g. game_name.vivox.com) |
| key_issuer | string | Yes | Vivox key issuer |
| key_time | integer | No | Number of seconds that vivox tokens last before expiration |
Legacy Schema
| Name | Type | Required | Description |
|---|
| allowed_game_versions | string | No | version check used by connection managers for new client/instance connections |
| eac_enabled | boolean | No | Whether or not to enforce EAC checks for new client connections |
| eac_check_ban_status_at_login | boolean | No | Whether or not to check EAC ban status at login |
| eac_submit_player_reports | boolean | No | Whether or not to submit player reports to EAC when handling normal player reports |
| experiments | array | No | List of experiments and if they are enabled. Use K/Vs instead |
| game_bits | array | No | List of game bits to enable. Use K/Vs instead |
| max_party_size | integer | No | Maximum number of players allowed in a party |
| max_party_info_count | integer | No | Maximum number of party info entries allowed per party |
| default_map_game_id | integer | No | Default map game ID to return to when leaving a match |
| game_id | integer | No | Game ID to use for the game |
| inventory_custom_data_item_legacy_type_field | string | No | Field name of the property in custom data that maps legacy item type to the fields in Inventory APIs. |
| inventory_custom_data_item_legacy_subtype_field | string | No | Field name of the property in custom data that maps legacy item subtype to the fields in Inventory APIs |
| inventory_custom_data_vendor_legacy_type_field | string | No | Field name of the property in custom data that maps legacy vendortype to the fields in Inventory APIs. |
Legacy_id_generation Schema
Vendor Enum Values
| Value | Description |
|---|
| uuid4 | Use uuid4 to generate IDs |
| sequential | Use sequential uuids (RallyHere internal implementation) to generate IDs |
| uuid5 | Use uuid5 uuids to generate IDs |
