#
QuickStartReqData
| Parameter | Required | Type | Description |
|---|---|---|---|
| user_infos | Yes | Array of user_info | Array of user information user_infos has priority. If the array is empty, the codes field will be used. (Note: Do not place the robot in the first position) |
| room_id | Yes | string | Room ID |
| mode | No | int32 | Mode. Default: 1 |
| language | No | string | Language. Default: zh-CN |
| rule | No | object | Game configuration |
| report_game_info_extras | No | string | Transmitted parameters, maximum length of 1024 bytes. If it exceeds, it will be truncated. |
| report_game_info_key | No | string | Transmitted parameter key, maximum length of 64 bytes. The access party server can query the data of a game based on this field. |
| mode_ex | No | int32 | Sub-mode |
| captain_uid | No | string | Specify the captain's uid (only real players can be specified) |
- user_info structure description
| Parameter | Required | Type | Description |
|---|---|---|---|
| uid | Yes | string | User ID |
| nick_name | Yes | string | User nickname |
| avatar_url | Yes | string | User avatar URL (recommended size: 128*128) |
| gender | Yes | string | Gender (female or male or "") If the gender is unknown, please fill in an empty string. |
| is_ai | No | int32 | 0: ordinary user, 1: robot (default is 0) |
| ai_level | No | int32 | ai level 0: simple ai 1: simple ai 2: intermediate ai 3: advanced ai Default is 0 |
Game Configuration (rule)
| Game name | name | Configuration | Introduction |
|---|---|---|---|
| Bump Me the Strongest | bumper | {"userInfos": [{"uid": "uid1","mass": 1, "trail": 1,}]} | "mass": body size, default value 10, range 10 20 30 40 50, trail model 1 2 3 4 |
| Flying Chess | ludo | { "mode":0, "chessNum":2, "item":0, "isReroll":0 } | mode: default competition system, 0 fast, 1 classic, 2 is competitive;; chessNum: default number of chess pieces, 2 corresponds to 2 chess pieces, 4 corresponds to 4 chess pieces; item: default props, 1 yes, 0 no; isReroll: whether to reroll, 1 yes, 0 no |
| Taiwan Mahjong | twmahjong | {"roundTimeDefault":1,"bottomScoreDefault":1 ,"multiplesDefault":1} | |
| Numberbomb | numberbomb | { "keyNum":45, "range":[1,99], "save":0} | keyNum: the final answer number, range: the initial range, save: whether to save, 0 does not save, that is, each setting is only effective once, if there is no setting next time, it will be restored to the default, 1 is to save, that is, each setting will continue to take effect until the next change |
| Who is the undercover | whoisspy | {"mode": 0} | mode: game mode, 0 means classic mode, 1 means explosive word mode |
| Monopoly | {"defaultRounds": 0, "defaultAsset": 2, "trade": 1} | defaultRounds: round number option index, range is 0~2; defaultAsset: winning asset option index, range is 0~2; trade: whether to open trading 0 is not open, 1 is open | |
| Balot | baloot | {"mode": 0} | mode: game mode, 0 is classic mode, 1 is fast mode |
| matchpairs | matchpairs | {"board_id": 1} | board_id: board id (0~4), if no id is passed, a random map |
| Find Find Special Offensive Team | Spotthedifference | {"maxTurn":15,"turnTime":30,"modeSelected":{"Flip":true,"Classic":true,"Shuffle":true,"Spotlight":true}} | True means enable; Classic: classic mode, Flase indicates disable, true means enable; shuffle: disorder mode, Flase means disable, true means enable; spotlight: spotlight mode, True means prohibit, true indicates enlightenment. |
Sub-mode Configuration (mode_ex)
| Game Name | name | Configuration | Introduction |
|---|---|---|---|
| Carrom | Carrom | mode_ex:1 | mode_ex: 1, 2, 3 represent Carrom, Freestyle, 2v2 respectively (teams are divided by seat index: 0,1 one team, 2,3 another team) |
| Jackaroo | Jackaroo | mode_ex:1 | mode_ex: 1, 2 represent Base, Complex respectively (teams are divided by seat index: 0,1 one team, 2,3 another team) |
| Block Master | Block Master | mode_ex:1 | mode_ex: 1, 2, 3 represent 1v1、Battle Royale、Team (teams are indexed by seats: 0,1 for one team, 2,3 for another, and so on) |
| American 8-Ball | EightBall | mode_ex:1 | mode_ex: 1, 2 means 1v1, 2v2 respectively (teams are indexed by seats: 0,1 is one team, 2,3 is one team) |
Request Example
{
"event": "quick_start",
"mg_id": "mg_id_1",
"timestamp": 1657770493152,
"data": {
"user_infos": [{
"uid": "uid_1",
"nick_name": "nick_name_1",
"avatar_url": "avatar_url_1",
"gender": "male",
"is_ai": 0,
"ai_level": 0
},{
"uid": "uid_2",
"nick_name": "nick_name_2",
"avatar_url": "avatar_url_2",
"gender": "female",
"is_ai": 1,
"ai_level": 1
}],
"room_id":"roomId_1",
"mode": 1,
"mode_ex": 1,
"language": "zh-CN"，
"rule": {
"mode": 0,
"chessNum": 2,
"item": 0
},
"report_game_info_extras": "",
"report_game_info_key": ""
}
}