Skip to content

MissingNO123/spotify-vrchat-status

Repository files navigation

Due to recent changes to the VRChat API, requests must now be properly identified. Until I update the repo to fix this, I'd consider only using the OSC version for now.

Spotify Now Playing Status for VRChat

Sets your status on VRChat to the name and artist of the currently playing song on Spotify. There is also an OSC version, which shows your now playing status in your chatbox. Uses spotify-web-api-node and vrchatapi-javascript. The OSC version only uses spotify-web-api-node.

Prerequisites

  • Install Node.js
  • Create an application on Spotify's Developer Page
  • Add http://localhost:8888/callback to the callback URL whitelist
  • Take note of the Client ID and Secret for your application

Installation

  • Clone the repository with git clone https://github.com/MissingNO123/spotify-vrchat-status.git
  • cd into the project folder
  • copy or rename config.example.json to config.json
  • add your Client ID and Secret from Spotify to config.json
  • Run npm install

Usage

npm run start
  • The program will open a browser window to generate the auth tokens for Spotify
  • Log in with your VRChat username and password (and 2FA, if necessary)
  • Play something on Spotify

Usage (OSC)

npm run osc
  • Make sure OSC is enabled in VRChat (Radial Menu > Options > OSC > Enabled)
  • The program will open a browser window to generate the auth tokens for Spotify
  • Play something on Spotify
  • While using the OSC version, it is not required to log in to VRChat

Disclaimer

VRChat does not officially support use of their API outside of the VRChat client, so using this tool could get your account suspended without warning at any time. While the program tries not to access either API excessively, there's no guarantee that this won't be deemed excessive by VRChat's moderators in the future.

If you are concerned about this, just use the OSC version, as it does not use the API and only sends data to people in your instance through the VRChat application.

Either way, use this at your own risk.

This is the official statement from Tupper, VRChat's community manager:

Use of the API using applications other than the approved methods (website, VRChat application) are not officially supported. You may use the API for your own application, but keep these guidelines in mind:

  • We do not provide documentation or support for the API.
  • Do not make queries to the API more than once per 60 seconds.
  • Abuse of the API may result in account termination.
  • Access to API endpoints may break at any given time, with no warning.

About

Displays song currently playing on Spotify in VRChat

Topics

Resources

License

Stars

Watchers

Forks