feat(workflow): add example config

nerdywoffy · Aug 8, 2022 · 7f16ecb · 7f16ecb
1 parent 0f00397
commit 7f16ecb
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 9 deletions.
diff --git a/.github/assets/config.example.yaml b/.github/assets/config.example.yaml
@@ -0,0 +1,34 @@
+OSC:
+  Sender:
+    Host: "127.0.0.1"
+    Port: 9000
+  Receiver:
+    Host: "127.0.0.1"
+    Port: 9001
+
+OBS:
+  WebsocketVersion: "v4"
+  Credential:
+    Host: "localhost"
+    Port: 4444
+    Password: "your-secure-obs-password-here"
+  Scene:
+    - Number: 1
+      Name: "Main Screen"
+    - Number: 2
+      Name: "VRChat Screen #1"
+    - Number: 3
+      Name: "VRChat Screen #2"
+    - Number: 4
+      Name: "VRChat Screen #3"
+    - Number: 5
+      Name: "Closing #1"
+    - Number: 6
+      Name: "Closing #2"
+    - Number: 7
+      Name: "Closing #3"
+    - Number: 8
+      Name: "Avatar Only"
+
+Logs:
+  Level: "info"
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -6,7 +6,7 @@ on:
 
 jobs:
     build:
-      name: Build VRChat OBS Control
+      name: Build VRChat OBS Control (Windows)
       runs-on: ubuntu-latest
       steps:
         - name: Checkout
@@ -15,6 +15,7 @@ jobs:
         - name: Prepare binary folder
           run: |
             mkdir bin/
+            cp .github/assets/config.example.yaml bin/config.yaml
 
         - name: Setup Go
           uses: actions/setup-go@v3
@@ -25,13 +26,13 @@ jobs:
           run: 'GOOS=windows GOARCH=amd64 go build -o bin/vrchat-obs-control-win64.exe .'
 
         - name: Compress 
-          run: 'tar -cvf vrc-obs.tar bin'
+          run: 'zip -r vrchat-obs-control-win64.zip bin/'
 
         - name: Upload artifacts
           uses: actions/upload-artifact@v2
           with:
-            name: vrc-obs
-            path: vrc-obs.tar
+            name: vrchat-obs-control-win64
+            path: vrchat-obs-control-win64.zip
 
     release:
       name: Release
@@ -41,15 +42,13 @@ jobs:
         - name: Download artifacts
           uses: actions/download-artifact@v2
           with:
-            name: vrc-obs
-
-        - name: Extract
-          run: 'tar xf vrc-obs.tar'
+            name: vrchat-obs-control-win64
 
         - name: Create release
           uses: "lauravuo/action-automatic-releases@latest"
           with:
             repo_token: "${{ secrets.GITHUB_TOKEN }}"
             prerelease: false
             auto_generate_release_notes: true
-            files: bin/*
+            files: |
+              vrchat-obs-control-win64.zip