librg

Vereinfacht seit 2017 die Entwicklung von Multiplayer-Spielen. Plattformübergreifende Weltreplikation mit einem Header in reinem C99.

_{Mit Liebe mit zpl erstellt • Präsentiert von @inlife, @zpl-zak und anderen Mitwirkenden}

Einführung

librg ist eine leichtgewichtige Bibliothek, die als Middleware zwischen datenübertragenden Bibliotheken (Netzwerk, Datei-Streaming usw.) und der Kernanwendungs-/Spiellogik dient.

Zu den Hauptaufgaben der Bibliothek gehören:

• Entitätsverfolgung (verfolgt, welche Entität zu welcher Welt gehört und welche Zustände sie hat)
• Eigentümerverfolgung (verfolgt, welcher Teilnehmer welche Entität besitzt)
• Interessenbereichsverwaltung (steuert, was ein Teilnehmer sehen kann und was nicht)
• Weltreplikation (erstellt in einer Zielwelt eine begrenzte Darstellung dessen, was für einen Teilnehmer in der Quellwelt als sichtbar gilt)

Die Bibliothek wurde ins Leben gerufen, um die Komplexität der Einrichtung und Verwaltung des Ablaufs von Mehrspieler-Spielen und dedizierten Spieleservern zu lösen. Es war ein langer Weg, Dinge zu entfernen, die unwesentlich waren, und sich langsam in die aktuelle Form zu formen, die Sie heute sehen und verwenden können.

Warum Sie es brauchen

Ohne Bibliothek

Normalerweise besteht die vernetzte Spielwelt aus einer Reihe vernetzter Spieler und einer Reihe vernetzter Einheiten. Die typische Variante zum Einrichten der Synchronisationsbeziehungen zwischen Entitäten und Spielern besteht darin, Everything-to-Everyone-Verbindungen einzurichten.

Dies ist das grundlegendste Setup, dem Sie folgen sollten. Mit zunehmender Anzahl von Entitäten wird es jedoch eher bandbreitenineffizient.

Mit librg

Mit librg können Sie die Bandbreitennutzung erheblich reduzieren, indem Sie radius- und sichtbarkeitsbasierte Entitätsbeziehungen erstellen. Entitäten werden nur mit den Spielern synchronisiert, für die sie sichtbar sind.

Vorteile

• Unterstützung für 2D/3D-Welten unterschiedlicher Größe
• Unterstützung der virtuellen Welt
• Benutzerdefinierte Entitätssichtbarkeitsmethoden
• Erweiterte Entitätsabfrage
• Ereignisse für Statusänderungen von Entität zu Entität
• Vernetzte LOD-Unterstützung (basierend auf variablem Radius)
• Plattformübergreifend, leicht, Single-Header

Netzwerkintegration

Die Gesamtschnittstelle der Bibliothek wurde im Hinblick auf die Unterstützung der meisten Netzwerkbibliotheken entwickelt.

Die Netzwerkbibliothek muss Folgendes unterstützen:

1. Möglichkeit zum Senden und Empfangen eines char * -Puffers
2. Möglichkeit, diese Puffergröße zu lesen oder festzulegen
3. Möglichkeit, anhand einer ganzzahligen ID zu identifizieren, wer der Empfänger oder Sender der Daten ist

Und das ist so ziemlich alles!

Eine Liste der unterstützten Bibliotheken:

• ENet
• GameNetworkingSockets
• yojimbo
• SLikeNet
• KCP
• Raknet
• Websocket
• WebRTC
• Jede andere UDP oder TCP basierte Bibliothek

Hinweis: Sie können sich ein Beispiel für die Netzwerkintegration für enet ansehen.

Installation

librg ist eine Single-Header-Bibliothek. Das heißt, um sie zu verwenden, müssen Sie lediglich die neueste (oder spezifische) Version der besagten Header-Datei aus dem Release-Bereich dieses Repositorys herunterladen, sie Ihrem Projekt hinzufügen und schon können Sie von den Vorteilen profitieren .

Wenn Sie sich mit Ihrer CLI wohl fühlen, können Sie alternativ auch Folgendes tun:

curl -L https://github.com/zpl-c/librg/releases/latest/download/librg.h > librg.h

# OR

wget https://github.com/zpl-c/librg/releases/latest/download/librg.h -O librg.h

FAQ

1. Ist das eine Netzwerkbibliothek?

   • Nicht wirklich, nein. Es ist für den Einsatz im Netzwerkbereich gedacht, verfügt jedoch über keine eigenständigen Netzwerkfunktionen.

2. Kann ich jede Netzwerkbibliothek damit verwenden?

   • Ja. Sie benötigen lediglich die Fähigkeit, Daten in den und aus dem Puffer zu lesen, was die meisten Bibliotheken unterstützen. Theoretisch kann es sich um alles auf niedriger Ebene wie reines UDP bis hin zu WebSocket / WebRTC handeln.

3. Das Repository enthält eine Reihe von *.h und *.c Dateien, und dennoch schlagen Sie vor, dass es sich um eine Single-Header-Bibliothek handelt. Wie ist das möglich?

   • Die Bibliothek ist auf mehrere Dateien verteilt, sodass Sie während der Entwicklung leichter damit arbeiten können. Allerdings wird jedes Mal, wenn ein neues Release erstellt wird, eine „gebündelte“ Version der Header-Datei erstellt und direkt auf die Release-Seite übertragen.

