Files
Momentum-Firmware/documentation/HowToBuild.md
2022-10-09 02:27:38 +03:00

1.8 KiB

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/RogueMaster/flipperzero-firmware-wPlugins.git

Building

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

Compile

Linux.MacOS

./fbt

Windows (powershell)

.\fbt.cmd

Production standard Options

./fbt
	--with-updater
	COMPACT=1
	DEBUG=0
	updater_package

Usefull options, check ./fbt -h and fbt.md for more

DEBUG=1 # Enable debug build
COMPACT=1 # Optimize for size
DIST_SUFFIX=custom # Suffix for binaries in build output for dist targets
CUSTOM_FLIPPER_NAME=Flipper # Replaces OTP flipper name with custom string of 8 chars
UPDATE_SPLASH=update_default # Directory name with slideshow frames to render after installing update package
LOADER_AUTOSTART= # Application name to automatically run on Flipper boot
FIRMWARE_APPS="{
	'default': ['crypto_start', 'basic_services', 'basic_apps', 'updater_app', 'archive', 'custom_apps', 'passport', 'system_settings', 'about', 'basic_plugins', 'custom_games', 'wifi_plugins', 'external_apps', 'debug_apps'],
	'unit_tests': ['basic_services', 'updater_app', 'unit_tests'],
	'ext_apps': ['basic_services', 'external_apps']}"
	# Map of (configuration_name->application_list)
-c # Clean

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.