Plugins

Vimiv provides the option to extend its functionality with python module plugins. To add a new plugin:

1. Put the python module into the plugins folder $XDG_DATA_HOME/vimiv/plugins/, where $XDG_DATA_HOME is usually ~/.local/share if you have not updated it.

2. Activate it in the PLUGINS section of the configuration file by adding: plugin_name = any additional information where plugin_name is the name of the python module added and any additional information is passed on to the plugin upon startup. Plugins can decide to use this information string for anything they like.

Currently the following user plugins are available:

Overview of user plugins

Name	Description
RawPrev	Raw support based on dcraw instead of qt raw
Importer	Easily import your images from a SD card, camera or any directory into your photo storage
BatchMark	Easily mark contiguous images
Video	List videos within vimiv and play them using an external player

If you would like to write a plugin, some of the information on Writing Plugins may be helpful to get started.

In addition to plugins that can be added by the user, vimiv ships with a few default plugins that can be activated:

Overview of default plugins

Name	Description
demo	Simple hello world greeting as example plugin
imageformats	Plugin enabling support for additional image formats
metadata	Metadata plugin wrapping the available backends to only load one
metadata_piexif	Metadata plugin based on piexif (https://pypi.org/project/piexif/) backend
metadata_pyexiv2	Metadata plugin based on pyexiv2 (https://pypi.org/project/py3exiv2/) backend
print	Plugin enabling print support

imageformats

Activate this plugin by adding imageformats = name, ... to the plugins section of your vimiv.conf. Here name, ... consists of the names of the image formats to add separated by a comma.

Currently the following formats are supported:

• cr2 (requires qt raw)

• avif (requires qt-avif-image-plugin)