librg

Упрощение разработки многопользовательских игр с 2017 года. Кроссплатформенная репликация мира с одним заголовком на чистом C99.

_{Создано с любовью с использованием zpl • Представлено @inlife, @zpl-zak и другими участниками}

Введение

librg — это легкая библиотека, которая служит промежуточным программным обеспечением между библиотеками передачи данных (сетевыми, потоковыми файлами и т. д.) и основной логикой приложения/игры.

К основным обязанностям библиотеки относятся:

• отслеживание объектов (отслеживает, какой объект принадлежит какому миру и какие состояния у них есть)
• отслеживание владельца (отслеживает, какой участник каким объектом владеет)
• Управление областью интересов (контролирует, что может и не может видеть участник)
• репликация мира (воссоздает в мире назначения ограниченное представление того, что считается видимым для участника исходного мира)

Библиотека была создана для решения сложностей настройки и управления потоком многопользовательских игр и выделенных игровых серверов. Он прошел долгий путь в удалении несущественных вещей и постепенном придании нынешней формы, которую вы можете увидеть и использовать сегодня.

Зачем вам это нужно

Без библиотеки

Обычно сетевой игровой мир состоит из набора сетевых игроков и множества сетевых объектов. Типичным вариантом настройки отношений синхронизации между сущностями и игроками является настройка соединений «Все-всем».

Это самая базовая настройка, которой нужно следовать. Однако с увеличением количества объектов это становится довольно неэффективным с точки зрения пропускной способности.

С librg

С помощью librg вы можете значительно уменьшить использование полосы пропускания, создавая отношения сущностей на основе радиуса и видимости. Сущности будут синхронизироваться только с игроками, которым они видны.

Преимущества

• Поддержка 2d/3d миров разных размеров.
• Поддержка виртуального мира
• Пользовательские методы видимости объектов
• Расширенный запрос сущностей
• События для изменения статуса между объектами
• Поддержка сетевого уровня детализации (на основе переменного радиуса)
• Кроссплатформенный, легкий, с одним разъемом

Сетевая интеграция

Общий интерфейс библиотеки был сделан с учетом поддержки большинства сетевых библиотек.

Сетевая библиотека должна поддерживать:

1. Возможность отправлять и получать буфер char *
2. Возможность читать или устанавливать этот размер буфера
3. Возможность определить, кто является получателем или отправителем данных с помощью целочисленного идентификатора.

И это почти все!

Список поддерживаемых библиотек:

• ENet
• GameNetworkingSockets
• yojimbo
• SLikeNet
• KCP
• Raknet
• Websocket
• WebRTC
• Любая другая библиотека на основе UDP или TCP

Примечание: вы можете посмотреть пример сетевой интеграции для enet.

Установка

librg — это библиотека с одним заголовком, что означает, что для ее использования вам нужно всего лишь получить последнюю (или конкретную) версию указанного заголовочного файла из раздела выпусков этого репозитория, добавить ее в свой проект и начать пользоваться преимуществами. .

В качестве альтернативы, если вы чувствуете себя комфортно в своем CLI, вы можете просто сделать следующее:

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

Часто задаваемые вопросы

1. Это сетевая библиотека?

   • Не совсем, нет. Он предназначен для использования с учетом сетевых возможностей, но сам по себе не имеет никаких сетевых возможностей.

2. Могу ли я использовать с ним любую сетевую библиотеку?

   • Да. Все, что вам нужно, это возможность читать данные в буфер и из него, что поддерживается большинством библиотек. Теоретически это может быть что угодно, начиная от чистого UDP и заканчивая WebSocket / WebRTC .

3. Репозиторий содержит кучу файлов *.h и *.c , но вы предполагаете, что это библиотека с одним заголовком, как это возможно?

   • Библиотека распределена по нескольким файлам, поэтому с ней легче работать во время разработки, однако каждый раз, когда создается новый выпуск, создается «связанная» версия заголовочного файла и помещается непосредственно на страницу выпусков.

