Files
sor/Client/context-files/scenes/settings.scene.md
T

75 lines
1.7 KiB
Markdown

# Settings Scene
## Status
Active draft.
## UI Blocks
- Support panel:
- `Contact Support` action
- Audio panel:
- master volume
- background music volume
- sound effects volume
- mute toggles (optional)
- Display panel:
- brightness control
- Additional settings panel (extensible):
- placeholder for future options (controls, accessibility, language, notifications, etc.)
## Client Interactions
- Load current user settings on scene open.
- Apply slider/toggle changes immediately in preview when safe.
- Persist confirmed changes to server.
- Offer reset-to-default for configurable categories.
- Open support flow when `Contact Support` is selected.
## Server Contract (Draft)
### Client -> Server (`SettingsGetRequest`)
- `requestId`
- `accountId`
### Server -> Client (`SettingsGetResponse`)
- `requestId`
- `audio`:
- `masterVolume`
- `musicVolume`
- `sfxVolume`
- `masterMute` (optional)
- `musicMute` (optional)
- `sfxMute` (optional)
- `display`:
- `brightness`
- `support`:
- `contactMethods`
- `helpUrl` (optional)
- `otherSettings` (extensible object)
### Client -> Server (`SettingsUpdateRequest`)
- `requestId`
- `audio` (optional)
- `display` (optional)
- `otherSettings` (optional)
### Server -> Client (`SettingsUpdateResponse`)
- `requestId`
- `success`
- `effectiveSettings`
- `errorCode` (if failed)
### Client -> Server (`SupportContactRequest`)
- `requestId`
- `category` (optional)
- `message` (optional)
### Server -> Client (`SupportContactResponse`)
- `requestId`
- `success`
- `ticketId` (optional)
- `redirectUrl` (optional)
- `errorCode` (if failed)
## Notes
- Keep Settings and Report Bug entry points globally available in all scenes.
- Keep this scene modular so additional settings can be added without redesign.