Skip to content

A simple (and janky) command-line Python app that reads track data from the Windows SMTC and broadcasts it over OSC

Notifications You must be signed in to change notification settings

Zyro1331/SqueakNP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SqueakNowPlaying 🦇

A simple (and janky) command-line Python app that reads track data from the Windows SMTC and broadcasts it over OSC

Showcase your favorite music to others in your favorite Social VR applications!

Resonite

SqueakNP is fully supported in Resonite via the SqueakNowPlaying UI.
A UI in Resonite showing a currently playing song

VRChat

SqueakNP supports VRChat's Chatbox feature, allowing other players to see what you're listening to in real-time.

A chatbox popup over a users head showing what they are listening to

How to Install

⚠️ You must be running Windows 10 or Windows 11 to use SqueakNP. Older or Alternative Operating Systems are untested and likely unsupported.

🐧 If you're running Linux, you should go check out GoSqueak!

Since SqueakNP is not self-packaged yet, you're going to have to setup Python on your system.

  1. Grab the latest Python 3.1x at the Official Website or from the Microsoft Store

  2. Once it's installed, go ahead and grab the latest SqueakNP by clicking the green "Code" button at the top right and pressing "Download Zip".
    *If you're familiar with GitHub, just clone the repo with whatever you like!

  3. Extract the zip file, and open a Terminal window to it.
    Make sure the Terminal's path is set to where all files are, instead of just the subfolder.

  4. Create a new Virtual Environment with the following command.

python3 -m venv env
  1. You should see a new folder appear called "env", now we can install the required dependencies to it!
"env\Scripts\pip.exe" install -r requirements.txt

If you saw no errors during this process, congrats! You've got all the dependencies installed, and now you can run SqueakNP by running "start.bat"!

Setup for VRChat

SqueakNP requires manually enabling VRChat's Chatbox support.
If you've ran SqueakNP for the first time, you should see a new file named "squeakconfig.cfg"
Right-click it and open it with Notepad (or any preferred text editor) and set the port value to 9000 instead of 9025.
Then, in the very bottom of the file there should be a section titled VRChat. Change the enabled value to true and you should be all set!

Using Last.fm for Album Artwork fetching

SqueakNP supports Last.fm for showing album artwork in Resonite!
To setup album artwork, visit https://www.last.fm and create an account there.
Then, once you verify your email, head to https://www.last.fm/api/account/create to obtain your API Key.
Make sure to name the application accordingly and set the Callback URL to http://localhost
Once you've gotten your API Key, paste the key and your Last.fm username into the fields in squeakconfig.cfg

Last.fm support was added via a generous code donation from @EuphieEuphoria, go send some love and support to him! 🧡

About

A simple (and janky) command-line Python app that reads track data from the Windows SMTC and broadcasts it over OSC

Topics

Resources

Stars

Watchers

Forks