Ein ruhiges Erlebnis für ZenClub entwickeln

Jedes Erlebnis in ZenClub ist eine eigene kleine Web-App. Es läuft unter einem eigenen Origin in einem isolierten Frame und kommuniziert über ein kleines SDK mit der Stadt. Du behältst deine Engine, dein Framework und deinen Veröffentlichungsrhythmus.

So greift alles ineinander

1. Die Plattform öffnet deine Einstiegs-URL in einem isolierten Frame und übergibt ihren eigenen Origin sowie eine Instanz-ID im URL-Hash.
2. Dein Code ruft connect() auf. Nach einem kurzen Handshake läuft jeder Aufruf über einen privaten MessagePort. Dein Frame ruft ZenClub-Server niemals direkt auf.
3. Die Plattform prüft jeden Aufruf anhand der für deine genaue Version freigegebenen Fähigkeiten und speichert, erfasst oder zeigt anschließend das Ergebnis für dich an.

Was dir das SDK bietet

• Das Design der BesuchendenFarben, heller oder dunkler Modus, Schrift und reduzierte Bewegung werden als CSS-Variablen übergeben und laufend aktualisiert.
• Sicheres SpeichernVersionierte Speicherplätze mit Revisionen, Konflikterkennung, sicheren Wiederholungen und automatischem Speichern.
• Erfasste NutzungszeitDu meldest, ob das Erlebnis läuft. Die Plattform erfasst die Zeit, du musst sie also nicht selbst zählen.
• Momente und AbzeichenLass Besuchende ein Bild eines stillen Moments behalten und beantrage Abzeichen, die von der Plattform geprüft werden.
• Aktionen in der KopfzeilePlatziere Ton, Neustart, Hilfe und eigene kleine Aktionen in der Kopfzeile der Plattform.
• Sprache und ZeitSprache und Zeitzone der Besuchenden sind im Kontext enthalten, damit dein Erlebnis sie in ihrer eigenen Sprache begrüßen kann.

Was privat bleibt

Plugins erhalten niemals eine E-Mail-Adresse, Konto-ID, ein Token oder Cookie. Der Kontext enthält nur Anzeigename, Sprache, Zeitzone, Mitgliedschaftsstufe, Design, optionale Klangpräferenz und die freigegebene Einstellung zur Stadtaufzeichnung. Das Frame kann keine Pop-ups öffnen, Alarmdialoge anzeigen, Formulare absenden oder die Seite weiterleiten.

Leitfäden

• SchnellstartErstelle ein Projekt, verbinde es mit einem Test-Host und speichere deinen ersten Fortschritt.
• Manifest und BerechtigungenGib an, wer du bist, wo dein Erlebnis liegt und welche Fähigkeiten du benötigst.
• SDK-ReferenzAlle Methoden, Optionen, Grenzen und Fehlercodes des Client-SDK.
• Lebenszyklus und SpeichernHandshake, Pausieren und Fortsetzen, Lebenszeichen, Revisionen und Wiederholungen.
• Hosting und PrüfungHoste dein Erlebnis, bestehe die Prüfung und veröffentliche neue Versionen sicher.

Das SDK erhalten

@zenclub/sdk ist ein ES-Modulpaket ohne Abhängigkeiten und mit TypeScript-Typen. Wir teilen es mit den Kreativen, mit denen wir zusammenarbeiten. Schreib uns von deiner Idee, dann senden wir dir die aktuelle Version und einen Prüfzeitraum.