happyleavesaoc / aoc-dashboard-client

2 stars 0 forks source link

dashboard-client

Web client component of AoC Spectator Dashboard.

Architecture

The client consumes a message stream from dashboard-server via the WebSocket protocol. Each message type is assigned a handler. The client indicates which message types it wishes to receive (subscription). Stream rate is variable. The client maintains 100ms and 1s interval loops independently of the message stream, for updating visual components.

Message Types

Type Frequency Buffered Description
start 1 yes
end 1 yes
time 1/sec yes
map 1 yes
positions 1-n yes n: number of players
title 1-v yes
heatmap 1/sec no
apm 1/sec yes
player_update 1/sec yes
research v yes
research_progress v yes
research_stop v yes
trade v yes
tribute v yes
chat v yes
alert v yes
resign 0-n yes n: number of players

Dependencies

Contribution