SDPL

A 3rd-party environment launcher for Stream Deck plugins.

Notice

This project requires StreamDeck v4.2 or later

Goal

SDPL aims to provide a wrapper for launching and monitoring 3rd-party runtime environments for use as a Stream Deck plugin; examples include launching NodeJS, PHP, Ruby, Perl, Java and so forth

Currently, Stream Deck does not allow plugins to specify arguments to be passed to an executable. This is very limiting as most runtime environments consist of an executate that requires arguments indicating which file it should process. SPDL provides such functionality along with a few QOL features

Features

• Runtimes can be launched with arguments
• Can launch executables via environment/PATH variables
• Logs all outputs from the executable to <plugin_dir>/logs/sdpl.log

Usage

1. Download the latest Release
2. Extract to your plugin's directory
3. Edit your plugins manifest.json file as indicated below
4. Launch Streamdeck

manifest.json

All SDPL configuration options are housed in the manifest.json under "SDPL"

{
    // ... rest of manifest ...

    // CodePath should point to the executable created after building
    "CodePath": "sdpl/sdpl.exe",
    "SDPL": {

        // "HideWindow" as Boolean - Optional - Defaults to true
        //     Set to true if the process's main window should be hidden
        "HideWindow": true,

        // "Path" as string - Required
        //     Path to the executable to run
        //     Can be an environment variable such as 'node' or 'java'
        //     If a relative path is used it is relative to the plugin's directory
        "Path": "node",

        // "Arguments" as string - Optional - Defaults to an empty string
        //     Arguments to pass to the executable upon launch
        "Arguments": "-v"
    }
}