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

Files

T

KoalaDev 3e7afd7592 feat: add server ping display with peer ping foundation

Adds application-level ping/pong between extension and relay server.
Extension sends PING every 15s, server echoes PONG. Round-trip time
displayed in Status tab (green/yellow/red color-coded).

Server also forwards PING with target peerId and routes PONG back,
enabling future peer-to-peer ping without server restart.
Extension already responds to incoming peer PINGs.

See CHANGELOG.md for details.

2026-06-09 07:08:14 +02:00

blacklist.js

fix: use orteil.dashnet.org instead of cookieclicker.com in blacklist

2026-06-02 08:04:31 +02:00

constants.js

feat: add server ping display with peer ping foundation

2026-06-09 07:08:14 +02:00

names.js

Smart disconnect + human-readable room IDs + expanded word lists

2026-06-01 13:29:02 +02:00

README.md

docs: comprehensive repository polish + step-by-step user guide

2026-05-04 05:41:43 +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.js 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