unleashed-firmware/documentation/HowToBuild.md

How to Build by yourself:

Install required software

• Git - Download for Windows, on Linux/Mac install via package manager (brew, apt, ...)

For development:

• Git
• Python3
• VSCode

Clone the Repository

You should clone with

$ git clone --recursive https://github.com/Eng1n33r/flipperzero-firmware.git

Build on Linux/macOS

Check out documentation/fbt.md for details on building and flashing firmware.

Compile everything for development

./fbt

Compile everything for release + get updater package to update from microSD card

./fbt COMPACT=1 DEBUG=0 updater_package

Check dist/ for build outputs.

Use flipper-z-{target}-full-{suffix}.dfu to flash your device.

Build on Windows

Check out documentation/fbt.md for details on building and flashing firmware.

Compile everything for development

.\fbt.cmd

Compile everything for release + get updater package to update from microSD card

.\fbt.cmd COMPACT=1 DEBUG=0 updater_package

Check dist/ for build outputs.

Use flipper-z-{target}-full-{suffix}.dfu to flash your device.

Build with Docker

Prerequisites

1. Install Docker Engine and Docker Compose
2. Prepare the container:

docker-compose up -d

Compile everything for development

docker-compose exec dev ./fbt

Compile everything for release + get updater package to update from microSD card

docker-compose exec dev ./fbt COMPACT=1 DEBUG=0 updater_package

Check dist/ for build outputs.

Use flipper-z-{target}-full-{suffix}.dfu to flash your device.

If compilation fails, make sure all submodules are all initialized. Either clone with --recursive or use git submodule update --init --recursive.