netcode.io browser

Расширения браузера для netcode.io

Этот репозиторий позволяет использовать netcode.io через расширения браузера до его принятия в браузерах. netcode.io обеспечивает безопасное использование UDP в веб-браузерах с целью поддержки многопользовательских игр HTML5. Более подробную информацию о netcode.io можно найти здесь.

Поддерживаемые браузеры

netcode.io поддерживается в следующих браузерах через расширения:

• Гугл Хром
• Firefox 42 и выше

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

Установка

Из источника

Чтобы это работало, требуется установка как расширения браузера, так и встроенного помощника приложения, который осуществляет фактическую связь netcode.io. Расширение использует собственные API-интерфейсы обмена сообщениями, предоставляемые в браузерах, чтобы сделать netcode.io доступным через помощник.

Чтобы опробовать это в своем браузере, сначала создайте помощник netcode.io.host:

1. Получите зависимости

go get github.com/wirepair/netcode

2. Инструкции по сборке для конкретной платформы

• go build - для текущей ОС
• env GOOS=windows GOARCH=amd64 go build — для сборки для Windows (в стиле Linux для установки переменных среды)
• env GOOS=linux GOARCH=amd64 go build — для сборки для Linux (в стиле Linux для установки переменных среды)
• env GOOS=darwin GOARCH=amd64 go build — для сборки для Mac (в стиле Linux для установки переменных среды)

3. Установите (запустите из командной строки)

./netcode.io.host

Оно должно работать без ошибок и устанавливаться как собственное расширение обмена сообщениями.

После этого добавьте каталог browserwebext как распакованное расширение.

API netcode.io

API доступен клиентам Javascript как window.netcode . Проверить доступность netcode.io можно с помощью обычного шаблона if (window.netcode) { ... } .

window.netcode предоставляет одну функцию: createClient(callback) :

window.netcode.createClient(протокол, обратный вызов)

Создает новый клиент netcode.io, который можно использовать для безопасной связи UDP с использованием протокола netcode.io. Обратный вызов имеет форму callback(err, client) . Если установлен err , при создании клиента произошла ошибка (и client будет нулевым). В противном случае client установлен, а err равна нулю. Возвращенный клиент является экземпляром Client .

protocol должен быть ipv4 или ipv6 и определяет, к какому типу адреса сервера вы можете подключиться.

Параметры:

• protocol : либо ipv4 , либо ipv6 .
• callback : обратный вызов в форме callback(err, client) , где err — это либо значение null , либо экземпляр Error , а client — это либо значение null , либо экземпляр Client .

window.netcode.isNativeHelperInstalled(обратный вызов)

Проверяет, установлен ли пользователем помощник netcode.io. Обратный вызов имеет форму callback(err, isPresent) , где err — это либо null , либо экземпляр Error . Если ошибок нет, isPresent является логическим значением, указывающим, установлен ли собственный помощник.

Если помощник netcode.io не установлен, вам следует направить пользователя на https://github.com/RedpointGames/netcode.io-browser/releases/tag/latest, где помощник netcode.io можно легко установить в несколько кликов.

Параметры:

• callback : обратный вызов в форме callback(err, isPresent) , где err — это либо значение null , либо экземпляр Error , а isPresent — это либо значение null , либо логическое значение.

Client.setTickRate(tickRate, обратный вызов)

Устанавливает тактовую частоту клиента netcode.io, выражаемую количеством тактов в секунду для приема и отправки пакетов. По умолчанию тикрейт для клиентов равен 60 ; то есть 60 раз в секунду.

Параметры:

• tickRate : целое число, равное или больше 1 .
• callback : обратный вызов в форме callback(err) , где err имеет значение null или экземпляр Error .

Client.connect(токен, обратный вызов)

Подключается к серверу netcode.io, используя указанный токен. token должен быть экземпляром Uint8Array и представлять токен netcode.io, полученный от сервера аутентификации.

Вы не можете использовать netcode.io для отправки пакетов UDP на произвольные IP-адреса; вместо этого у вас должен быть сервер аутентификации, использующий библиотеку netcode.io (или совместимую реализацию), который может генерировать и подписывать токены со списком IP-адресов игровых серверов и закрытым ключом, общим для вашего сервера аутентификации и игровых серверов.

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

Параметры:

• token : экземпляр Uint8Array , содержащий данные токена.
• callback : обратный вызов в форме callback(err) , где err имеет значение null или экземпляр Error .

Client.send(packetBuffer, обратный вызов)

Отправляет пакет на подключенный сервер с использованием packetBuffer в качестве данных. packetBuffer должен быть экземпляром Uint8Array .

Параметры:

• token : экземпляр Uint8Array , который содержит данные пакета для отправки.
• callback : обратный вызов в форме callback(err) , где err имеет значение null или экземпляр Error .

Client.getClientState(обратный вызов)

Возвращает текущее состояние клиента в виде строки. Возвращенное состояние является одним из: connected , connectionDenied , connectionRequestTimeout , connectionResponseTimeout , connectionTimedOut , connectTokenExpired , disconnected , invalidConnectToken , sendingConnectionRequest , sendingConnectionResponse или destroyed .

Параметры:

• callback : обратный вызов в форме callback(err, state) , где err — это либо значение null , либо экземпляр Error . state равно null (в случае ошибки) или одному из состояний, перечисленных выше.

Client.destroy(обратный вызов)

Уничтожает клиент, отключая его от сервера и очищая все связанные ресурсы. После уничтожения клиента его нельзя использовать повторно.

Параметры:

• callback : обратный вызов в форме callback(err) , где err имеет значение null или экземпляр Error .

Client.addEventListener(тип, обратный вызов)

Добавляет прослушиватель событий к клиенту. В настоящее время единственным поддерживаемым type является receive , который запускается, когда клиент получает пакет от сервера.

Для receive обратный вызов имеет форму callback(clientId, buffer) , где clientId — это идентификатор клиента, первоначально выданный сервером аутентификации, а buffer — это полученный пакет как экземпляр Uint8Array .

Параметры:

• type : один из поддерживаемых типов, перечисленных выше.
• callback : обратный вызов, форма которого различается в зависимости от type .

Лицензия

Этот код расширения хоста предоставляется по лицензии MIT.

Содействие

Основными целями этого проекта на данный момент являются:

• Стабилизация реализации, представленной в настоящее время здесь
• Делаем расширение доступным в Edge и Firefox
• Размещение расширения в соответствующих интернет-магазинах расширений.
• Упрощение установки расширения и встроенного помощника, чтобы игроки могли установить его по запросу из игр HTML5.

Все запросы на включение должны быть доступны по лицензии MIT.