4. Bietet librg ein Entity-System an?

   • Nein, die Bibliothek verwaltet oder erstellt ihre eigenen Entitäten nicht, sondern erwartet vielmehr, dass Sie Ihr eigenes Entitäts-/Objekthandle bereitstellen, um einige interne Daten daran anzuhängen, was im Kontext der Bibliothek als „Tracking“ bezeichnet wird.

5. Wie verpacke ich Daten? Stellen Sie Methoden dafür bereit?

   • Nein, die Bibliothek bietet keine Methoden zur Datenverpackung/Serialisierung. Sie sollten dafür eine vorhandene Bibliothek verwenden ( protobuf , flatbuffers , msgpack usw.) oder Ihre eigene Implementierung erstellen.

6. Ich sehe, dass Sie Chunks erwähnen. Bedeutet das, dass mein Spiel/meine App Chunk-basiert sein sollte?

   • Nein. Chunks werden nur intern verwendet, um den Weltraum künstlich in Quadrate/Würfel mit statischer Größe zu unterteilen, damit die Abfrage effizient funktioniert. Selbst wenn Ihr Spiel Chunks verwendet, sind deren Menge/Größe/Offset nicht allzu sehr erforderlich und sollten gleich sein.

Dokumentation

Um eine ausführliche Dokumentation zur Bibliothek, Beispiele und eine Kurzanleitung zu lesen, besuchen Sie bitte unsere Dokumentationsseite.

Darüber hinaus können Sie im Code/Apps-Ordner nach tatsächlichen Codebeispielen suchen.

Illustrationen

Weltreplikation

Hier ist eine einfache Illustration, die versucht, die Funktionsweise der Bibliothek in einer einfachen 2D-Welt aus 4x4-Blöcken nachzubilden. Für eine größere 3D-Welt würde alles auf sehr ähnliche Weise funktionieren, nur in 3 Dimensionen.

_{(Klicken Sie auf das Bild, um es in voller Größe anzuzeigen)}

Weltprotokoll

Und dieses Bild zeigt die Struktur des zugrunde liegenden Binärprotokolls, das zum Kodieren und Dekodieren von Daten von/nach verwendet wird. Der resultierende Binärpuffer kann in einen beliebigen anderen Puffer eingefügt, als Datei auf der Festplatte gespeichert oder mit jeder verfügbaren Methode über das Netzwerk gesendet werden. Das Einfügen benutzerdefinierter Daten neben jeder Entität innerhalb des Pakets ermöglicht eine kontextabhängige Datenspeicherung, die die Funktionen erweitert und eine speicher- und bandbreiteneffiziente Entitätsreplikation ermöglicht.

_{(Klicken Sie auf das Bild, um es in voller Größe anzuzeigen)}

Migration

Wenn Sie die Bibliothek vor Version v6.0.0 verwendet haben, wird empfohlen, den Migrationsleitfaden hier zu lesen.

Unterstützung

Wir testen die Bibliothek für verschiedene Plattformen. Diese Tabelle enthält eine Art Beschreibung zur Kompatibilität. Wenn Sie es getestet haben und Ihr Ergebnis von dem in der Tabelle abweicht, können Sie das Problem gerne in den Ausgaben beschreiben.

Plattform / Ergebnis	Windows	macOS	Linux	iOS	Android	Raspberry Pi	OpenBSD	FreeBSD	Emscripten
❔				klirren	klirren	gcc, klirren	gcc, klirren	gcc, klirren
✅	msvc, mingw	gcc, klirren	gcc, klirren						emcc

Legende:

• ❔ – Die Bibliothek wurde auf dieser Plattform/diesem Compiler noch nicht getestet
• ✅ – Die Bibliothek wird erfolgreich kompiliert und alle Tests werden ordnungsgemäß ausgeführt

Entwicklung

Wenn Sie einen Beitrag leisten, neue Funktionen, Optimierungen oder allgemeine Verbesserungen hinzufügen möchten, finden Sie hier die Anweisungen dazu:

1. Klonen Sie das Repo, z. B.: git clone https://github.com/zpl-c/librg.git
2. Führen Sie make aus, um alle Projekte zu erstellen und zu überprüfen, ob alles funktioniert
3. Entwickeln Sie eine Funktion und fügen Sie Tests dafür in code/tests/ hinzu.
4. Und schließlich führen Sie make test erneut aus, um dies zu überprüfen

Falls Sie unter Windows arbeiten und/oder make nicht verwenden können, können Sie auch die integrierte cmake Konfigurationsdatei verwenden, um eine Visual Studio-Lösung zu generieren:

1. mkdir build
2. cd build
3. cmake ../misc -G"Visual Studio 16 2019" (oder eine beliebige Konfiguration, die Sie haben)
4. cmake --open . (öffnet VS mit der Lösung)
5. Und wiederholen Sie die Schritte von oben

Für Entwickler bietet es nette Vorteile:

• kompilierbar und zur Laufzeit konfigurierbar
• geschrieben in C99 (aus Gründen der Portabilität)
• keine externen Abhängigkeiten
• Integrierte Unit-Test-Abdeckung