Overlays

Apollon provides embeddable overlays for OBS Browser Sources and streaming. All overlays live under /overlay/ and use a minimal layout without navigation.

Map Overlay

URL: /overlay/map

Live-Karte mit GPS-Tracking, AIS-Vessel-Tracking und optionalem Debug-Modus.

URL-Parameter

Karte

Parameter	Default	Beschreibung
tiles	openfreemap	Tile-Provider: carto, openfreemap, openfreemap3d, positron, liberty, fiord
theme	light	Farbschema: light, dark
zoom	16	Initiale Zoom-Stufe
autotime	false	Automatischer Tag/Nacht-Wechsel (Europe/Berlin, 20:00–06:00 = dark). true / 1 zum Aktivieren

Widgets

Parameter	Default	Beschreibung
speed	true	Speed-Badge am GPS-Marker. false / 0 zum Deaktivieren
speedbadgescale	1	Skalierung des Speed-Badges am Marker (z.B. 1.5, 2)
unit	kmh	Geschwindigkeitseinheit(en) für Badge + Widget, kommagetrennt: kmh, mph, mps, knots
interval	5	Wechselintervall in Sekunden zwischen Einheiten und AIS-Info-Badges (min. 2)
compass	true	Kompass im Widget-Bar (unten links). false / 0 zum Deaktivieren
speedwidget	false	Speed-Anzeige im Widget-Bar (neben Kompass). true / 1 zum Aktivieren
widgetscale	1	Skalierung der Widget-Bar. Gilt für Compass + Speed-Widget gemeinsam
widgeticons	false	Lucide-Icons vor Pegel- und Speed-Widget anzeigen. true / 1 zum Aktivieren
pegel	true	Pegelonline Wasserstand im Widget-Bar. false / 0 zum Deaktivieren
water	(leer)	Gewässer-Filter für Pegel (z.B. RHEIN)
pegelradius	(Server-Default)	Suchradius für Pegel in km

Heading Up

Parameter	Default	Beschreibung
headingup	false	Heading-Up-Modus: Karte rotiert mit Fahrtrichtung nach oben. true / 1 zum Aktivieren
headingoffset	30	Vertikaler Offset in Prozent (0–50). GPS-Punkt wird nach unten verschoben für mehr Sicht voraus

Im Stand friert die Rotation ein: Fällt die Geschwindigkeit unter ~0,5 km/h, hält die Karte die zuletzt bekannte Fahrtrichtung (verhindert nervöses Hin- und Herdrehen durch GPS-Heading-Jitter). Ab ~2 km/h folgt die Rotation wieder der aktuellen Heading (Hysterese-Band gegen Flackern am Grenzwert).

Zoom-Cycle

Parameter	Default	Beschreibung
zoomcycle	(aus)	Komma-separierte Zoom-Stufen (z.B. 14,16,18)
zoominterval	30	Sekunden zwischen Zoom-Wechseln

AIS Vessel Tracking

Parameter	Default	Beschreibung
ais	true	AIS-Schiffe anzeigen. false / 0 zum Deaktivieren
aisnames	true	Schiffsnamen-Badges. false / 0 zum Deaktivieren
aisinfo	true	Info-Badges (Speed, Länge, Breite, Typ — rotierend). false / 0 zum Deaktivieren
aisbadgekm	10	Maximale Entfernung (km) für Name/Info-Badges
aisbadgescale	1	Skalierung der AIS-Badges

Debug

Parameter	Default	Beschreibung
debug	false	Debug-Modus. true / 1 zum Aktivieren

Der Debug-Modus zeigt:

• Debug-Panel (unten rechts): GPS-Koordinaten, Heading, alle Speed-Einheiten, DOP-Werte, AIS-BBox
• BBox-Overlay: Blaues gestricheltes Rechteck — zeigt den aktiven AIS-Bereich
• Console-Logs: [AIS] bbox updated: bei jedem BBox-Relocate

