Note: There are ways to tweak this configuration, feel free to change things! These instructions are intended to be the most direct path to get a working Stream Deck Python plugin up and running on your machine.

Prerequisites

1. Elgato Stream Deck (tested with Elgato Stream Deck V1, but should work with any model).

2. Stream Deck Software (https://www.elgato.com/en/downloads).

3. Windows 10 system (have not needed to distribute on Linux/Mac yet).

4. python-3.8 or higher (https://realpython.com/installing-python/#how-to-install-from-the-full-installer).

   Make sure that the python executable is in your system path (https://docs.python.org/3/using/windows.html#setting-envvars)

Environment Setup

Open a command line in the project folder. Create a virtual environment with the following command:

.../streamdeck_python_plugin/> python -m venv .venv

Activate this new virtual environment:

.../streamdeck_python_plugin/> .venv\Scripts\activate.bat

Make sure pip is up-to-date:

.../streamdeck_python_plugin/> python -m pip install --upgrade pip

Install packages from requirements.txt file:

.../streamdeck_python_plugin/> pip install -r requirements.txt

Creating a Stream Deck Plugin

Creating a Stream Deck python plugin consists of 4 steps.

1. Write the python code.

main.py is where the Elgato Stream Deck runs code from.

The Plugin().process_streamdeck_data() function in plugin_core.py is where actions can be performed based on updates from the Stream Deck app:

...
def process_streamdeck_data(self, data):
    """Process data from Stream Deck and perform actions.

    Args:
        data (dict): Data dictionary.
    """

    logging.info(f"Processing data: {data}")

Based on the data from the app, different actions can be programmed.

Reference for data structures that can be received: https://developer.elgato.com/documentation/stream-deck/sdk/events-received/.

Reference for data structures that can the sent: https://developer.elgato.com/documentation/stream-deck/sdk/events-sent/.

2. Create an executable from the python code.

To create the executable pyinstaller will be used. Navigate to the plugin folder and run the following command to create the executable:

.../streamdeck_python_plugin/streamcom.streamdeck-python-plugin.sdPlugin/plugin> pyinstaller main.py

This will create a dist and build folder in the plugin folder.

The path to the executable will be plugin/dist/main.exe.

Note: pyinstaller will find all imports and include them in the build. There are some external libraries where additional setup is needed, in which case some customization will be needed (https://pyinstaller.readthedocs.io/en/stable/operating-mode.html#analysis-finding-the-files-your-program-needs)

3. Set up manifest.json to point to the executable.

If no modifications are made to the image filenames and the executable path doesn't change, the manifest.json can be left as is.

Otherwise, use this documentation from Elgato as reference: https://developer.elgato.com/documentation/stream-deck/sdk/manifest/

4. Package the plugin using the package distribution tool provided by Elgato.

Reference: https://developer.elgato.com/documentation/stream-deck/sdk/exporting-your-plugin/

Finally, to install the plugin in the Stream Deck app, Elgato has provided a distribution tool for both Mac and Windows.

Run this command from the command line in the project folder:

.../streamdeck_python_plugin/> tools/DistributionTool.exe -b -i com.streamdeck-python-plugin.sdPlugin -o release

com.streamdeck-python-plugin.sdPlugin is the plugin folder, and the value after -o is where the distribution file will be put.

In the above case , you should find a com.streamdeck-python-plugin.streamDeckPlugin file in the release folder.

Double clicking com.streamdeck-python-plugin.streamDeckPlugin will install your plugin in the Stream Deck App.

Development

During development, if you make changes to the plugin code and rebuild it, you will need to uninstall the old plugin first before installing the updated plugin in the Stream Deck App. MAKE SURE YOU ARE NOT ACCESSING THE APP PLUGIN FOLDER WHEN YOU DOUBLE CLICK/RUN com.streamdeck-python-plugin.streamDeckPlugin (C:\Users\\(user)\AppData\Roaming\Elgato\StreamDeck\Plugins\\(plugin-name) for Windows). The uninstall will not complete properly if so and you may have to restart your system, close the Stream Deck app, and delete the plugin folder manually from the App Plugin folder as an administrator.

Potential Error Messages

WARNING: lib not found: api-ms-win-core-path-l1-1-0.dll dependency of ...\python\python39\python39.dll

Context: occurs sometimes when running pyinstaller (will be in the command line output, and the executable will not run).

Solutions:

• Uninstall and re-install python

  Do not have a good explanation for this fix other than that it worked for me. May be that the python paths were not set up properly.