Skip to content

Latest commit

 

History

History
67 lines (60 loc) · 2.97 KB

README.md

File metadata and controls

67 lines (60 loc) · 2.97 KB

Spotifly

image me

Overview

Spotifly is a cross-platform overlay that provides real-time updates on your Spotify playback. By integrating OAuth authentication with the advanced Spotify Web API, it offers a seamless and dynamic display of current track information, playback progress, and upcoming queue details directly on your desktop.

Features

  • Cross-Platform Overlay: Built with Electron and Node.js to work on multiple operating systems.
  • Secure Authentication: Utilizes OAuth for secure, reliable connection with Spotify.
  • Real-Time Playback Monitoring: High-frequency API updates ensure the overlay stays in sync with your Spotify player.
  • Responsive UI: Implements debounced window resizing for a smooth user experience.
  • Optimized API Management: Features strategic caching and adaptive rate limiting to handle rapid API calls efficiently.

Installation

  1. Clone the Repository:
    git clone https://github.com/your-username/spotifly.git
    cd spotifly
  2. Install Dependencies:
    npm install
  3. Run the Application:
    npm start

Configuration

Spotify Credentials: Update your Spotify client credentials in spotifyClient.js with your own client ID and client secret obtained from your Spotify Developer Dashboard.

Customization: Tweak the overlay styling by modifying index.html and renderer.js to match your preferences.

Usage

After launching the application, you will be prompted to authenticate with your Spotify account. Once connected, the overlay displays:

  • Current Track Details: Including album art, track title, artist, and playback progress.
  • Playback Controls: Manage play/pause, skip tracks, toggle shuffle, and repeat.
  • Queue Management: View the upcoming tracks in your Spotify queue.

Contributing

Contributions are welcome! If you'd like to improve Spotifly or report an issue, please:

  1. Fork the repository.
  2. Create a feature branch.
  3. Commit your changes and open a pull request.

License

Spotifly is released under the MIT License. See the LICENSE file for more details.