librg

Tornando o desenvolvimento de jogos multijogador mais simples desde 2017. Replicação mundial multiplataforma de cabeçalho único em C99 puro.

_{Construído com amor usando zpl • Trazido a você por @inlife, @zpl-zak e outros colaboradores}

Introdução

librg é uma biblioteca leve que serve como um middleware entre bibliotecas de transferência de dados (rede, streaming de arquivos, etc.) e a lógica principal do aplicativo/jogo.

As principais responsabilidades da biblioteca incluem:

• rastreamento de entidade (rastreia qual entidade pertence a qual mundo e quais estados ela possui)
• rastreamento do proprietário (rastreia qual participante possui qual entidade)
• Gerenciamento de área de interesse (controla o que pode e o que não pode ser visto por um participante)
• replicação mundial (recria uma representação limitada em um mundo de destino do que é considerado visível para um participante no mundo de origem)

A biblioteca nasceu para resolver as complexidades de configuração e gerenciamento do fluxo de jogos multijogador e servidores de jogos dedicados. Percorreu um longo caminho para eliminar coisas que não eram essenciais, esculpindo lentamente em sua forma atual, que você pode ver e usar hoje.

Por que você precisa disso

Sem biblioteca

Normalmente, o mundo do jogo em rede consiste em um conjunto de jogadores em rede e um monte de entidades em rede. A variante típica de estabelecer relações de sincronização entre entidades e jogadores é estabelecer conexões Tudo-para-Todos.

Esta é a configuração mais básica a seguir. No entanto, com uma quantidade crescente de entidades, torna-se bastante ineficiente em termos de largura de banda.

Com biblioteca

Com librg, você pode diminuir consideravelmente o uso de largura de banda construindo relações de entidade baseadas em raio e visibilidade. As entidades serão sincronizadas apenas com os jogadores para os quais estão visíveis.

Benefícios

• Suporte para mundos 2D/3D de vários tamanhos
• Suporte ao mundo virtual
• Métodos personalizados de visibilidade de entidade
• Consulta avançada de entidade
• Eventos para alterações de status de entidade para entidade
• Suporte LOD em rede (com base em raio variável)
• Plataforma cruzada, leve, cabeçalho único

Integração de rede

A interface geral da biblioteca foi feita tendo em mente o suporte da maioria das bibliotecas da rede.

A biblioteca de rede deve suportar:

1. Capacidade de enviar e receber um buffer char *
2. Capacidade de ler ou definir esse tamanho de buffer
3. Capacidade de identificar quem é o destinatário ou remetente dos dados com um ID inteiro

E é basicamente isso!

Uma lista de quais tipos de bibliotecas são suportadas:

• ENet
• GameNetworkingSockets
• yojimbo
• SLikeNet
• KCP
• Raknet
• Websocket
• WebRTC
• Qualquer outra biblioteca baseada em UDP ou TCP

Nota: você pode conferir um exemplo de integração de rede para enet.

Instalação

librg é uma biblioteca de cabeçalho único, o que significa que para usá-la, você só precisa obter a versão mais recente (ou específica) do referido arquivo de cabeçalho na seção de lançamentos deste repositório, adicioná-la ao seu projeto e começar a aproveitar os benefícios .

Alternativamente, se você se sentir confortável com sua CLI, você pode simplesmente fazer o seguinte;

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

Perguntas frequentes

1. Esta é uma biblioteca de rede?

   • Na verdade não, não. Ele foi projetado para ser usado com a rede em mente, mas não possui recursos de rede por si só.

2. Posso usar qualquer biblioteca de rede com ele?

   • Sim. Tudo que você precisa é a capacidade de ler dados de e para o buffer, que a maioria das bibliotecas suporta. Teoricamente, pode ser qualquer coisa de nível tão baixo quanto UDP puro e até WebSocket / WebRTC .

3. O repositório contém vários arquivos *.h e *.c , mas você sugere que é uma biblioteca de cabeçalho único, como isso é possível?

   • A biblioteca é espalhada em vários arquivos, portanto é mais fácil trabalhar com ela durante o desenvolvimento; no entanto, cada vez que uma nova versão é criada, uma versão "agrupada" do arquivo de cabeçalho é criada e enviada diretamente para a página de versões.

