{"id":19391934,"url":"https://github.com/bddvlpr/vrc-osc-spotify","last_synced_at":"2025-04-24T00:31:55.828Z","repository":{"id":65806875,"uuid":"528790192","full_name":"bddvlpr/vrc-osc-spotify","owner":"bddvlpr","description":"Small Spotify integration into VRChat's chatbox OSC.","archived":false,"fork":false,"pushed_at":"2023-07-02T14:38:53.000Z","size":351,"stargazers_count":11,"open_issues_count":2,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-16T05:24:20.833Z","etag":null,"topics":["lyrics","music","osc","pinned","spotify","spotify-api","vrchat"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bddvlpr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-25T09:55:53.000Z","updated_at":"2024-09-29T18:26:08.000Z","dependencies_parsed_at":"2024-11-10T10:31:02.348Z","dependency_job_id":"4aca2d41-d393-4f95-b838-3018f5458f9a","html_url":"https://github.com/bddvlpr/vrc-osc-spotify","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bddvlpr%2Fvrc-osc-spotify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bddvlpr%2Fvrc-osc-spotify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bddvlpr%2Fvrc-osc-spotify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bddvlpr%2Fvrc-osc-spotify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bddvlpr","download_url":"https://codeload.github.com/bddvlpr/vrc-osc-spotify/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250539512,"owners_count":21447327,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lyrics","music","osc","pinned","spotify","spotify-api","vrchat"],"created_at":"2024-11-10T10:29:44.682Z","updated_at":"2025-04-24T00:31:54.185Z","avatar_url":"https://github.com/bddvlpr.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vrc-osc-spotify\n\n[![Yarn CI](https://github.com/bddvlpr/vrc-osc-spotify/actions/workflows/node-ci.yml/badge.svg)](https://github.com/bddvlpr/vrc-osc-spotify/actions/workflows/node-ci.yml)\n\n💬 Small Spotify integration into VRChat's chatbox OSC. Works on Linux and Windows!\n\n\u003e **Warning**  \n\u003e This project will soon be integrated in a (currently work-in-progress) project to provide an actual ui and more features.  \n\u003e Development will be halted and focused on the new project.\n\n- [vrc-osc-spotify](#vrc-osc-spotify)\n  - [Prerequisites](#prerequisites)\n  - [Installation](#installation)\n    - [Using Yarn (Recommended)](#using-yarn-recommended)\n    - [Using Docker](#using-docker)\n  - [Setup](#setup)\n  - [Update](#update)\n  - [Lyrics](#lyrics)\n  - [Screenshots](#screenshots)\n\n## Prerequisites\n\nTo allow the application to interface with Spotify, you'll need to create a OAuth application in [Spotify's developer portal](https://developer.spotify.com/dashboard/applications).\nIn order to do this, I've created a step-by-step tutorial below.\n\n1. Open [the Spotify developer portal](https://developer.spotify.com/dashboard/applications) in any browser of your choice.\n2. 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.\n\n![Create](https://i.imgur.com/QZRoDqH.png)\n\n3. 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.**\n\n![Client](https://i.imgur.com/t9aKZmy.png)\n\n4. 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.\n\n![Callback Tab](https://i.imgur.com/wHd2eGY.png)\n\n## Installation\n\nFor both methods you'll need to have [Git](https://git-scm.com/), a version control system, installed.\n\n### Using Yarn (Recommended)\n\nYou'll need to have [Node JS](https://nodejs.org/en/) version 16 or above and a functioning [Yarn](https://yarnpkg.com/) install.\n\n1. Clone the project using `git clone https://github.com/bddvlpr/vrc-osc-spotify.git` to a directory on your local machine.\n2. Enter the directory you've just cloned using `cd vrc-osc-spotify`.\n3. Install the dependencies using `yarn install`.\n4. Copy `.env.example` to `.env` and fill in the 'Client ID' and 'Client Secret' you obtained above.\n5. Run the application using `yarn dev` (or build using `yarn build`).\n\n### Using Docker\n\nYou'll need to have [Docker](https://www.docker.com/) installed on your machine, alongside with [Docker Compose](https://docs.docker.com/compose/) (usually included in the Docker install) version 3 or above.\n\n**Note that this option will only work on Linux hosts as Docker Desktop does not support host network sharing.**\n\n1. Clone the project using `git clone https://github.com/bddvlpr/vrc-osc-spotify.git` to a directory on your local machine.\n2. Enter the directory you've just cloned using `cd vrc-osc-spotify`.\n3. Copy `.env.example` to `.env` and fill in the 'Client ID' and 'Client Secret' you obtained above.\n4. Simply write `docker compose up` and the project will start building itself. After building, the app should automatically start.\n\n## Setup\n\nOnce you've got the app running, navigate to [localhost:8888/login](http://localhost:8888/login) and log in using the account you'll be using for your status.\nAfter this, it should save your access token and refresh token in `data/` and will (probably) never ask you to log in again.\n\nThat's it! Make sure you have OSC enabled and have chatboxes shown.\n\n## Update\n\nIf you want to update the project, simply make sure you're navigated into the right directory (`cd vrc-osc-spotify`) and enter `git pull`.\nMake sure all packages are updated / installed by entering `yarn install` after.\n\n## Lyrics\n\nCurrently (experimentally) fetches lyrics using [musixmatch.com](https://musixmatch.com/)'s internal API and uses them to schedule each lyric in-sync with the song.\nThis feature is currently in development and I will **not** provide support on retrieving an internal API. (See .env.example on how to setup)\n\n## Screenshots\n\n![Example](https://i.imgur.com/ha3hOOD.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbddvlpr%2Fvrc-osc-spotify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbddvlpr%2Fvrc-osc-spotify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbddvlpr%2Fvrc-osc-spotify/lists"}