librg

Simplificando el desarrollo de juegos multijugador desde 2017. Replicación mundial multiplataforma de un solo encabezado en C99 puro.

_{Construido con amor usando zpl • Presentado por @inlife, @zpl-zak y otros colaboradores}

Introducción

librg es una biblioteca liviana que sirve como middleware entre bibliotecas de transferencia de datos (redes, transmisión de archivos, etc.) y la lógica central de aplicaciones/juegos.

Las principales responsabilidades de la biblioteca incluyen:

• seguimiento de entidades (sigue qué entidad pertenece a qué mundo y qué estados tienen)
• seguimiento del propietario (sigue qué participante posee qué entidad)
• Gestión del área de interés (controla lo que un participante puede y no puede ver)
• replicación mundial (recrea una representación limitada en un mundo de destino de lo que se considera visible para un participante en el mundo de origen)

La biblioteca nació para resolver las complejidades de configurar y administrar el flujo de juegos multijugador y servidores de juegos dedicados. Recorrió un largo camino para eliminar cosas que no eran esenciales, esculpiéndolas lentamente hasta su forma actual, que puedes ver y usar hoy.

¿Por qué lo necesitas?

sin librar

Por lo general, el mundo del juego en red consta de un conjunto de jugadores en red y un conjunto de entidades en red. La variante típica de establecer relaciones de sincronización entre entidades y jugadores es establecer conexiones de todo para todos.

Esta es la configuración más básica a seguir. Sin embargo, con una cantidad cada vez mayor de entidades, el ancho de banda se vuelve bastante ineficiente.

con libra

Con librg, puede disminuir considerablemente el uso de ancho de banda al crear relaciones entre entidades basadas en radio y visibilidad. Las entidades se sincronizarán solo con los jugadores para los que son visibles.

Beneficios

• Soporte para mundos 2D/3D de varios tamaños.
• Soporte del mundo virtual
• Métodos de visibilidad de entidades personalizados
• Consulta avanzada de entidades
• Eventos para cambios de estado de entidad a entidad
• Soporte LOD en red (basado en radio variable)
• Multiplataforma, liviano y de un solo encabezado

Integración de redes

La interfaz general de la biblioteca se creó teniendo en cuenta el soporte de la mayoría de las bibliotecas de la red.

La biblioteca de redes debe admitir:

1. Capacidad para enviar y recibir un buffer char *
2. Capacidad para leer o establecer ese tamaño de búfer
3. Capacidad de identificar quién es el receptor o remitente de los datos con una identificación entera

¡Y eso es todo!

Una lista de qué tipo de bibliotecas son compatibles:

• ENet
• GameNetworkingSockets
• yojimbo
• SLikeNet
• KCP
• Raknet
• Websocket
• WebRTC
• Cualquier otra biblioteca basada en UDP o TCP

Nota: puede consultar un ejemplo de integración de red para enet.

Instalación

librg es una biblioteca de un solo encabezado, lo que significa que para usarla, solo necesita obtener la versión más reciente (o específica) de dicho archivo de encabezado de la sección de lanzamientos de este repositorio, agregarlo a su proyecto y comenzar a disfrutar de los beneficios. .

Alternativamente, si se siente cómodo con su CLI, puede hacer lo siguiente;

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

Preguntas frecuentes

1. ¿Es esta una biblioteca de redes?

   • Realmente no, no. Está pensado para utilizarse teniendo en cuenta la creación de redes, pero no tiene ninguna capacidad de red por sí solo.

2. ¿Puedo usar cualquier biblioteca de redes con él?

   • Sí. Todo lo que necesita es la capacidad de leer datos hacia y desde el búfer, que es compatible con la mayoría de las bibliotecas. En teoría, puede ser cualquier nivel tan bajo como UDP puro y hasta WebSocket / WebRTC .

3. El repositorio contiene un montón de archivos *.h y *.c y, aun así, usted sugiere que sea una biblioteca de un solo encabezado, ¿cómo es eso posible?

   • La biblioteca se distribuye en varios archivos, por lo que es más fácil trabajar con ella durante el desarrollo; sin embargo, cada vez que se crea una nueva versión, se crea una versión "empaquetada" del archivo de encabezado y se envía directamente a la página de versiones.

