Getting Started - songify-rocks/Songify GitHub Wiki

Getting started

Install

  1. Download the latest Songify.zip from Releases.
  2. Extract it and run Songify.exe.

Coming from 1.8.x? Follow Migrating from 1.8 before you rely on widgets or recap (you need a Songify API token).

On first launch, Getting started walks through player, accounts, song requests, the OBS text file, and widgets. You can skip any step and finish later from Home or Help β†’ Getting started.

For a reliable Spotify setup, use your own Spotify API applicationβ€”see Spotify setup.

Quick start (in the app)

The wizard asks, in order:

  1. Language and player (Spotify is the usual choice).
  2. Spotify β€” Client ID and account link (if you picked Spotify).
  3. Twitch β€” Broadcaster login if you want song requests. Skip for overlay-only.
  4. Song requests β€” Channel points, chat commands (!ssr), or both.
  5. Rewards (if you chose channel points) β€” Create a reward or check existing ones that should add a song. Refunds only work for rewards created in Songify, not ones made in the Twitch dashboard (those show the Songify icon when they are refundable).
  6. Request rules β€” Who can redeem channel points, and a per-user queue limit. The wizard also lists where to change this later:
    • Settings β†’ Song requests β€” user levels, queue limits per badge, cooldowns
    • Settings β†’ Rewards β€” which rewards add a song, skip rewards, refund conditions
    • Settings β†’ Commands β€” !ssr and other chat commands, triggers, who may use them
    • Settings β†’ Responses β€” what the bot says in chat
  7. Songify API token β€” Needed to upload now playing and the queue to web widgets.
  8. Song output file β€” Songify.txt for an OBS Text source.
  9. Stream widget β€” Optional browser overlay. Browse widgets opens the full gallery (including Premium). Widget generator is a simpler customizer. The local web server port is for custom HTML overlays.

Home keeps a Getting started checklist until the important items are done (or you dismiss it), plus a Stream widget card so overlays are easy to find.

Main window

  • Left navigation β€” Home, Queue, Blocklists, History, User list, then Settings, Help, About. Help includes getting started, support links, folders, and the live log. When the pane is collapsed, hover an icon to see its name.
  • Tools β€” Widget gallery, Widget generator, queue/console pop-out windows, local web server, queue website.
  • Player dropdown (Home) β€” Where Songify reads β€œnow playing” from: Spotify, Windows Playback API, foobar2000, VLC, Browser Companion, or Pear Desktop. See Music sources.
  • Center β€” Current track and album art (when supported).
  • Footer β€” Status icons (Twitch chat, Twitch API, PubSub, Spotify, web server), info text, version, website link.

Common tasks

Goal Where to start
Link Spotify Spotify setup
Twitch bot & song requests Twitch setup, Song requests
Overlay in OBS Widget and OBS
YouTube Music (Pear) Pear (YouTube Music)
Local API / automation Web server and API

Logs

Help β†’ Log folder opens the log directory. Logs are stored under:

%LocalAppData%\Songify.Rocks\Logs

Useful when reporting bugs or diagnosing connection issues.

Next steps