Merge pull request #139 from StartAutomating/StartAutomating-patch-1

StartAutomating · web-flow · commit fdc856e2aa25 · 2023-07-07T23:02:01.000-07:00
Update README.ps1.md
diff --git a/Assets/obs-powershell-animated-icon.svg b/Assets/obs-powershell-animated-icon.svg
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- Generated with PSSVG 0.2.9 <https://github.com/StartAutomating/PSSVG> -->
+<!-- Generated with PSSVG 0.2.10 <https://github.com/StartAutomating/PSSVG> -->
 <svg viewBox="0 0 500 500" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg">
-  <symbol viewBox="0 0  " id="psChevron">
+  <symbol viewBox="0 0 100 100" id="psChevron">
     <polygon points="40,20 45,20 60,50 35,80 32.5,80 55,50" xmlns="http://www.w3.org/2000/svg" />
   </symbol>
   <mask id="psChevronMask">
diff --git a/Assets/obs-powershell-icon.svg b/Assets/obs-powershell-icon.svg
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- Generated with PSSVG 0.2.9 <https://github.com/StartAutomating/PSSVG> -->
+<!-- Generated with PSSVG 0.2.10 <https://github.com/StartAutomating/PSSVG> -->
 <svg viewBox="0 0 500 500" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg">
-  <symbol viewBox="0 0  " id="psChevron">
+  <symbol viewBox="0 0 100 100" id="psChevron">
     <polygon points="40,20 45,20 60,50 35,80 32.5,80 55,50" xmlns="http://www.w3.org/2000/svg" />
   </symbol>
   <mask id="psChevronMask">
diff --git a/Assets/obs-powershell-text-and-animated-icon.svg b/Assets/obs-powershell-text-and-animated-icon.svg
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- Generated with PSSVG 0.2.9 <https://github.com/StartAutomating/PSSVG> -->
+<!-- Generated with PSSVG 0.2.10 <https://github.com/StartAutomating/PSSVG> -->
 <svg viewBox="0 0 500 500" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg">
-  <symbol viewBox="0 0  " id="psChevron">
+  <symbol viewBox="0 0 100 100" id="psChevron">
     <polygon points="40,20 45,20 60,50 35,80 32.5,80 55,50" xmlns="http://www.w3.org/2000/svg" />
   </symbol>
   <mask id="psChevronMask">
diff --git a/Assets/obs-powershell-text-and-icon.svg b/Assets/obs-powershell-text-and-icon.svg
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- Generated with PSSVG 0.2.9 <https://github.com/StartAutomating/PSSVG> -->
+<!-- Generated with PSSVG 0.2.10 <https://github.com/StartAutomating/PSSVG> -->
 <svg viewBox="0 0 500 500" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg">
-  <symbol viewBox="0 0  " id="psChevron">
+  <symbol viewBox="0 0 100 100" id="psChevron">
     <polygon points="40,20 45,20 60,50 35,80 32.5,80 55,50" xmlns="http://www.w3.org/2000/svg" />
   </symbol>
   <mask id="psChevronMask">
diff --git a/Assets/obs-powershell.svg b/Assets/obs-powershell.svg
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- Generated with PSSVG 0.2.9 <https://github.com/StartAutomating/PSSVG> -->
+<!-- Generated with PSSVG 0.2.10 <https://github.com/StartAutomating/PSSVG> -->
 <svg viewBox="0 0 1000 1000" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg">
-  <symbol viewBox="0 0  " id="psChevron">
+  <symbol viewBox="0 0 100 100" id="psChevron">
     <polygon points="40,20 45,20 60,50 35,80 32.5,80 55,50" xmlns="http://www.w3.org/2000/svg" />
   </symbol>
   <symbol viewBox="0 0 500 250" id="combinedLogo">
diff --git a/README.md b/README.md
@@ -178,3 +178,18 @@ Because the obs-websocket cleanly documents it's protocol, most commands in obs-
 * [Full List Of Commands](docs/obs-powershell-commands.md)
 * [Full list of websocket commands](docs/obs-powershell-websocket-commands.md)
 
