diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 50 |
1 files changed, 15 insertions, 35 deletions
@@ -5,44 +5,28 @@ A rofi inspired native client for web services. Currently supported web services: `youtube`, `peertube`, `lbry`, `soundcloud`, `nyaa.si`, `manganelo`, `manganelos`, `mangatown`, `mangakatana`, `mangadex`, `onimanga`, `4chan`, `matrix`, `saucenao`, `hotexamples`, `anilist`, `dramacool` and _others_.\ QuickMedia also supports reading local manga and watching local anime, see [local manga](#local-manga) and [local anime](#local-anime) ## Usage -``` -usage: quickmedia [plugin|] [--no-video] [--upscale-images] [--upscale-images-always] [--dir <directory>] [--instance <instance>] [-e <window>] [--video-max-height <height>] -OPTIONS: - plugin|url The plugin to use. Should be either launcher, 4chan, manga, manganelo, manganelos, mangatown, mangakatana, mangadex, onimanga, local-manga, local-anime, youtube, peertube, lbry, soundcloud, nyaa.si, matrix, saucenao, hotexamples, anilist, dramacool, file-manager or stdin. This can also be a youtube url, youtube channel url or a 4chan thread url - --no-video Only play audio when playing a video. 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 <directory> Set the start directory when using file-manager - --instance <instance> The instance to use for peertube - -e <window-id> Embed QuickMedia into another window - --video-max-height <height> Media plugins will try to select a video source that is this size or smaller -EXAMPLES: - quickmedia - quickmedia --upscale-images-always manganelo - quickmedia https://www.youtube.com/watch?v=jHg91NVHh3s - echo -e "hello\nworld" | quickmedia stdin - tabbed -c -k quickmedia launcher -e -``` +Run `qm --help` to see the usage options. ## Installation -If you are running arch linux then you can install QuickMedia from aur: [https://aur.archlinux.org/packages/quickmedia-git/](https://aur.archlinux.org/packages/quickmedia-git/), otherwise you will need to first install [sibs](https://git.dec05eba.com/sibs/) and then run `./install.sh` as root.\ +If you are running arch linux then you can install QuickMedia from aur: [https://aur.archlinux.org/packages/quickmedia-git/](https://aur.archlinux.org/packages/quickmedia-git/), otherwise you will need to run `./install.sh` as root.\ `tar` and curl needs to be installed to run the `install.sh` script.\ -Installing `lld` (the LLVM linker) can improve compile times.\ There is also an unofficial ebuild for gentoo users. On gentoo you can install QuickMedia by running these commands: ```bash -eselect repository add overlay-from-plan9 git https://gitea.plan9.rocks/9/overlay-from-plan9 +eselect repository add overlay-from-plan9 git https://git.plan9.rocks/cat/overlay-from-plan9 emerge --sync overlay-from-plan9 emerge -av quickmedia ``` ## Dependencies +Meson needs to be installed to run the build script. ### Libraries `libglvnd (LibGL.so)`, `libx11`, `libxrandr`, `libmpv` ### Executables -`curl` +`curl`.\ +`yt-dlp` needs to be installed right now to play youtube videos. This requirement will be removed in the future. ### Fonts `noto-fonts` (when `use_system_fonts` config is not set to `true`) ### Optional `noto-fonts-cjk` needs to be installed to view chinese, japanese and korean characters (when `use_system_fonts` config is not set to `true`).\ -`yt-dlp/youtube-dl` needs to be installed to download soundcloud music, fallback for youtube (for example for age restricted videos) or to play/download xxx videos.\ +`yt-dlp` needs to be installed to download soundcloud music or to play/download xxx videos.\ `notify-send` (which is part of `libnotify`) needs to be installed to show notifications (on Linux and other systems that uses d-bus notification system).\ [automedia](https://git.dec05eba.com/AutoMedia/) needs to be installed when tracking anime/manga with `Ctrl + T`.\ `waifu2x-ncnn-vulkan` needs to be installed when using the `--upscale-images` or `--upscale-images-always` option.\ @@ -105,6 +89,7 @@ Type text and then wait and QuickMedia will automatically search.\ `Home`: Go to the first page.\ `End`: Go to the last page.\ `F`: Toggle between scaling the image to the window size or only down scaling if the image is too large.\ +`B`: Show/hide the bottom progress bar.\ `I`: Switch to scroll view. ### Manga scroll view controls `Arrow up`/`K`: Move up.\ @@ -113,6 +98,7 @@ Type text and then wait and QuickMedia will automatically search.\ `Home`: Go to the first page.\ `End`: Go to the last page.\ `F`: Toggle between scaling the image to the window size or only down scaling if the image is too large.\ +`B`: Show/hide the bottom progress bar.\ `I`: Switch to page view. ### Manga chapters controls `Ctrl+T`: Start tracking the manga after the selected chapter ([AutoMedia](https://git.dec05eba.com/AutoMedia/) needs to be installed). @@ -144,7 +130,9 @@ Type text and then wait and QuickMedia will automatically search.\ `Alt+End`: Select the last room in the room list.\ `Ctrl+P`: Pin the selected message.\ `Ctrl+R`: Navigate to the replied to message.\ -`Ctrl+B`: Navigate to the bottom (the latest message). +`Ctrl+B`: Navigate to the bottom (the latest message).\ +`G`: Start typing an `/encrypt` message, `Esc` to cancel.\ +`Ctrl+G`: Start replying to the selected message with `/encrypt`, `Esc` to cancel. #### Pinned messages page controls `Ctrl+D`: Unpin the selected message.\ `Ctrl+R`: Navigate to the pinned message in the messages tab. @@ -184,16 +172,7 @@ Type text and then wait and QuickMedia will automatically search.\ `Ctrl+Enter`/`Click on save`: Save the file.\ `Esc`/`Click on cancel`: Cancel download. ## Matrix text commands -`/help`: Show a list of valid commands.\ -`/upload`: Bring up the file manager and select a file to upload to the room, `Esc` to cancel.\ -`/join [room]`: Join a room by name or id.\ -`/invite`: Invite a user to the room.\ -`/logout`: Logout.\ -`/leave`: Leave the current room.\ -`/me [text]`: Send a message of type "m.emote".\ -`/react [text]`: React to the selected message (also works if you are replying to a message).\ -`/id`: Show the room id.\ -`/encrypt [text]`: Send a message encrypted with gpg. gpg needs to be installed to do this. Uses the gpg key specified by the user id in your config variable "matrix.gpg_user_id". +`/help`: Show a list of valid commands. ## Matrix gpg encryption Matrix gpg email should use the matrix user id, but in email format. For example: @dec05eba:matrix.org should be created with a gpg with the email dec05eba@matrix.org. ## Config @@ -258,7 +237,8 @@ Cache is stored under `$XDG_CACHE_HOME/quickmedia` or `~/.cache/quickmedia`. ## Tabs [tabbed](https://tools.suckless.org/tabbed/) can be used to put quickmedia windows into tabs. After installing `tabbed`, run `tabbed -c -k quickmedia launcher -e`. ## License -QuickMedia is free software licensed under GPL 3.0, see LICENSE for more details. The emojis are from the twemoji project, licensed under Creative Commons Public License 4.0 (see https://raw.githubusercontent.com/twitter/twemoji/v14.0.2/LICENSE-GRAPHICS). The file and directory images are from https://github.com/L4ki/Breeze-Chameleon-Icons and are licensed under GPL 3.0. +QuickMedia is free software licensed under GPL 3.0, see LICENSE for more details. The emojis are from the twemoji project, licensed under Creative Commons Public License 4.0 (see https://raw.githubusercontent.com/twitter/twemoji/v14.0.2/LICENSE-GRAPHICS). The file and directory images are from https://github.com/L4ki/Breeze-Chameleon-Icons and are licensed under GPL 3.0.\ +`src/plugins/utils/aes.*` are from https://github.com/kokke/tiny-AES-c which are licensed under the Unlicence license. # Screenshots ## Youtube search  |