How to install packages or reference packages from node? Like I want to use websocket functionality

Hello,

I found this project and am trying to reverse engineer how to run it right now. This is probably trivial for anyone who develops plugins for the stream deck, but I have no such experience.

I bet I will have figured it out by the time anyone replies, but its just a suggestion to write a quick start guide. Nothing fancy, just how do you run it.

I'll also be trying to extend this project to change the source on the AVR which would be my main use-case. If successful, I'll raise a PR.

I followed the exact steps in the README.md but the plugin doesnt show up on the Elgato Stream Deck.app on my macbook. I see old versions needed the DestributionTool, is this still the case? How can I debug this? I am not sure if restarting the Stream Deck application is enough to get the plugin to show.

Why is there a package-lock.json file in the repo but no package.json file?

Following the quick start guide, I got a 'fatal: No url found for submodule path 'src/com.elgato.template.sdPlugin/libs' in .gitmodules'.

Step to reproduce:

% git clone https://github.com/elgatosf/streamdeck-plugin-template
Cloning into 'streamdeck-plugin-template'...
remote: Enumerating objects: 362, done.
remote: Counting objects: 100% (79/79), done.
remote: Compressing objects: 100% (33/33), done.
remote: Total 362 (delta 57), reused 50 (delta 46), pack-reused 283
Receiving objects: 100% (362/362), 267.59 KiB | 4.69 MiB/s, done.
Resolving deltas: 100% (197/197), done.
% mv streamdeck-plugin-template/ test
% cd test
% mv src/com.elgato.template.sdPlugin/ src/dk.wetendorff.test.sdPlugin
% find . -type f \( -path './.*' -not -name '.gitmodules' -prune -o -name 'action.sketch' -prune -o -print \) | xargs sed -i '' 's/com.elgato.template/dk.wetendorff.test/g'

% git submodule init && git submodule update
fatal: No url found for submodule path 'src/com.elgato.template.sdPlugin/libs' in .gitmodules

Workaround (instead of 'git submodule init && git submodule update'):**

% rm -rf src/dk.wetendorff.test.sdPlugin/libs/
% git submodule add https://github.com/elgatosf/streamdeck-javascript-sdk src/dk.wetendorff.test.sdPlugin/libs/

System:

macOS Ventura 13.3
git 2.40.0

The 'Localization' key/section inside the localization json doesn't work. This worked with the old pi-samples libraries, but not with the new ones.

{
 ....
  "Localization": {
    "More info": "More info",
    "Message": "Message",
    "Click Me": "Click Me",
    "Button": "Button"
  }
}

I did not change much onConnected works but the onKeyUp won't do anything. Also linking the project into the plugin folder won't work as expected. I can't see the plugin in the stream deck then. Only with DistributionTool i can see it

/// <reference path="libs/js/action.js" />
/// <reference path="libs/js/stream-deck.js" />

const myAction = new Action('ch.sohneg.server-manager');

/**
 * The first event fired when Stream Deck starts
 */
$SD.onConnected(({ actionInfo, appInfo, connection, messageType, port, uuid }) => {
	console.log('Stream Deck connected!');
});

myAction.onKeyUp(({ action, context, device, event, payload }) => {
	console.log('Your key code goes here!');
});

myAction.onDialRotate(({ action, context, device, event, payload }) => {
	console.log('Your dial code goes here!');
});

Hi,

I am successfully using the setSettings / getSettings to save actions however I am unable to use the setGlobalSettings/getGlobalSettings in a similar manner. I can confirm that the onDidReceiveGlobalSettings event is being fired and there are no Streamdeck log entries (%AppData%/Elgato/StreamDeck/logs) that indicate the request was not accept.

Any help would be appreciated.

The following is an extract of the code I am using in the property inspector for the custom plugin:

const globalSettings = $PI.getGlobalSettings();
.
.
Utils.setFormValue(globalSettings, formGlobalSettings);
.
.
formGlobalSettings.addEventListener(
        'input',
        Utils.debounce(150, () => {
            const value = Utils.getFormValue(formGlobalSettings);
            $PI.setGlobalSettings(value);
        })
    );

Thanks in advance!
M.

The dev experience when developing a Streamdeck plugin is really bad.
I would have expected a proper module bundler like rollup to be setup, or a vite plugin.
Is this something you are planing to do ?

hey, i'm on my first plugin, and i need set a new title

i try with these options but none work

myAction.onKeyDown(({ action, context, device, event, payload }) => { 
   $SD.send(context, Events.setTitle, { title: "testing title" }); 
   $SD.setTitle(context, "testing title");
   ...

I noticed extensions based on this template may stop working when the PC is waking from sleep (Windows 10).

api.js:160 WebSocket is already in CLOSING or CLOSED state.
send	@	api.js:160
setTitle	@	stream-deck.js:94
sendRequest	@	app.js:63

API needs to handle this case and create a new socket automatically.

I'm developing a Stream Deck plugin, but the plugin doesn't show up in the Elgato Stream Deck app.

$ ls  -1 "~/Library/Application Support/com.elgato.StreamDeck/Plugins/works.wen.sdPlugin"
defaultImage.png
[email protected]
en.json
manifest.json
placeholder.png
[email protected]
pluginIcon.png
[email protected]
app

How do I find out what's going wrong?

I'm almost done with my first plugin, but there's still an issue:

When I close and reopen the Property Inspector, the data from the input fields obviously disappears.

I allready can get the settings in the app.js, when I open the Property inspector, via the onPropertyInspectorDidAppear method:

myAction.onPropertyInspectorDidAppear(({action, context, device, event}) => { $SD.getSettings(context); });

$SD.onDidReceiveSettings('de.nas-max.test.action', (jsn) => { console.log(jsn); });

So, how can I get the settings in the inspector.js, or how can I send a JSON element (in this context the settings) from app.js to inspector.js?