content/projects/picard-plugins.md

   1 ---
   2 title: Picard Plugins
   3 copyright: 2020 Nick Bowler
   4 license: gpl-3 or (at your option) any later version
   5 ---
   6
   7 I maintain a variety of extensions which make the [MusicBrainz
   8 Picard][picard-homepage] tagger even better than it already is.
   9
  10 [picard-homepage]: https://picard.musicbrainz.org/
  11
  12 # Obtaining the plugins
  13
  14 [picard-plugins-gitweb]: //git.draconx.ca/gitweb/picard-plugins.git
  15
  16 As a collection of extension programs, there are no release packages per se.
  17 The collection [may be browsed online][picard-plugins-gitweb] or cloned
  18 directly using git, e.g.,
  19
  20 <kbd>git clone https://git.draconx.ca/picard-plugins.git</kbd>
  21
  22 Alternately, direct links to the latest revision of individual plugins are
  23 provided below.
  24
  25 # Installation
  26
  27 Individual plugins may be installed by simply placing them in the Picard user
  28 directory, typically `~/.config/MusicBrainz/Picard/plugins/`.  A newly
  29 installed plugin will be disabled by default and must be enabled in Picard's
  30 plugin dialog.
  31
  32 Note that Picard must be restarted after any plugin changes in order for them
  33 to take effect.
  34
  35 # List of Plugins
  36
  37 [karaoke-flagger-plugin]: //git.draconx.ca/gitweb/picard-plugins.git/blob_plain/HEAD:/karaoke-flagger.py
  38 [external-script-plugin]: //git.draconx.ca/gitweb/picard-plugins.git/blob_plain/HEAD:/external-script-manager.py
  39 [tweak-filename-plugin]: //git.draconx.ca/gitweb/picard-plugins.git/blob_plain/HEAD:/tweak-filename-filter.py
  40 [no-remote-plugin]: //git.draconx.ca/gitweb/picard-plugins.git/blob_plain/HEAD:/no-remote-plugins.py
  41
  42 Where relevant, detailed usage information for these plugins is displayed
  43 in Picard's plugin dialog after installation.
  44
  45 [Karaoke+ Flagger][karaoke-flagger-plugin]
  46
  47 : Enabling this plugin adds new metadata variables so that Picard tagger
  48   scripts can identify recordings which have the "karaoke version of..."
  49   relationship.  This is useful as part of a system to generate playlists
  50   for your karaoke dance parties (or to just exclude karaoke tracks from
  51   your normal playlists).
  52
  53   Recordings of audio dramas are flagged similarly.
  54
  55 [vim-homepage]: https://www.vim.org/
  56
  57 [External Script Manager][external-script-plugin]
  58
  59 : Enabling this plugin will allow tagger scripts to be almost entirely managed
  60   outside of Picard and edited using [your favourite editor][vim-homepage].
  61   Aside from the obvious benefit of using a real editor, this is useful for
  62   tracking script changes in Git or synchronizing scripts between different
  63   Picard installations.
  64
  65 [Tweak Filename Filter][tweak-filename-plugin]
  66
  67 : Prior to generating filenames, Picard will substitute directory separators
  68   in metadata with underscores.  This behaviour cannot be adjusted in a file
  69   naming script as the script only gets the metadata after this substitution.
  70   Enabling this plugin adds additional configuration options to adjust how
  71   this substitution is performed.
  72
  73 [No Remote Plugins][no-remote-plugin]
  74
  75 : Picard's plugins dialog by default contains a list of online plugins that
  76   Picard will automatically download and install at the push of a button.
  77   Unfortunately many of these online plugins have missing or unclear license
  78   information and as such are probably non-free.
  79
  80   Enabling this plugin will prevent Picard from downloading the online plugin
  81   list at startup so that it cannot entice you to install proprietary plugins.
  82   The only plugins displayed in the UI will be those you have manually placed
  83   in the plugins directory.
  84
  85 # License
  86
  87 These plugins are free software: you can redistribute and/or modify them
  88 under the terms of the GNU General Public License as published by the Free
  89 Software Foundation, either version 3 of the License or (at your option)
  90 any later version.