README file modify (#23)
* 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>
This commit is contained in:
halfdog
GitHub
parent
d890dcd1f0
commit
cabcb5dd33
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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입니다.
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
|
||||
# BattleBit Remastered 服务器 API
|
||||
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
|
||||
Language [English Readme](/README.md) | 中文 | [한국어](/README_koKR.md)
|
||||
|
||||
这个 repo 是 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` 的监听进程，传递你*自己定义*的`Player` 和 `GameServer` 类型覆盖原本游戏自身的`Player` 和 `GameServer`类型。在这些类型中添加任何你想要的功能，以此来定制属于你自己的游戏玩法。
|
||||
如果想给你的服务端添加功能，可以直接把覆盖的功能写在 `Program.cs` 的 `MyPlayer` 和 `MyGameServer`中，当然也可以按照框架规范进行其他的功能纂写。
|
||||
|
||||
|
||||
### 编译
|
||||
|
||||
可以直接使用 [`dotnet build`](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-build) 的命令进行编译，或者在你的 IDE 中自定义编译.
|
||||
|
||||
### 连接服务端
|
||||
|
||||
当你将此项目的功能写完并进行了编译后，需要将此 API 服务进行部署。此 API 服务可以部署在本地网络、本机网络或者广域网中。我们强烈建议以「最低延迟」为基准进行部署，以保证 `ServerListener` 可以同时监听 *多个* 游戏服务端。
|
||||
你可以在游戏服务端的启动配置中对 API 的地址和端口进行设定。
|
||||
Loading…
Reference in New Issue