Development
Build firmware, Native SD Apps, and GhostScript extensions for GhostESP
Build GhostESP from source or extend an installed device without changing its firmware.
Choose an extension model
| GhostScript | Native SD Apps | |
|---|---|---|
| Best for | Automation, event-driven workflows, and chaining existing GhostESP features | Full interactive apps, custom UI, direct hardware access, and performance-sensitive work |
| Language | Lua 5.4 source compiled to .gsb | C compiled to a target-specific ESP-IDF shared object |
| Toolchain | Python and ghostbt; ESP-IDF is not required | Python, GBT, and ESP-IDF |
| Portability | One script package across supported boards, subject to available hardware | Build one package for each ESP target architecture |
| Runtime model | Constrained Lua environment with permission-checked GhostESP APIs | Trusted native code running in the firmware process |
| Device support | Designed to work with and without PSRAM | The on-device Apps gallery currently exposes third-party native apps only on PSRAM-equipped boards |
Start with GhostScript when the available Lua APIs can perform the job. Choose a Native SD App when you need custom widgets, lower-level peripherals, or native performance.
Native app permissions gate the official SDK functions, but native apps are not sandboxed. Only install native packages from developers you trust.
Development paths
- GhostScript — write, compile, install, and debug Lua automation packages.
- Native SD Apps — build target-specific C apps with the native SDK.
- GBT — use the current build, packaging, GhostScript compiler, firmware, and serial commands.
- Environment Setup — prepare ESP-IDF for firmware and native app development.
- Custom Board Configurations — add or adjust supported hardware.
Environment Setup
Install ESP-IDF and configure your development environment for GhostESP.
Adjusting build options
Use the build helper to edit GhostESP configuration options.
Custom Board Configurations
Create and customize board profiles for GhostESP.
Hardware Integration
Understanding hardware quirks and bus conflicts in GhostESP.
Native SD Apps
Build and run native plug-in apps from the SD card with the GhostESP SDK.
GBT (Ghost Build Tool)
Build and package Native SD Apps, compile GhostScript, and manage GhostESP firmware.