Boolean-Parameter

Standardmäßig aktive Features (true): speed, compass, pegel, ais, aisnames, aisinfo, watchlist

• Deaktivieren: ?speed=false oder ?speed=0

Standardmäßig inaktive Features (false): speedwidget, widgeticons, autotime, headingup, debug

• Aktivieren: ?speedwidget=true oder ?speedwidget=1

Beispiele

# Basis
/overlay/map

# Dark Mode
/overlay/map?theme=dark

# Auto Tag/Nacht mit Zoom-Cycle
/overlay/map?autotime=true&zoomcycle=14,16,18&zoominterval=20

# AIS mit nahen Badges (5km) und Debug
/overlay/map?aisbadgekm=5&debug=true

# Minimale AIS-Anzeige (nur Dots, keine Badges)
/overlay/map?aisnames=false&aisinfo=false

# Kein Speed-Badge, 3D Tiles
/overlay/map?tiles=openfreemap3d&speed=false

# Kompass + Speed-Widget in Knoten
/overlay/map?speedwidget=true&unit=knots

# Multi-Unit Speed mit 3s Wechsel
/overlay/map?speedwidget=true&unit=kmh,knots,mph&interval=3

# Nur Speed-Widget (ohne Kompass), größer skaliert
/overlay/map?compass=false&speedwidget=true&widgetscale=1.5&unit=mph

# Heading Up (Fahrtrichtung oben, GPS-Punkt unten)
/overlay/map?headingup=true

# Heading Up mit mehr Offset und Knoten
/overlay/map?headingup=true&headingoffset=40&unit=knots

# Kompass + Pegel + Speed-Widget
/overlay/map?speedwidget=true

# Pegel nur für Rhein
/overlay/map?water=RHEIN

# Ohne Pegel
/overlay/map?pegel=false

Speed Overlay

URL: /overlay/speed

Zeigt die aktuelle Geschwindigkeit als animiertes Display mit Spring-Animation. Verbindet sich via WebSocket (Channel: speed). Unterstützt mehrere Einheiten mit automatischem Fade-Cycling.

URL-Parameter

Parameter	Default	Beschreibung
unit	kmh	Geschwindigkeitseinheit(en), kommagetrennt: kmh, mph, mps, knots
interval	5	Wechselintervall in Sekunden zwischen Einheiten (min. 2)
float	false	Floating-Modus: keine Border links, rundum gerundet, mit Abstand vom Rand

Beispiele

/overlay/speed
/overlay/speed?unit=knots
/overlay/speed?unit=kmh,knots,mph
/overlay/speed?unit=kmh,knots&interval=3
/overlay/speed?float=true

Compass Overlay

URL: /overlay/compass

Standalone-Kompass mit 16-Punkt-Himmelsrichtungen und animierter Nadel. Verbindet sich via WebSocket (Channel: gps).

URL-Parameter

Parameter	Default	Beschreibung
scale	1	Skalierung (z.B. 1.5, 2)
float	false	Floating-Modus: keine Border links, rundum gerundet, mit Abstand vom Rand

Beispiele

/overlay/compass
/overlay/compass?scale=2
/overlay/compass?float=true

Data Overlay

URL: /overlay/data

Kombiniert Compass und Speed-Widget in einer kompakten Leiste — identisch zum Widget-Bar im Map-Overlay, aber als Standalone ohne Karte. Verbindet sich via WebSocket (Channels: gps, speed).

URL-Parameter

Parameter	Default	Beschreibung
compass	true	Kompass anzeigen (false/0 zum Ausblenden)
speed	true	Geschwindigkeit anzeigen (false/0 zum Ausblenden)
pegel	true	Wasserstand anzeigen (false/0 zum Ausblenden)
water	(leer)	Gewässer-Filter (z.B. RHEIN)
pegelradius	(Server-Default)	Suchradius in km
unit	kmh	Geschwindigkeitseinheit(en), kommagetrennt: kmh, mph, mps, knots
interval	5	Wechselintervall in Sekunden zwischen Einheiten (min. 2)
scale	1	Skalierung (z.B. 1.5, 2)
widgeticons	false	Lucide-Icons vor Pegel- und Speed-Widget. true / 1 zum Aktivieren
float	false	Floating-Modus: keine Border links, rundum gerundet, mit Abstand vom Rand

