152 lines
2.9 KiB
Markdown
152 lines
2.9 KiB
Markdown
# Item Schema
|
|
|
|
## World Item (server-authoritative)
|
|
|
|
```json
|
|
{
|
|
"id": "string",
|
|
"type": "radio_station | dice | wheel | clock",
|
|
"title": "string",
|
|
"x": 0,
|
|
"y": 0,
|
|
"createdBy": "user-id",
|
|
"createdAt": 1735689600000,
|
|
"updatedAt": 1735689600000,
|
|
"version": 1,
|
|
"capabilities": ["editable", "carryable", "deletable", "usable"],
|
|
"emitSound": "sounds/roll.ogg",
|
|
"params": {},
|
|
"carrierId": null
|
|
}
|
|
```
|
|
|
|
- `emitSound`: optional client-played sound path when item `use` succeeds; global item field and not user-editable in V1.
|
|
- `capabilities` and `emitSound` are derived from global item-type definitions at runtime (not stored per-instance in persisted state).
|
|
- `useCooldownMs`: global per item type (`radio_station=1000`, `dice=1000`, `wheel=4000`, `clock=1000`), not per-instance editable.
|
|
|
|
## Persisted Item State (`server/runtime/items.json`)
|
|
|
|
```json
|
|
{
|
|
"id": "string",
|
|
"type": "radio_station | dice | wheel | clock",
|
|
"title": "string",
|
|
"x": 0,
|
|
"y": 0,
|
|
"createdBy": "user-id",
|
|
"createdAt": 1735689600000,
|
|
"updatedAt": 1735689600000,
|
|
"version": 1,
|
|
"params": {},
|
|
"carrierId": null
|
|
}
|
|
```
|
|
|
|
- Persisted state stores only instance data.
|
|
- Global/type-level properties are loaded from server registry in `server/app/item_catalog.py`.
|
|
|
|
## Type Params
|
|
|
|
### `radio_station`
|
|
|
|
```json
|
|
{
|
|
"streamUrl": "",
|
|
"enabled": true,
|
|
"channel": "stereo",
|
|
"volume": 50,
|
|
"effect": "off",
|
|
"effectValue": 50
|
|
}
|
|
```
|
|
|
|
- `streamUrl`: string, empty allowed until configured.
|
|
- `enabled`: boolean on/off flag.
|
|
- UI behavior: in property menu, `Enter` toggles on/off directly.
|
|
- `volume`: integer, range `0-100`, default `50`.
|
|
- `channel`: one of `stereo | mono | left | right`, default `stereo`.
|
|
- `effect`: one of `reverb | echo | flanger | high_pass | low_pass | off`, default `off`.
|
|
- `effectValue`: number, range `0-100`, precision `0.1`.
|
|
|
|
### `dice`
|
|
|
|
```json
|
|
{
|
|
"sides": 6,
|
|
"number": 2
|
|
}
|
|
```
|
|
|
|
- `sides`: integer, range `1-100`.
|
|
- `number`: integer, range `1-100`.
|
|
|
|
### `wheel`
|
|
|
|
```json
|
|
{
|
|
"spaces": "yes, no"
|
|
}
|
|
```
|
|
|
|
- `spaces`: comma-delimited string of values.
|
|
- Server validation:
|
|
- must include at least 1 value
|
|
- max 100 values
|
|
- each value max 80 chars
|
|
|
|
### `clock`
|
|
|
|
```json
|
|
{
|
|
"timeZone": "America/Detroit",
|
|
"use24Hour": false
|
|
}
|
|
```
|
|
|
|
- `timeZone`: one of `America/Detroit | America/New_York | America/Indiana/Indianapolis | America/Kentucky/Louisville`.
|
|
- `use24Hour`: boolean (or `on/off` in updates), default `false`.
|
|
|
|
## Packet Shapes
|
|
|
|
- `item_upsert`:
|
|
|
|
```json
|
|
{
|
|
"type": "item_upsert",
|
|
"item": { "..." : "World Item" }
|
|
}
|
|
```
|
|
|
|
- `item_remove`:
|
|
|
|
```json
|
|
{
|
|
"type": "item_remove",
|
|
"itemId": "item-id"
|
|
}
|
|
```
|
|
|
|
- `item_action_result`:
|
|
|
|
```json
|
|
{
|
|
"type": "item_action_result",
|
|
"ok": true,
|
|
"action": "add | pickup | drop | delete | use | update",
|
|
"message": "human-readable status",
|
|
"itemId": "optional-item-id"
|
|
}
|
|
```
|
|
|
|
- `item_use_sound`:
|
|
|
|
```json
|
|
{
|
|
"type": "item_use_sound",
|
|
"itemId": "item-id",
|
|
"sound": "sounds/roll.ogg",
|
|
"x": 12,
|
|
"y": 8
|
|
}
|
|
```
|