Duskt/tbsp

Websocket data format

Open

#15 opened on Sep 22, 2025

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (0 forks)auto 404
documentationenhancementhelp wantedsystem

Repository metrics

Stars
 (5 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We need a consistent protocol for the format of messages across websockets so we can distinguish chat messages, mafia actions, other events etc. I believe this is sometimes referred to as a sub-protocol.

This would ideally include:

  • Protocol version for future backwards compatibility
  • Minification format for efficient transmission

Contributor guide

Research direction
Research existing WebSocket sub protocols (e.g., STOMP, WAMP). Propose a lightweight JSON based protocol with a version prefix and message type field. Consider minification techniques like message type codes or key reduction.
Tech stack
typescriptnodejs
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
WebSocket basicsJSON
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60