Merge branch 'main' of https://github.com/MrOkiDoki/BattleBit-Community-Server-API
This commit is contained in:
MrOkiDoki
commit
e373873a96
|
|
@ -3,7 +3,7 @@
|
|||
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
|
||||
Language [English Readme](/README.md) | 中文
|
||||
Language [English](/README.md) | 中文 | [한국어](/README_koKR.md)
|
||||
|
||||
这个 repo 是 BBR（像素战地）的服务端 API
|
||||
|
||||
|
|
|
|||
|
|
@ -2,8 +2,8 @@
|
|||
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
|
||||
Language English | [中文](/README-zhCN.md)
|
||||
|
||||
Language English | [中文](/README-zhCN.md) | [한국어](/README_koKR.md)
|
||||
|
||||
This repository provides an API that can be used to handle events on your community server(s) and manipulate them.
|
||||
|
||||
## Getting started
|
||||
|
|
@ -30,4 +30,4 @@ 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 gameservers run 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.
|
||||
|
||||
The gameserver connects to the API with the launch argument `"-apiendpoint=<IP>:<port>"`, where `port` is the port that the listener listens on and the `IP` is the IP of the API server.
|
||||
The gameserver connects to the API with the launch argument `"-apiendpoint=<IP>:<port>"`, where `<port>` is the port that the listener listens on and the `<IP>` is the IP of the API server.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,35 @@
|
|||
# BattleBit Remastered Community Server API
|
||||
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
|
||||
Language [English](/README.md) | [中文](/README-zhCN.md) | 한국어
|
||||
|
||||
이 레포지토리는 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를 사용하는 방법은 `Player` 및 `GameServer`의 *자체* 서브클래스의 유형을 전달하는 `ServerListener` 인스턴스를 생성하고 이를 시작하는 것입니다.
|
||||
|
||||
이러한 서브클래스에서는 `Player` 및 `GameServer`에 이미 존재하는 메서드를 오버라이드하여 자신만의 메서드, 필드 및 프로퍼티를 추가할 수 있습니다
|
||||
|
||||
가장 쉬운 방법은 `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 서버(주소와 포트)를 지정할 수 있습니다.
|
||||
|
||||
게임 서버는 실행 인수 `-apiendpoint=<IP>:<PORT>`를 사용하여 API에 연결합니다. 여기서 <PORT>는 리스터가 수신하는 포트이고, IP는 API 서버의 IP입니다.
|
||||
Loading…
Reference in New Issue