Merge pull request #47 from SutekhVRC/0.3.0-dev

0.3.0 dev

.eslintrc.json

@@ -17,5 +17,10 @@
   "plugins": ["react", "@typescript-eslint"],
   "rules": {
     "react/react-in-jsx-scope": "off"
+  },
+  "settings": {
+    "react": {
+      "version": "detect"
+    }
   }
 }

.github/workflows/build.yml

@@ -32,8 +32,8 @@ jobs:
           TAURI_KEY_PASSWORD: ${{ secrets.TAURI_KEY_PASSWORD }}
         with:
           # the action automatically replaces \_\_VERSION\_\_ with the app version
-          tagName: __VERSION__-beta
-          releaseName: "__VERSION__ BETA"
+          tagName: __VERSION__
+          releaseName: "__VERSION__"
           releaseBody: "See the assets to download this version and install."
           releaseDraft: true
           prerelease: false

.github/workflows/test.yml

@@ -1,6 +1,7 @@
 name: test
 
 on:
+  push:
   pull_request:
     branches: [main]
 
@@ -20,6 +21,7 @@ jobs:
 
   test-build:
     needs: check-frontend
+    if: ${{ github.ref == 'refs/heads/main' }}
     strategy:
       fail-fast: false
     runs-on: [windows-latest]

README.md

@@ -5,35 +5,15 @@ An app to connect bluetooth sex toys to your VRChat avatar using VRChat's OSC im
 
 **Please report bugs/issues or feature requests if you have them!**
 
