Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fnando/streamdeck-youtube-tools

stream-deck streamdeck streamdeck-plugin streamdeck-plugins youtube

Last synced: 25 days ago
JSON representation

Host: GitHub
URL: https://github.com/fnando/streamdeck-youtube-tools
Owner: fnando
License: mit
Created: 2022-02-01T02:43:54.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2022-02-03T05:25:15.000Z (almost 3 years ago)
Last Synced: 2024-12-07T03:26:33.963Z (29 days ago)
Topics: stream-deck, streamdeck, streamdeck-plugin, streamdeck-plugins, youtube
Language: CSS
Homepage:
Size: 270 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

# streamdeck-ts-template

![Build/Test](https://github.com/rweich/streamdeck-ts-template/workflows/Build%2FTest/badge.svg)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Frweich%2Fstreamdeck-ts-template.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Frweich%2Fstreamdeck-ts-template?ref=badge_shield)

A template repository for creating streamdeck plugins in typescript using the [streamdeck-ts](https://github.com/rweich/streamdeck-ts) library.

## Easily start building your own streamdeck plugins

This template gives you a fully configured initial setup to help you get started coding your own stremdeck plugin.
No need to worry about how to talk to the streamdeck or how to build and bundle everything together.

### Includes
- a streamdeck-sdk that lets you **easily communicate with the streamdeck**
- a fully configured build environment to **automatically create a package ready to be installed** by the streamdeck software

## Usage / Setup

### Start
- Fork this repository
- delete the CHANGELOG.md (it will be re-created by the release process)
- replace `rweich/streamdeck-ts-template` in the repository.url node in `package.json` with your repository name
- modify the name / description / author as well
- modify the contents of the README.md file to your liking

### Init
To install all the packages necessary run:
```shell
yarn install
```

### Create / Code
- overwrite the example code in the [Plugin.ts](src/Plugin.ts)
- make sure the plugin instance kepps being exported as default export
- add your code in the [Propertyinspector.ts](src/Propertyinspector.ts) (if you want a propertyinspector)
- make sure the propertyinspector instance kepps being exported as default export

### Configure
- Open the [manifest.json](assets/manifest.json) file and apply the configuration based on the [documentation](https://developer.elgato.com/documentation/stream-deck/sdk/manifest/):
- Note: no need to set the `Version` as that'll be done by the release workflow
- add / change all the necessary icons to the [images](./assets/images) directory
- if you don't need a propertyinspector -> remove `PropertyInspectorPath` from the manifest

### Build
Build the development-version of the plugin with:
```shell
yarn build
```
The resulting directory created in the dist directory can be copied into your streamdeck plugin folder as described in the [documentation](https://developer.elgato.com/documentation/stream-deck/sdk/create-your-own-plugin/).

### Release
Start the release by manually by executing the [release workflow](.github/workflows/release.yml) in your GitHub actions.
This will use the current state of the main branch to create a plugin-archive that can be installed using the streamdeck software.

## Links
[Example implementaition of the NumberDisplay-plugin using this template.]()

[Official Streamdeck developer documentation.](https://developer.elgato.com/documentation/)

## License
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Frweich%2Fstreamdeck-ts-template.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Frweich%2Fstreamdeck-ts-template?ref=badge_large)