librg

Simplifier le développement de jeux multijoueurs depuis 2017. Réplication mondiale multiplateforme à en-tête unique en C99 pur.

_{Construit avec amour en utilisant zpl • Présenté par @inlife, @zpl-zak et d'autres contributeurs}

Introduction

librg est une bibliothèque légère qui sert de middleware entre les bibliothèques de transfert de données (réseau, streaming de fichiers, etc.) et la logique principale de l'application/du jeu.

Les principales responsabilités de la bibliothèque comprennent :

• suivi des entités (suit quelle entité appartient à quel monde et quels états elle possède)
• suivi du propriétaire (suit quel participant possède quelle entité)
• Gestion des zones d'intérêt (contrôle ce qui peut et ne peut pas être vu par un participant)
• réplication mondiale (recrée une représentation limitée dans un monde de destination de ce qui est considéré comme visible pour un participant dans le monde source)

La bibliothèque est née pour résoudre les complexités liées à la configuration et à la gestion du flux de jeux multi-joueurs et de serveurs de jeux dédiés. Il a parcouru un long chemin en supprimant les choses qui n'étaient pas essentielles, en sculptant lentement sa forme actuelle, que vous pouvez voir et utiliser aujourd'hui.

Pourquoi tu en as besoin

Sans bibliothèque

Habituellement, le monde du jeu en réseau se compose d’un ensemble de joueurs en réseau et d’un ensemble d’entités en réseau. La variante typique de mise en place des relations de synchronisation entre entités et acteurs est de mettre en place des connexions Everything-to-Everyone.

Il s’agit de la configuration la plus élémentaire à suivre. Cependant, avec un nombre croissant d’entités, cela devient plutôt inefficace en termes de bande passante.

Avec bibliothèque

Avec librg, vous pouvez réduire considérablement l'utilisation de la bande passante en créant des relations d'entité basées sur le rayon et la visibilité. Les entités seront synchronisées uniquement avec les joueurs pour lesquelles elles sont visibles.

Avantages

• Prise en charge de mondes 2D/3D de différentes tailles
• Prise en charge du monde virtuel
• Méthodes de visibilité des entités personnalisées
• Requête d'entité avancée
• Événements pour les changements de statut d'entité à entité
• Prise en charge du LOD en réseau (basé sur un rayon variable)
• Multiplateforme, léger, à en-tête unique

Intégration réseau

L'interface globale de la bibliothèque a été conçue en pensant à la prise en charge de la plupart des bibliothèques réseau.

La bibliothèque réseau doit prendre en charge :

1. Possibilité d'envoyer et de recevoir un tampon char *
2. Possibilité de lire ou de définir cette taille de tampon
3. Possibilité d'identifier qui est le destinataire ou l'expéditeur des données avec un identifiant entier

Et c'est à peu près tout !

Une liste des types de bibliothèques prises en charge :

• ENet
• GameNetworkingSockets
• yojimbo
• SLikeNet
• KCP
• Raknet
• Websocket
• WebRTC
• Toute autre bibliothèque basée sur UDP ou TCP

Remarque : vous pouvez consulter un exemple d'intégration réseau pour enet.

Installation

librg est une bibliothèque à en-tête unique, ce qui signifie que pour l'utiliser, il vous suffit d'obtenir la version la plus récente (ou spécifique) dudit fichier d'en-tête dans la section des versions de ce référentiel, de l'ajouter à votre projet et de commencer à profiter des avantages. .

Alternativement, si vous vous sentez à l'aise dans votre CLI, vous pouvez simplement procéder comme suit :

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. Est-ce une bibliothèque réseau ?

   • Pas vraiment, non. Il est destiné à être utilisé dans un souci de mise en réseau, mais il ne possède aucune capacité de mise en réseau à lui seul.

2. Puis-je utiliser n’importe quelle bibliothèque réseau avec ?

   • Oui. Tout ce dont vous avez besoin est de pouvoir lire des données vers et depuis le tampon, ce que la plupart des bibliothèques prennent en charge. Théoriquement, il peut s'agir d'un niveau aussi bas UDP pur et jusqu'à WebSocket / WebRTC .

3. Le référentiel contient un tas de fichiers *.h et *.c , et pourtant vous suggérez qu'il s'agit d'une bibliothèque à en-tête unique, comment est-ce possible ?

   • La bibliothèque est répartie en plusieurs fichiers, il est donc plus facile de travailler avec elle lors du développement. Cependant, chaque fois qu'une nouvelle version est créée, une version « groupée » du fichier d'en-tête est créée et poussée directement vers la page des versions.

4. librg propose-t-il un système d'entités ?

   • Non, la bibliothèque ne gère ni ne crée réellement ses propres entités, elle attend plutôt que vous fournissiez votre propre descripteur d'entité/objet pour y attacher certaines données internes, ce qui dans le contexte de la bibliothèque est appelé "suivi".

5. Comment puis-je emballer les données, fournissez-vous des méthodes pour cela ?

   • Non, la bibliothèque ne fournit aucune méthode de conditionnement/sérialisation des données. Vous devez utiliser une bibliothèque existante pour cela ( protobuf , flatbuffers , msgpack , etc.), ou créer votre propre implémentation.

6. Je vois que vous mentionnez des morceaux, cela signifie-t-il que mon jeu/application doit être basé sur des morceaux ?

   • Les morceaux ne sont utilisés qu'en interne pour diviser artificiellement l'espace du monde en carrés/cubes de taille statique afin que les requêtes fonctionnent efficacement. Même si votre jeu utilise des morceaux, leur quantité/tailles/décalages ne sont pas nécessaires et doivent être les mêmes.

Documentation

Pour lire une documentation détaillée sur la bibliothèque, voir des exemples et un guide de démarrage rapide, veuillez visiter notre page de documentation.

De plus, vous pouvez consulter le dossier code/apps pour des exemples de code réels.

Illustrations

Réplication mondiale

Voici une illustration simple qui tente de reproduire le fonctionnement de la bibliothèque sur un simple monde 2D de morceaux 4x4. Pour un monde 3D de plus grande taille, tout fonctionnerait de manière très similaire, juste en 3 dimensions.

_{(cliquez sur l'image pour l'afficher en taille réelle)}

Protocole mondial

Et cette image présente la structure du protocole binaire sous-jacent qui est utilisé pour coder et décoder les données depuis/vers. Le tampon binaire résultant peut être inséré dans n'importe quel autre tampon, enregistré sur le disque sous forme de fichier ou envoyé via le réseau en utilisant n'importe quelle méthode disponible. Le fait de placer des données personnalisées à côté de chaque entité du paquet permet un stockage de données dépendant du contexte qui étend les capacités et permet une réplication d'entité efficace en termes de mémoire et de bande passante.

_{(cliquez sur l'image pour l'afficher en taille réelle)}

Migration

Si vous avez utilisé la bibliothèque avant la version v6.0.0 , il est recommandé de lire le guide de migration situé ici.

Soutien

Nous testons la bibliothèque pour différentes plates-formes. Ce tableau fournit une sorte de description de la compatibilité. Si vous l'avez testé et que votre résultat est différent de celui du tableau, n'hésitez pas à décrire le problème dans les problèmes.

Plateforme / Résultat	Fenêtres	macOS	Linux	IOS	Androïde	Framboise Pi	OpenBSD	GratuitBSD	Emscripten
❔				bruit	bruit	gcc, clang	gcc, clang	gcc, clang
✅	msvc, mingw	gcc, clang	gcc, clang						emcc

Légende:

• ❔ - La bibliothèque n'a pas encore été testée sur cette plateforme/compilateur
• ✅ - La bibliothèque se compile avec succès et tous les tests sont exécutés correctement

Développement

Si vous souhaitez contribuer, ajouter de nouvelles fonctionnalités, des optimisations ou des améliorations globales, voici les instructions pour procéder :

1. Clonez le dépôt, par exemple : git clone https://github.com/zpl-c/librg.git
2. Exécutez make pour construire tous les projets et vérifier que tout fonctionne
3. Développer une fonctionnalité, ajouter des tests pour celle-ci dans code/tests/
4. Et éventuellement réexécutez make test pour vérifier

Si vous travaillez sous Windows et/ou ne parvenez pas à utiliser make , vous pouvez également utiliser le fichier de configuration cmake intégré pour générer une solution Visual Studio, pour ce faire :

1. mkdir build
2. cd build
3. cmake ../misc -G"Visual Studio 16 2019" (ou toute configuration dont vous disposez)
4. cmake --open . (ouvre VS avec la solution)
5. Et répétez les étapes d'en haut

Pour les développeurs, il offre de jolis avantages :

• configurable au moment de la compilation et de l'exécution
• écrit en C99 (raisons de portabilité)
• pas de dépendances externes
• couverture de tests unitaires intégrée