-***VibeCheck 0.2 is in Beta Testing and will be getting updates frequently.***
-
 [![GitHub all releases](https://img.shields.io/github/downloads/SutekhVRC/VibeCheck/total?color=pink&logoColor=pink&style=for-the-badge)](https://github.com/SutekhVRC/VibeCheck/releases/latest)
 [![Discord](https://img.shields.io/discord/1031167339246407721?color=pink&label=Discord&logo=discord&logoColor=pink&style=for-the-badge)](https://discord.gg/g6kUFtMtpw)
 
-## Getting Started
-
-- [Get a Buttplug IO Supported Toy](https://iostindex.com/?filter0ButtplugSupport=4)
-- Get requirements for [Bluetooth](./docs/Bluetooth.md#requirements) or [Lovense Connect](./docs/LovenseConnect.md#requirements)
-- [Download Installer](https://github.com/SutekhVRC/VibeCheck/releases/latest) and install VibeCheck.
-- [Setup avatar](./docs/AvatarSetup.md) your own custom way or use a VibeCheck prefab.
-- [Setup VibeCheck](./docs/AppSetup.md) app.
-- [Join the Discord](https://discord.gg/g6kUFtMtpw) for help!
-
-## FAQ
-
-Having issues? Check the [FAQ](./docs/Faq.md)
-
-## Credits
-
-- TutiDore: Frontend developer.
-- [DigiGhost](https://twitter.com/digi_ghost): Commissioned Artist (Icons and Banners).
-- [Tini](https://vrchat.com/home/user/usr_7d526959-f3ab-4226-aa82-dba613df998e): Helped with frontend UI mockups and testing.
-- [Buttplug IO developers!](https://buttplug.io/) For the amazing work they have put in to making Bluetooth sex toys more accessible for app developers!
+## Get started with the Wiki!
 
-Thanks to the people below for testing and suggestions!
+1. [Get a Buttplug IO Supported Toy](https://iostindex.com/?filter0ButtplugSupport=4)
+2. [Setup toy connection](https://github.com/SutekhVRC/VibeCheck/wiki/Connecting-Toys) for Bluetooth or Lovense Connect.
+3. [Download Installer](https://github.com/SutekhVRC/VibeCheck/releases/latest) and install VibeCheck.
+4. [Setup avatar](https://github.com/SutekhVRC/VibeCheck/wiki/Avatar-Setup) your own custom way or use a VibeCheck prefab.
+5. [Setup VibeCheck](https://github.com/SutekhVRC/VibeCheck/wiki/VibeCheck-App-Setup) app.
 
-- Googii
-- Buneskapp
-- MikuLove
-- Kali
-- Nitro
+[**Join the Discord**](https://discord.gg/g6kUFtMtpw) for help!

docs/OSCAPI.md

@@ -0,0 +1,54 @@
+# VibeCheck OSC API
+
+VibeCheck features an OSC API that listens while the app is enabled. At the moment the API is early in dev and has only two endpoints.
+To use the API, the parameter on your avatar must be a synced parameter.
+
+Synced parameters include:
+- Parameters listed in the VRCExpressionParameters script.
+- Contacts and Physbones script parameters.
+
+## Endpoints
+
+### State
+
+Value Type: `Boolean`
+
+Parameter Address:
+`vibecheck/api/state`
+
+This endpoint changes the app's OSC state. There are two states: enabled (true) and disabled (false).
+
+### Anatomy
+
+Value Type: `Boolean`
+
+Parameter Address:
+`vibecheck/api/anatomy/<ANATOMY_TYPE>/enabled`
+
+Anatomy address parameter types (Not case-sensitive):
+```
+Anus
+Breasts
+Buttocks 
+Chest
+Clitoris 
+Face
+Feet
+FootL
+FootR
+HandLeft 
+HandRight
+Hands
+Labia
+Mouth
+NA
+Nipples
+Penis
+Perineum 
+Testicles
+Vagina
+Vulva
+Wrist
+```
+
+This endpoint changes the toy's enabled state. The app user can specify the anatomy tag for each toy. When the API endpoint for a specified anatomy tag is hit it will change the all the toy's features to disabled or enabled. There are two states: enabled (true) and disabled (false).

package.json

@@ -14,30 +14,35 @@
     "format:check": "prettier --check --end-of-line=auto \"./src/**/*.{cjs,js,jsx,ts,tsx,html,css,json}\""
   },
   "dependencies": {
-    "@headlessui/react": "^1.7.13",
-    "@heroicons/react": "^2.0.16",
-    "@radix-ui/react-slider": "^1.1.1",
-    "@radix-ui/react-toast": "^1.1.3",
-    "@radix-ui/react-tooltip": "^1.0.5",
-    "@tauri-apps/api": "^1.2.0",
+    "@heroicons/react": "^2.0.18",
+    "@radix-ui/react-slider": "^1.1.2",
+    "@radix-ui/react-switch": "^1.0.3",
+    "@radix-ui/react-tooltip": "^1.0.6",
+    "@tauri-apps/api": "^1.4.0",
+    "clsx": "^1.2.1",
+    "framer-motion": "^10.12.17",
+    "lodash": "^4.17.21",
     "react": "^18.2.0",
-    "react-dom": "^18.2.0"
+    "react-dom": "^18.2.0",
+    "react-toastify": "^9.1.3",
+    "tailwind-merge": "^1.13.2"
   },
   "devDependencies": {
-    "@tauri-apps/cli": "^1.2.3",
-    "@types/node": "^18.14.6",
-    "@types/react": "^18.0.28",
-    "@types/react-dom": "^18.0.11",
-    "@typescript-eslint/eslint-plugin": "^5.54.1",
-    "@typescript-eslint/parser": "^5.54.1",
-    "@vitejs/plugin-react-swc": "^3.2.0",
-    "autoprefixer": "^10.4.13",
-    "eslint": "^8.35.0",
+    "@tauri-apps/cli": "^1.4.0",
+    "@types/lodash": "^4.14.195",
+    "@types/node": "^20.3.1",
+    "@types/react": "^18.2.14",
+    "@types/react-dom": "^18.2.6",
+    "@typescript-eslint/eslint-plugin": "^5.60.0",
+    "@typescript-eslint/parser": "^5.60.0",
+    "@vitejs/plugin-react-swc": "^3.3.2",
+    "autoprefixer": "^10.4.14",
+    "eslint": "^8.43.0",
     "eslint-plugin-react": "^7.32.2",
-    "postcss": "^8.4.21",
-    "prettier": "^2.8.4",
-    "tailwindcss": "^3.2.7",
-    "typescript": "^4.9.5",
-    "vite": "^4.1.4"
+    "postcss": "^8.4.24",
+    "prettier": "^2.8.8",
+    "tailwindcss": "^3.3.2",
+    "typescript": "^5.1.3",
+    "vite": "^4.3.9"
   }
 }