Merge branch 'main' of https://github.com/MrOkiDoki/BattleBit-Community-Server-API
This commit is contained in:
MrOkiDoki
commit
4c0fb56f04
|
|
@ -0,0 +1,33 @@
|
|||
|
||||
# BattleBit Remastered 服务器 API
|
||||
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
|
||||
Language [English Readme](/README.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 的地址和端口进行设定。
|
||||
42
README.md
42
README.md
|
|
@ -1,6 +1,8 @@
|
|||
# BattleBit Remastered Community Server API
|
||||
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
|
||||
Language English | [中文](/README-zhCN.md)
|
||||
|
||||
This repository provides an API that can be used to handle events on your community server(s) and manipulate them.
|
||||
|
||||
|
|
@ -14,11 +16,11 @@ This repository provides an API that can be used to handle events on your commun
|
|||
|
||||
### Writing
|
||||
|
||||
Documentation and examples can be found on the [wiki](https://github.com/MrOkiDoki/BattleBit-Community-Server-API/wiki).
|
||||
Documentation and examples can be found on the [wiki](https://github.com/MrOkiDoki/BattleBit-Community-Server-API/wiki) (WIP).
|
||||
|
||||
The way to use this API is to make an instance of `ServerListener` (and start it) on which you pass the types of your *own* subclasses of `Player` & `GameServer`. In those subclasses, you can make your own overrides to the already existing methods in `Player` and `GameServer`. You can also add your own methods and fields/properties.
|
||||
|
||||
The way to use this API is to make an instance of `ServerListener` and add your own handlers to certain events that happen on your server(s).
|
||||
The easiest way to do this, is to add/put your own code in `Program.cs` and then build the project.
|
||||
The easiest way to get started with all of this, is to use `Program.cs` and add your overrides etc. into `MyPlayer` & `MyGameServer`.
|
||||
|
||||
### Building
|
||||
|
||||
|
|
@ -27,35 +29,3 @@ This project can either be built by using [`dotnet build`](https://learn.microso
|
|||
### Connecting to the gameserver
|
||||
|
||||
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
|
||||
|
||||
[](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 的地址和端口进行设定。
|
||||
|
|
|
|||
|
|
@ -1,16 +1,15 @@
|
|||
version: "3.8"
|
||||
version: "3.8"
|
||||
|
||||
# In the docker compose file, we define some services (containers) to run.
|
||||
# This will be geared towards production.
|
||||
services:
|
||||
|
||||
battlebit-community-api:
|
||||
image: bb-cummunity-server-api:latest
|
||||
image: bb-community-server-api:latest
|
||||
build:
|
||||
# Specify how to build the image above.
|
||||
context: .
|
||||
target: build
|
||||
|
||||
restart: always
|
||||
ports:
|
||||
- "29294:29294"
|
||||
- "29294:29294"
|
||||
|
|
|
|||
Loading…
Reference in New Issue