Skip to content

Latest commit

 

History

History
169 lines (124 loc) · 6.22 KB

README.md

File metadata and controls

169 lines (124 loc) · 6.22 KB
Raw

GNOME MPV

GNOME MPV is a simple GTK+ frontend for mpv. GNOME MPV interacts with mpv via the client API exported by libmpv, allowing access to mpv's powerful playback capabilities.

Screenshot

Dependencies

  • appstream-glib[1] (build)
  • autoconf >= 2.69[1] (build)
  • autoconf-archive[1] (build)
  • automake >= 1.12[1] (build)
  • pkg-config (build)
  • gcc (build)
  • glib >= 2.44
  • gtk >= 3.18[2]
  • mpv >= 0.21
  • epoxy
  • lua (optional)
  • youtube-dl (optional)

[1]: Not required when building from release tarballs

[2]: Some features may be unavailable with gtk < 3.20

Installation

GNU/Linux packages

Flatpak

Flatpak packages support multiple distributions and are sandboxed. Flatpak 0.9.5+ is recommended for best integration.

Stable releases are hosted on Flathub:

flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
flatpak install flathub io.github.GnomeMpv

Development versions are also packaged:

flatpak install https://dl.tingping.se/flatpak/gnome-mpv.flatpakref

Source code

Run the following command in the source code directory to build and install:

./autogen.sh && make && sudo make install

When building from release tarballs, replace ./autogen.sh with ./configure:

./configure && make && sudo make install

Alternatively, you can use Meson:

meson build && cd build && ninja && sudo ninja install

Usage

Opening files

There are 4 ways to open files in GNOME MPV.

  1. Passing files and/or URIs as command line arguments.
  2. Using the file chooser dialog box, accessible via the "Open" menu item.
  3. Typing URI into the "Open Location" dialog box, accessible via the menu item with the same name.
  4. Dragging and dropping files or URIs onto GNOME MPV.

Manipulating playlist

The playlist is hidden by default. To show the playlist, click the "Playlist" menu item or press F9. Files can be added by dragging and dropping files or URIs onto the playlist. Dropping files or URIs onto the video area will replace the content of the playlist. Playlist files or online playlists (eg. YouTube's playlist) will be automatically expanded into individual items when loaded.

Items in the playlist can be reordered via drag-and-drop. To remove items from the playlist, select the item by clicking on it then press the delete button on your keyboard.

Configuration

GNOME MPV can be configured using the preferences dialog accessible via the "Preferences" menu item. Additional configuration options can be set from an external file using the same syntax as mpv's mpv.conf. See mpv's man page for the full list of options. The file must be specified and enabled in the preferences dialog under the "MPV Configuration" section.

Options can also be set using the "Extra MPV Options" text box in the preferences dialog. The syntax used is the same as mpv's command line options.

Lua Scripts

GNOME MPV can use most mpv Lua scripts as-is. Some Lua scripts may define keybindings that conflict with GNOME MPV, in which case you'll need to resolve the conflict by explicitly defining new keybindings using input.conf. See mpv's manual for more details.

Lua scripts can be installed by switching to the Lua Scripts tab in the preferences dialog and dropping script files there. A list of mpv Lua scripts can be found here.

Keybindings

GNOME MPV defines a set of keybindings in the macro DEFAULT_KEYBINDS, which can be found in src/def.h. The syntax used is exactly the same as mpv's input.conf. These keybindings are applied on top of default keybindings provided by mpv.

Additional keybindings can be defined in an external file using mpv's input.conf syntax. The file can be set in the preferences dialog under the "Keybindings" section.

Contributing Translations

GNOME MPV uses Zanata to coordinate translations. You can find GNOME MPV's page here. To start translating, follow the instructions here. If you'd like to add a new language, open an issue on GitHub.

While translating, you will find the string translator-credits. You should not translate this string. Instead, you should put your name, and optionally your email address, in the following format: FirstName LastName <Email Address>. Your name will then appear in the About dialog when your translation is active.

License

GNOME MPV is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

GNOME MPV is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with GNOME MPV. If not, see http://www.gnu.org/licenses/.