Skip to content

SputNikPlop/obs_blade

 
 

Repository files navigation

OBS Blade

alt text

DISCLAIMER: This app is not in any way affiliated with OBS (Open Broadcaster Software).

Control and manage your stream and recording while using OBS by making use of the WebSocket Plugin for OBS. This project is build with the Flutter framework and could therefore be compiled and deployed for various platforms. This release is optimized for iOS and Android (Phone as well as Tablet).

Feel free to either create issues if something does not work or you want to add a feature request or pull this repo and make changes and build it on your own!

Preparation

In order to be able to connect to OBS with OBS Blade, you need to have the OBS WebSocket plugin installed. Depending on the OBS Studio version you have installed, you either have to install it manually or can use it out of the box.

If your OBS Studio version is:

  • 28.0 or higher: you are done 🎉🎉🎉 - since OBS Studio 28.0 the WebSocket plugin is part of OBS Studio out of the box and you can use the app immediately!

  • Lower than 28.0: you need to install the WebSocket manually (if possible, I recommend upgrading OBS Studio itself). Follow these steps to proceed manually:

    • Visit https://github.com/obsproject/obs-websocket/
    • Go to the Release section of this GitHub page and download version 5.X and above for your operating system (found under 'Assets').
    • Once this plugin is installed, make sure you restarted OBS Studio at least once
    • Now you should be able to use this app!

The device running OBS Blade needs to be in the same network as the device running OBS itself and the autodiscover feature should find open OBS sessions on its own! You can also enter the local (internal) IP address of the device running OBS (How to find my local IP address) or even enter a domain name!

Features

OBS Blade is designed to be your stream companion and help you to manage your live stream. While using OBS (Open Broadcaster Software) you can connect to the running instance and gain control over important parts of the software. This should help you to manage what your audience can see / hear without the need to switch to OBS on your machine and make such changes. You can keep doing what you do and easily use this app to control OBS!

Currently OBS Blade supports:

  • Start / stop your stream / recording
  • Changing the active scene
  • Toggle visibility of scene items (like desktop capture etc.)
  • Change the volume of your current audio sources (or mute them)
  • View any Twitch and YouTube chats and write messages
  • See live statistics of your stream and recording performance (FPS, CPU usage, kbit/s etc.)

OBS Blade also saves statistics of your previous streams and recordings so you can track the overall performance and some nice to know facts!

This app is still in its early stages and will get updated with new features over time - for now the main features which I want to add are:

  • More engagement with OBS (renaming, sorting, scripted switching etc.)
  • Export / merge statistics
  • Soundboard
  • Incoming feature requests
  • (Maybe) Streamlabs client connection

I hope you have a good time using this app. If you encounter any bugs, have feature requests or anything similar, feel free to get in touch with me!

contact@kounex.com

App Store

This App is available in the iOS App Store, Google Play Store, F-Droid and here on GitHub:

How to build

This app is build with the Flutter framework. To build it yourself, you need to setup Flutter in your environment: https://docs.flutter.dev/get-started/install. Make sure the platform you want to build for is listed and marked as ready (checkmark) when you run:

flutter doctor -v

If your platform is not listed or is not ready (exclamation mark or 'x'), check back with the install guide listed above and make sure you followed everthing correctly and / or check the output of flutter doctor -v what needs to be done.

Once this has been done, open the project with your preferred IDE (VSCode and Android Studio will get all dependencies automatically, if you are using another IDE or this does not happen automatically, run flutter pub get in the root directory of the project to get the dependencies of this project). After that you should not have any errors left and you can run the app with:

flutter run

How to select the device you want the app to build on and how to run this project with your IDE instead of the CLI, refer to the install guide at the beginning.

Support me!

I love developing free, high quality applications accessible for everyone, no need for In-App purchases or Ads. No one wants that. It takes a lot of time creating and maintaining my work - if you like using them and want me to continue working on them please consider supporting me!

Buy Me A Coffee PayPal.Me

About

Make use of the OBS WebSocket Plugin (https://github.com/obsproject/obs-websocket) and control your stream

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Dart 95.8%
  • C++ 1.8%
  • CMake 1.3%
  • HTML 0.4%
  • Swift 0.3%
  • Ruby 0.2%
  • Other 0.2%