Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thimc/vifmimg
Image previews for Vifm (vi file manager) using Überzug
https://github.com/thimc/vifmimg
filepreview image ueberzug vifm
Last synced: 6 days ago
JSON representation
Image previews for Vifm (vi file manager) using Überzug
- Host: GitHub
- URL: https://github.com/thimc/vifmimg
- Owner: thimc
- License: gpl-3.0
- Created: 2019-03-03T15:11:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-16T15:48:46.000Z (10 months ago)
- Last Synced: 2024-11-12T03:34:58.701Z (8 days ago)
- Topics: filepreview, image, ueberzug, vifm
- Language: Shell
- Homepage:
- Size: 381 KB
- Stars: 242
- Watchers: 9
- Forks: 26
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Image previews using Überzug for vifm (vi file manager)
This script is used along [vifm](https://github.com/vifm/vifm) to generate image previews for various file types in vifm.
If you want image preview support for [lf](https://github.com/gokcehan/lf) check out [cirala/lfimg](https://github.com/cirala/lfimg).
The script is currently able to handle the following formats:
* Video
* Pdf
* Djvu
* eBook
* Images
* Audio files
* Fonts
All previews are cached (except for regular images) and stored in your **~/.cache/vifm/** folder.
## Installation
1. Copy the **vifmimg** and **vifmrun** scripts to a folder that is included in your $PATH
variable for easy access to the files.
2. Edit your **~/.config/vifm/vifmrc** file and add fileviewer properties like so:
```
fileviewer *.pdf
\ vifmimg pdf %px %py %pw %ph %c
\ %pc
\ vifmimg clear
fileviewer *.djvu
\ vifmimg djvu %px %py %pw %ph %c
\ %pc
\ vifmimg clear
fileviewer *.epub
\ vifmimg epub %px %py %pw %ph %c
\ %pc
\ vifmimg clear
fileviewer
\ vifmimg video %px %py %pw %ph %c
\ %pc
\ vifmimg clear
fileviewer
\ vifmimg draw %px %py %pw %ph %c
\ %pc
\ vifmimg clear
fileviewer
\ vifmimg audio %px %py %pw %ph %c
\ %pc
\ vifmimg clear
fileviewer
\ vifmimg font %px %py %pw %ph %c
\ %pc
\ vifmimg clear
```
3. In order to launch vifm with image preview support from now on, you will need to use the supplied **vifmrun** script.
I recommend that you make an alias in your shell that points to vifm.
## Prerequisites
* [Überzug](https://github.com/seebye/ueberzug) and [Vifm](https://github.com/vifm/vifm) (isn't this obvious?)
* [ffmpegthumbnailer](https://github.com/dirkvdb/ffmpegthumbnailer)
* ImageMagick
* pdftoppm (Available in the AUR as `poppler` package.)
* [ddjvu](http://djvu.sourceforge.net/doc/man/ddjvu.html) (Contains in the Debian/Ubuntu `djvulibre-bin` package.)
* [epub-thumbnailer](https://github.com/marianosimone/epub-thumbnailer)
* [fontpreview](https://github.com/sdushantha/fontpreview)
## Credits
* Seebye for creating [Überzug](https://github.com/seebye/ueberzug) and the initial script
that this script is heavily based upon.
* [Ranger's](https://github.com/ranger/ranger) approach to file previewing as an
inspiration source.