Mopidy — Mopidy 4.0.0a2 documentation

# Mopidy

Mopidy is an extensible music server written in Python.

Mopidy plays music from local disk, Spotify, SoundCloud, Google Play Music, and more. You edit the playlist from any phone, tablet, or computer using a variety of MPD and web clients.

Stream music from the cloud

Vanilla Mopidy only plays music from files and radio streams. Through extensions, Mopidy can play music from cloud services like Spotify, SoundCloud, and Google Play Music. With Mopidy’s extension support, backends for new music sources can be easily added.

Mopidy is just a server

Mopidy is a Python application that runs in a terminal or in the background on Linux computers or Macs that have network connectivity and audio output. Out of the box, Mopidy is an HTTP server. If you install the Mopidy-MPD extension, it becomes an MPD server too. Many additional frontends for controlling Mopidy are available as extensions.

Pick your favorite client

You and the people around you can all connect their favorite MPD or web client to the Mopidy server to search for music and manage the playlist together. With a browser or MPD client, which is available for all popular operating systems, you can control the music from any phone, tablet, or computer.

Mopidy on Raspberry Pi

The Raspberry Pi is a popular device to run Mopidy on, either using Raspbian, Ubuntu, or Arch Linux. Pimoroni recommends Mopidy for use with their Pirate Audio audio gear for Raspberry Pi. Mopidy is also a significant building block in the Pi Musicbox integrated audio jukebox system for Raspberry Pi.

Mopidy is hackable

Mopidy’s extension support and Python, JSON-RPC, and JavaScript APIs make Mopidy a perfect base for your projects. In one hack, a Raspberry Pi was embedded in an old cassette player. The buttons and volume control are wired up with GPIO on the Raspberry Pi, and are used to control playback through a custom Mopidy extension. The cassettes have NFC tags used to select playlists from Spotify.

Getting started

To get started with Mopidy, begin by reading Installation.

Getting help

If you get stuck, you can get help at the our Discourse forum or in the `#mopidy-users` stream on Zulip chat.

If you stumble into a bug or have a feature request, please create an issue in the issue tracker. If you’re unsure if it’s a bug or not, ask for help in the forum or the chat first. The source code may also be of help.

If you want to stay up to date on Mopidy developments, you can follow the `#mopidy-dev` stream on Zulip chat or watch out for announcements on the Discourse forum.

Usage

- Installation
  - Debian/Ubuntu
  - Arch Linux
  - Fedora
  - macOS
  - Install from PyPI
  - Raspberry Pi
- Running
  - Running in a terminal
  - Running as a service
- Configuration
  - Configuration file location
  - Editing the configuration
  - View effective configuration
  - Core configuration
  - Extension configuration
  - Adding new configuration values
- Clients
  - Web clients
  - MPD clients
  - MPRIS clients
- Troubleshooting
  - Getting help
  - Show effective configuration
  - Show installed dependencies
  - Debug logging
  - Track metadata
  - Debugging deadlocks
  - Debugging GStreamer

Bundled extensions

- Mopidy-File
- Mopidy-M3U
- Mopidy-Stream
- Mopidy-HTTP
- Mopidy-SoftwareMixer

Advanced setups

- Audio sinks
- Icecast
- UPnP

About

- Changelog
- History
- Versioning
- Authors
- Sponsors

Development

- Contributing
  - Asking questions
  - Helping users
  - Issue guidelines
  - Pull request guidelines
- Development environment
  - Initial setup
  - Running Mopidy from Git
  - Running tests
  - Writing documentation
  - Working on extensions
  - Contribution workflow
- Extension development
  - Anatomy of an extension
  - cookiecutter project template
  - Example README.rst
  - Example setup.py
  - Example __init__.py
  - Example frontend
  - Example backend
  - Example command
  - Example web application
  - Running an extension
  - Python conventions
  - Use of Mopidy APIs
  - Logging in extensions
  - Making HTTP requests from extensions
  - Testing extensions
- Code style
- Release procedures
  - Releasing extensions
  - Releasing Mopidy itself

Reference

- API reference
  - Concepts
  - Basics
  - Web/JavaScript
  - Audio
  - Utilities
- mopidy command
  - Synopsis
  - Description
  - Options
  - Built in commands
  - Extension commands
  - Files
  - Examples
  - Reporting bugs
- Glossary

## Indices and tables

- Index

- Module Index