AirDeck plugin developer guide
Build your first plugin, then explore the complete developer reference.
A plugin gives AirDeck a new desktop action that a person can put on their phone's deck. Your code runs on AirDeck Helper, on the computer. The public SDK connects that code to the helper and handles communication for you.
Choose the section that matches what you need now.
Get started: build something that works
Start the guided tutorial if you are creating your first plugin. You will make a new project, understand its files, build a package, test it without the app, and install it on the helper. Choose Go, Python, Java or C++.
The starter has one Say hello button. When the button runs, it writes Hello from AirDeck! to the plugin's diagnostic output. This gives you a small, predictable project to extend.
Follow the steps in order. Each page explains what a command does and what success looks like. You do not need to understand the full message protocol before starting.
Documentation: look up how things work
Open the developer reference when you need exact information about manifests, button catalogs, SDK methods, permission-controlled capabilities, schemas, updates or distribution.
The reference is organized by topic. It includes complete method/type tables for the shipped core capabilities and explains the difference between an SDK, a plugin and a packaged release.
Source, price and ownership
The SDK and this documentation are public in codewhen/air_deck_plugin_sdk. Community members can contribute there. The SDK uses Apache-2.0; third-party files retain their own licenses.
Your plugin implementation can be open source or closed source, and its binary can be free or paid. Preserve the notices for dependencies you include. AirDeck-owned private plugins such as OBS are maintained separately from the public SDK.
What this guide covers
This guide covers executable plugin API v2 for AirDeck Helper on macOS and Windows. It explains deck actions and host capabilities. Dedicated custom mobile plugin screens are not part of the current public SDK.
The examples and starter packaging checks have been executed on macOS. Windows-specific instructions and launchers are included, but an actual Windows helper run is required before advertising Windows support.