summaryrefslogtreecommitdiff
path: root/yazi/plugins/preview-audio.yazi/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'yazi/plugins/preview-audio.yazi/README.md')
-rw-r--r--yazi/plugins/preview-audio.yazi/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/yazi/plugins/preview-audio.yazi/README.md b/yazi/plugins/preview-audio.yazi/README.md
new file mode 100644
index 0000000..88626cd
--- /dev/null
+++ b/yazi/plugins/preview-audio.yazi/README.md
@@ -0,0 +1,27 @@
+<img width="1920" height="1080" alt="preview of alubum art and some audio metadata" src="https://github.com/user-attachments/assets/731bd9b8-b963-43c9-866e-4250885d0bbe" />
+
+# Installation
+
+```sh
+ya pkg add AminurAlam/yazi-plugins:preview-audio
+```
+
+# Dependencies
+
+- [ffmpeg](https://repology.org/project/ffmpeg/versions) - for extracting images and metadata
+
+# Usage
+
+in `~/.config/yazi/yazi.toml`
+
+```toml
+[plugin]
+prepend_previewers = [
+ { mime = 'audio/mpegurl', run = 'code' }, # ignore .m3u files
+ { mime = 'audio/*', run = 'preview-audio' },
+]
+prepend_preloaders = [
+ { mime = 'audio/mpegurl', run = 'code' }, # ignore .m3u files
+ { mime = 'audio/*', run = 'preview-audio' },
+]
+```