mirror of
https://github.com/MrOkiDoki/BattleBit-Community-Server-API.git
synced 2025-01-25 02:33:08 -03:00
cabcb5dd33
* Readme add KR version add how to set apiEndPoint * readme update * Update README.md * Update README_koKR.md * KR readme update * Update README.md --------- Co-authored-by: Julgers <141361545+Julgers@users.noreply.github.com>
2.4 KiB
2.4 KiB
BattleBit Remastered Community Server API
이 레포지토리는 BattleBit Remastered 커뮤니티 서버에서 이벤트를 처리하고 조작하는 데 사용할 수 있는 API를 제공합니다.
Getting started
Prerequisites
- BattleBit Remastered 커뮤니티 서버를 개설할 수 있는 권한을 보유하고 BattleBit Remastered 에서 요구하는 조건을 충족해야 합니다.
- .NET 6.0을 이용해 C# 코드를 작성하고 컴파일할 수 있어야 합니다.
- (프로덕션 한정) 이 API를 호스팅할 장소가 필요합니다.
Writing
문서와 예제는 wiki에서 확인할 수 있습니다.
이 API를 사용하는 방법은 Player
및 GameServer
의 자체 서브클래스의 유형을 전달하는 ServerListener
인스턴스를 생성하고 이를 시작하는 것입니다.
이러한 서브클래스에서는 Player
및 GameServer
에 이미 존재하는 메서드를 오버라이드하여 자신만의 메서드, 필드 및 프로퍼티를 추가할 수 있습니다
가장 쉬운 방법은 Program.cs
에 직접 코드를 추가/작성한 후 프로젝트를 빌드하는 것입니다.
Build
이 프로젝트는 CMD에서 dotnet build
를 사용하거나 선호하는 IDE에서 Run / Build 옵션을 이용하여 빌드할 수 있습니다.
Connecting to the gameserver
API를 작성하고 컴파일한 후, 다른 곳에서 호스팅하고 싶을 수도 있습니다. 게임 서버가 실행되는 서버와 동일한 서버일 수 있으며 완전히 다른 서버일 수도 있습니다. 보다 원활하고 빠른 통신을 위해 게임 서버와의 지연 시간을 최소화하는 것이 좋습니다. 동일한 ServerListener
를 동시에 여러 게임 서버에 사용할 수 있습니다. 게임 서버의 실행 옵션에서 API 서버(주소와 포트)를 지정할 수 있습니다.
게임 서버는 실행 인수 -apiendpoint=<IP>:<PORT>
를 사용하여 API에 연결합니다. 여기서 는 리스터가 수신하는 포트이고, IP는 API 서버의 IP입니다.