4. A librg oferece um sistema de entidades?

   • Não, a biblioteca não gerencia nem cria suas próprias entidades, mas espera que você forneça seu próprio identificador de entidade/objeto para anexar alguns dados internos a ela, o que no contexto da biblioteca é chamado de "rastreamento".

5. Como faço para empacotar dados, você fornece métodos para isso?

   • Não, a biblioteca não fornece nenhum método de empacotamento/serialização de dados. Você deve usar alguma biblioteca existente para isso ( protobuf , flatbuffers , msgpack , etc.) ou fazer sua própria implementação.

6. Vejo que você mencionou pedaços, isso significa que meu jogo/aplicativo deve ser baseado em pedaços?

   • Não. Os pedaços são usados ​​apenas internamente para dividir artificialmente o espaço do mundo em quadrados/cubos de tamanho estaticamente, para que a consulta funcione de forma eficiente. Mesmo que o seu jogo use pedaços, suas quantidades/tamanhos/compensações não são muito necessárias e devem ser as mesmas.

Documentação

Para ler a documentação detalhada sobre a biblioteca, ver exemplos e um guia de início rápido, visite nossa página de documentação.

Além disso, você pode verificar a pasta code/apps para obter exemplos de código reais.

Ilustrações

Replicação Mundial

Aqui está uma ilustração simples que tenta replicar como a biblioteca funciona em um mundo 2D simples de pedaços 4x4. Para um mundo 3D de tamanho maior, tudo funcionaria de forma muito semelhante, apenas em 3 dimensões.

_{(clique na imagem para ver em tamanho real)}

Protocolo Mundial

E esta imagem mostra a estrutura do protocolo binário subjacente que é usado para codificar e decodificar dados de/para. O buffer binário resultante pode ser inserido em qualquer outro buffer, salvo no disco como um arquivo ou enviado pela rede usando qualquer método disponível. Colocar dados personalizados ao lado de cada entidade dentro do pacote permite o armazenamento de dados dependente do contexto que amplia os recursos e permite a replicação de entidades com uso eficiente de memória e largura de banda.

_{(clique na imagem para ver em tamanho real)}

Migração

Se você usou a biblioteca antes da versão v6.0.0 , é recomendável ler o guia de migração localizado aqui.

Apoiar

Estamos testando a biblioteca para diversas plataformas. Esta tabela fornece algum tipo de descrição de compatibilidade. Se você o testou e seu resultado é diferente daquele da tabela, sinta-se à vontade para descrever o problema nas questões.

Plataforma/Resultado	Windows	macOS	Linux	iOS	Android	Framboesa Pi	OpenBSD	FreeBSD	Escrito
❔				clangor	clangor	gcc, clang	gcc, clang	gcc, clang
✅	msvc, mingw	gcc, clang	gcc, clang						emcc

Lenda:

• ❔ - A biblioteca ainda não foi testada nesta plataforma/compilador
• ✅ - A biblioteca é compilada com sucesso e todos os testes são executados corretamente

Desenvolvimento

Se você deseja contribuir, adicionar novos recursos, otimizações ou melhorias gerais, aqui estão as instruções sobre como fazer isso:

1. Clone o repositório, por exemplo: git clone https://github.com/zpl-c/librg.git
2. Execute make para construir todos os projetos e verificar se tudo funciona
3. Desenvolva um recurso, adicione testes para ele em code/tests/
4. E eventualmente execute make test novamente para verificar

Caso você esteja trabalhando no Windows e/ou não consiga usar make , você também pode usar o arquivo de configuração cmake integrado para gerar uma solução do Visual Studio, para fazer isso:

1. mkdir build
2. cd build
3. cmake ../misc -G"Visual Studio 16 2019" (ou qualquer configuração que você tenha)
4. cmake --open . (abre VS com a solução)
5. E repita os passos acima

Para desenvolvedores, oferece ótimos benefícios:

• configurável em tempo de compilação e execução
• escrito em C99 (motivos de portabilidade)
• sem dependências externas
• cobertura de teste de unidade integrada