diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 3 insertions, 8 deletions
@@ -1,26 +1,22 @@ # QuickMedia A dmenu-inspired native client for web services. Currently supported web services: `youtube`, `spotify (podcasts)`, `soundcloud`, `nyaa.si`, `manganelo`, `mangatown`, `mangadex`, `4chan`, `matrix` and _others_.\ -**Note:** Manganelo doesn't work when used with TOR.\ -**Note:** Posting comments on 4chan doesn't work when used with TOR. However browsing works.\ -**Note:** TOR system service needs to be running (`systemctl start tor.service`) when using `--tor` option.\ **Note:** file-manager is early in progress.\ Config data, including manga progress is stored under `$HOME/.config/quickmedia`.\ Cache is stored under `$HOME/.cache/quickmedia`. ## Usage ``` -usage: QuickMedia <plugin> [--tor] [--use-system-mpv-config] [--dir <directory>] +usage: QuickMedia <plugin> [--use-system-mpv-config] [--dir <directory>] OPTIONS: plugin The plugin to use. Should be either 4chan, manganelo, mangatown, mangadex, youtube, spotify, soundcloud, nyaa.si, matrix, file-manager or pipe --no-video Only play audio when playing a video. Disabled by default - --tor Use tor. 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 EXAMPLES: -QuickMedia manganelo -QuickMedia youtube --tor + QuickMedia manganelo + QuickMedia --upscale-images-always manganelo ``` ## 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. @@ -89,7 +85,6 @@ See project.conf \[dependencies]. `mpv` needs to be installed to play videos.\ `youtube-dl` needs to be installed to play youtube music/video or spotify podcasts.\ `notify-send` needs to be installed to show notifications (on Linux and other systems that uses d-bus notification system).\ -`torsocks` needs to be installed when using the `--tor` option.\ [automedia](https://git.dec05eba.com/AutoMedia/) needs to be installed when tracking manga with `Ctrl + T`.\ `waifu2x-ncnn-vulkan` needs to be installed when using the `--upscale-images` or `--upscale-images-always` option.\ `xdg-utils` which provides `xdg-open` needs to be installed when downloading torrents with `nyaa.si` plugin.\ |