vrc-osc-spotify

💬 Small Spotify integration into VRChat's chatbox OSC. Works on Linux and Windows!

Warning
This project will soon be integrated in a (currently work-in-progress) project to provide an actual ui and more features.
Development will be halted and focused on the new project.

• vrc-osc-spotify
  • Prerequisites
  • Installation
    • Using Yarn (Recommended)
    • Using Docker
  • Setup
  • Update
  • Lyrics
  • Screenshots

Prerequisites

To allow the application to interface with Spotify, you'll need to create a OAuth application in Spotify's developer portal. In order to do this, I've created a step-by-step tutorial below.

1. Open the Spotify developer portal in any browser of your choice.
2. Press 'CREATE AN APP' and give it a name and description. This shouldn't matter but make sure you can identify it in case it ever breaks.

3. Once you've created an app, click on it to go to its overview. On this page you'll need to get the two parameters called 'Client ID' and 'Client Secret'. Never share the Client Secret with anyone besides yourself.

4. Go to 'Edit Settings', scroll down to 'Redirect URIs' and add http://localhost:8888/callback. Press save at the bottom and you're good to go.

Installation

For both methods you'll need to have Git, a version control system, installed.

Using Yarn (Recommended)

You'll need to have Node JS version 16 or above and a functioning Yarn install.

1. Clone the project using git clone https://github.com/bddvlpr/vrc-osc-spotify.git to a directory on your local machine.
2. Enter the directory you've just cloned using cd vrc-osc-spotify.
3. Install the dependencies using yarn install.
4. Copy .env.example to .env and fill in the 'Client ID' and 'Client Secret' you obtained above.
5. Run the application using yarn dev (or build using yarn build).

Using Docker

You'll need to have Docker installed on your machine, alongside with Docker Compose (usually included in the Docker install) version 3 or above.

Note that this option will only work on Linux hosts as Docker Desktop does not support host network sharing.

1. Clone the project using git clone https://github.com/bddvlpr/vrc-osc-spotify.git to a directory on your local machine.
2. Enter the directory you've just cloned using cd vrc-osc-spotify.
3. Copy .env.example to .env and fill in the 'Client ID' and 'Client Secret' you obtained above.
4. Simply write docker compose up and the project will start building itself. After building, the app should automatically start.

Setup

Once you've got the app running, navigate to localhost:8888/login and log in using the account you'll be using for your status. After this, it should save your access token and refresh token in data/ and will (probably) never ask you to log in again.

That's it! Make sure you have OSC enabled and have chatboxes shown.

Update

If you want to update the project, simply make sure you're navigated into the right directory (cd vrc-osc-spotify) and enter git pull. Make sure all packages are updated / installed by entering yarn install after.

Lyrics

Currently (experimentally) fetches lyrics using musixmatch.com's internal API and uses them to schedule each lyric in-sync with the song. This feature is currently in development and I will not provide support on retrieving an internal API. (See .env.example on how to setup)

Screenshots