Skip to content

Commit 81185a3

Browse files
committed
Merge branch 'main' of https://github.com/Soapwood/VXMusic
2 parents c4c60ef + b33d447 commit 81185a3

File tree

1 file changed

+11
-62
lines changed

1 file changed

+11
-62
lines changed

README.md

Lines changed: 11 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ Download Installer
2323

2424
<div>
2525
<a href="#how-to-use" class="button">How to Use</a> |
26-
<a href="#byo-api-keys" class="button">API Key Setup</a> |
2726
<a href="#steamvr" class="button">Add to SteamVR</a>
2827
</div>
2928

@@ -60,11 +59,7 @@ You can also choose if you want to be prompted when new versions are available,
6059
<img src=".github/readme/DesktopRecognition.gif" alt="VXMusic Desktop" style="max-width: 80%">
6160

6261
## Recognition
63-
VXMusic currently supports two Music Recognition services, **Shazam**, and **AudD.io**.
64-
65-
- Shazam is the recommended API to use, as it has the most rich recognition database and metadata.
66-
67-
- AudD.io doesn't have the same rich data experience, but it runs a lot faster than Shazam. The speed is negligible in the grand scheme of things.
62+
VXMusic uses **Shazam** for music recognition.
6863

6964
Recognised tracks are stored in your `My Documents/VXMusic` folder.
7065

@@ -78,61 +73,6 @@ For easy access, you can click the `Open Track Library` button on the Recognitio
7873

7974
### Tip: You can also add recognised tracks to <a href="#spotify" class="button">Spotify Playlists</a> and scrobble on <a href="#connections" class="button">Last.fm</a>!
8075

81-
82-
### BYO API Keys
83-
VXMusic allows you to "bring-your-own" API Key for Music Recognition Services.
84-
85-
This is super easy to set up, and more importantly, **FREE!**
86-
87-
See the instructions below on how to get your own API keys.
88-
89-
### Shazam
90-
#### ⚠️ Note: With the Shazam Free Test Account, you are limited to 500 Requests per Month.
91-
1. Navigate to: https://rapidapi.com/apidojo/api/shazam
92-
2. Sign in with Google, or an alternative login method.
93-
3. Navigate back to: https://rapidapi.com/apidojo/api/shazam
94-
4. On the top right, hit Subscribe to Test
95-
96-
<img src=".github/readme/OnTheTopRightHitSubscribeToTest.png" alt="VXMusic Desktop" width="50%">
97-
98-
5. Hit "Start Free Plan"
99-
100-
<img src=".github/readme/HitStartFreePlan.png" alt="VXMusic Desktop" width="50%">
101-
102-
6. Hit "Subscribe"
103-
104-
<img src=".github/readme/HitSubscribe.png" alt="VXMusic Desktop" width="50%">
105-
106-
7. From the Shazam API page, click one of the Endpoints on the left
107-
108-
<img src=".github/readme/ClockOneOfTheEndpointsOnTheLeft.png" alt="VXMusic Desktop" width="40%">
109-
110-
8. Under "Code Snippets" on the right, copy the API Key under "x-rapidapi-key"
111-
112-
<img src=".github/readme/GrabTheApiKeyOnTheRight.png" alt="VXMusic Desktop" width="60%">
113-
114-
8. In VXMusic, on the Recognition tab, paste this key into the Api Key box.
115-
116-
<img src=".github/readme/PasteThisIntoTheApiKeyBox.png" alt="VXMusic Desktop" width="60%">
117-
118-
9. If the light next to Shazam turns green, you have successfully set up your API Key! ✔️
119-
120-
### AudD.io
121-
#### ⚠️ Note: With the AudD.io Free Trial Account, you are limited to two weeks of usage per account email address.
122-
123-
1. Navigate to: https://audd.io/
124-
2. Click on `Dashboard` on the top right
125-
3. Sign in with Google, or an alternative login method.
126-
4. From the Dashboard page, hit `Copy` next to `Your api_token`
127-
128-
<img src=".github/readme/AudDDashboard.png" alt="VXMusic Desktop" width="60%">
129-
130-
6. In VXMusic, on the Recognition tab, paste this key into the Api Key box.
131-
132-
<img src=".github/readme/AudDApiKeyBox.png" alt="VXMusic Desktop" width="60%">
133-
134-
7. If the light next to AudD.io turns green, you have successfully set up your API Key! ✔️
135-
13676
## Notifications
13777
VXMusic supports two VR notification services that allow you to receive HUD toast notifications while in VR - **SteamVR**, **XSOverlay** and **OVR Toolkit**.
13878

@@ -146,14 +86,23 @@ SteamVR has a built-in Notifications service that VXMusic can use to send you HU
14686
This is plug and play and doesn't need any additional configuration.
14787

14888
### XSOverlay
149-
<img src=".github/readme/XSOverlayLogo.jpg" alt="VXMusic Desktop" width="30%">
89+
<img src=".github/readme/XSOverlayLogo.jpg" alt="XSOverlayLogo.jpg" width="30%">
15090

15191
VXMusic also interfaces with XSOverlay for HUD toast notifications.
15292

15393
XSOverlay is the recommended Notification service for how responsive and reactive it is. Ultimately it is purely aesthetical, but you will benefit from the bespoke configuration offered by XSOverlay if you are already a user.
15494

15595
XSOverlay is a paid Overlay available on [Steam](https://store.steampowered.com/app/1173510/XSOverlay/), and is purely optional when using VXMusic.
15696

97+
### OVR ToolKit
98+
<img src=".github/readme/OVRToolKit.jpg" alt="OVRToolKit.jpg" width="30%">
99+
100+
OVR ToolKit is another fantastic option for notifications.
101+
102+
This also has a lovely UI for notifications, and a more bespoke desktop application for settings.
103+
104+
OVRToolkit is a paid Overlay available on [Steam](https://store.steampowered.com/app/1068820/OVR_Toolkit__Desktop_Overlay/), and is purely optional when using VXMusic.
105+
157106
## Optional Notifications - VRChat ChatBox
158107

159108
VXMusic can send ChatBox notifications to VRChat to share Recognition results with your friends!

0 commit comments

Comments
 (0)