https://github.com/jsopn/vrc-lyrics

Display the track and its lyrics in a VRChat's chatbox using the OSC
https://github.com/jsopn/vrc-lyrics

osc spotify synced-lyrics vrchat

Last synced: about 1 month ago
JSON representation

Display the track and its lyrics in a VRChat's chatbox using the OSC

• Host: GitHub
• URL: https://github.com/jsopn/vrc-lyrics
• Owner: jsopn
• License: mit
• Archived: true
• Created: 2023-06-20T15:47:35.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-08-21T10:36:01.000Z (about 1 year ago)
• Last Synced: 2024-09-22T12:32:55.956Z (about 1 month ago)
• Topics: osc, spotify, synced-lyrics, vrchat
• Language: Go
• Homepage:
• Size: 27.3 KB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# VRChat Lyrics

Display the track and its lyrics in VRChat's chatbox using the OSC.



  





  Installation guide



## Installation

1. **Download** the latest version of the software from the [release section](https://github.com/jsopn/vrc-lyrics/releases).

2. **Copy** the `config.example.toml` file and rename it as `config.toml`. Place the `config.toml` file next to the software executable.

3. **Sign in** to your Spotify account by visiting [open.spotify.com](https://open.spotify.com) in your preferred web browser.

4. **Open devtools** in your web browser (shortcut: CTRL+SHIFT+I) and locate the request that contains the `sp_dc` cookie. Copy the value of the `sp_dc` cookie.

5. **Paste** the copied `sp_dc` cookie value into the `config.toml` file, in the appropriate field as indicated by the comments in the configuration file.

6. **Configure** the format settings in the `config.toml` file according to your preferences, following the instructions provided in the comments.

7. **Enable** the OSC (Open Sound Control) feature in VRChat.

8. **Start** the software by running the executable.

9. Enjoy displaying track information and lyrics in VRChat's chatbox!

## Software License

This software is released under the MIT License. You can find the license details in the [LICENSE](LICENSE) file.

## Contributing

Contributions to VRChat Lyrics are welcome! If you would like to contribute, please follow these steps:

1. Fork the repository on GitHub.

2. Make your changes or additions in a new branch.

3. Ensure that your code adheres to the project's coding conventions and style guide.

4. Test your changes thoroughly.

5. Commit your changes and push them to your forked repository.

6. Create a pull request on the main repository, describing your changes and why they should be merged.

7. Wait for the maintainers to review your pull request. Feedback or requests for further changes may be provided.

8. Once your pull request is approved, it will be merged into the main repository.

Thank you for contributing to VRChat Lyrics! Your help is greatly appreciated.