+
+## Depdendencies
+
+To use obs-powershell, you'll need OBS and PowerShell Core.  You can run both of these on any operating system.
+
+### Specific Command Requirements
+
+Some commands in obs-powershell will not work unless you have additional software installed.
+
+|Commands|Dependency|
+|-|-|
+|Add/Set-OBSVLCSource|[VLC](https://www.videolan.org/vlc/)|
+|Add/Set-OBS3DFilter |[VLC](https://obsproject.com/forum/resources/3d-effect.1692/)|
+|Add/Set-OBSShaderFilter|[obs-shaderfilter 2.0+](https://obsproject.com/forum/resources/obs-shaderfilter.1736/)
+
diff --git a/README.ps1.md b/README.ps1.md
@@ -177,3 +177,18 @@ Because the obs-websocket cleanly documents it's protocol, most commands in obs-
 
 * [Full List Of Commands](docs/obs-powershell-commands.md)
 * [Full list of websocket commands](docs/obs-powershell-websocket-commands.md)
+
+
+## Depdendencies
+
+To use obs-powershell, you'll need OBS and PowerShell Core.  You can run both of these on any operating system.
+
+### Specific Command Requirements
+
+Some commands in obs-powershell will not work unless you have additional software installed.
+
+|Commands|Dependency|
+|-|-|
+|Add/Set-OBSVLCSource|[VLC](https://www.videolan.org/vlc/)|
+|Add/Set-OBS3DFilter |[VLC](https://obsproject.com/forum/resources/3d-effect.1692/)|
+|Add/Set-OBSShaderFilter|[obs-shaderfilter 2.0+](https://obsproject.com/forum/resources/obs-shaderfilter.1736/)
diff --git a/docs/Assets/obs-powershell-animated-icon.svg b/docs/Assets/obs-powershell-animated-icon.svg
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- Generated with PSSVG 0.2.9 <https://github.com/StartAutomating/PSSVG> -->
+<!-- Generated with PSSVG 0.2.10 <https://github.com/StartAutomating/PSSVG> -->
 <svg viewBox="0 0 500 500" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg">
-  <symbol viewBox="0 0  " id="psChevron">
+  <symbol viewBox="0 0 100 100" id="psChevron">
     <polygon points="40,20 45,20 60,50 35,80 32.5,80 55,50" xmlns="http://www.w3.org/2000/svg" />
   </symbol>
   <mask id="psChevronMask">
diff --git a/docs/Assets/obs-powershell-icon.svg b/docs/Assets/obs-powershell-icon.svg
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- Generated with PSSVG 0.2.9 <https://github.com/StartAutomating/PSSVG> -->
+<!-- Generated with PSSVG 0.2.10 <https://github.com/StartAutomating/PSSVG> -->
 <svg viewBox="0 0 500 500" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg">
-  <symbol viewBox="0 0  " id="psChevron">
+  <symbol viewBox="0 0 100 100" id="psChevron">
     <polygon points="40,20 45,20 60,50 35,80 32.5,80 55,50" xmlns="http://www.w3.org/2000/svg" />
   </symbol>
   <mask id="psChevronMask">
diff --git a/docs/Assets/obs-powershell-text-and-animated-icon.svg b/docs/Assets/obs-powershell-text-and-animated-icon.svg
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- Generated with PSSVG 0.2.9 <https://github.com/StartAutomating/PSSVG> -->
+<!-- Generated with PSSVG 0.2.10 <https://github.com/StartAutomating/PSSVG> -->
 <svg viewBox="0 0 500 500" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg">
-  <symbol viewBox="0 0  " id="psChevron">
+  <symbol viewBox="0 0 100 100" id="psChevron">
     <polygon points="40,20 45,20 60,50 35,80 32.5,80 55,50" xmlns="http://www.w3.org/2000/svg" />
   </symbol>
   <mask id="psChevronMask">
diff --git a/docs/Assets/obs-powershell-text-and-icon.svg b/docs/Assets/obs-powershell-text-and-icon.svg
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- Generated with PSSVG 0.2.9 <https://github.com/StartAutomating/PSSVG> -->
+<!-- Generated with PSSVG 0.2.10 <https://github.com/StartAutomating/PSSVG> -->
 <svg viewBox="0 0 500 500" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg">
-  <symbol viewBox="0 0  " id="psChevron">
+  <symbol viewBox="0 0 100 100" id="psChevron">
     <polygon points="40,20 45,20 60,50 35,80 32.5,80 55,50" xmlns="http://www.w3.org/2000/svg" />
   </symbol>
   <mask id="psChevronMask">
diff --git a/docs/Assets/obs-powershell.svg b/docs/Assets/obs-powershell.svg
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- Generated with PSSVG 0.2.9 <https://github.com/StartAutomating/PSSVG> -->
+<!-- Generated with PSSVG 0.2.10 <https://github.com/StartAutomating/PSSVG> -->
 <svg viewBox="0 0 1000 1000" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://www.w3.org/2000/svg">
-  <symbol viewBox="0 0  " id="psChevron">
+  <symbol viewBox="0 0 100 100" id="psChevron">
     <polygon points="40,20 45,20 60,50 35,80 32.5,80 55,50" xmlns="http://www.w3.org/2000/svg" />
   </symbol>
   <symbol viewBox="0 0 500 250" id="combinedLogo">
diff --git a/docs/README.md b/docs/README.md
@@ -177,3 +177,18 @@ Because the obs-websocket cleanly documents it's protocol, most commands in obs-
 
 * [Full List Of Commands](obs-powershell-commands.md)
 * [Full list of websocket commands](obs-powershell-websocket-commands.md)
+
+
+## Depdendencies
+
+To use obs-powershell, you'll need OBS and PowerShell Core.  You can run both of these on any operating system.
+
+### Specific Command Requirements
+
+Some commands in obs-powershell will not work unless you have additional software installed.
+
+|Commands|Dependency|
+|-|-|
+|Add/Set-OBSVLCSource|[VLC](https://www.videolan.org/vlc/)|
+|Add/Set-OBS3DFilter |[VLC](https://obsproject.com/forum/resources/3d-effect.1692/)|
+|Add/Set-OBSShaderFilter|[obs-shaderfilter 2.0+](https://obsproject.com/forum/resources/obs-shaderfilter.1736/)
