The server/client for community servers API.
Go to file
Julgers 078108207f
Merge pull request #105 from livingflore/main
Russian README translation
2024-05-23 11:11:33 +02:00
.github/ISSUE_TEMPLATE Remove GH workflows 2023-08-24 13:08:52 +02:00
BattleBitAPI Default modifications fixed. 2023-11-30 08:36:00 +03:00
.dockerignore Add docker support 2023-08-11 13:56:04 +02:00
.gitignore Add docker support 2023-08-11 13:56:04 +02:00
CommunityServerAPI.csproj Default modifications fixed. 2023-11-30 08:36:00 +03:00
CommunityServerAPI.sln Squad implementation 2023-08-20 10:39:00 +03:00
docker-compose.yml Fix mistake in docker-compose.yml 2023-08-11 23:38:52 +02:00
Dockerfile Add docker support 2023-08-11 13:56:04 +02:00
LICENSE Initial commit 2023-03-03 15:09:34 +03:00
README-esES.md Update README(s) 2024-05-23 01:26:06 +05:00
README-koKR.md Update README(s) 2024-05-23 01:26:06 +05:00
README-ptBR.md Update README(s) 2024-05-23 01:26:06 +05:00
README-ruRU.md Create README-ruRU.md 2024-05-23 01:25:57 +05:00
README-zhCN.md Update README(s) 2024-05-23 01:26:06 +05:00
README.md Update README(s) 2024-05-23 01:26:06 +05:00

BattleBit Remastered Community Server API

License: MIT

Language English | 中文 | Русский | 한국어 | Español | Português

This repository provides an API that can be used to handle events on your community server(s) and manipulate them.

Getting started

Prerequisites

  • Your own community server within BattleBit Remastered with progression disabled and access to its launch options.
  • The ability to write and compile .NET 6.0 C# code.
  • (for production) A place to host this API on.

Writing

Documentation and examples can be found on the 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 easiest way to get started with all of this, is to use Program.cs and add your overrides etc. into MyPlayer & MyGameServer.

Building

This project can either be built by using dotnet build on the command-line or by using the run / build options inside your preferred IDE.

Alternatively, you can use Docker to run it. An easy way to do this it to run docker compose up.

Connecting to the gameserver(s)

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.

Gameserver start arguments

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.

If Api Token verification is required in your Server API, you need to add "-apiToken=<ApiToken>" to the startup parameters of the gameserver(s). Should <ApiToken> the same as Api Token defined in Server API, gameserver(s) can communicate with Server API.

When the gameserver is up, you can also directly modify the Api Token of the gameserver by entering setapitoken <new token> in its command line.

Adjust API listening port

The project is currently configured to have the API listen on port 29294. If you want to change this, make sure to change it in the code (on your listener.start(port)). Port 29294 is also exposed in Docker and bound to the same port on the host in Docker Compose. This means that when using Docker, you will have to change the port in the Dockerfile and in docker-compose.yml (when using Compose) as well. See EXPOSE in the Dockerfile reference and networking in Compose.