{"id":20675658,"url":"https://github.com/barraider/streamdeck-obstools","last_synced_at":"2025-08-05T08:14:02.134Z","repository":{"id":41139614,"uuid":"196516545","full_name":"BarRaider/streamdeck-obstools","owner":"BarRaider","description":"Advanced OBS commands and tools to use on your Elgato Stream Deck","archived":false,"fork":false,"pushed_at":"2023-03-09T08:32:32.000Z","size":1114,"stargazers_count":33,"open_issues_count":4,"forks_count":9,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-11-06T07:38:49.908Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BarRaider.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-12T05:50:13.000Z","updated_at":"2024-09-04T14:37:46.000Z","dependencies_parsed_at":"2023-01-30T03:45:41.560Z","dependency_job_id":null,"html_url":"https://github.com/BarRaider/streamdeck-obstools","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BarRaider%2Fstreamdeck-obstools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BarRaider%2Fstreamdeck-obstools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BarRaider%2Fstreamdeck-obstools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BarRaider%2Fstreamdeck-obstools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BarRaider","download_url":"https://codeload.github.com/BarRaider/streamdeck-obstools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224970071,"owners_count":17400294,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T21:10:07.922Z","updated_at":"2024-11-16T21:10:08.477Z","avatar_url":"https://github.com/BarRaider.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OBS Tools\nAdvanced OBS commands and tools to use on your Elgato Stream Deck\n\n**Author's website and contact information:** [https://barraider.com](https://barraider.com)\n\n# New in v3.1\n- 🆕 **Stream Deck+ Support** - New `Input Volume` action allows you to control the volume of an OBS Audio Input from the Dials. Pressing the dial will toggle mute.\n\n# New in v2.9\n- Stability and performance improvements\n\n## Features:\n- `Smart Scene Switcher`  - Easily switch scenes between Preview/Studio (if enabled)  and Live modes. \n  - Shows a border on the scene indicating if it's in preview or live\n  - **See a Preview of how the scene will look on the Stream Deck key**\n- `Source Animation` action! Create cool transitions and effects for your sources with one click!! \n    - Phases allow multi-phased animations, without the need of a multi-action\n\t- Easily create animation with the `RECORD` feature: 1. Place source at starting position, then press 'Record'. 2. Move/Modify source to end result and then press 'End Recording' =\u003e The plugin will automatically calculate and input the changes.\n\t- Import/Export Settings allows you to share your animations (or keep a backup)\n    - Options to hide source/remove filter at various stages\n- `Studio Mode Toggle` action allows you to quickly toggle Studio/Preview mode on and off.\n- `Instant Replay` Action - Click to save the last seconds of your stream to your OBS \"Recordings\" folder.\n  - Long-Press the button to toggle whether the Instant Replay buffer is recording or not\n- `Video Player` allows using the same source to display different media files\n- Support for modifying the speed of Videos/Instant Replay (great when you want to do a slow mo)\n- `Source Volume` allows increasing/decreasing/setting the volume of an audio source\n- `Dropped Frames Alarm` - Shows the current amount of dropped frames and starts alerting if it increases.\n  - Choose between 3 different dropped frame types: Dropped Frames, Output Skipped Frames, Render Missed Frames\n  - You can now customize the color of the alert\n- OBS `CPU Usage` - Shows how much CPU is being utilized by OBS\n- `Previous Scene` Action - Allows you to switch back to your previously used scene. Writes the name of the scene on the key.\n- ***Twitch Integration***\n\t- Let your chat to type !replay and trigger an instant replay which is shown on stream\n    - Instant Replay can now also create a Twitch Clip for you, and post it on chat\n    - Instant Replay can now create a Twitch Clip even if the replay buffer is off\n- `Browser Sources` can now be modified using the Stream Deck\n- `Remote Recording Toggle` to toggle recording from a remote PC (if your Stream Deck is not connected to your Streaming PC)\n- `Remote Streaming Toggle` to stop/start streaming from a remote PC (if your Stream Deck is not connected to your Streaming PC)\n- `Set Transition` allows you to modify the default scene transition from the Stream Deck\n- `Filter Toggle` allows you to enable/disable filters on a source from the Stream Deck.\n- `Set Profile` action allows you to modify the OBS Profile\n- `Set Scene Collection` action allows you to modify the Scene Collection\n- `Source Visibility` action allows you to toggle sources on/off (+ multi-action support)\n- `Image Settings` action allows to change the settings of an Image source (as an example - think changing your background image with one press)\n- `HotkeyTriggerAction` allows you to send Hotkeys directly to OBS (even when OBS is running as Admin)\n- `Source Monitor Set` action allows you to set the Monitor Type of an Audio Source (None, Monitor Only, Monitor and Output)\n- `Source Mute Toggle` action allows you to mute/unmute Audio Sources.\n- `Virtual Camera` action allows you to enable/disable the Virtual Camera from the Stream Deck\n\n\n\n\n# INSTALLATION\n**Important:** You must download and install obs-websocket before using this plugin. Install from here: https://github.com/Palakis/obs-websocket/releases/\n\n2. After installing, enable from inside OBS: Tools -\u003e WebSockets Server Setting \n[You can keep the port as is, but It is ***highly recommended you Enable authentication and set a password***]\n\n3. For instant replay to work, you must check the **Enabled Replay Buffer** from File-\u003eSettings-\u003eOutput-\u003eRecording\n\n## Usage\n**Demo for Instant Replay**: https://www.youtube.com/watch?v=7mioa-hnndw\n\nOBS must be streaming for the majority of the features to work\nFor instant replay to work, you must check the **Enabled Replay Buffer** from File-\u003eSettings-\u003eOutput-\u003eRecording\n\n### Download\n\n* [Download plugin](https://github.com/BarRaider/streamdeck-obstools/releases/)\n\n## I found a bug, who do I contact?\nFor support please contact the developer. Contact information is available at https://barraider.com\n\n## I have a feature request, who do I contact?\nPlease contact the developer. Contact information is available at https://barraider.com\n\n## Dependencies\n* Uses StreamDeck-Tools by BarRaider: [![NuGet](https://img.shields.io/nuget/v/streamdeck-tools.svg?style=flat)](https://www.nuget.org/packages/streamdeck-tools)\n* Uses [Easy-PI](https://github.com/BarRaider/streamdeck-easypi) by BarRaider - Provides seamless integration with the Stream Deck PI (Property Inspector) \n\n## Change Log\n\n# New in v2.8\n- Support for OBS v28 (with OBS Websocket v5)\n- `Instant Replay` action now allows to switch to a specific Scene before starting the replay 🔥\n- Stability and performance improvements\n\n# New in v2.1\n***NOTE: This version requires upgrading to OBS Websocket v4.9 (!!) see: https://barraider.com/obs***\n- :new: `HotkeyTriggerAction` allows you to send Hotkeys directly to OBS (even when OBS is running as Admin)\n- :new: Auto-Reconnect feature will try to connect to OBS every few seconds automatically .\n    - Keys will now show an indicator if plugin is not connected to OBS\n- `Instant Replay` key allows enabling/disabling the Replay Buffer (long pressing the key) *even when you're not streaming or recording.*\n    -  `Instant Replay` key now shows a visual indicator if the Replay Buffer is enabled\n- `Toggle Filter` action now shows a visual indicator if the filter is enabled or disabled\n- `Toggle Filter` action can now toggle filters on ***Sources*** (just like Scenes)\n- `Set Transition` action now allows to set the transition duration\n\n- Multiple improvements to the `Recording Toggle` action:\n    - Recording action now supports to Pause/Resume recordings\n    - Recording action now supports multi-actions\n    - Recording Action now allows to customize the recording indicator\n- `Stream Toggle` Action now allows to customize the streaming indicator\n- `Source Volume Adjuster` action now supports -/+1 steps\n\n## New in v1.9\n- Fixed issues with `Filter Toogle` not working when scene does not include that source\n- Improved load times of `SmartSceneSwitcher` and `Instant Replay` actions\n- Stability improvements\n\n\n## New in v1.8\n- New `Set Profile` action allows you to modify the OBS Profile\n- New `Set Scene Collection` action allows you to modify the Scene Collection\n- New `Source Visibility` action allows you to toggle sources on/off (+ multi-action support)\n- New `Image Settings` action allows to change the settings of an Image source (as an example - think changing your background image with one press)\n- `Set Transition`/`Set Profile`/`Set Scene Collection` all change color if the active Transition/Profile/Scene Collection matches the one set on the key.\n- Added support for custom images to both `Smart Scene Switcher` and `Source Visibility`\n- `Source Animation` action now supports looping the animation multiple times\n\n***NOTE: This version requires upgrading to OBS Websocket v4.8 (!!) see: https://barraider.com/obs***\n\n\n## New in v1.7\n***NOTE: This version requires upgrading to OBS Websocket v4.8 (!!) see: https://barraider.com/obs***\n\nNOTE2: There is now a dedicated channel to speak about the OBS Animations. Reach out to @BarRaider to join.\n\nWhat's New:\n- Introducing `Source Animation` action! Create cool transitions and effects for your sources with one click!! :kreygasm10000: \n    - Phases allow multi-phased animations, without the need of a multi-action\n\t- Easily create animation with the `RECORD` feature: 1. Place source at starting position, then press 'Record'. 2. Move/Modify source to end result and then press 'End Recording' =\u003e The plugin will automatically calculate and input the changes.\n\t- Import/Export Settings allows you to share your animations (or keep a backup)\n    - Options to hide source/remove filter at various stages\n- New `Studio Mode Toggle` action allows you to quickly toggle Studio/Preview mode on and off.\n- Multi-Action support for Smart Scene Switcher\n    - Behavior can now be customized when inside the multi-action (Standard, Force Studio, Force Live)\n- `Video Player` action now supports Export/Import of settings to share your animations (or keep a backup)\n- Upgraded to OBS Websocket 4.8\n- Refreshed the icons to better reflect each action\n\n## New in v1.6\n- `Source Volume` allows increasing/decreasing/setting the volume of an audio source\n- Support for modifying the speed of Videos/Instant Replay (great when you want to do a slow mo)\n- :new: `Smart Scene Switcher`  - Easily switch scenes between Preview/Studio (if enabled)  and Live modes. \n  - Shows a border on the scene indicating if it's in preview or live\n  - **See a Preview of how the scene will look on the Stream Deck key**\n\n## New in v1.5\n- New Action: `Set Transition` allows you to modify the default scene transition from the Stream Deck\n- New Action `Filter Toggle` allows you to enable/disable filters on a source from the Stream Deck.\n- Added Multi-Action support for the `Previous Scene` action\n- Added checks to verify user is on the correct version of obs-websocket\n***Make sure to upgrade to obs-websocket v4.7 or above ***\n\n# New in v2.5\n- Migrated code to use Twitch's new APIs\n\n# New in v2.4\n- :new: `Source Monitor Set` action allows you to set the Monitor Type of an Audio Source (None, Monitor Only, Monitor and Output)\n- :new: `Source Mute Toggle` action allows you to mute/unmute Audio Sources.\n- :new: `Virtual Camera` action allows you to enable/disable the Virtual Camera from the Stream Deck\n     - Includes Multi-Action support!\n- Added support for customizable icons to many of the actions\n- Reworked the setup wizard to clearly state the required Websocket version and give more informative messages in case of errors.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarraider%2Fstreamdeck-obstools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbarraider%2Fstreamdeck-obstools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbarraider%2Fstreamdeck-obstools/lists"}