Skip to content

Latest commit

 

History

History
44 lines (37 loc) · 2.05 KB

README.md

File metadata and controls

44 lines (37 loc) · 2.05 KB
Raw
Project Icon

Notifications for OBS Studio

Receive desktop notifications for OBS Studio events

Recording, Streaming and Replay Buffer

Lua PowerShell

Overview

This Lua script for OBS Studio will send desktop notifications for recording, streaming and Replay Buffer events. It is designed for OBS Studio and should also work with Streamlabs OBS.

Features

  • Desktop notifications for these events:
    • Start and stop recording;
    • Start and stop streaming;
    • Save Replay Buffer;
  • Cross-platform support for Windows, macOS and Linux;

Requirements

  • OBS Studio or Streamlabs OBS;
  • PowerShell 5.1 or newer (Windows only);
  • BurntToast PowerShell Module (Windows only);
    • It will be installed automatically when you first run the script;
  • notify-send (Linux only);

Installation

  1. Download the latest version from the Releases page;
  2. Extract the archive to a folder of your choice;
  3. Open OBS Studio;
  4. Go to Tools > Scripts;
  5. Click on the + button;
  6. Select the notifications.lua file;
  7. If you are using Windows, you will be prompted to install the BurntToast PowerShell Module.

Contributing

You can contribute to the project by creating a pull request or an issue.

To contribute, you can fork the repository and after you made your changes, you can create a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more information.