Skip to content

Commit

Permalink
Fixes versioning, README, and manifest (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
RecklessBoon authored Oct 31, 2023
1 parent e9ae73d commit 3364549
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 15 deletions.
3 changes: 2 additions & 1 deletion ExtensionManifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"author": "Macro Deck",
"repository": "https://github.com/SuchByte/Macro-Deck-OBS-WebSocket-Plugin",
"packageId": "SuchByte.OBS-WebSocketPlugin",
"version": "1.5.0",
"version": "2.0.0",
"target-plugin-api-version": 40,
"target-macro-deck-version": "2.13.0-b10",
"dll": "OBS-WebSocket Plugin.dll"
}
1 change: 0 additions & 1 deletion GUI/Controls/ObsSelectorButton.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
using System.Threading.Tasks;
using System.Windows.Forms;
using static System.Net.Mime.MediaTypeNames;
using System.Windows.Media.Media3D;
using SuchByte.MacroDeck.GUI;

namespace SuchByte.OBSWebSocketPlugin.GUI.Controls
Expand Down
4 changes: 3 additions & 1 deletion Macro-Deck-OBS-WebSocket.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\..\Macro-Deck\MacroDeck\MacroDeck.csproj" />
<Reference Include="SuchByte.MacroDeck">
<HintPath>$(SolutionDir)..\Macro-Deck\MacroDeck\bin\$(ConfigurationName)\$(TargetFramework)\win-x64\Macro Deck 2.dll</HintPath>
</Reference>
</ItemGroup>

<ItemGroup>
Expand Down
44 changes: 32 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,52 @@
Control Open Broadcaster Software with Macro Deck

## Important
To use this plugin, you need to install the OBS-WebSocket plugin to your Open Broadcaster Software first.
To use this plugin, simply download it from the Macro Deck Extension Store. This plugin works with the websocket plugin built into OBS.

This plugin only supports version 4.9 of the OBS-WebSocket plugin!
This plugin only supports version 5+ of the OBS-WebSocket plugin! This is the version built into OBS since version 28.

More informations [here](https://obsproject.com/forum/resources/obs-websocket-remote-control-obs-studio-from-websockets.466/)
### Features

# Features
- ### Save replay buffer
#### Multiple Connections
Control multiple instances of OBS with a single Macro Deck server!

#### Save replay buffer
Save the replay buffer by a press of an action button
- ### Variables

#### Variables
This plugin automatically creates variables for the streaming/recording state, the current scene, streaming statistics and more.
You can easily add this variables to action buttons or use it as action button state binding.
- ### Start/stop/toggle recording, streaming, replay buffer and virtual camera

#### Start/stop/toggle recording, streaming, replay buffer and virtual camera
Easily start/stop/toggle recording, streaming, replay buffer or the virtual camera by a press of an action button
- ### Set scene

#### Set scene
Change the current scene by a press of an action button
- ### Set profile

#### Set profile
Change the current profile by a press of an action button

### This is a plugin for [Macro Deck 2](https://github.com/SuchByte/Macro-Deck), it does NOT function as a standalone app
#### Set Audio Level/Mute/Unmute
Increase/decrease the db level of an audio source or set it to a specific db. Mute/Unmute also available

#### Set Filter State
Set the visibility of the a source filter

#### Set Text Source Value
Update the value of a text source

#### Set Source Visibility
Hide/Unhide sources

----

> NOTE: This is a plugin for [Macro Deck 2](https://github.com/SuchByte/Macro-Deck), it does NOT function as a standalone app
<img height="64px" src="https://macrodeck.org/images/macro_deck_2_official_plugin.png" />

----

# Third party licenses
This plugin uses some awesome 3rd party libraries:
- [Newtonsoft.Json (MIT license)](https://www.newtonsoft.com/json)
- [obs-websocket-dotnet (MIT license)](https://github.com/BarRaider/obs-websocket-dotnet)
- [websocket-sharp (MIT license)](https://github.com/sta/websocket-sharp)
- [Open Broadcaster Software logo in the icon (GNU GPL v2)](https://de.m.wikipedia.org/wiki/Datei:Open_Broadcaster_Software_Logo.png)

0 comments on commit 3364549

Please sign in to comment.