Documentation for PyDeck — a Python-powered, web-based macro deck that lets you trigger actions from buttons in a browser UI.
Live site: docs.pydeck.no
This repository contains the official developer documentation for PyDeck. It covers how to extend PyDeck through plugins and themes, and how to maintain a plugin catalog for the marketplace.
The docs live in the docs/ folder and are published to docs.pydeck.no via GitHub Pages.
| File | Description |
|---|---|
docs/pydeck/PLUGIN_DEVELOPMENT.md |
How to build, test, and ship a PyDeck plugin — covers manifest.json, plugin.py, UI fields, credentials, OAuth, WebSocket events, and more. |
docs/pydeck/THEME_DEVELOPMENT.md |
How to create and ship a PyDeck theme — covers CSS variables, single-file and multi-variant themes, and the theme loader. |
docs/pydeck/MARKETPLACE_REPO.md |
How the PyDeck marketplace works — covers the two-repo architecture, catalog manifest.json format, the install flow, and common errors. |
docs/pydeck/SPOTIFY_SETUP.md |
Step-by-step guide to connecting Spotify — create a Developer Dashboard app, configure the redirect URI, authorize, and add playback buttons. |
docs/pydeck/DISCORD_SETUP.md |
Step-by-step guide to connecting Discord — create a Developer Portal application, enable RPC, authorize, and add mute/deafen buttons. |
| File | Description |
|---|---|
docs/pydeck-plugins/GENERATE_MANIFEST.md |
How to use generate_manifest.py — regenerates the root manifest.json by scanning the plugins/ directory tree. |
docs/pydeck-plugins/SYNC_FROM_PYDECK.md |
How to use sync_from_pydeck.py — syncs plugin source files from a local pydeck checkout into the catalog repo with automatic version bumping. |
docs/pydeck-plugins/RELEASE_STABLE.md |
How to use release_stable.py — promotes the canary branch to stable and restores the canary label in one automated step. |
| Repo | Description |
|---|---|
opvault/pydeck |
The main PyDeck application (FastAPI server, web UI, hardware listener). |
opvault/pydeck-plugins |
The official plugin catalog repo used by the PyDeck marketplace. |