LI PASS Web Configuration
| Initialization Parameters | Type | Description | Remarks |
|---|---|---|---|
| env | string | SDK environment, test means test environmentFor more information, see Get Deployment Cluster Info | Required |
| gameID | number | Game ID | Required |
| appID | string | App ID, the ACCOUNT_APP_ID assigned by the Player Network Console | Required |
| WebID | string | Web ID, the Web ID assigned by the Player Network Console | Optional |
| config | object | Advanced Configuration | Optional |
config
note
If you have already created the LI PASS Web configuration in the Player Network Console, you only need to select the configuration in the console and do not need to manually configure most parameters in config.Configuration distributed by the Player Network Console takes precedence over config.
The following configurations are not supported in the Player Network Console:
- langType - Not supported for configuration. You may pass it during initialization as needed.
- crossGameLink - No configuration needed, automatically provided
| Parameter | Type | Description | Note |
|---|---|---|---|
| isMobile | boolean | Whether to display the mobile interface | Optional Default: false (shows PC interface) If you want to determine the device environment and dynamically set isMobile, configure Web Layout as Custom Configuration in the Player Network Console |
| socialList | string[] | Supported third-party login channels list e.g. facebook, twitter, google, apple, line, steam, epic, ps5, discord, vk, twitch, qq, wechat | Optional Default: [] |
| socialParams | object | Additional configuration for third-party login channels | Required for Apple and Kakao v3 channels Default: {} |
| renderMode | string | Display mode inline: Normal mode modal: Modal mode | Optional Default: inline |
| loginWithCode | object | Verification code login configuration | Optional Default: { enable: true, registerType: 'manual'} |
| loginWithPwd | object | Password login configuration | Optional Default: { enable: true, registerType: 'manual'} |
| procedureSwitch | object | Procedure switches | Optional Default: { region: false, adultStatus: false, agreement: false, registerPassword: 'onDemand'} |
| serviceIntro | boolean | Whether to enable LI PASS service introduction entry | Optional Default: false |
| langType | string | Default language. See Language List | Optional Default: en Cannot be configured in Player Network Console |
| crossGameLink | boolean | Whether to enable cross-game account linking | Optional Default: false No configuration needed, automatically delivered |
socialParams
| Parameter | Type | Description | Remarks |
|---|---|---|---|
| appleAppId | string | Apple channel Web app ID | Apple channel required |
| platform | number | Specify the Garena login method 1: Garena 3: Facebook 8: Google 10: Apple 11: Twitter | Garena channel optional |
| kakaov3AppId | string | Kakao app ID | Kakao v3 channel required |
| kakaov3JsKey | string | Kakao Javascript key | Kakao v3 channel required |
loginWithCode
| Parameter | Type | Description | Remarks | Default |
|---|---|---|---|---|
| enable | boolean | Enable verification code login | Optional | true |
| registerType | string | Registration typemanual: Only allow users to register manuallyauto: Unregistered users can automatically register through verification code logindisabled: Disable registration, only allow existing users to log in | Optional | manual |
loginWithPwd
| Parameter | Type | Description | Remarks | Default |
|---|---|---|---|---|
| enable | boolean | Enable password login | Optional | true |
| registerType | string | Registration typemanual: Only allow users to register manuallydisabled: Disable registration, only allow existing users to log in | Optional | manual |
procedureSwitch
| arameter | Type | Description | Remarks |
|---|---|---|---|
| region | boolean | Region switch, affects display of adultStatus and agreement false: Region is not required during registration; registration does not check user region info during login true: Region is required during registration; during login, the system will check if region info is filled, and will prompt for completion if not | Optional Default: false |
| adultStatus | boolean | Adult status switch, depends on the region setting; enabling only this has no effect false: No need to enter birthday or confirm adult clause during registration; login does not check user adult status info. true: According to the user's selected region, require entry of birthday or confirmation of adult clause during registration; login will check if adult status info is filled, and will prompt for completion if not.In regions where compliance certification is not required, related content will not be displayed. | Optional Default: false |
| agreement | boolean | Agreement clause switch, depends on the region setting Basic Agreement Clauses: Terms of Service [required], Privacy Policy [required], Marketing Email Subscription [optional] Regional Agreement Clauses: Data Transfer Notice [required] (EEA/Switzerland, except UK), Nighttime Marketing Email Subscription [optional] (Korea only) false: No agreement clauses displayed during registration; login does not check agreement clause selection. true, region=true: All agreement clauses are displayed during registration according to user's selected region; the system will check agreement clause selection during login.If required clauses are not selected, the system will prompt for completion; optional clauses may only be selected once per website. true, region=false: Only basic agreement clauses are displayed during registration; only basic agreement clause selection is checked during login.If required clauses are not selected, system will prompt for selection. | Optional Default: false |
| unrestrictedRegion | string[] | Removes restrictions for specified regions Array of three-digit region codes, e.g. ['356'] | Optional Default: [] Not supported for configuration in Player Network Console |
| registerPassword | string | Three states for password settings, affects loginWithPwd workflow When logging in with password, if the user has not set a password, a popup will guide the user to set a password or use verification code login. disabled: No password setting required during registration; registration flow skips password setup page. required: Password must be set during registration; user cannot skip. onDemand: User can choose to set password during registration as needed. | Optional Default: onDemand |