add KR version
add how to set apiEndPoint
This commit is contained in:
devhalfdog 2023-08-12 20:52:19 +09:00
parent 2ab5710c11
commit 5b00afa590
3 changed files with 71 additions and 28 deletions

View File

@ -28,34 +28,11 @@ This project can either be built by using [`dotnet build`](https://learn.microso
After writing and compiling this project. You will want to host it somewhere. This could be on the same server that the gameserver runs on, or somewhere completely different. We do recommend to keep the latency to the gameserver minimal for smoother and faster communication. The same `ServerListener` can be used for *multiple* gameservers at the same time. You can specify the API server (address & port) in the launch options of the gameserver.
Chinese Version
# BBR服务器API
#### Setting launch option in gameserver
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
这个是BBR像素战地的服务端API
## 如何开始
### 系统需求
- 拥有 BBR 服务端的开服权限,且满足开服条件。
- 可以写基于 [.NET 6.0](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) 的 C# 代码.
- 生产环境中可以部署此代码.
### 如何制作功能
查看维基 [此页面](https://github.com/MrOkiDoki/BattleBit-Community-Server-API/wiki).
使用这个 API 将开启一个`ServerListener` 的监听进程,来了解你的服务端中正在发生什么。
如果想给你的服务端添加功能,可以直接把功能写在 `Program.cs` 中,当然也可以按照框架规范进行其他的功能纂写。
`-apiEndpoint=<apiIPAddress>:<apiPort>`
### 编译
可以直接使用 [`dotnet build`](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-build) 的命令进行编译,或者在你的 VSC 等 IDE 中自定义编译.
### 连接服务端
当你将此项目的功能写完并进行了编译后,需要将此 API 进行部署。此服务可以部署在本地网络、本机网络或者广域网中。我们强烈建议以「最低延迟」为基准进行部署,以保证 `ServerListener` 可以同时监听*多个*游戏服务端。
你可以在游戏服务端的启动配置文件中对 API 的地址和端口进行设定。
# API Docs localization
- [Chinese](/docs/README_zhCN.md)
- [Korean](/docs/README_koKR.md)

32
docs/README_koKR.md Normal file
View File

@ -0,0 +1,32 @@
# BattleBit Remastered Community Server API
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
이 레포지토리는 BattleBit Remastered 커뮤니티 서버에서 이벤트를 처리하고 조작하는 데 사용할 수 있는 API를 제공합니다.
## Getting started
### Prerequisites
- BattleBit Remastered 커뮤니티 서버를 개설할 수 있는 권한을 보유하고 BattleBit Remastered 에서 요구하는 조건을 충족해야 합니다.
- [.NET 6.0](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)을 이용해 C# 코드를 작성하고 컴파일할 수 있어야 합니다.
- (프로덕션 한정) 이 API를 호스팅할 장소가 필요합니다.
### Writing
문서와 예제는 [wiki](https://github.com/MrOkiDoki/BattleBit-Community-Server-API/wiki)에서 확인할 수 있습니다.
이 API를 사용하는 방법은 `ServerListener`의 인스턴스를 생성하고 서버에서 발생하는 특정 이벤트에 자신만의 핸들러를 추가하는 것입니다.
가장 쉬운 방법은 `Program.cs`에 직접 코드를 추가/작성한 후 프로젝트를 빌드하는 것입니다.
### Build
이 프로젝트는 CMD에서 [`dotnet build`](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-build)를 사용하거나 선호하는 IDE에서 Run / Build 옵션을 이용하여 빌드할 수 있습니다.
### Connecting to the gameserver
API를 작성하고 컴파일한 후, 다른 곳에서 호스팅하고 싶을 수도 있습니다. 게임 서버가 실행되는 서버와 동일한 서버일 수 있으며 완전히 다른 서버일 수도 있습니다. 보다 원활하고 빠른 통신을 위해 게임 서버와의 지연 시간을 최소화하는 것이 좋습니다. 동일한 `ServerListener`를 동시에 *여러* 게임 서버에 사용할 수 있습니다. 게임 서버의 실행 옵션에서 API 서버(주소와 포트)를 지정할 수 있습니다.
#### Setting launch option in gameserver
`-apiEndpoint=<apiIPAddress>:<apiPort>`

34
docs/README_zhCN.md Normal file
View File

@ -0,0 +1,34 @@
# BBR服务器API
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
这个是BBR像素战地的服务端API
## 如何开始
### 系统需求
- 拥有 BBR 服务端的开服权限,且满足开服条件。
- 可以写基于 [.NET 6.0](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) 的 C# 代码.
- 生产环境中可以部署此代码.
### 如何制作功能
查看维基 [此页面](https://github.com/MrOkiDoki/BattleBit-Community-Server-API/wiki).
使用这个 API 将开启一个`ServerListener` 的监听进程,来了解你的服务端中正在发生什么。
如果想给你的服务端添加功能,可以直接把功能写在 `Program.cs` 中,当然也可以按照框架规范进行其他的功能纂写。
### 编译
可以直接使用 [`dotnet build`](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-build) 的命令进行编译,或者在你的 VSC 等 IDE 中自定义编译.
### 连接服务端
当你将此项目的功能写完并进行了编译后,需要将此 API 进行部署。此服务可以部署在本地网络、本机网络或者广域网中。我们强烈建议以「最低延迟」为基准进行部署,以保证 `ServerListener` 可以同时监听*多个*游戏服务端。
你可以在游戏服务端的启动配置文件中对 API 的地址和端口进行设定。
#### Setting launch option in gameserver
`-apiEndpoint=<apiIPAddress>:<apiPort>`