https://github.com/bitfocus/io.bitfocus.companion-plugin
Companion plugin for the native Stream Deck application
https://github.com/bitfocus/io.bitfocus.companion-plugin
Last synced: about 2 months ago
JSON representation
Companion plugin for the native Stream Deck application
- Host: GitHub
- URL: https://github.com/bitfocus/io.bitfocus.companion-plugin
- Owner: bitfocus
- License: mit
- Created: 2019-01-13T21:59:10.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-17T19:12:22.000Z (6 months ago)
- Last Synced: 2025-04-15T22:15:19.002Z (about 2 months ago)
- Language: CSS
- Size: 339 KB
- Stars: 9
- Watchers: 5
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
#io.bitfocus.companion-plugin
Companion plugin for the native Stream Deck application
## Getting Started
1. To contribute to this plugin, first follow the instructions provided by the Streamdeck SDK to set up a development environment: https://docs.elgato.com/streamdeck/sdk/introduction/getting-started
1. You will need to install the Elgagto Streamdeck CLI: `yarn global add @elgato/cli`
1. Clone this repository and install dependencies by running `yarn` in the repo folder.
1. Make your code changes as necessary.
1. If you are editing any Property Inspectors, you can refer to the SDPI documentation here: https://sdpi-components.dev/
1. Run `yarn build` to ensure everything compiles correctly.
1. If the plugin is already installed in the Elgato Stream Deck software, uninstall it.
1. Run `yarn run link`.
1. Run `yarn run restart` in the repo folder.
1. If you are making frequent code changes, you can run `yarn run watch` which will automatically recompile the source code as needed.
Submit your changes as a pull request to this repository.
## Debugging
You can view the "server side" logs by opening one of the log files in the `./io.bitfocus.companion-plugin.sdPlugin/logs/` folder.
To view the "client side" logs:
1. Make sure development mode is enabled by running `streamdeck dev`.
1. Open the Property Inspector for the Action you are editing.
1. Open a browser window to: `http://127.0.0.1:23654`
1. This web page will show a list of plugins you can view. You can then open the dev tools page for this plugin.
1. View the console output and inspect elements using this interface.
## Packaging
If you want to provide a packaged file for others: `yarn pack`