aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: def2b6c36c6b457fcd14eaffdcda9e6b0d0fa3da (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# QuickMedia
Native clients of websites with fast access to what you want to see, **with TOR support**.
Currently supported web services: `youtube`, `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`).\
**Note:** Image pages that were downloaded without --upscale-images and are cached wont get upscaled when running with `--upscale-images`.\
**Note:** Matrix and 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>] [-p <placeholder-text>]
OPTIONS:
  plugin                      The plugin to use. Should be either 4chan, manganelo, mangatown, mangadex, youtube, nyaa.si, matrix, file-manager or dmenu
  --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
  --dir                       Set the start directory when using file-manager
  -p                          Change the placeholder text for dmenu
EXAMPLES:
QuickMedia manganelo
QuickMedia youtube --tor
echo -e "hello\nworld" | QuickMedia dmenu
```
## 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.\
## Controls
Press `Arrow up` or `Arrow down` to navigate the menu and also to scroll to the previous/next image when viewing manga in scroll mode. Alternatively you can use the mouse scroll to scroll to the previous/next manga in scroll mode.\
Press `Arrow left` or `Arrow right` to switch tab.\
Press `Page up` to scroll up and entire page or `Page down` to scroll down an entire page.\
Press `Home` to scroll to the top or `End` to scroll to the bottom.\
Press `Enter` (aka `Return`) to select the item.\
Press `ESC` to go back to the previous menu.\
Press `Ctrl + F` to switch between window mode and fullscreen mode when watching a video.\
Press `Ctrl + R` to show/hide related videos menu when watching a video.\
Press `Ctrl + T` when hovering over a manga chapter to start tracking manga after that chapter. This only works if AutoMedia is installed and accessible in PATH environment variable.\
Press `Backspace` to return to the preview item when reading replies in image board threads.\
Press `R` to paste the post number of the selected post into the post field (image boards).\
Press `Ctrl + M` to begin writing a post to a thread (image boards), press `ESC` to cancel.\
Press `1 to 9` or `Numpad 1 to 9` to select google captcha image when posting a comment on 4chan.\
Press `P` to preview the 4chan image of the selected row in full screen view, press `ESC` or `Backspace` to go back.\
Press `I` to switch between single image and scroll image view mode when reading manga.\
Press `Middle mouse button` to "autoscroll" in scrolling image view mode.\
Press `Tab` to autocomplete a search when autocomplete is available (currently only available for youtube).\
Press `Tab` to switch between username/password field in login panel.\
Press `Ctrl + C` to copy the url of the currently playing video to the clipboard (with timestamp).\
Press `Ctrl + V` to paste the content of your clipboard into the search bar.\
Press `Enter` to view image/video attached to matrix message, or to view the url in the message in quickmedia (youtube) or in the browser.\
Press `Ctrl + M` to begin writing a message in a matrix room, press `ESC` to cancel.\
Press `Ctrl + R` to reply to a message on matrix, press `ESC` to cancel.\
Press `Ctrl + E` to edit a message on matrix, press `ESC` to cancel. Currently only works for your own messages.\
Press `Ctrl + D` to delete a message on matrix. Currently deleting a message only deletes the event, so if you delete an edit then the original message wont be deleted.

In matrix you can select a message with enter to open the url in the message (or if there are multiple urls then a menu will appear for selecting which to open).
## Matrix commands
`/upload` to upload an image. TODO: Support regular files and videos.\
`/logout` to logout.
## Video controls
Press `space` to pause/unpause video. `Double-click` video to fullscreen or leave fullscreen.
# Mangadex
To search for manga with mangadex, you need to be logged into mangadex in your browser and copy the `mangadex_rememberme_token` cookie from developer tools
and store it in `$HOME/.config/quickmedia/credentials/mangadex.json` under the key `rememberme_token`. Here is an example what the file should look like:
```
{
    "rememberme_token": "21s9d3f7ad224a131239Dsfaf033029d2e390dAsfd3ldadb3a39dk43jfldj35das"
}
```
# Dependencies
## Compile
See project.conf \[dependencies].
## Runtime
### Required
`curl` is required for network requests.\
`noto-fonts` and `noto-fonts-cjk` is required for alphanumerical and japanese characters.
### Optional
`mpv` is required for playing videos. This is not required if you dont plan on playing videos.\
`youtube-dl` needs to be installed to play videos from youtube.\
`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` option.\
`xdg-utils` which provides `xdg-open` needs to be installed when downloading torrents with `nyaa.si` plugin.\
`ffmpeg (and ffprobe)` to upload videos with thumbnails on matrix.
# Screenshots
## Youtube search
![](https://www.dec05eba.com/images/youtube.jpg)
## Youtube video
![](https://www.dec05eba.com/images/youtube-video.jpg)
## Manganelo search
![](https://www.dec05eba.com/images/manganelo.jpg)
## Manganelo chapters
![](https://www.dec05eba.com/images/manganelo-chapters.jpg)
## Manganelo page
![](https://www.dec05eba.com/images/manganelo-page.jpg)
## 4chan thread
![](https://www.dec05eba.com/images/4chan.jpg)
## Matrix chat
![](https://www.dec05eba.com/images/matrix.jpg)