mirror of https://github.com/Shik3i/KoalaSync.git synced 2026-07-26 12:08:15 +00:00

Files

T

KoalaDev 9963da2ebc feat(host-control-mode): explicit server capabilities for feature detection

Replace the implicit "hostPeerId present ⇒ feature supported" heuristic with an
explicit capabilities list the relay advertises in ROOM_DATA. Cleaner, self-
documenting, and the extensible hook for the planned co-host feature (owner
promotes guests to extra controllers) — a future 'co-host' capability + events
slot in without a protocol bump.

- shared: CAPABILITIES { HOST_CONTROL }.
- server: SERVER_CAPABILITIES advertised in ROOM_DATA.
- background: track serverCapabilities (empty against older relay), serverSupports(),
  thread hostControlSupported through GET_STATUS / GET_CONTROL_MODE / CONTROL_MODE.
- popup: gate the host-control card on the explicit capability instead of hostPeerId.

Backwards-compatible both ways: old relay omits the field → feature stays hidden
(no errors); old client ignores the field. WS test asserts ROOM_DATA advertises
the capability. Adds docs/host-control-mode-TESTING.md (beta-server setup, wss
caveat, two-new-clients note, verification checklist).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

2026-06-27 04:48:45 +02:00

blacklist.js

docs: audit and update script references, supported languages, and completed milestones

2026-06-19 11:35:49 +02:00

constants.js

feat(host-control-mode): explicit server capabilities for feature detection

2026-06-27 04:48:45 +02:00

names.js

docs: audit and update script references, supported languages, and completed milestones

2026-06-19 11:35:49 +02:00

README.md

docs: audit and update script references, supported languages, and completed milestones

2026-06-19 11:35:49 +02:00

README.md

KoalaSync Shared Constants

This directory contains constants and protocol definitions used by both the extension and the server.

Syncing with the Extension

Important

Every time this directory is modified, you must run node scripts/build-extension.cjs to keep the extension's copy up to date.

Because Browser Extensions (Manifest V3) cannot load files outside their root directory, all files in this directory must be copied to extension/shared/ whenever they are modified. The build script handles this automatically.

Security & Versioning Constants

OFFICIAL_SERVER_TOKEN: A 32-byte hex token required to connect to the official relay server.
APP_VERSION: The current version of the extension. Automatically injected from the git tag during CI release builds.
OFFICIAL_SERVER_URL: The default endpoint for the official KoalaSync relay.

Protocol Events

For the complete and current event list, see the EVENTS object in constants.js. Key events include:

Event	Direction	Purpose
`JOIN_ROOM`	Client → Server	Request to join a room with credentials
`LEAVE_ROOM`	Client → Server	Leave the current room
`ROOM_DATA`	Server → Client	Current room state (peers list)
`PLAY` / `PAUSE` / `SEEK`	Bidirectional relay	Media control commands
`PEER_STATUS`	Bidirectional relay	Heartbeat or join/leave notification
`FORCE_SYNC_PREPARE`	Bidirectional relay	Phase 1: Pause & seek to target time
`FORCE_SYNC_ACK`	Bidirectional relay	Phase 1 confirmation: peer is buffered
`FORCE_SYNC_EXECUTE`	Bidirectional relay	Phase 2: Resume playback simultaneously
`EVENT_ACK`	Server → Client	Delivery confirmation for UI feedback
`EPISODE_LOBBY`	Bidirectional relay	Episode transition: waiting for all peers
`EPISODE_READY`	Bidirectional relay	Episode confirmation: peer has loaded
`GET_ROOMS` / `ROOM_LIST`	Client ↔ Server	Room discovery
`ERROR`	Server → Client	Error message