jeanclaude
/
vimiv-Video
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README

This commit is contained in:
Jean-Claude 2023-08-17 09:57:22 +02:00
parent a7edc7bca4
commit 32d63b2a68
Signed by: jeanclaude
GPG Key ID: 8A300F57CBB9F63E
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,7 +1,7 @@
## Vimiv Video
> [vimiv](https://github.com/karlch/vimiv-qt) plugin for video support
Vimiv Video enables support for videos. Videos get listed within vimiv and can be played using an external player like [mpv](https://mpv.io/) or [vlc](https://www.videolan.org/vlc/).
vimiv Video enables support for videos. Videos get listed within vimiv and can be played using an external player like [mpv](https://mpv.io/) or [vlc](https://www.videolan.org/vlc/).
### Supported Formats
The following video formats are currently supported:
@ -13,14 +13,12 @@ The following video formats are currently supported:
| Audio Video Interleave (AVI) | `.avi` |
### Installation
- This plugin requires `ffmpeg` which needs to be installed.
- This plugin requires [ffmpeg](https://ffmpeg.org/) which needs to be installed.
- Clone this project into `$XDG_DATA_HOME/vimiv/plugins/`
- Activate Vimiv Video by adding `video =` to the `PLUGINS` section of `$XDG_CONFIG_HOME/vimiv/vimiv.conf`.
- Activate vimiv Video by adding `video =` to the `PLUGINS` section of `$XDG_CONFIG_HOME/vimiv/vimiv.conf`.
### Usage
All your videos are automatically listed in vimiv. To play the currently selected video, type something like `:!mpv %`.
All your videos are automatically listed in vimiv. To play the selected video, type something like `:!mpv %`.
### Contribute
If you would like support for a new video format feel free to open a PR with the appropriate additions. In case you do not know how this is implemented, you are also very welcome to open an issue and submit an adequate sample file.
Let me also know if you detect some inconsistencies with the type detection. I.e. a non-video file is being detected as a video or vice-versa.
If you would like to add support for a new video file format feel free to open a PR with the appropriate additions. In case you do not know how to implement it, you are also welcome to open an issue and submit an adequate sample file.