Skip to content

Installation

Adrian Preuß edited this page Oct 25, 2025 · 3 revisions

The installation process is fairly simple and is handled by the package manager npm:

npm install --save battlefield6-api

After installation, you can directly switch to Usage!

Development

If you would like to contribute to this project, additional software must be installed:

Protobuf

WinGet install Google.Protobuf

Initial Project setup

First, clone this repository:

git clone https://github.com/Battlefield6/API.git

after an initial fetch, you need to install all depencies:

cd ./API/

npm install

We using IntelliJ IDEA (Ultimate) for development, because the tool sets for unit tests and general development are much more user-friendly than in Visual Studio Code.

However, you can also use VSCode or any other editor or IDE as long as the code base remains the same.

General

The actual abstraction layer for retrieving or sending data from the portal server.

⠀⠀ Installation

⠀⠀ Usage

⠀⠀ Examples

Backends

The actual abstraction layer for retrieving or sending data from the portal server.

⠀⠀ Blueprints

⠀⠀ Experience

⠀⠀ Mods⠀⠀⠀⠀

⠀⠀ PlayElements

Models

Model data for simplified use of the data.

⠀⠀ Blueprint

⠀⠀ Creator

⠀⠀ Design

⠀⠀ Map

⠀⠀ MapRotation

⠀⠀ Option

⠀⠀ PlayElement

⠀⠀ Settings

⠀⠀ Tag

⠀⠀ Team

⠀⠀ TeamComposition

Enum

Static data and informations.

⠀⠀ CreatorType

⠀⠀ OptionType

⠀⠀ Status


Clone this wiki locally