4. Предлагает ли librg систему сущностей?

   • Нет, библиотека не управляет и фактически не создает свои собственные сущности, она скорее ожидает, что вы предоставите свой собственный дескриптор сущности/объекта, чтобы прикрепить к нему некоторые внутренние данные, что в контексте библиотеки называется «отслеживанием».

5. Как мне упаковать данные, предоставляете ли вы для этого методы?

   • Нет, библиотека не предоставляет никаких методов упаковки/сериализации данных. Для этого вам следует использовать какую-нибудь существующую библиотеку ( protobuf , flatbuffers , msgpack и т. д.) или создать свою собственную реализацию.

6. Я вижу, вы упомянули чанки. Означает ли это, что моя игра/приложение должно быть основано на чанках?

   • Нет. Чанки используются только внутри, чтобы искусственно разделить мировое пространство на квадраты/кубы статического размера, чтобы запросы работали эффективно. Даже если в вашей игре используются фрагменты, их количество/размеры/смещения не должны быть слишком большими и должны быть одинаковыми.

Документация

Чтобы прочитать подробную документацию по библиотеке, посмотреть примеры и краткое руководство, посетите нашу страницу документации.

Кроме того, вы можете проверить папку code/apps на наличие реальных примеров кода.

Иллюстрации

Репликация мира

Вот простая иллюстрация, которая пытается воспроизвести работу библиотеки в простом 2D-мире, состоящем из блоков 4x4. В трехмерном мире большего размера все будет работать очень похоже, только в трех измерениях.

_{(нажмите на изображение, чтобы просмотреть в полном размере)}

Мировой протокол

И это изображение демонстрирует структуру базового двоичного протокола, который используется для кодирования и декодирования данных из/в. Полученный двоичный буфер можно было вставить в любой другой буфер, сохранить на диск в виде файла или отправить по сети любым доступным способом. Размещение пользовательских данных рядом с каждым объектом в пакете позволяет хранить данные в зависимости от контекста, что расширяет возможности и обеспечивает репликацию объектов с эффективным использованием памяти и пропускной способности.

_{(нажмите на изображение, чтобы просмотреть в полном размере)}

Миграция

Если вы использовали библиотеку до версии v6.0.0 , рекомендуется прочитать руководство по миграции, расположенное здесь.

Поддерживать

Мы тестируем библиотеку на различных платформах. В этой таблице представлено своего рода описание совместимости. Если вы протестировали его и ваш результат отличается от приведенного в таблице, пожалуйста, опишите проблему в вопросах.

Платформа/Результат	Окна	macOS	Линукс	iOS	Андроид	Малиновый Пи	OpenBSD	FreeBSD	Эмскриптен
❔				лязг	лязг	gcc, лязг	gcc, лязг	gcc, лязг
✅	мсвк, мингв	gcc, лязг	gcc, лязг						эмкк

Легенда:

• ❔ - Библиотека еще не тестировалась на этой платформе/компиляторе.
• ✅ - Библиотека успешно компилируется, и все тесты выполняются корректно.

Разработка

Если вы хотите внести свой вклад, добавить новые функции, оптимизации или общие улучшения, вот инструкции, как это сделать:

1. Клонируйте репозиторий, например: git clone https://github.com/zpl-c/librg.git
2. Запустите make чтобы собрать все проекты и убедиться, что все работает.
3. Разработайте фичу, добавьте для нее тесты в code/tests/
4. И в конце концов снова запустите make test чтобы проверить

Если вы работаете в Windows и/или не можете использовать make , вы также можете использовать встроенный файл конфигурации cmake для создания решения Visual Studio:

1. mkdir build
2. cd build
3. cmake ../misc -G"Visual Studio 16 2019" (или любая имеющаяся у вас конфигурация)
4. cmake --open . (открывает VS с решением)
5. И повторите шаги сверху

Для разработчиков это предлагает приятные преимущества:

• настраивается во время компиляции и выполнения
• написан на C99 (из соображений переносимости)
• нет внешних зависимостей
• встроенное покрытие модульными тестами