Beispiele

/overlay/data
/overlay/data?unit=kmh,knots
/overlay/data?compass=false&unit=mph
/overlay/data?scale=1.5&unit=kmh,knots,mph&interval=3
/overlay/data?float=true

Pegel Overlay

URL: /overlay/pegel

Zeigt den aktuellen Wasserstand der nächsten Pegelonline-Station (WSV). Zeigt den Stationsnamen (z.B. "OTTENHEIM") unter dem Pegelwert an. Die GPS-Position kommt vom Server (Peplink). Pollt alle 5 Minuten, bei 404 Retry nach 10 Sekunden.

URL-Parameter

Parameter	Default	Beschreibung
water	(leer)	Gewässer-Filter (z.B. RHEIN)
pegelradius	(Server-Default)	Suchradius in km (nur im Radius-Modus, bei Whitelist ignoriert)
scale	1	Skalierung (z.B. 1.5, 2)
float	false	Floating-Modus: keine Border links, rundum gerundet

Trendfarben

Zustand	Farbe
low (≤ MNW)	Blau
normal (MNW–MHW)	Grün (Accent)
high (≥ MHW)	Rot
unknown / out-dated	Grau

Beispiele

/overlay/pegel
/overlay/pegel?water=RHEIN
/overlay/pegel?scale=1.5&float=true
/overlay/pegel?water=ELBE&pegelradius=10

Watchlist Overlay

URL: /overlay/watchlist

Standalone GTA-artiges 5-Sterne-Alert-System für AIS-Watchlist-Treffer. Zeigt den Alert mit den meisten Sternen oben rechts an. Spielt Sound bei Ersterkennung und bei Stufe ≥4. Verbindet sich via WebSocket (Channel: watchlist).

Das Display erscheint nur wenn ein Watchlist-Vessel in Reichweite ist. Transparenter Hintergrund — ideal für OBS.

URL-Parameter

Parameter	Default	Beschreibung
scale	1	Skalierung (z.B. 1.5, 2)

Integration im Map Overlay

Parameter	Default	Beschreibung
watchlist	true	Watchlist-Alerts + Sterne-Display. false / 0 zum Deaktivieren
watchlistscale	1	Skalierung des Watchlist-Sterne-Displays (z.B. 1.5, 2)

Watchlist-Vessels werden auf der Karte in ihrer starColor hervorgehoben (statt Standard-Amber).

Sterne-System

Sterne	Bedeutung
★	Vessel innerhalb äußerster Reichweite (Default: 10 km)
★★	Default: 7 km
★★★	Default: 5 km
★★★★	Default: 2 km — Danger-Sound wird getriggert
★★★★★	Default: 1 km

Reichweiten, Sounds und Farben sind konfigurierbar unter /feature/watchlist/settings.

Beispiele

/overlay/watchlist
/overlay/watchlist?scale=2

/overlay/map?watchlist=true
/overlay/map?watchlist=false
/overlay/map?watchlistscale=1.5

OBS Browser Source Einrichtung

Alle Overlays sind für OBS Browser Sources optimiert:

1. Quelle hinzufügen → Browser
2. URL: http://your-server:port/overlay/speed (oder /map, /compass, /data)
3. Breite/Höhe: Nach Bedarf (Speed: 200×100, Map: 1920×1080, Compass: 150×80)
4. Benutzerdefiniertes CSS: (leer lassen)
5. Hintergrund transparent: Die Overlays haben bereits transparente/halbtransparente Hintergründe