Skip to content

Latest commit

 

History

History
106 lines (69 loc) · 3.63 KB

README.md

File metadata and controls

106 lines (69 loc) · 3.63 KB
Raw

Vim Apple Music

View Apple Music media playback status, control playback and favorite songs, all while never leaving Vim (on macOS only)

Screenshot

Requirements

  1. Vim 8 or Neovim
  2. macOS
  3. Apple Music (not iTunes)

Installation

You can probably use any plugin manager to install, just follow their documentation. Here's an example using Vim Plug:

Plug 'arjndr/vim-apple-music'

Setup

You can use g:applemusic_status variable to get the Apple Music playback status, which you can inject wherever variables are supported. Like in the default Vim statusline or Lualine's sections. You can skip this if you want to use the plugin in headless mode

  • Showing Apple Music in default statusline:
" Run this in Vim command
set statusline = %{applemusic_status}
set laststatus = 2
  • Showing Apple Music in lualine:
-- init.lua
require('lualine').setup{
  sections = {
    lualine_c = { 'filename', 'g:applemusic_status' },
  }
}
Headless Mode

The plugin's commands can be used without displaying the playback status anywhere.

Pro tip: Add this to your .vimrc to prevent plugin from polling Apple Music track details:

let g:applemusic_headless = 1

Customization

Use the g:applemusic_status variable to show Apple Music status anywhere that's supported. Custom templates can be used to modify status text if you don't like the default template. Available identifiers are:

Identifier Description
status Playback status of Apple Music (will be replaced with play / pause icons appropriately)
title Title of currently playing media
artist Artist of currently playing media
album Album of currently playing media
loved If the currently playing media is favorited by user
disliked If the currently playing media is disliked by user

Custom icons:

You can have custom icons (or text) for playback status and liked/disliked status by setting the g:applemusic_play_character, g:applemusic_pause_character, g:applemusic_loved_character, g:applemusic_unloved_character, g:applemusic_disliked_character variables

Here's an example:

" using an icon would be prettier :)
let g:applemusic_play_character = 'Paused'
let g:applemusic_pause_character = 'Playing'

let g:applemusic_loved_character = 'Loved'
let g:applemusic_unloved_character = 'Not loved yet'

let g:applemusic_disliked_character = 'Disliked >:('

Commands

  • :AMP - Play/Pause media.

  • :AMN - Equivalent to pressing the next button.

  • :AMPr - Equivalent to pressing the previous button.

  • :AMF - Favorite/heart currently playing media.

  • :AMD - Dislike currently playing media.

  • :AMDS - Dislike and skip currently playing media.

Credits

I probably would've had a really hard time with building this plugin if it weren't for these projects below. I modified some of the code from these projects to suit the needs.

License

GPLv3. See LICENSE.