From d3543b4f6d654cae1d1d9ffe1f640106dad5cfed Mon Sep 17 00:00:00 2001 From: dec05eba Date: Tue, 6 Apr 2021 22:54:12 +0200 Subject: Add support for embedding the window into another application, such as suckless tabbed --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 98569a2..cb70613 100644 --- a/README.md +++ b/README.md @@ -6,18 +6,20 @@ Config data, including manga progress is stored under `$HOME/.config/quickmedia` Cache is stored under `$HOME/.cache/quickmedia`. ## Usage ``` -usage: quickmedia [--use-system-mpv-config] [--dir ] +usage: quickmedia [--use-system-mpv-config] [--dir ] [-e ] OPTIONS: plugin The plugin to use. Should be either launcher, 4chan, manganelo, mangatown, mangadex, youtube, spotify, soundcloud, nyaa.si, matrix, file-manager or stdin --no-video Only play audio when playing a video. Disabled by default --use-system-mpv-config Use system mpv config instead of no config. Disabled by default --upscale-images Upscale low-resolution manga pages using waifu2x-ncnn-vulkan. Disabled by default --upscale-images-always Upscale manga pages using waifu2x-ncnn-vulkan, no matter what the original image resolution is. Disabled by default - --dir Set the start directory when using file-manager + --dir Set the start directory when using file-manager + -e Embed QuickMedia into another window EXAMPLES: - quickmedia manganelo + quickmedia launcher quickmedia --upscale-images-always manganelo echo -e "hello\nworld" | quickmedia stdin + tabbed quickmedia launcher -e ``` ## Installation If you are running arch linux then you can install QuickMedia from aur (https://aur.archlinux.org/packages/quickmedia-git/), otherwise you will need to use [sibs](https://git.dec05eba.com/sibs/) to build QuickMedia manually. @@ -74,6 +76,8 @@ Set `QM_PHONE_FACTOR=1` to disable the room list side panel in matrix. Either set the `GDK_SCALE` environment variable or add `Xft.dpi` to `$HOME/.Xresources` (`xrdb` which is part of the `xorg-xrdb` package needs to be installed).\ For example a value of 96 for the `Xft.dpi` means 1.0 scaling and 144 (96*1.5) means 1.5 scaling.\ Note that at the moment, cached images will not be scaled with the dpi. Images do also not scale above their original size. +## Tabs +[tabbed](https://tools.suckless.org/tabbed/) can be used to put quickmedia windows into tabs. After installing `tabbed`, run `tabbed quickmedia launcher -e`. # Dependencies ## Compile See project.conf \[dependencies]. -- cgit v1.2.3