{"id":20191326,"url":"https://github.com/patrickbussmann/streamdeck-sdk","last_synced_at":"2026-05-29T13:31:24.759Z","repository":{"id":57372132,"uuid":"265952148","full_name":"patrickbussmann/streamdeck-sdk","owner":"patrickbussmann","description":"A not official SDK for Elgato's Stream Deck","archived":false,"fork":false,"pushed_at":"2020-07-08T15:43:49.000Z","size":12,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-19T04:25:07.384Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/patrickbussmann.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-21T21:09:03.000Z","updated_at":"2020-07-08T15:43:51.000Z","dependencies_parsed_at":"2022-09-01T18:00:24.695Z","dependency_job_id":null,"html_url":"https://github.com/patrickbussmann/streamdeck-sdk","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/patrickbussmann/streamdeck-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickbussmann%2Fstreamdeck-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickbussmann%2Fstreamdeck-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickbussmann%2Fstreamdeck-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickbussmann%2Fstreamdeck-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/patrickbussmann","download_url":"https://codeload.github.com/patrickbussmann/streamdeck-sdk/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patrickbussmann%2Fstreamdeck-sdk/sbom","scorecard":{"id":722205,"data":{"date":"2025-08-11","repo":{"name":"github.com/patrickbussmann/streamdeck-sdk","commit":"51c1bd168c8aa23a714c51681f68f2fd62926933"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/release.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":3,"reason":"dependency not pinned by hash detected -- score normalized to 3","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/patrickbussmann/streamdeck-sdk/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/patrickbussmann/streamdeck-sdk/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/patrickbussmann/streamdeck-sdk/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/patrickbussmann/streamdeck-sdk/release.yml/master?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/release.yml:21","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   1 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   1 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Code-Review","score":0,"reason":"Found 0/5 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v1.0.0 not signed: https://api.github.com/repos/patrickbussmann/streamdeck-sdk/releases/26778624","Warn: release artifact v1.0.0 does not have provenance: https://api.github.com/repos/patrickbussmann/streamdeck-sdk/releases/26778624"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-22T11:41:41.170Z","repository_id":57372132,"created_at":"2025-08-22T11:41:41.170Z","updated_at":"2025-08-22T11:41:41.170Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33655440,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-29T02:00:06.066Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T03:48:31.341Z","updated_at":"2026-05-29T13:31:24.739Z","avatar_url":"https://github.com/patrickbussmann.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Stream Deck SDK\n\nThis project is a **not official** SDK for Elgato's Stream Deck.\n\nThe idea behind was that there are few \"files\" or projects which want providing an layer for the Stream Deck.\nBut I want to develop some plugins as easy as possible and as fast as possible.\n\n## Features\n\n- Automatic setting management (Loading \u0026 Saving values in Property Inspector with 2 lines of code)\n- Setting image easily via URL\n- Drawing management (Canvas)\n- HTTP Module (http.get/http.post/... easily instead of fetch)\n\n# Installation\n\n    $ npm install streamdeck-sdk\n\nAfter that add the script to header of your html files. (i.e. `plugin.html`/`index.html` and `property-inspector.html`)\n\n    \u003cscript src=\"node_modules/streamdeck-sdk/dist/StreamDeckSDK.js\"\u003e\u003c/script\u003e\n\nWhen you downloaded only the `StreamDeckSDK.js` you can easily add them, too.\n\n    \u003cscript src=\"StreamDeckSDK.js\"\u003e\u003c/script\u003e\n\n# Registration Procedure\n\nRead the steps for the plugin and for the property inspector.\n\n## Plugin\n\nThe plugin is easily load via:\n\n    \u003cscript\u003e\n        var plugin = new StreamDeckPlugin();\n    \u003c/script\u003e\n\n## Property Inspector\n\nThe property inspector is easily load via:\n\n    \u003cscript\u003e\n        var propertyInspector = new StreamDeckPropertyInspector();\n    \u003c/script\u003e\n\n### Automatic setting management\n\nFor enabling the property inspector setting management you must add this line to your `\u003cscript\u003e`:\n\n    propertyInspector.enableSettingManager();\n\nBehind the scene it loops all your `input`, `textarea` and `select` elements.\nThen it checks for the `name` or `id` attribute and if it's already set in the `settings` of your Stream Deck.\n\nIf yes, it automatically set's the `value` of your element to the stored value.\nOn change event it will automatically store the value.\nAnd in case of closing the property inspector there is a listener for the `beforeunload` event.\n(which sends the settings to the plugin which stores it then automatically)\n\nYou can disable the automatic loading and saving for single elements by adding the `sdk-ignore` class.\n\nThis logic supports also `file` inputs.\nYou can show the `file` then in the plugin via `instance.setImageURL(instance.settings.myname)`.\n\n### Example: Simple counter (with stored and changable value)\n\nThis demonstrates how easy you can develop a plugin with property inspector view.\n\n_Do not forget to add the StreamDeckSDK.js in plugin and property inspector files as described in Installation!_\n\n#### Plugin\n\nThe plugin shows a number (counter) and on each key press (keyUp) it will count the number plus one.\nBut when we got a new value from property inspector we also want to use this number.\n\n    // First we initialize the Stream Deck Plugin\n\tvar plugin = new StreamDeckPlugin();\n\t// Then we listen to the initialization process\n\tplugin.on('init', function(event) {\n\t    // Each init gives one instance (instance = 1 button on the Stream Deck)\n\t    // Instances having an `action` which you can check when you have multiple actions!\n\t    // i.e. if (instance.action === 'org.examle.firstaction') { }\n\t\tvar instance = event.detail.instance;\n\t\t// Then we setting the title of the instance to the counter - else 1\n\t\tinstance.setTitle((+instance.settings.counter) || 1);\n\t\t// Now we're going to listen for keyUp, so whenever we press the button and release this is called\n\t\tinstance.on('keyUp', function() {\n\t\t    // Lets get the current value and count + 1\n\t\t    var count = ((+instance.settings.counter) || 1) + 1;\n\t\t    // Now lets set the title of our instance to the number\n            instance.setTitle(count);\n            // And then lets save the new number\n            instance.setSetting('counter', count);\n\t\t});\n\t\t// We want also to listen for changed settings from the property inspector\n\t\tinstance.on('didReceiveSettings', function() {\n\t\t    // So when property inspector changes the counter value set the title to it\n            instance.setTitle(instance.settings.counter || 1);\n\t\t});\n\t});\n\n#### Property Inspector\n\nIn the property inspector we add the element with the input to the `\u003cbody\u003e`.\n\n    \u003cdiv class=\"sdpi-item\"\u003e\n        \u003cdiv class=\"sdpi-item-label\"\u003eCounter Value\u003c/div\u003e\n        \u003cinput class=\"sdpi-item-value\" name=\"counter\" /\u003e\n    \u003c/div\u003e\n\nAnd in the `\u003cscript\u003e` (maybe before closing `\u003c/body\u003e`) we add our logic.\n\n    \u003cscript\u003e\n        var plugin = new StreamDeckPropertyInspector();\n        plugin.enableSettingManager();\n    \u003c/script\u003e\n\n#### Done\n\nEt voilà - we created a simple logic which sends the counter value to the plugin which shows it.\nAnd the plugin count it up on each keypress.\nThe property inspector will also be updated on each `keyUp` because it's listening to the setting change event.\n\n# Build\n\nRun `npm run build` to build the project. The build artifacts will be stored in the `dist/` directory.\n\n# Sample plugins\n\n* Coming May 2020: Toggl\n* Coming May 2020: INSTAR Camera Viewer\n\n# Contributing\n\nFeel free to open issues, pull requests or something else.\n\nWhen you need a plugin feel free to request it via the issues.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrickbussmann%2Fstreamdeck-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpatrickbussmann%2Fstreamdeck-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatrickbussmann%2Fstreamdeck-sdk/lists"}