Python bindings and project tools for the Pilot Light real-time application framework.

About • Installation • Quick Start • Python API • Development • License

pilotlight-python provides Python bindings and development tools for the Pilot Light real-time application framework.

It can be used to:

• create Pilot Light projects from ready-to-use templates
• prototype real-time applications in Python
• access Pilot Light engine systems through Python
• build development tools and editor workflows
• automate asset processing and other engine tasks

Pilot Light is designed around a modular collection of APIs and extensions. Applications can use only the systems they need while retaining access to rendering, input, UI, ECS, asset loading, and other framework features.

Install the latest published version from PyPI:

python -m pip install pilotlight

To upgrade an existing installation:

python -m pip install --upgrade pilotlight

Wheels are published for CPython 3.14 on:

• Windows (x64) — requires a GPU driver with Vulkan support.

• Linux (x86_64, glibc 2.35+) — requires a GPU driver with Vulkan support and X11. The Vulkan loader and X11/xcb libraries are not bundled; on Debian/Ubuntu they can be installed with:

  sudo apt install libvulkan1 libx11-6 libx11-xcb1 libxcb1 libxcb-cursor0 libxcb-xfixes0 libxcb-keysyms1 libxkbcommon0

• macOS (Apple Silicon, macOS 15+) — uses Metal, no additional dependencies.

The project generator is the recommended starting point for new applications:

python -m pilotlight new <project-name> [options]

For example:

python -m pilotlight new MyGame -2d

Use -3d for the 3D template (the default is -2d).

This creates a new MyGame directory containing the files and configuration needed to get started.

MyGame/
├── ...
└── ..

Using the generator helps ensure that a new project has the expected structure, startup code, build configuration, and supporting files for the installed Pilot Light version.

You can now run the project like so:

cd MyGame
python src/app.py

The generated projects are the best starting point for now; the repository's sandbox/app.py shows more of the API (3D drawing, UI, textures, and 2D drawing). Documentation is lacking at the moment but will come soon.

The Python API is still under active development. Some names and interfaces may change between releases until the package reaches a stable version.

WIP

• Pilot Light — core real-time application framework

The project is under active development.

Bug reports, documentation improvements, examples, and other contributions are welcome through the GitHub issue tracker.

pilotlight-python is licensed under the MIT License, matching the core Pilot Light framework. Third party components bundled with or compiled into the published wheels are listed in THIRD_PARTY_NOTICES.md.