Git Product home page Git Product logo

obs-status-overlay's Introduction

Status overlay for OBS Studio

Introduction

This simple script was created to provide an overlay displaying the status of the OBS Studio.

When streaming an fullscreen content and only one screen is available, or for any other reason it is not possible to see the OBS Studio window itself, it is the place when this script cames into the action. It provides minimalistic text overlay that contains basic OBS Studio status information.

Installation

To install the script, download it and save on your local. Next, in the OBS Studio, go to Tools -> Scripts. In the opened dialog click on the + button and provide a patch where you saved the script. It should now be active, and the overlay should be visible in the top left corner of your screen.

Configuration

In the right panel of the scripts dialog, you can configure a couple of script's parameters. Currently, it is Font face, size, and color.

Contribution

This is the very initial version of this script. Therefore, I wrote in in a way that it should be relatively easy to be extended with new features.

Feel free to contribute by reporting the issues or dropping suggestions of the new features. Pull requests will of course be appreciated.

Currently, Black with default configuration is used to maintain the proper code style. Please run it before submitting the pull request.

obs-status-overlay's People

Contributors

majkrzak avatar

Stargazers

 avatar

Watchers

 avatar  avatar

obs-status-overlay's Issues

Transpaency does not work when compositor is of

When running script in the KDE desktop environment and compositor is of, transparency does not work and the background goes black.

Default configuration of the desktop environment allows some applications, like games, to shut down the compositor on demand to get some more computing power. This option can be disabled to make the overlay work as expected, but it may have some minor drawback on the performance.

Currently the Qt::WA_TranslucentBackground flag is used to provide transparency of the window. It is either a bug or a feature in the Qt. At the other hand, disabled compositor does not affect libxosd, so it should be possible to achieve the same effect.

image

image

Overlay can not be moved

Currently, position of the overlay window is not managed, and it is displayed usually at the top left corner. It is mostly OK, but may be not suitable for someone.

image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.