BattleBit Community Server API

Website	BattleBit Discord	Community Hosting Discord	Get Server List API	Steam

Table of Contents

0. Introduction
1. Prerequisites
2. Installation
3. How to Contribute
4. License

0. Introduction

Before start, you need to keep in mind:

1. You will have to sign some sort of agreement (TOS) - Eula from BattleBit that you agree to not misuse the whitelisted IPs for server browser.
2. You will be allowed to mod the servers.
3. You won't have progression from official stats of the players, you can make it;
   • Your players enters server with their official stats but they won't able to progress it.
   • Connect your backend preferable anything you want (BattleBit will create the API for you to connect what ever you want, a database, use disk, use memory as database or Web Requests, etc) and you will be responsible of storing/retrieving stats of your players.

1. Prerequisites

Before installing, there are certain tools and applications you will need which differs between the varying operating systems available.

Hardware

Hardware Type	Minimum	Recommended
CPU	2 Core	4 Cores
RAM	4 GB	8 GB
Disk Space	2 GB	10 GB

CPU

Fabricator	Minimum	Recommended
Intel	Xeon 2288G	Xeon 2388G
AMD	Ryzen 7 5700X	Ryzen 7 5900

Operating System & Preferred Compiler

Operating System	Compiler
Linux	.NET Core 6.0
Windows	MS Visual Studio 2017 or newer

Supported Databases

Database	Version
MySQL	5 or newer
MariaDB	5 or newer
Postgres	12 or newer

2. Installation

TODO: Add the installation step

3. How to Contribute

Details on how to contribute can be found in CONTRIBUTING.md!

4. License

Copyright (c) MrOkiDoki - Licensed under MIT License