Skip to content

Music Recognition for Social VR

License

Notifications You must be signed in to change notification settings

Soapwood/VXMusic

Repository files navigation

Alt Text

Discord X

Latest Stable Release

GitHub Actions Workflow Status

Music Recognition Overlay for Social VR

Also suitable for Desktop use!

Get VXMusic

Download

Download Installer

Quick Start Menu

Installation

An Installer is available from the Releases page. Click the download button above!

The install wizard will take care of the rest.

VXMusic can also be easily installed as a SteamVR Plugin with one click!

Updates

You will be automatically notified when updates are available.

VXMusic Desktop

You can also choose if you want to be prompted when new versions are available, or manually update on the bottom right of the Desktop Client.

VXMusic Desktop

How to Use

Using the Overlay, simply pull the trigger, and boop with your index finger!

VXMusic Desktop

Recognition also works on Desktop! Enjoy recognising music on livestreams or videos.

VXMusic Desktop

Recognition

VXMusic currently supports two Music Recognition services, Shazam, and AudD.io.

  • Shazam is the recommended API to use, as it has the most rich recognition database and metadata.

  • 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.

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

For easy access, you can click the Open Track Library button on the Recognition tab.

VXMusic Desktop

If you are playing VRChat, VXMusic will name the trackfile after the World you are currently in for later inspection.

VXMusic Desktop

Tip: You can also add recognised tracks to Spotify Playlists and scrobble on Last.fm!

BYO API Keys

VXMusic allows you to "bring-your-own" API Key for Music Recognition Services.

This is super easy to set up, and more importantly, FREE!

See the instructions below on how to get your own API keys.

Shazam

⚠️ Note: With the Shazam Free Test Account, you are limited to 500 Requests per Month.

  1. Navigate to: https://rapidapi.com/apidojo/api/shazam
  2. Sign in with Google, or an alternative login method.
  3. Navigate back to: https://rapidapi.com/apidojo/api/shazam
  4. On the top right, hit Subscribe to Test
VXMusic Desktop
  1. Hit "Start Free Plan"
VXMusic Desktop
  1. Hit "Subscribe"
VXMusic Desktop
  1. From the Shazam API page, click one of the Endpoints on the left
VXMusic Desktop
  1. Under "Code Snippets" on the right, copy the API Key under "x-rapidapi-key"
VXMusic Desktop
  1. In VXMusic, on the Recognition tab, paste this key into the Api Key box.
VXMusic Desktop
  1. If the light next to Shazam turns green, you have successfully set up your API Key! ✔️

AudD.io

⚠️ Note: With the AudD.io Free Trial Account, you are limited to two weeks of usage per account email address.

  1. Navigate to: https://audd.io/
  2. Click on Dashboard on the top right
  3. Sign in with Google, or an alternative login method.
  4. From the Dashboard page, hit Copy next to Your api_token
VXMusic Desktop
  1. In VXMusic, on the Recognition tab, paste this key into the Api Key box.
VXMusic Desktop
  1. If the light next to AudD.io turns green, you have successfully set up your API Key! ✔️

Notifications

VXMusic supports two VR notification services that allow you to receive HUD toast notifications while in VR - SteamVR and XSOverlay.

To choose which service you would like to use, simply click on your desired service from the Notifications tab.

VXMusic Desktop

SteamVR

SteamVR has a built-in Notifications service that VXMusic can use to send you HUD toast notifications.

This is plug and play and doesn't need any additional configuration.

XSOverlay

VXMusic Desktop

VXMusic also interfaces with XSOverlay for HUD toast notifications.

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.

XSOverlay is a paid Overlay available on Steam, and is purely optional when using VXMusic.

Optional Notifications - VRChat ChatBox

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

VXMusic Desktop

You can also enable/disable this from the Notifications tab.

VXMusic Desktop

Connections

Instead of just tracking recognised songs in a text file, VXMusic also supports external Music tracking services, Spotify and Last.fm!

Spotify

⚠️ Note: Spotify Integration

The Spotify Integration App is currently undergoing review by Spotify.

Until this is complete, it is currently required to manually add Users to the App configuration for the Playlists feature to work.

Please reach out on Discord to have your Spotify account added!

To connect VXMusic to your Spotify account, simply click Connect on the Connections tab and follow the login instructions on your browser.

VXMusic Desktop

Tracks will be added to automatically created Playlists.

If you are playing in VRChat, the current World will also be used to name the playlists for later inspection.

VXMusic Desktop

Last.fm

To connect VXMusic to your Last.fm account, navigate to the Connections tab and enter your Login details.

VXMusic Desktop

Recognised tracks will be automatically scrobbled to your Last.fm account while using VXMusic!

VXMusic Desktop

SteamVR

VXMusic can be installed as a SteamVR Plugin.

With this, you can automatically launch VXMusic when you launch SteamVR.

  • Navigate to the Settings Tab
  • Click "Install" under Install as SteamVR Overlay. You will be prompted when the installation is complete.
  • It is recommended that you enable "Launch Overlay on Startup" for quicker startup!
VXMusic Desktop

Reporting Bugs

Please direct all bug reports to the bug_reports channel on the VX Discord!

Each Bug report requires logs to be posted as part of the report.

For quick access to your logs, click Open Logs Directory in the About tab.

Your feedback is greatly appreciated.

VXMusic Desktop

License

VXMusic is protected under the Mozilla Public License Version 2.0.

Okay... so what does this actually mean?

You are free to fork and change VXMusic as you wish - the source code for VXMusic is open and freely distributed.

However, the MPL 2.0 license does not grant you any rights to use the Virtual Xtensions/VXMusic name, logos, or trademark branding.

If you distribute your changes, you must share your modified source code. This ensures that others can benefit from your improvements.

Font

BRUSHSTRIKE is a brush typeface designed by Francesco Canovaro. Free for non-commercial use.

Special Thanks

Special thanks to the testing team and early adopters. Your feedback has been immeasurable. <3

Made in 🇮🇪