-
Notifications
You must be signed in to change notification settings - Fork 0
Add a README card
The hosted card puts your now-playing on a GitHub README without opening your media server to the internet. The app on your PC pushes a small update to the card service; the service never connects back to you.
It's off until you turn it on.
-
Open the nowplaying Settings page (tray icon, Settings) and find the hosted card section.
-
Turn it on. You get a per-PC card link with a random ID that can't be traced to you, plus a ready-made Markdown snippet. Want one card shared by all your PCs? Sign in with GitHub from setup's Card hosting step - see below.
-
Paste the snippet into your README, for example:
-
Play something on your media server. Your card updates within a few seconds.
Success looks like: the card image on your README shows what's playing.
By default each PC gets its own card link with a random ID. If you have more than one PC, sign in to share one card:
- In setup, on the Card hosting step (choose Run setup again from the tray if you're past setup), pick NowPlaying's hosted service and choose Sign in with GitHub.
- Open the GitHub link shown and enter the code. GitHub only tells nowplaying your username - no other permissions.
- Your card link becomes
https://nowplaying-hosted.vercel.app/u/<your-username>.svg. Sign in on each PC; whichever is playing updates the card.
Settings > Hosted card devices lists the PCs signed in as you. You can rename one, sign one out, or Sign out everywhere (the card stops updating until you sign in again).
- Music shows as "Listening", films and TV episodes as "Watching".
- Paused, idle and offline each have their own look.
- Themes, width and which fields to show are options on the card link; secrets never go in the URL.
You choose what the card can ever receive. With a media type hidden or privacy set to private, the card only ever gets "nothing playing". Your server address, username and artwork never leave your PC. Full detail: Privacy and safe configuration and what leaves your PC.
GitHub fetches README images through its own cache, so a fresh card can take a while to appear there even when the origin has updated. Open your card link directly: if it's fresh there, the card service is fine and you just need to wait.
Stop playing or close the app and the card goes back to "Not playing" within about ten minutes.
Disconnect in the hosted card section deletes this PC's state and device key on the service and on your PC. With GitHub sign-in your other PCs keep updating the card; without it, the card link stops showing anything.