Skip to content

Jelmerro/Garlmap

Repository files navigation

Garlmap

icon

Garlmap is the Gapless Almighty Rule-based Logical Mpv Audio Player.

  • Gapless playback for a wide range of formats
    • No clicks or stops between different tracks, even for mp3
  • Almighty knowledge of your library and its tags
    • It knows a lot, so it rarely needs internet to find answers
  • Rule-based playlist management and auto queueing
    • Search with filters, custom queries and build a dynamic playlist
  • Logical in form and function, no hidden magic
    • A base folder, your own queries and a playlist, that's all
  • Mpv is used as the underlying technology to play the files
  • Audio only playback, no video support or other second-grade features
  • Player that plays music >.>

Why

  • Listening to music locally should allow you to define rules for automatic playback
  • Queuing that one album from a specific artist after the current song should be easy
  • Lyrics and gapless playback are essential features for active listening to music
  • Completely offline, unless told to fetch stuff, which should be cached until you tell it not to
  • Re-ordering songs to play should be configurable for that specific set of songs
  • There should be options to clear or hide irrelevant info in the playlist automatically
  • Adding a group of songs to your queue in bulk should allow you to remove them in one go

Getting started

Fedora

I host a custom DNF repository that you can use for Garlmap, or you can download a release from here.

sudo dnf config-manager --add-repo https://jelmerro.nl/fedora/jelmerro.repo
sudo dnf install garlmap

Windows/Mac/Other Linux

  1. Install mpv from mpv.io or your package manager. You must add mpv to your path, or use the --mpv option.
  2. Download a release from here.
  3. Read the built-in help on the right or run Garlmap with --help on startup.

See what's changed recently by viewing the changelog.

Building

Please clone this repo and run npm ci then npm start. You should now have Garlmap up and running from source, next you can make your own executable builds using node build. See node build --help for other options, the builds will be stored in dist. If you plan to contribute, please follow the included linter, see npm run lint.

License

Garlmap is created by Jelmer van Arnhem.

You can copy or modify the code under the terms of the GPL3.0 or later versions. For more information and legal terms, see the LICENSE file.