Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zyro1331/squeaknp
A simple (and janky) command-line Python app that reads track data from the Windows SMTC and broadcasts it over OSC
https://github.com/zyro1331/squeaknp
lastfm-api opensoundcontrol python resonite vrchat windows winrt
Last synced: 5 days ago
JSON representation
A simple (and janky) command-line Python app that reads track data from the Windows SMTC and broadcasts it over OSC
- Host: GitHub
- URL: https://github.com/zyro1331/squeaknp
- Owner: Zyro1331
- Created: 2025-01-08T10:59:08.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-02-06T18:45:00.000Z (6 days ago)
- Last Synced: 2025-02-06T19:42:24.111Z (6 days ago)
- Topics: lastfm-api, opensoundcontrol, python, resonite, vrchat, windows, winrt
- Language: Python
- Homepage:
- Size: 14.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SqueakNowPlaying 🦇
A simple _(and janky)_ command-line Python app that reads track data from the Windows SMTC and broadcasts it over [OSC](https://en.wikipedia.org/wiki/Open_Sound_Control)
Showcase your favorite music to others in your favorite Social VR applications!
## Resonite
SqueakNP is fully supported in Resonite via the **SqueakNowPlaying UI**.
## VRChat
SqueakNP supports **VRChat's Chatbox** feature, allowing other players to see what you're listening to in real-time.
# 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.
*Sorry Linux friends, you'll get some appreciation sooner or later!*
**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](https://www.python.org/downloads/) or from the [Microsoft Store](https://apps.microsoft.com/detail/9PNRBTZXMB4Z?hl=en-us&gl=US&ocid=pdpshare)
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
```
5. 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](https://www.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](https://github.com/EuphieEuphoria), go send some love and support to him! 🧡