# echosixhiya/webspeak-client-for-teamspeak architecture

> Architecture diagram of the GitHub repository echosixhiya/webspeak-client-for-teamspeak, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/echosixhiya/webspeak-client-for-teamspeak
- Repository: https://github.com/echosixhiya/webspeak-client-for-teamspeak

## Overview

WebSpeak is a self-hosted browser client and voice gateway for TeamSpeak 3/6. A user configures a target and access policy in the admin console, opens the web client, and joins through the gateway; browser controls cover voice, channels, chat, members, and screen sharing. The backend manages sessions and TeamSpeak protocol connections, with persistence and optional UDP acceleration. The graph also preserves documented administration and skin capabilities. Internal links use SOURCE INDEX references or excerpts; links based only on README-level product behavior cite the README, and unsampled implementation details are not inferred.

Main entry points: [`web/src/views/WebClient.vue`](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/views/WebClient.vue) (Web client UI), [`src/server/server.ts`](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/server/server.ts) (HTTP gateway), [`web/src/composables/useVoiceWebSocket.ts`](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/composables/useVoiceWebSocket.ts) (Voice WebSocket), [`src/admin/admin-router.ts`](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/admin/admin-router.ts) (Admin routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_web["Browser client"]
  node_webclient["Web client UI<br/>[WebClient.vue]"]
  node_connection["Connection controls"]
  node_channels["Channels"]
  node_chat["Chat"]
  node_members["Member controls"]
  node_audio["Audio controls"]
  node_screenshareui["Screen share UI"]
  node_websocket["Voice WebSocket"]
end

subgraph group_gateway["Gateway runtime"]
  node_server["HTTP gateway<br/>[server.ts]"]
  node_voicebridge["Voice sessions<br/>[voice-bridge.ts]"]
  node_tsclient["TeamSpeak client<br/>[ts-client.ts]"]
  node_accel["UDP acceleration"]
  node_screenshare["Screen sharing<br/>[screen-share.ts]"]
end

subgraph group_admin["Administration"]
  node_adminui["Admin console<br/>[AdminView.vue]"]
  node_adminrouter["Admin routes<br/>[admin-router.ts]"]
  node_adminservice["Admin settings<br/>[admin-service.ts]"]
  node_target["Target validation"]
end

subgraph group_state["State and presentation"]
  node_browserstore[("Browser persistence")]
  node_database[("Application database<br/>[database.ts]")]
  node_skins["Skin registry<br/>[skin-registry.ts]"]
  node_skinbrowser["Skin runtime<br/>[skin-runtime.ts]"]
  node_i18n["Client translations<br/>[web-client.ts]"]
end

node_user(("Browser user"))
node_tsservice["TeamSpeak server"]

node_user -->|"opens"| node_webclient
node_webclient -->|"uses"| node_connection
node_webclient -->|"uses"| node_channels
node_webclient -->|"uses"| node_chat
node_webclient -->|"uses"| node_members
node_webclient -->|"uses"| node_audio
node_webclient -->|"uses"| node_screenshareui
node_webclient -->|"uses"| node_i18n
node_connection -->|"uses"| node_chat
node_connection -->|"uses"| node_channels
node_channels -->|"uses"| node_websocket
node_chat -->|"uses"| node_websocket
node_members -->|"uses"| node_websocket
node_screenshareui -->|"uses"| node_websocket
node_websocket -->|"reads and writes"| node_browserstore
node_webclient -->|"connects to"| node_server
node_server -->|"routes voice"| node_voicebridge
node_voicebridge -->|"manages sessions"| node_tsclient
node_tsclient -->|"connects to"| node_tsservice
node_tsclient -->|"creates relay client"| node_accel
node_voicebridge -->|"handles sharing"| node_screenshare
node_user -->|"configures gateway"| node_adminui
node_adminui -->|"submits settings"| node_adminrouter
node_server -->|"mounts routes"| node_adminrouter
node_adminrouter -->|"calls"| node_adminservice
node_adminservice -->|"reads and writes"| node_database
node_adminservice -->|"parses targets"| node_target
node_server -->|"reads visitor counts"| node_database
node_server -->|"serves skin registry"| node_skins
node_adminrouter -->|"uses"| node_skins
node_webclient -.->|"supports skins"| node_skinbrowser

click node_webclient "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/views/WebClient.vue"
click node_connection "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/composables/useWebClientConnection.ts"
click node_channels "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/composables/useWebClientChannels.ts"
click node_chat "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/composables/useWebClientChat.ts"
click node_members "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/composables/useWebClientMembers.ts"
click node_audio "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/composables/useWebClientAudioControls.ts"
click node_screenshareui "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/composables/useWebClientScreenShare.ts"
click node_websocket "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/composables/useVoiceWebSocket.ts"
click node_browserstore "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/services/local-persistence.ts"
click node_server "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/server/server.ts"
click node_voicebridge "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/server/voice-bridge.ts"
click node_tsclient "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/server/ts-client.ts"
click node_accel "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/server/acceleration-relay.ts"
click node_screenshare "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/server/screen-share.ts"
click node_adminui "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/views/AdminView.vue"
click node_adminrouter "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/admin/admin-router.ts"
click node_adminservice "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/admin/admin-service.ts"
click node_target "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/domain/teamspeak-target.ts"
click node_database "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/persistence/database.ts"
click node_skins "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/admin/skin-registry.ts"
click node_skinbrowser "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/services/skin-runtime.ts"
click node_i18n "https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/i18n/web-client.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_webclient,node_connection,node_channels,node_chat,node_members,node_audio,node_screenshareui,node_websocket,node_user toneBlue
class node_server,node_voicebridge,node_tsclient,node_accel,node_screenshare toneAmber
class node_adminui,node_adminrouter,node_adminservice,node_target,node_tsservice toneMint
class node_browserstore,node_database,node_skins,node_skinbrowser,node_i18n toneRose
```

## Components

### Browser client

- [Web client UI](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/views/WebClient.vue): `web/src/views/WebClient.vue`
- [Connection controls](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/composables/useWebClientConnection.ts): `web/src/composables/useWebClientConnection.ts`
- [Channels](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/composables/useWebClientChannels.ts): `web/src/composables/useWebClientChannels.ts`
- [Chat](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/composables/useWebClientChat.ts): `web/src/composables/useWebClientChat.ts`
- [Member controls](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/composables/useWebClientMembers.ts): `web/src/composables/useWebClientMembers.ts`
- [Audio controls](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/composables/useWebClientAudioControls.ts): `web/src/composables/useWebClientAudioControls.ts`
- [Screen share UI](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/composables/useWebClientScreenShare.ts): `web/src/composables/useWebClientScreenShare.ts`
- [Voice WebSocket](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/composables/useVoiceWebSocket.ts): `web/src/composables/useVoiceWebSocket.ts`

### Gateway runtime

- [HTTP gateway](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/server/server.ts): `src/server/server.ts`
- [Voice sessions](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/server/voice-bridge.ts): `src/server/voice-bridge.ts`
- [TeamSpeak client](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/server/ts-client.ts): `src/server/ts-client.ts`
- [UDP acceleration](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/server/acceleration-relay.ts): `src/server/acceleration-relay.ts`
- [Screen sharing](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/server/screen-share.ts): `src/server/screen-share.ts`

### Administration

- [Admin console](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/views/AdminView.vue): `web/src/views/AdminView.vue`
- [Admin routes](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/admin/admin-router.ts): `src/admin/admin-router.ts`
- [Admin settings](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/admin/admin-service.ts): `src/admin/admin-service.ts`
- [Target validation](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/domain/teamspeak-target.ts): `src/domain/teamspeak-target.ts`

### State and presentation

- [Browser persistence](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/services/local-persistence.ts): `web/src/services/local-persistence.ts`
- [Application database](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/persistence/database.ts): `src/persistence/database.ts`
- [Skin registry](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/src/admin/skin-registry.ts): `src/admin/skin-registry.ts`
- [Skin runtime](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/services/skin-runtime.ts): `web/src/services/skin-runtime.ts`
- [Client translations](https://github.com/echosixhiya/webspeak-client-for-teamspeak/blob/master/web/src/i18n/web-client.ts): `web/src/i18n/web-client.ts`

### Other components

- **Browser user**
- **TeamSpeak server**

## Connections

- Browser user → Web client UI: opens
- Web client UI → Connection controls: uses (evidence: `web/src/views/WebClient.vue`)
- Web client UI → Channels: uses (evidence: `web/src/views/WebClient.vue`)
- Web client UI → Chat: uses (evidence: `web/src/views/WebClient.vue`)
- Web client UI → Member controls: uses (evidence: `web/src/views/WebClient.vue`)
- Web client UI → Audio controls: uses (evidence: `web/src/views/WebClient.vue`)
- Web client UI → Screen share UI: uses (evidence: `web/src/views/WebClient.vue`)
- Web client UI → Client translations: uses (evidence: `web/src/views/WebClient.vue`)
- Connection controls → Chat: uses (evidence: `web/src/composables/useWebClientConnection.ts`)
- Connection controls → Channels: uses (evidence: `web/src/composables/useWebClientConnection.ts`)
- Channels → Voice WebSocket: uses (evidence: `web/src/composables/useWebClientChannels.ts`)
- Chat → Voice WebSocket: uses (evidence: `web/src/composables/useWebClientChat.ts`)
- Member controls → Voice WebSocket: uses (evidence: `web/src/composables/useWebClientMembers.ts`)
- Screen share UI → Voice WebSocket: uses (evidence: `web/src/composables/useWebClientScreenShare.ts`)
- Voice WebSocket → Browser persistence: reads and writes (evidence: `web/src/composables/useVoiceWebSocket.ts`)
- Web client UI → HTTP gateway: connects to
- HTTP gateway → Voice sessions: routes voice (evidence: `src/server/server.ts`)
- Voice sessions → TeamSpeak client: manages sessions (evidence: `src/server/voice-bridge.ts`)
- TeamSpeak client → TeamSpeak server: connects to
- TeamSpeak client → UDP acceleration: creates relay client (evidence: `src/server/ts-client.ts`)
- Voice sessions → Screen sharing: handles sharing (evidence: `src/server/voice-bridge.ts`)
- Browser user → Admin console: configures gateway
- Admin console → Admin routes: submits settings
- HTTP gateway → Admin routes: mounts routes (evidence: `src/server/server.ts`)
- Admin routes → Admin settings: calls (evidence: `src/admin/admin-router.ts`)
- Admin settings → Application database: reads and writes (evidence: `src/admin/admin-service.ts`)
- Admin settings → Target validation: parses targets (evidence: `src/admin/admin-service.ts`)
- HTTP gateway → Application database: reads visitor counts (evidence: `src/index.ts`)
- HTTP gateway → Skin registry: serves skin registry (evidence: `src/index.ts`)
- Admin routes → Skin registry: uses (evidence: `src/admin/admin-router.ts`)
- Web client UI → Skin runtime: supports skins (evidence: `web/src/views/WebClient.vue`)
