Benutzerhandbuch¶
Willkommen zum d-back-Benutzerhandbuch! Dieser umfassende Leitfaden deckt alles ab, was Sie benötigen, um d-back effektiv als WebSocket-Server für Ihre d-zone Ambient-Life-Simulation oder andere Echtzeitanwendungen zu nutzen.
Einführung¶
Dieses Handbuch ist für Benutzer konzipiert, die bereits das Tutorial Erste Schritte abgeschlossen haben und tiefer in die Funktionen und Möglichkeiten von d-back eintauchen möchten. Egal, ob Sie das Serververhalten anpassen, echte Discord-Daten integrieren oder Ihre Einrichtung optimieren möchten, Sie finden hier die benötigten Informationen.
Das Benutzerhandbuch ist in drei Hauptbereiche unterteilt:
- Konfiguration: Erfahren Sie, wie Sie d-back über Befehlszeilenoptionen, Umgebungsvariablen und programmatische Einstellungen konfigurieren
- Callbacks & Anpassung: Entdecken Sie, wie Sie das Serververhalten mit Callback-Funktionen für Datenabruf, Authentifizierung und mehr anpassen
- Benutzerdefinierte Datenanbieter: Ersetzen Sie Mock-Daten durch echte Discord-API-Integration oder Ihre eigenen benutzerdefinierten Datenquellen
Handbuch-Struktur¶
-
Konfiguration
Erfahren Sie mehr über Befehlszeilenoptionen, Umgebungsvariablen und Servereinstellungen
-
Callbacks & Anpassung
Passen Sie das Serververhalten mit Callback-Funktionen für Datenabruf und Authentifizierung an
-
Benutzerdefinierte Datenanbieter
Ersetzen Sie Mock-Daten durch echte Discord-API-Integration oder benutzerdefinierte Datenquellen
Häufige Anwendungsfälle¶
Müssen Sie eine bestimmte Aufgabe erfüllen? Hier sind Schnelllinks zu häufigen Szenarien:
| Szenario | Wo suchen |
|---|---|
| Ich möchte den Serverport ändern | Konfiguration → Befehlszeilenoptionen |
| Ich möchte meine eigenen statischen Dateien ausliefern | Konfiguration → Statische Dateiauslieferung |
| Ich möchte echte Discord-Daten verwenden | Benutzerdefinierte Datenanbieter |
| Ich möchte OAuth2-Authentifizierung hinzufügen | Callbacks → OAuth2-Validierung |
| Ich möchte benutzerdefinierte Nachrichten broadcasten | Callbacks → Broadcasting-Methoden |
| Ich möchte das Benutzerdatenformat anpassen | Callbacks → Benutzerdaten-Callback |
Schnellreferenz¶
Hier ist eine Zusammenfassung der Schlüsselkonzepte, denen Sie in diesem Handbuch begegnen werden:
| Konzept | Beschreibung |
|---|---|
| WebSocketServer | Haupt-Serverklasse, die WebSocket-Verbindungen, HTTP-Anfragen und Nachrichten-Broadcasting verwaltet |
| MockDataProvider | Integrierter Testdatengenerator, der Discord-Benutzeraktivität simuliert |
| Callbacks | Anpassungs-Hooks, die es ermöglichen, Standardverhalten zu überschreiben (z.B. on_get_user_data, on_get_server_data) |
| Statische Dateiauslieferung | Integrierter HTTP-Server für die Bereitstellung von Frontend-Assets wie HTML, CSS und JavaScript |
| Broadcasting | Methoden zum Senden von Echtzeit-Updates an verbundene Clients (Präsenz, Nachrichten, etc.) |
| OAuth2-Integration | Unterstützung für Discord-OAuth2-Authentifizierung und Token-Validierung |
API-Details benötigt?
Für detaillierte API-Dokumentation einschließlich Methodensignaturen, Parametern und Rückgabetypen siehe die API-Referenz.
Was kommt als Nächstes?¶
Bereit, Ihre d-back-Einrichtung anzupassen? Beginnen Sie mit:
- Konfiguration - Richten Sie Ihren Server mit den richtigen Einstellungen ein
- Callbacks & Anpassung - Erfahren Sie, wie Sie Verhalten anpassen
- Benutzerdefinierte Datenanbieter - Integrieren Sie echte Datenquellen
Fragen?
Wenn Sie nicht finden, wonach Sie suchen, überprüfen Sie die API-Referenz oder besuchen Sie unsere GitHub Discussions.