https://github.com/missingno123/spotify-vrchat-status
Displays song currently playing on Spotify in VRChat
https://github.com/missingno123/spotify-vrchat-status
nodejs spotify vrchat
Last synced: 8 days ago
JSON representation
Displays song currently playing on Spotify in VRChat
- Host: GitHub
- URL: https://github.com/missingno123/spotify-vrchat-status
- Owner: MissingNO123
- License: gpl-3.0
- Created: 2022-02-08T03:14:13.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-10T03:13:59.000Z (about 2 months ago)
- Last Synced: 2025-04-24T00:05:10.983Z (8 days ago)
- Topics: nodejs, spotify, vrchat
- Language: JavaScript
- Homepage:
- Size: 48.8 KB
- Stars: 9
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# **This project is no longer being actively maintained, as it is superceded by many much better alternatives that are easier to set up.**
On top of that, the presence of constantly visible chatbox messages displaying info is **generally looked down upon** by the VRChat community as a whole. For those who still want to use this, the repository will remain here.
# 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](https://github.com/thelinmichael/spotify-web-api-node) and [vrchatapi-javascript](https://github.com/vrchatapi/vrchatapi-javascript).
The OSC version only uses spotify-web-api-node.
## Prerequisites
- Install [Node.js](https://nodejs.org)
- Create an application on [Spotify's Developer Page](https://developer.spotify.com/dashboard/applications)
- 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
```bash
npm run start
```
- The program will open a browser window to generate the auth tokens for Spotify
- If it fails, open http://localhost:8888/login manually
- Log in with your VRChat username and password (and 2FA, if necessary)
- Play something on Spotify
## Usage (OSC)
```bash
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
- If it fails, open http://localhost:8888/login manually
- 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.