diff --git a/README-esES.md b/README-esES.md index 154414d..edcbf66 100644 --- a/README-esES.md +++ b/README-esES.md @@ -2,7 +2,7 @@ [![Licencia: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -Language [English](/README.md) | [中文](/README-zhCN.md) | [한국어](/README-koKR.md) | Español | [Português](/README-ptBR.md) +Language [English](/README.md) | [Русский](/README-ruRU.md) | [中文](/README-zhCN.md) | [한국어](/README-koKR.md) | Español | [Português](/README-ptBR.md) Este repositorio proporciona una API que puede ser usada para manejar eventos en tu servidor de comunidad y manipularlos. diff --git a/README-koKR.md b/README-koKR.md index db25d37..b3483f1 100644 --- a/README-koKR.md +++ b/README-koKR.md @@ -2,7 +2,7 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -Language [English](/README.md) | [中文](/README-zhCN.md) | 한국어 | [Español](/README-esES.md) | [Português](/README-ptBR.md) +Language [English](/README.md) | [Русский](/README-ruRU.md) | [中文](/README-zhCN.md) | 한국어 | [Español](/README-esES.md) | [Português](/README-ptBR.md) 이 레포지토리는 BattleBit Remastered 커뮤니티 서버에서 이벤트를 처리하고 조작하는 데 사용할 수 있는 API를 제공합니다. diff --git a/README-ptBR.md b/README-ptBR.md index 3795dab..fb5cd68 100644 --- a/README-ptBR.md +++ b/README-ptBR.md @@ -2,7 +2,7 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -Language [English](/README.md) | [中文](/README-zhCN.md) | [한국어](/README-koKR.md) | [Español](/README-esES.md) | Português +Language [English](/README.md) | [Русский](/README-ruRU.md) | [中文](/README-zhCN.md) | [한국어](/README-koKR.md) | [Español](/README-esES.md) | Português Este repositório proporciona uma API que pode ser usada para manipular eventos em seu(s) servidor(es) da comunidade. diff --git a/README-ruRU.md b/README-ruRU.md new file mode 100644 index 0000000..d506f94 --- /dev/null +++ b/README-ruRU.md @@ -0,0 +1,44 @@ +# BattleBit Remastered Community Server API + +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) + +Language [English](/README.md) | [中文](/README-zhCN.md) | Русский | [한국어](/README-koKR.md) | [Español](/README-esES.md) | [Português](/README-ptBR.md) + +Этот репозиторий предоставляет API, который можно использовать для обработки событий на сервере/серверах и манипулирования ими. + +## Приступая к работе + +### Предварительные условия + +- Собственный коммьюнити сервер в BattleBit Remastered c **отключенной** официальной прогрессией для доступа к параметрам запуска. +- Способность писать и компилировать [.NET 6.0](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) C# код. +- (Для продакшена) Место, на котором будет размещен этот API. + +### Написание кода + +Документацию и примеры можно найти на [wiki](https://github.com/MrOkiDoki/BattleBit-Community-Server-API/wiki) (WIP). + +Способ использования этого API заключается в создании инстанции `ServerListener` (и ее запуске), которой вы передаете типы ваших *собственных* подклассов `Player` и `GameServer`. В этих подклассах вы можете делать свои собственные переопределения уже существующих методов в `Player` и `GameServer`. Вы также можете добавлять свои собственные методы и поля/свойства. + +Самый простой способ начать работу со всем этим - использовать `Program.cs` и добавить свои переопределения и т.п. в `MyPlayer` и `MyGameServer`. + +### Сборка + +Этот проект можно собрать с помощью команды [`dotnet build`](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-build) в командной строке или с помощью опций run / build в предпочитаемой вами IDE. +В качестве альтернативы вы можете использовать [Docker](https://docs.docker.com/get-started/overview/) для его запуска. Простой способ сделать это - запустить `docker compose up`. + +### Подключение к игровому серверу/серверам + +После написания и компиляции этого проекта, вы захотите разместить его где-нибудь. Это может быть тот же сервер, на котором запущен текущий игровой сервер, или совершенно другой. Мы рекомендуем поддерживать минимальную задержку до игрового сервера для более плавной и быстрой коммуникации между ними. Один и тот же `ServerListener` может использоваться для *нескольких* игровых серверов одновременно. Вы можете указать API-сервер (адрес и порт) в параметрах запуска игрового сервера. + +#### Параметры запуска игрового сервера + +Игровой сервер подключается к API с помощью параметра запуска `«-apiendpoint=:»`, где `` - это порт, который слушает слушатель, а `` - IP сервера API. + +Если в вашем Server API требуется проверка `Api Token`, вам необходимо добавить `«-apiToken=»` в параметры запуска игрового сервера/серверов. Если `` совпадает с `Api Token`, определенным в Server API, игровой сервер(ы) смогут взаимодействовать с Server API. + +Когда игровой сервер запущен, вы также можете напрямую изменить `Api Token` игрового сервера, введя `setapitoken ` в его командной строке. + +#### Настройка порта прослушивания API + +В настоящее время проект настроен на прослушивание API на порту `29294`. Если вы хотите изменить это, обязательно измените это в коде (на вашем `listener.start(port)`). Порт `29294` также открыт в Docker и привязан к тому же порту на хосте в Docker Compose. Это означает, что при использовании Docker вам придется изменить порт в `Dockerfile` и в `docker-compose.yml` (при использовании Compose). Подробнее в [EXPOSE в справке по Dockerfile](https://docs.docker.com/engine/reference/builder/#expose) и [networking in Compose](https://docs.docker.com/compose/networking/). diff --git a/README-zhCN.md b/README-zhCN.md index ac57103..2e2456a 100644 --- a/README-zhCN.md +++ b/README-zhCN.md @@ -2,7 +2,7 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -Language [English](/README.md) | 中文 | [한국어](/README-koKR.md) | [Español](/README-esES.md) | [Português](/README-ptBR.md) +Language [English](/README.md) | 中文 | [Русский](/README-ruRU.md) | [한국어](/README-koKR.md) | [Español](/README-esES.md) | [Português](/README-ptBR.md) BBR(像素战地)的服务端 API 在部署后可以提供`社区服`所需要的游戏服务端事件处理以及事件控制。 diff --git a/README.md b/README.md index 4207039..a2661e0 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -Language English | [中文](/README-zhCN.md) | [한국어](/README-koKR.md) | [Español](/README-esES.md) | [Português](/README-ptBR.md) +Language English | [中文](/README-zhCN.md) | [Русский](/README-ruRU.md) | [한국어](/README-koKR.md) | [Español](/README-esES.md) | [Português](/README-ptBR.md) This repository provides an API that can be used to handle events on your community server(s) and manipulate them.