Skip to content

WordPress plugin that displays a setlist block designed for musician play-along practice sessions.

ironprogrammer/setlist-player

Repository files navigation

Setlist Player

A WordPress plugin for creating and displaying YouTube video setlists with musician-focused playback controls.

WordPress Plugin Version WordPress Compatibility PHP Compatibility License

Description

Setlist Player is designed for musicians who need to practice along with videos at different speeds. Build curated video playlists directly in the WordPress block editor with an intuitive interface and powerful keyboard controls.

Perfect for drummers, guitarists, bassists, or any musician who practices along with YouTube videos.

Features

Editor Experience

  • Sidebar Playlist Management: Build and manage your setlist entirely from the block sidebar
  • Multiple Add Methods: Add YouTube videos by URL, video ID, or search directly within the editor
  • Drag-and-Drop Reordering: Easily reorder videos in your setlist
  • Video Metadata Display: See thumbnails, titles, channels, and durations at a glance

Frontend Playback

  • Clean Video Player: Large, responsive player with your full playlist below
  • Variable Speed Control: Adjust playback from 10% to 150% in 10% increments
  • Audio-Only Mode: Hide the video to reduce distractions
  • Keyboard Shortcuts: Keyboard controls for operation without a touchpad/mouse
    • Space - Play/Pause
    • r - Restart current video
    • p - Previous video
    • n - Next video
    • i - Increase speed
    • d - Decrease speed
    • l - Toggle looping (replays current video)
    • h - Toggle hide video (audio-only display)

Requirements

  • WordPress: 6.1 or higher
  • PHP: 7.4 or higher
  • Google API Key: Required for video add/search functionality (requires YouTube Data API v3)

Installation

From WordPress.org (Coming Soon)

  1. Navigate to Plugins > Add New in your WordPress admin
  2. Search for "Setlist Player"
  3. Click Install and then Activate

Manual Installation

  1. Download the latest release from the Releases page
  2. Upload the setlist-player folder to /wp-content/plugins/
  3. Activate the plugin through the Plugins menu in WordPress

From Source

git clone https://github.com/ironprogrammer/setlist-player.git
cd setlist-player
npm install
composer install
npm run build
# to generate plugin ZIP:
npm run plugin-zip
# or you can symlink this folder to your local site's plugins directory

Setup

  1. After activation, go to Settings > Setlist Player
  2. Enter your Google Developer API key
  3. The plugin will validate your key upon save
  4. Add the "Setlist Player" block to any page or post

Getting a Google API Key

  1. Visit the Google Cloud Console
  2. Create a new project (or select an existing one)
  3. Enable the YouTube Data API v3
  4. Go to Credentials and create an API Key
  5. Strongly Recommended: Set restrictions on your key for application (e.g. "Websites"), website domain(s), and specific API
  6. Copy your API key to the plugin settings and save

For more detailed instructions, see Google's API documentation.

Usage

  1. Add the Setlist Player block to your page or post
  2. In the block sidebar, use the "Add Video" section to build your playlist:
    • Paste a YouTube URL or video ID and click the Add / Search button
    • Or enter a search term and click Add / Search to find videos; refine your search as needed
  3. Drag and drop to reorder videos
  4. Publish your page/post

Support

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for development setup, coding standards, and guidelines.

License

This plugin is licensed under the GPL v2 or later.

About

WordPress plugin that displays a setlist block designed for musician play-along practice sessions.

Resources

Contributing

Stars

Watchers

Forks

Sponsor this project

  •  

Packages

No packages published