Building

The build process for Pilot Light is simple and will stay that way. We do not use a build system. You can use whatever editor or IDE you want. We prefer to use Visual Studio Code which in our opinion provides the most uniform experience across multiple platforms.

If you are using Visual Studio Code, run python scripts/setup.py from terminal to generate the .vscode folder we use and continue to the appropriate operating system section below.

[!NOTE]
The instructions below use the build scripts checked into the repo. They can be generated by running python3 gen_build.py in the scripts folder.

Windows

Requirements

• python 3
• git
• Vulkan SDK
• Visual Studio 2022 or greater (just for the toolchain) with the following workflows:
  • Desktop development with C++
  • Game development with C++

Instructions

From within a local directory, enter the following commands in your terminal:

git clone https://github.com/PilotLightTech/pilotlight
cd pilotlight/src
build_win32.bat

Binaries will be in pilotlight/out/.

Linux

Requirements

• git
• Vulkan SDK
• X11 & XCB

Environment Setup

Those installing the required packages may find the following guide useful: link.

Instructions

From within a local directory, enter the following commands in your terminal:

git clone https://github.com/PilotLightTech/pilotlight
cd pilotlight/src
chmod +x build_linux.sh
./build_linux.sh

Binaries will be in pilotlight/out/.

MacOS

Requirements

• git
• Vulkan SDK
• Xcode

Instructions

From within a local directory, enter the following commands in your terminal:

git clone https://github.com/PilotLightTech/pilotlight
cd pilotlight/src
chmod +x build_macos.sh
./build_macos.sh

Binaries will be in pilotlight/out/.

Additional Assets

Run the download_assets.py script with the "-gltf" and "-dev" options.