streamdeck-clicker

Stream Deck plugin to automate the mouse in macOS.

Development

Install

streamdeck link com.dtrt.clicker.sdPlugin/

If you receive the error Linking failed due to a UUID clash

cd ~/Library/Application\ Support/com.elgato.StreamDeck/plugins/ && unlink com.dtrt.clicker.sdPlugin/

Watch for code changes

# rebuild and restart the plugin after code changes
# note: you may have to delete the instance from the button and drag a new one in to see changes to `States` or Property Inspector
npm run watch

To quit Stream Deck app, use the icon in the top right menu bar.

Logging

Node

import streamDeck, { LogLevel } from "@elgato/streamdeck";
const logger = streamDeck.logger.createScope("Clicker")
logger.setLevel(LogLevel.TRACE);

logger.error('...');
logger.info('...');

Frontend

console.log('...');

1. Open Property Inspector inside Stream Deck
2. View the console at http://localhost:23654/
3. Select com.dtrt.clicker Property Inspector

Debug UI

The default debugger is available at http://localhost:23654/ but it can be slow to debug layout here.

Since all paths are relative, another option is to open /com.dtrt.clicker.sdPlugin/property-inspector/inspector.html directly in a web browser.

Links

• Create a Stream Deck Plugin to Interact with Webhooks
• streamdeck-plugin-template - official frontend JS template
• How to add the library to plugins incl those using the Node SDK: Get the latest library: Add Submodule
• SDK documentation
• Plugin showing all supported HTML elements: Samples: PISamples
• Marketplace Makers Discord channel
• MVF1-Streamdeck shows how Property Inspector events are done

Tips

• Node methods are namedspaced, see com.dtrt.clicker.sdPlugin/bin/plugin.js

Attributions

• v5.1 of cliclick - thanks @BlueM for a wonderful library!
• @elgato/cli for plugin scaffolding
• Stream Deck SDK for Node.js (Beta)
• Pure CSS Custom Checkbox Style
• Icons created using Button Creator for Stream Deckl, SF Symbols and Inkscape