README.md

Maintenance notice: Dieses Projekt wurde in https://github.com/dasgefolge/gefolge.org integriert.

Dieses Projekt ist ein WebSocket server für die gefolge.org API.

Protokoll

Der server verwendet async-proto 0.9. Dementsprechend sind einzelne Pakete als binäre WebSocket-Nachrichten dargestellt.

Verbindungsaufbau

1. Der client sendet seinen API key als String.
2. Der client sendet ein byte, das den Zweck der Verbindung darstellt:
   • 0: Rasende Roboter (siehe https://github.com/dasgefolge/ricochet-robots)
   • 1: Aktuelles event

Aktuelles event

In diesem Modus sendet der server jedes mal ein Paket, wenn sich der für den client sichtbare Zustand des aktuellen event ändert. Der Event-Beamer verwendet diesen Modus. Ein Paket hat folgende Varianten (durch das erste byte dargestellt):

• 0: Ping
• 1: Fehler
• 2: Aktuell läuft kein event mehr*
• 3: Aktuell läuft ein event*, mit folgenden Daten:
  • event ID als String
  • Zeitzone des event als IANA timezone identifier (String)
• 4: Die aktuelle Version von sil hat sich geändert*
  • Gefolgt vom aktuellen git commit hash als 20 bytes langer array.

*Kann auch zu Beginn der Verbindung geschickt werden.