https://github.com/coccodrillooxds/obs-notifications
Receive desktop notifications for OBS Studio events (recording, streaming and Replay Buffer)
https://github.com/coccodrillooxds/obs-notifications
linux lua lua-script macos notification notifications obs obs-plugin obs-script obs-scripts obs-studio obs-studio-plugin obs-studio-script obs-studio-scripts powershell powershell-script script scripts windows
Last synced: 7 months ago
JSON representation
Receive desktop notifications for OBS Studio events (recording, streaming and Replay Buffer)
- Host: GitHub
- URL: https://github.com/coccodrillooxds/obs-notifications
- Owner: CoccodrillooXDS
- License: mit
- Created: 2023-07-30T11:36:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-31T22:21:22.000Z (over 2 years ago)
- Last Synced: 2023-07-31T23:34:35.522Z (over 2 years ago)
- Topics: linux, lua, lua-script, macos, notification, notifications, obs, obs-plugin, obs-script, obs-scripts, obs-studio, obs-studio-plugin, obs-studio-script, obs-studio-scripts, powershell, powershell-script, script, scripts, windows
- Language: PowerShell
- Homepage: https://github.com/CoccodrillooXDS/OBS-Notifications
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Notifications for OBS Studio
Receive desktop notifications for OBS Studio events
Recording, Streaming and Replay Buffer
# Overview
This Lua script for OBS Studio will send desktop notifications for recording, streaming and Replay Buffer events.
It is designed for [OBS Studio](https://obsproject.com/) and should also work with [Streamlabs OBS](https://streamlabs.com/).
# 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](https://obsproject.com/) or [Streamlabs OBS](https://streamlabs.com/);
- 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](https://github.com/CoccodrillooXDS/OBS-Notifications/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](LICENSE)** file for more information.