MPRIS Media Control for VS Code

An extension for VS Code to control various media players via MPRIS protocol.

• See the track title with a glance
• Hover over the status bar to see the art, album, and artist
• Control the media player directly from VS Code

Getting Started

Prerequisites

This project requires VS Code to function.

It uses D-Bus and MPRIS, so only some platforms and media players are supported. See MPRIS on ArchWiki for more information.

Additionally, building from source requires Node.JS v20 or later.

Installation

Via VS Code Marketplace: MPRIS Media Control on VS Code Marketplace.

Via GitHub Releases: MPRIS Media Control Releases.

Build from source:

1. Clone the repository:

    git clone https://github.com/esdmr/vscode-mpctl
   

2. Navigate to the project directory:

    cd vscode-mpctl
   

3. Install the dependencies:

    corepack pnpm i --prod
   

4. Bundle the source code:

    corepack pnpm run bundle
   

5. Package the extension:

    corepack pnpm run package --out ./mpctl.vsix
   

6. Install the extension package:

    code --install-extension ./mpctl.vsix
   

Usage

The extension will provide the following:

• A status bar showing the title
• A tooltip showing the art, title, artist, album, and some control buttons
• Several commands to control the player: play, pause, next, previous, stop
• A command to switch the player
• A command to reconnect to D-Bus

Contributing

Prepare Your Development Environment

git clone https://github.com/esdmr/vscode-mpctl
cd vscode-mpctl
corepack pnpm i

Unlike the installation instructions, you should install every dependency, rather than only the development ones.

Build the extension

corepack pnpm run bundle

Install the extension

Since you are developing the extension, it might be helpful to symlink the built extension, rather than rely on .vsix packages.

ln -is "$PWD" "$HOME/.vscode/extensions/esdmr.mpctl"

Lint the project

corepack pnpm run typecheck
corepack pnpm run lint

Submit a pull request

If you would like to contribute, please fork the repository and open a pull request to the main branch.

License

This project is provided under the MIT license. Please see the LICENSE file for details.