Merge branch 'master' of https://github.com/mikeoliphant/StompboxUI

.github/workflows/build.yml

@@ -2,9 +2,6 @@ name: Build
 
 on:
   [workflow_dispatch, push, pull_request]
-
-env:
-  BUILD_TYPE: Release
 
 jobs:
   build-windows:
@@ -39,5 +36,5 @@ jobs:
     - name: Create Plugin Archive
       uses: actions/upload-artifact@v1
       with:
-        name: StompboxVST3Pugin
+        name: StompboxVST3Plugin
         path: ${{github.workspace}}\StompboxPlugin\bin\Release\net6.0-windows

.github/workflows/release.yml

@@ -0,0 +1,69 @@
+name: Release
+
+on:
+  workflow_dispatch:
+
+jobs:
+  create_release:
+    name: Create release
+    runs-on: ubuntu-latest
+    outputs:
+      upload_url: ${{steps.create_release.outputs.upload_url}}
+    steps:
+      - name: Check out repository
+        uses: actions/[email protected]
+        with:
+          submodules: recursive
+
+      - name: Create release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        with:
+          draft: true
+          tag_name: ${{github.ref}}
+          release_name: Release ${{github.ref}}
+
+  build-windows:
+    name: Build Windows
+    needs: create_release
+    runs-on: windows-latest
+    steps:
+    - uses: actions/[email protected]
+      with:
+        submodules: recursive
+
+    - name: Configure stompbox
+      working-directory: ${{github.workspace}}/Dependencies/stompbox/build
+      run: |
+        cmake.exe -G "Visual Studio 17 2022" -A x64  ..
+
+    - name: Setup MSBuild and add to PATH
+      uses: microsoft/[email protected]
+
+    - name: Restore NuGet Packages
+      run: dotnet restore
+
+    - name: Run Image Processor
+      working-directory: ${{github.workspace}}
+      run: |
+        msbuild .\StompboxUI.sln /t:StompboxImageProcessor /p:Configuration="Release" 
+        StompboxImageProcessor\bin\Release\net6.0-windows\StompboxImageProcessor.exe
+        
+    - name: Run MSBuild
+      working-directory: ${{github.workspace}}
+      run: msbuild .\StompboxUI.sln /p:Configuration=Release
+
+    - name: Add Plugin Archive
+      run: Compress-Archive -Path ${{github.workspace}}\StompboxPlugin\bin\Release\net6.0-windows\* -Destination StompboxVST3Plugin.zip
+
+    - name: Upload Release Asset
+      uses: actions/upload-release-asset@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ needs.create_release.outputs.upload_url }}
+        asset_path: ./StompboxVST3Plugin.zip
+        asset_name: StompboxVST3Plugin.zip
+        asset_content_type: application/zip

README.md

@@ -26,3 +26,23 @@ This is what it looks like:
   - Wah/Auto-Wah
 * Tuner
 * Audio file player
+
+# Platform Support
+
+Stompbox currently can be run in the following ways:
+
+* Headless on Linux (I use it on a [Raspberry Pi based pedalboard](https://www.youtube.com/watch?v=2I_bxxzQs2s)
+* Remote UI on Windows or Android (Android currently not functional, but will be fixed soon)
+* Standalone app on Windows
+* VST3 plugin on Windows
+
+# Installation
+
+To run it as a VST3, you can simply download it from [the releases section of this repo](https://github.com/mikeoliphant/StompboxUI/releases/latest).
+
+Simply extract the .zip file and copy the resulting folder to "C:\Program Files\Common Files\VST3".
+
+# User Data Location
+
+Files, such as NAM models, impulse responses, etc. go in your local user roaming AppData folder. Go to "%APPDATA%" in file explorer, and you should see a "stompbox" folder after the VST has been loaded at least once.
+