install.rst 3.28 KB
Newer Older
Colin Duquesnoy's avatar
Colin Duquesnoy committed
1
2
3
4
5
6
7
8
9
Installation
============

This page will guide you throught the installation of MellowPlayer on the
supported operating systems.

GNU/Linux
---------

Colin Duquesnoy's avatar
Colin Duquesnoy committed
10
We provide several ways to install a pre-compiled version of MellowPlayer on GNU/Linux:
Colin Duquesnoy's avatar
Colin Duquesnoy committed
11

Colin Duquesnoy's avatar
Colin Duquesnoy committed
12
13
1. Flatpak
2. Native packages
Colin Duquesnoy's avatar
Colin Duquesnoy committed
14

Colin Duquesnoy's avatar
Colin Duquesnoy committed
15
16
**Flatpak is the recommended solution** as it is what the developers use and test against. It contains a recent version
of QtWebEngine/Chromium which is essential for MellowPlayer to work correctly.
Colin Duquesnoy's avatar
Colin Duquesnoy committed
17

Colin Duquesnoy's avatar
Colin Duquesnoy committed
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
Native packages (especially on old/LTS distributions) may cause problems as they don't provide a recent version of QtWebEngine/Chromium

Flatpak
+++++++

MellowPlayer is available on `flathub`_:

.. code-block:: bash

    flatpak install flathub com.gitlab.ColinDuquesnoy.MellowPlayer


.. _flathub: https://flathub.org/apps/details/com.gitlab.ColinDuquesnoy.MellowPlayer

Native Packages
+++++++++++++++
34

Colin Duquesnoy's avatar
Colin Duquesnoy committed
35
Fedora
Colin Duquesnoy's avatar
Colin Duquesnoy committed
36
~~~~~~
Colin Duquesnoy's avatar
Colin Duquesnoy committed
37
38
39
40

Starting from Fedora 27, MellowPlayer is available from the official stable repositories:

.. code-block:: bash
axxx007xxxz 's avatar
axxx007xxxz committed
41

Colin Duquesnoy's avatar
Colin Duquesnoy committed
42
    sudo dnf install mellowplayer
axxx007xxxz 's avatar
axxx007xxxz committed
43
44

Most services require proprietary audio codecs to work. You can install them from the `RPMFusion repositories`_:
Colin Duquesnoy's avatar
Colin Duquesnoy committed
45
46
47
48
49

.. code-block:: bash

    sudo dnf install qt5-qtwebengine-freeworld

Colin Duquesnoy's avatar
Colin Duquesnoy committed
50
ArchLinux
Colin Duquesnoy's avatar
Colin Duquesnoy committed
51
~~~~~~~~~
Colin Duquesnoy's avatar
Colin Duquesnoy committed
52

Colin Duquesnoy's avatar
Colin Duquesnoy committed
53
MellowPlayer is available from the `AUR`_, install it with your favorite AUR tool (e.g. yaourt).
Colin Duquesnoy's avatar
Colin Duquesnoy committed
54
55
56
57


.. code-block:: bash

Colin Duquesnoy's avatar
Colin Duquesnoy committed
58
    yaourt -S mellowplayer
Colin Duquesnoy's avatar
Colin Duquesnoy committed
59

Colin Duquesnoy's avatar
Colin Duquesnoy committed
60
.. _AUR: https://aur.archlinux.org/packages/mellowplayer
Colin Duquesnoy's avatar
Colin Duquesnoy committed
61

Colin Duquesnoy's avatar
Colin Duquesnoy committed
62
KaOS
Colin Duquesnoy's avatar
Colin Duquesnoy committed
63
~~~~
Colin Duquesnoy's avatar
Colin Duquesnoy committed
64
65

MellowPlayer is available from `KaOSx/apps`_ repository, just run:
Colin Duquesnoy's avatar
Colin Duquesnoy committed
66
67
68

.. code-block:: bash

Colin Duquesnoy's avatar
Colin Duquesnoy committed
69
    $ sudo pacman -S mellowplayer
Colin Duquesnoy's avatar
Colin Duquesnoy committed
70
71


72
.. _KaOSx/apps: https://kaosx.us/packages/packages.php?sortby=name&sortdir=&flagged=&page=&repo=apps&exact=&search=mellowplayer
73

74
Other distributions
Colin Duquesnoy's avatar
Colin Duquesnoy committed
75
~~~~~~~~~~~~~~~~~~~
76
77
78
79

Pre-compiled packages for other distributions (Ubuntu, openSUSE,...) can be found on our `OBS Download Page`_

.. _OBS Download Page: https://software.opensuse.org//download.html?project=home%3AColinDuquesnoy&package=mellowplayer
80

Colin Duquesnoy's avatar
Colin Duquesnoy committed
81
82
Compiling from source
+++++++++++++++++++++
Colin Duquesnoy's avatar
Colin Duquesnoy committed
83

84
See the `README`_ for build instructions.
Colin Duquesnoy's avatar
Colin Duquesnoy committed
85

86
.. _README: https://gitlab.com/ColinDuquesnoy/MellowPlayer/blob/master/README.md#compilation
Colin Duquesnoy's avatar
Colin Duquesnoy committed
87

Colin Duquesnoy's avatar
Colin Duquesnoy committed
88
89
Widevine DRM Plugin
+++++++++++++++++++
90

91
Many services like Spotify, Tidal and Amazon Music require the widevine DRM plugin to work.
92

Salim B's avatar
Salim B committed
93
You can install it on GNU/Linux by running the below script (tested with native packages and flatpak; make sure the `binutils` package is installed on Debian/Ubuntu providing the `ar` command)
94
95
96

.. code-block:: bash

97
    curl -s "https://gitlab.com/ColinDuquesnoy/MellowPlayer/-/raw/master/scripts/install-widevine.sh" | bash
98

99

Colin Duquesnoy's avatar
Colin Duquesnoy committed
100
101
102
103
104
Windows
-------

Just grab the windows installer from the `official website`_ (click on the **Windows folder**) and follow the instructions.

Colin Duquesnoy's avatar
Colin Duquesnoy committed
105
106
Please note the Windows Installer we provide is built with a version of QtWebEngine built without proprietary codecs support (for licensing reasons).
If your favorite service require proprietary codecs to work, you'll need to build QtWebEngine with the flag ``use_proprietary_codecs`` and build MellowPlayer using that QtWebEngine version.
Colin Duquesnoy's avatar
Colin Duquesnoy committed
107

Colin Duquesnoy's avatar
Colin Duquesnoy committed
108

Colin Duquesnoy's avatar
Colin Duquesnoy committed
109
.. _official website: https://colinduquesnoy.gitlab.io/MellowPlayer
axxx007xxxz 's avatar
axxx007xxxz committed
110
.. _RPMFusion repositories: https://rpmfusion.org/Configuration
111
112
113
114
115

OS X
----

OSX is not officially supported anymore. You may try to build and run MellowPlayer from sources.