Update readme
This commit is contained in:
83
README.md
83
README.md
@ -433,6 +433,53 @@ Message: `product_purchase_start`
|
||||
|
||||
Data:
|
||||
```json
|
||||
{
|
||||
"player": {
|
||||
"id": "test-player-pero",
|
||||
"name": "Pero",
|
||||
"active": true,
|
||||
"position": {
|
||||
"x": 10,
|
||||
"y": 10
|
||||
},
|
||||
"move_count": 1,
|
||||
"move_attempt_count": 1,
|
||||
"state": "ON_DESTINATION"
|
||||
},
|
||||
"products": [
|
||||
{
|
||||
"name": "CocaCola",
|
||||
"id": "cocacola-id",
|
||||
"description": null
|
||||
},
|
||||
{
|
||||
"name": "Pepsi",
|
||||
"id": "pepsi-id",
|
||||
"description": null
|
||||
},
|
||||
{
|
||||
"name": "Fanta",
|
||||
"id": "fanta-id",
|
||||
"description": null
|
||||
},
|
||||
{
|
||||
"name": "Snickers",
|
||||
"id": "snickers-id",
|
||||
"description": null
|
||||
},
|
||||
{
|
||||
"name": "Mars",
|
||||
"id": "mars-id",
|
||||
"description": null
|
||||
},
|
||||
{
|
||||
"name": "Burek",
|
||||
"id": "burek-id",
|
||||
"description": null
|
||||
}
|
||||
],
|
||||
"timeout": 5
|
||||
}
|
||||
```
|
||||
|
||||
### Product purchase timer tick
|
||||
@ -441,6 +488,21 @@ Message: `product_purchase_timer_tick`
|
||||
|
||||
Data:
|
||||
```json
|
||||
{
|
||||
"time_left": 4,
|
||||
"player": {
|
||||
"id": "test-player-pero",
|
||||
"name": "Pero",
|
||||
"active": true,
|
||||
"position": {
|
||||
"x": 10,
|
||||
"y": 10
|
||||
},
|
||||
"move_count": 1,
|
||||
"move_attempt_count": 1,
|
||||
"state": "ON_DESTINATION"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Product purchase timer done
|
||||
@ -449,4 +511,25 @@ Message: `product_purchase_done`
|
||||
|
||||
Data:
|
||||
```json
|
||||
{
|
||||
"player": {
|
||||
"id": "test-player-pero",
|
||||
"name": "Pero",
|
||||
"active": true,
|
||||
"position": {
|
||||
"x": 10,
|
||||
"y": 10
|
||||
},
|
||||
"move_count": 1,
|
||||
"move_attempt_count": 1,
|
||||
"state": "ON_DESTINATION"
|
||||
},
|
||||
"product": {
|
||||
"name": "CocaCola",
|
||||
"id": "cocacola-id",
|
||||
"description": null
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
If product selection timeout occured, product will be null.
|
||||
|
||||
Submodule fairhopper-sdk updated: 10290dba54...edca936325
@ -45,5 +45,5 @@ class Settings:
|
||||
ws_server: WSServerSettings
|
||||
purchase_timeout: int = 10 # seconds
|
||||
log_level: int = logging.INFO
|
||||
products: Optional[List[Product]] = None
|
||||
products: List[Product] = None
|
||||
debug: Optional[DebugSettings] = None
|
||||
|
||||
Reference in New Issue
Block a user