Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nyanhp/poshobs
Repository for PowerShell module implementing obs-websocket-dotnet
https://github.com/nyanhp/poshobs
Last synced: 4 months ago
JSON representation
Repository for PowerShell module implementing obs-websocket-dotnet
- Host: GitHub
- URL: https://github.com/nyanhp/poshobs
- Owner: nyanhp
- License: mit
- Created: 2022-05-12T14:54:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-31T08:10:58.000Z (about 2 years ago)
- Last Synced: 2024-05-17T00:17:33.164Z (9 months ago)
- Language: C#
- Size: 102 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# PoshObs
This project wraps cmdlets around obs-websocket-dotnet to interact with OBS using PowerShell 5+.
## Installation and usage
To install the module, please use the PowerShell Gallery. At some point I'll also package a release,
but I hardly see the point.
```powershell
# Install
Install-Module -Repository PSGallery -Scope CurrentUser -Name PoshObs # -AllowPrerelease to get the GOOD STUFF
# Connect
Connect-POWebSocket -Uri ws://127.0.0.1:4444 -Credential (Get-Credential)
# Use!
Get-POCurrentScene
Set-POCurrentScene -Name Michael.MICHAEL!
Start-POVirtualCam
# Now join that boring team meeting ;)
```
## Build it yourself
Using the .NET Core SDK you can build that project your self. Why? Because I've gone
the easy route and implemented a bunch of C# cmdlets instead of writing PowerShell functions.
```powershell
./build/vsts-prerequisites.ps1
./build/vsts-build.ps1 -SkipPublish
```
## Requirements
- OBS with WebSocket plugin configured and enabled
- PowerShell 5 and newer
- An overwhelming urge to automate the crap out of things
## NuGet packages used
Licenses apply and so on.
- [PowerShellStandard.Library](https://github.com/PowerShell/PowerShellStandard)
- [obs-websocket-dotnet](https://github.com/BarRaider/obs-websocket-dotnet)
- [Newtonsoft.Json](https://www.newtonsoft.com/json)
- [WebSocketSharp](https://sta.github.io/websocket-sharp)