mopidy/docs/index.rst
2015-07-08 23:43:40 +02:00

165 lines
4.1 KiB
ReStructuredText

******
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 range
of MPD and web clients.
**Stream music from the cloud**
Vanilla Mopidy only plays music from your :ref:`local disk <ext-local>` and
:ref:`radio streams <ext-stream>`. Through :ref:`extensions <ext-backends>`,
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 :ref:`MPD <ext-mpd>` and :ref:`HTTP <ext-http>` server.
:ref:`Additional frontends <ext-frontends>` for controlling Mopidy can be
installed from extensions.
**Everybody use their favorite client**
You and the people around you can all connect their favorite :ref:`MPD
<mpd-clients>` or :ref:`web client <http-clients>` 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 :ref:`Raspberry Pi <raspberrypi-installation>` is a popular device to run
Mopidy on, either using Raspbian or Arch Linux. It is quite slow, but it is
very affordable. In fact, the Kickstarter funded Gramofon: Modern Cloud Jukebox
project used Mopidy on a Raspberry Pi to prototype the Gramofon device. Mopidy
is also a major building block in the Pi Musicbox integrated audio jukebox
system for Raspberry Pi.
**Mopidy is hackable**
Mopidy's extension support and :ref:`Python <api-ref>`, :ref:`JSON-RPC
<http-api>`, and :ref:`JavaScript APIs <mopidy-js>` makes Mopidy perfect for
building your own hacks. In one project, 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 is 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, start by reading :ref:`installation`.
.. _getting-help:
**Getting help**
If you get stuck, you can get help at the `Mopidy discussion forum
<https://discuss.mopidy.com/>`_. We also hang around at IRC on the ``#mopidy``
channel at `irc.freenode.net <http://freenode.net/>`_. The IRC channel has
`public searchable logs <https://botbot.me/freenode/mopidy/>`_.
If you stumble into a bug or have a feature request, please create an issue in
the `issue tracker <https://github.com/mopidy/mopidy/issues>`_. If you're
unsure if it's a bug or not, ask for help in the forum or at IRC first. The
`source code <https://github.com/mopidy/mopidy>`_ may also be of help.
If you want to stay up to date on Mopidy developments, you can follow `@mopidy
<https://twitter.com/mopidy/>`_ on Twitter. There's also a `mailing list
<https://groups.google.com/forum/?fromgroups=#!forum/mopidy>`_ used for
announcements related to Mopidy and Mopidy extensions.
Usage
=====
.. toctree::
:maxdepth: 2
installation/index
config
running
troubleshooting
debian
.. _ext:
Extensions
==========
.. toctree::
:maxdepth: 2
ext/local
ext/file
ext/m3u
ext/stream
ext/http
ext/mpd
ext/softwaremixer
ext/mixers
ext/backends
ext/frontends
ext/web
Clients
=======
.. toctree::
:maxdepth: 2
clients/http
clients/mpd
clients/mpris
clients/upnp
About
=====
.. toctree::
:maxdepth: 1
authors
sponsors
changelog
versioning
Development
===========
.. toctree::
:maxdepth: 2
contributing
devenv
releasing
codestyle
extensiondev
Reference
=========
.. toctree::
:maxdepth: 2
glossary
command
api/index
modules/index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`