Skip to content

Latest commit

 

History

History
57 lines (35 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

57 lines (35 loc) · 1.6 KB
Raw

Contributing

First, thank you for contributing to DIM Stream Deck!

Developer Quick start

  1. Install Pre-requisites
  2. Clone
  3. Install the streamdeck cli
  4. Develop
  5. Build

Pre-requisites

Clone the repo

To work with this plugin you can simply clone the code repository:

git clone https://github.com/dim-stream-deck/com.dim.streamdeck

To contribute changes to the project, you'll want to:

  1. Fork DIM Stream Deck to make your own copy of the repository
  2. Edit the local files
  3. Commit and push your code changes to your fork
  4. Create a Pull Request

More detailed information on these steps are here.

Install the cli

This CLI is required to develop plugins for the Elgato Stream Deck.

  • Run npm i -g @elgato/cli

Develop

Enter the ./plugin/com.dim.streamdeck.sdPlugin directory and

  • run streamdeck link
  • run streamdeck dev

You're ready, you can now test your changes using only cd ../.. && pnpm dev.

Usually actions on the plugin have a relative code also on DIM, follow their contributing guidelines to setup your local instance.

Build

This step will build the plugin and generate the .streamDeckPackage file.

  • Run pnpm build (from the root)