https://github.com/ecrax/streamdeck

An alternative to an Elgato Stream Deck.
https://github.com/ecrax/streamdeck

dart elgato-stream-deck flutter obs python-script streamdeck

Last synced: 4 days ago
JSON representation

An alternative to an Elgato Stream Deck.

• Host: GitHub
• URL: https://github.com/ecrax/streamdeck
• Owner: ecrax
• License: gpl-3.0
• Created: 2020-11-18T16:20:15.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2020-12-11T15:57:42.000Z (almost 4 years ago)
• Last Synced: 2023-04-06T06:40:10.247Z (over 1 year ago)
• Topics: dart, elgato-stream-deck, flutter, obs, python-script, streamdeck
• Language: Dart
• Homepage: https://ecrax.github.io/streamdeck/
• Size: 71.9 MB
• Stars: 29
• Watchers: 1
• Forks: 6
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# streamdeck

> An alternative to an Elgato Stream Deck.

[![ecrax](https://circleci.com/gh/ecrax/streamdeck.svg?style=shield)](https://app.circleci.com/pipelines/github/ecrax/streamdeck)

[![GitHub issues](https://img.shields.io/github/issues/ecrax/streamdeck)](https://github.com/ecrax/streamdeck/issues)

![GitHub repo size](https://img.shields.io/github/repo-size/ecrax/streamdeck)

[![GitHub license](https://img.shields.io/github/license/ecrax/streamdeck)](https://github.com/ecrax/streamdeck/blob/master/LICENSE)

## What is this about?

Streamdeck is an app and a python script, developed by two students from Germany, which allows you to use your Phone to remotely control the open-source screen recording program OBS. The app is built entirely with the open-source framework Flutter. The python script on the other hand serves the server and runs inside of OBS to handle the requests coming from the app.

## Why Streamdeck?

- Open Source

- Built only with open source technology

- No big tech companies involved

- Nice and intuitive interface

- Resource-efficient

  - No software running in the background, except a small Python script

- Easy setup

- No external software to install

## Documentation

You will find the entire documentation, covering various topics, [here](https://ecrax.github.io/streamdeck/#/).

## Motivation

We always liked the idea of streaming, so we wanted to try it as well. The only problem was that, even though we had two or even three monitors, we would get lost quickly in our streaming setup. That is where normally an Elgato Stream Deck would fit in perfectly. But of course, we did not want to pay for it, so we built it ourselves. And this is how Streamdeck was born.

## Features

- Muting audio

- Switching to a scene

- Hiding a source

- Toggle your stream on and off

- Toggle your recording on and off

- Pause and resume your recording

- Cross-platform

  - App:

    - Android

    - (iOS) **coming soon**

  - Computer:

    - Linux

    - Windows

    - macOS

## Roadmap / TODO

> Contributions and Suggestions are very welcome :)

- iOS support

- iOS documentation

- Add images to this documentation

All todos are on our GitHub pages issue tracker ([here](https://github.com/ecrax/streamdeck/issues))

## Contributing

Contributions are very welcome!

You can find a guide on how you can contribute [here](https://ecrax.github.io/streamdeck/#/contributing).

## Community

The creators and maintainers of this project are Jonathan Kron and Leo Kling. Here are their socials:

- Jonathan Kron: [YouTube](https://www.youtube.com/jonathankron)

- Leo Kling: [YouTube](https://www.youtube.com/ecrax_official)

## License

Streamdeck is released as open source software under the GPL v3 license, see the [LICENSE](https://github.com/ecrax/streamdeck/blob/master/LICENSE) file in the project root for the full license text.

Streamdeck has been developed by Jonathan Kron and Leo Kling.