4. ¿Librg ofrece un sistema de entidades?

   • No, la biblioteca no administra ni crea sus propias entidades, sino que espera que usted proporcione su propio identificador de entidad/objeto para adjuntarle algunos datos internos, lo que en el contexto de la biblioteca se denomina "seguimiento".

5. ¿Cómo empaqueto datos? ¿Proporcionan métodos para ello?

   • No, la biblioteca no proporciona ningún método de serialización/empaquetado de datos. Deberías usar alguna biblioteca existente para eso ( protobuf , flatbuffers , msgpack , etc.) o hacer tu propia implementación.

6. Veo que mencionas fragmentos, ¿significa que mi juego/aplicación debería estar basado en fragmentos?

   • No. Los fragmentos solo se usan internamente para dividir artificialmente el espacio del mundo en cuadrados/cubos de tamaño estático para que las consultas funcionen de manera eficiente. Incluso si tu juego usa fragmentos, su cantidad/tamaño/compensación no son demasiado necesarios y deben ser los mismos.

Documentación

Para leer documentación detallada sobre la biblioteca, ver ejemplos y una guía de inicio rápido, visite nuestra página de documentación.

Además, puede consultar la carpeta de código/aplicaciones para ver ejemplos de código reales.

Ilustraciones

Replicación mundial

Aquí hay una ilustración simple que intenta replicar cómo funciona la biblioteca en un mundo 2D simple de fragmentos de 4x4. Para un mundo 3D de mayor tamaño, todo funcionaría de forma muy similar, sólo que en 3 dimensiones.

_{(haga clic en la imagen para verla en tamaño completo)}

Protocolo Mundial

Y esta imagen muestra la estructura del protocolo binario subyacente que se utiliza para codificar y decodificar datos desde/hacia. El búfer binario resultante podría insertarse en cualquier otro búfer, guardarse en el disco como un archivo o enviarse a través de la red utilizando cualquier método disponible. Colocar datos personalizados junto a cada entidad dentro del paquete permite un almacenamiento de datos dependiente del contexto que amplía las capacidades y permite la replicación de entidades eficiente en memoria y ancho de banda.

_{(haga clic en la imagen para verla en tamaño completo)}

Migración

Si ha utilizado la biblioteca antes de la versión v6.0.0 , se recomienda leer la guía de migración que se encuentra aquí.

Apoyo

Estamos probando la biblioteca para varias plataformas. Esta tabla proporciona algún tipo de descripción de compatibilidad. Si lo ha probado y su resultado es diferente al de la tabla, no dude en describir el problema en los problemas.

Plataforma / Resultado	ventanas	macos	linux	iOS	Androide	Frambuesa Pi	OpenBSD	FreeBSD	escritos
❔				sonido metálico	sonido metálico	gcc, sonido metálico	gcc, sonido metálico	gcc, sonido metálico
✅	msvc, mingw	gcc, sonido metálico	gcc, sonido metálico						emcc

Leyenda:

• ❔ - La biblioteca aún no se ha probado en esta plataforma/compilador
• ✅ - La biblioteca se compila correctamente y todas las pruebas se ejecutan correctamente

Desarrollo

Si desea contribuir, agregar nuevas funciones, optimizaciones o mejoras generales, aquí tiene las instrucciones sobre cómo hacerlo:

1. Clona el repositorio, fe: git clone https://github.com/zpl-c/librg.git
2. Ejecute make para construir todos los proyectos y verificar que todo funcione.
3. Desarrollar una función, agregar pruebas para ella en code/tests/
4. Y finalmente ejecute make test nuevamente para verificar

En caso de que esté trabajando desde Windows y/o no pueda usar make , también puede usar el archivo de configuración cmake incorporado para generar una solución de Visual Studio, para hacer eso:

1. mkdir build
2. cd build
3. cmake ../misc -G"Visual Studio 16 2019" (o cualquier configuración que tenga)
4. cmake --open . (abre VS con la solución)
5. Y repite los pasos desde arriba.

Para los desarrolladores, ofrece buenos beneficios:

• Configurable en tiempo de compilación y ejecución.
• escrito en C99 (razones de portabilidad)
• sin dependencias externas
• cobertura de prueba unitaria incorporada