Skip to main content

​
Installing the Kyber Launcher

The Kyber Launcher is the primary way to play on Kyber servers. This guide covers both user installation and building from source.

​
Prerequisites

You must have Star Wars Battlefront II (2017) installed on your system before installing Kyber.
Required:
  • Windows 10 or later (64-bit)
  • Star Wars Battlefront II (2017) via Steam, Origin, or EA App
  • Visual C++ 2017 Redistributable or later
  • 500MB free disk space for the launcher
  • Additional space for mods (varies)
Optional:
  • EA Account (required to play)
  • Nexus Mods account (for mod downloads)
  • Discord account (for community features)

​
End User Installation

1

Download the Installer

Get the latest KyberLauncherInstaller.exe from kyber.gg.The installer is built using Inno Setup and includes:
  • The launcher application
  • Required dependencies (7z, UnRAR libraries)
  • Visual C++ Redistributable (if needed)
2

Run the Installer

Execute KyberLauncherInstaller.exe and follow the setup wizard:
  1. Accept the license agreement
  2. Choose installation directory (default: C:\Program Files\KYBER Launcher)
  3. Select additional tasks:
    • Create desktop icon (optional)
  4. Click Install
The installer will automatically:
  • Create C:\ProgramData\Kyber with proper permissions
  • Create C:\ProgramData\Kyber\Module for game modules
  • Register .kbcollection file associations
  • Add Kyber to your Start Menu
3

First Launch

After installation completes, you can choose to launch Kyber immediately.On first run:
  1. The launcher will detect your Battlefront II installation
  2. You’ll be prompted to link your EA account
  3. The latest game module will be downloaded to C:\ProgramData\Kyber\Module\Kyber.dll
The module path was moved to C:\ProgramData in beta9 to prevent issues with non-ASCII characters in user profile paths.

​
File Locations

After installation, Kyber uses the following directories: | Path | Purpose | |------|---------|| | C:\Program Files\KYBER Launcher | Application binaries | | C:\ProgramData\Kyber\Module | Game module (Kyber.dll) | | %APPDATA%\Kyber | User settings and cache | | %LOCALAPPDATA%\Temp | Mod browser cache |
The C:\ProgramData\Kyber directory requires write permissions for all users to allow module updates.

​
Building from Source

Developers can build Kyber components from source. Each component has specific requirements.

​
Global Prerequisites

1

Clone the Repository

Clone with submodules to get all dependencies:
git clone --recurse-submodules https://github.com/ArmchairDevelopers/Kyber.git
cd Kyber
If you already cloned without submodules:
git submodule update --init --recursive
2

Install Protobuf Compiler

Download and install Protoc and ensure protoc is in your PATH.Verify installation:
protoc --version

​
Building the Launcher

The launcher is built with Flutter and includes Rust components for native performance.
1

Install Dependencies

Required tools:Install Melos globally:
dart pub global activate melos
2

Bootstrap the Workspace

From the repository root:
melos bootstrap
This command:
  • Installs all Dart dependencies
  • Generates protocol buffer bindings
  • Runs code generation for all packages
3

Generate FFI Bindings

Navigate to the Launcher directory and generate FFI bindings:
cd Launcher
dart run tool/ffigen.dart
4

Run in Debug Mode

Test the launcher in development:
flutter run
Use flutter run -d windows to explicitly target Windows if you have multiple platforms configured.
5

Build Release Binary

Create an optimized release build:
flutter build windows
The output will be in build/windows/x64/runner/Release/.
6

Build the Installer (Optional)

To create the installer:
  1. Install Inno Setup
  2. Navigate to Launcher/installer/
  3. Open installer.iss in Inno Setup
  4. Click Build > Compile
The installer will be generated as KyberLauncherInstaller.exe.

​
Building the Module

The game module is a C++ DLL injected into Battlefront II.
The Module can only be compiled on Windows with MSVC. Building without --config=release will cause crashes.
1

Install Build Tools

Required:
  • Visual Studio 2019+ with MSVC
  • MSYS2 installed to C:\msys64
  • Bazelisk renamed as bazel.exe in PATH
2

Create Build Directory

Due to Windows path length limitations:
mkdir C:\bz
This folder stores Bazel’s intermediate build files.
3

Build the Module

From the repository root:
bazel --output_user_root="C:\bz" build --config=release Kyber
Or use the provided batch file:
.\build.bat
The first build will take a while as Bazel downloads and compiles all dependencies.
4

Install the Module

Copy the built DLL to the Kyber module directory:
copy Module\bazel-bin\Kyber.dll C:\ProgramData\Kyber\Module\Kyber.dll
The launcher will use this module when launching the game.

​
Module Development Setup

For code completion in VS Code:
  1. Install the clangd extension
  2. Navigate to the Module directory: 
    cd Module
  3. Generate compile_commands.json: 
    clangd\refresh.bat

​
Building the API

The API service is written in Go.
1

Install Go

Requires Go 1.24 or later from go.dev.
2

Install Protoc Plugins

go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
3

Generate Protobuf Files

Linux/macOS:
cd API
./scripts/gen-proto.sh
Windows:
cd API
scripts\gen-proto.bat
4

Build the API

Linux/macOS:
go build -o kyber-api ./cmd/server
Windows:
go build -o kyber-api.exe ./cmd/server

​
Building the Proxy

The proxy is written in Rust for maximum performance.
1

Install Rust

Requires Rust nightly toolchain from rustup.rs.
rustup toolchain install nightly
rustup default nightly
2

Build the Proxy

cd Proxy
cargo build --release
Output: target/release/kyber_proxy (or kyber_proxy.exe on Windows)

​
Building the CLI

The CLI provides command-line tools for server management.
1

Install Dependencies

Same as the Launcher:
  • Flutter (master channel)
  • Rust (nightly)
  • Melos (installed globally)
2

Build the CLI

cd CLI
flutter pub get
flutter_rust_bridge_codegen generate
dart compile exe bin/kyber_cli.dart
Output: build/cli/<platform>/bundle/bin/kyber_cli
3

Prepare Runtime Files

The CLI requires additional files to run:
  1. Copy the Rust library from build/cli/<platform>/bundle/lib/ next to the binary
  2. Build Maxima first (part of the build process)
  3. Copy platform-specific files next to the binary:
Windows:
  • maxima-service.exe
  • maxima-bootstrap.exe
Linux:
  • maxima-bootstrap

​
Uninstalling Kyber

To completely remove Kyber from your system:
  1. Run the uninstaller from Add or Remove Programs in Windows Settings
  2. Manually delete these directories if they remain:
    • C:\ProgramData\Kyber
    • %APPDATA%\Kyber
    • %LOCALAPPDATA%\Kyber
  3. (Optional) Remove downloaded mods from your custom mod directory
Uninstalling Kyber does not affect your Star Wars Battlefront II installation or save data.

​
Next Steps

Quick Start

Learn how to use the launcher and join servers

Contributing

Start contributing to the Kyber project

API Reference

Explore the API documentation for developers

Troubleshooting

Common issues and solutions

Build docs developers (and LLMs) love

Get started for freeTalk to us