#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
2. You will need to install the Elgagto Streamdeck CLI: yarn global add @elgato/cli
3. Clone this repository and install dependencies by running yarn in the repo folder.
4. Make your code changes as necessary.
5. If you are editing any Property Inspectors, you can refer to the SDPI documentation here: https://sdpi-components.dev/
6. Run yarn build to ensure everything compiles correctly.
7. If the plugin is already installed in the Elgato Stream Deck software, uninstall it.
8. Run yarn run link.
9. Run yarn run restart in the repo folder.
10. 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.
2. Open the Property Inspector for the Action you are editing.
3. Open a browser window to: http://127.0.0.1:23654
4. This web page will show a list of plugins you can view. You can then open the dev tools page for this plugin.
5. View the console output and inspect elements using this interface.

Packaging

If you want to provide a packaged file for others: yarn pack