Plugins

IMPORTANT: This guide applies to 3.0.0 only. Version 3.0.0 is still in active development and this page is subject to change.

Table of Contents

• Installation
  • Windows
  • macOS
• Development
  • Getting Started
  • Helper Class
  • DevTools

Installation

Windows

• Navigate to %appdata%\AppleMusic
  • This can be done using (Windows Key) + R and entering this path
• Create a folder in this directory named plugins
• Copy the plugins .js files to the new plugins directory
• Relaunch Apple Music Electron

macOS

• Navigate to ~/Library/Application Support/AppleMusic
  • This can be done by opening the Finder, click the Go menu, and select Go to folder...
• Create a folder in this directory named plugins
• Copy the plugins .js files to the new plugins directory
• Relaunch Apple Music Electron

Development

Getting Started

To get started developing a plugin create a new .js file in the plugins folder. In this plugin.js file add a comment block to the top of your file in this format, and fill in the information:

After that you're good to go! You can now start developing your plugin, we provide a helper class with common Apple Music event handlers and functions that can speed up development. As well as several ipcRenderer messages that can be viewed here.

Development Resources

• Example Plugin
• MusicKit JS documentation
• Apple Music Electron Developer Documentation

Helper Class

AMEPluginHelper

The AMEPluginHelper class is available with common events and functions to help you develop your plugin, without having to reinvent the wheel.
More events and functions are being added as development continues, view the full developer documentation here.

DevTools

Go to Preferences > Advanced Settings > Advanced Development Settings and enable DevTools.
Once relaunched pressing CTRL + SHIFT + I will bring up the DevTools.