From 02e029ed40f801e0710b09062069e7083cd30b93 Mon Sep 17 00:00:00 2001 From: dec05eba Date: Thu, 17 Feb 2022 19:18:19 +0100 Subject: Add local anime tracking. Check readme for more info about local_anime config --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 45 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9533bc0..4baf18b 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # QuickMedia A rofi inspired native client for web services. Currently supported web services: `youtube`, `peertube`, `lbry`, `soundcloud`, `nyaa.si`, `manganelo`, `manganelos`, `mangatown`, `mangakatana`, `mangadex`, `readm`, `onimanga`, `4chan`, `matrix`, `saucenao`, `hotexamples`, `anilist` and _others_.\ -QuickMedia also supports reading local manga (add "local_manga_directory" config to `~/.config/quickmedia/config.json`, see the [config](#config) section). +QuickMedia also supports reading local manga and watching local anime, see [local manga](#local-manga) and [local anime](#local-anime) ## Usage ``` usage: quickmedia [plugin] [--dir ] [-e ] [youtube-url] OPTIONS: - plugin The plugin to use. Should be either launcher, 4chan, manga, manganelo, manganelos, mangatown, mangakatana, mangadex, readm, onimanga, local-manga, youtube, peertube, lbry, soundcloud, nyaa.si, matrix, saucenao, hotexamples, anilist, file-manager or stdin + plugin The plugin to use. Should be either launcher, 4chan, manga, manganelo, manganelos, mangatown, mangakatana, mangadex, readm, onimanga, local-manga, local-anime, youtube, peertube, lbry, soundcloud, nyaa.si, matrix, saucenao, hotexamples, anilist, file-manager or stdin --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 @@ -76,6 +76,8 @@ Type text and then wait and QuickMedia will automatically search.\ `Ctrl+B`: Bookmark the selected manga. If the manga is already bookmarked then its removed from bookmarks. ### Local manga search page controls `Ctrl+R`: Mark the manga as read/unread. +### Local anime search page controls +`Ctrl+R`: Mark the anime as watched/unwatched. ### Manga page view controls `Arrow up`/`Ctrl+K`: Go to the next page (or chapter if the current page is the last one).\ `Arrow down`/`Ctrl+J`: Go to the previous page (or chapter if the current page is the first one).\ @@ -159,14 +161,53 @@ Type text and then wait and QuickMedia will automatically search.\ `/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. -## Config +## Config Config is loaded from `~/.config/quickmedia/config.json` if it exists. See [example-config.json](https://git.dec05eba.com/QuickMedia/plain/example-config.json) for an example config. All fields in the config file are optional.\ If `use_system_mpv_config` is set to `true` then your systems mpv config in `~/.config/mpv/mpv.conf` and plugins will be used. ## Theme Theme is loaded from `~/.config/quickmedia/themes/.json` if it exists or from `/usr/share/quickmedia/themes`. Theme name is set in `~/.config/quickmedia/config.json` under the variable `theme`.\ Default themes available: `default, nord`.\ See [default.json](https://git.dec05eba.com/QuickMedia/plain/themes/default.json) for an example theme.\ -The `default` there is used by default. +The `default` is used by default. +## Local manga +`local_manga.directory` needs to be set in `~/.config/quickmedia/config.json` to a directory with all your manga.\ +The directory layout is expected to be like this: +``` +Manga 1 + Chapter 1 + 1.png + 2.png + Chapter 2 + 1.png + 2.png +Manga 2 + Chapter 1 + 1.png + 2.png + Chapter 2 + 1.png + 2.png +``` +Note that the manga name and chapter names can be anything you want, but the image names need to be a number (with `.jpg`, `.jpeg`, or `.png` extension). +## Local anime +`local_anime.directory` needs to be set in `~/.config/quickmedia/config.json` to a directory with all your anime.\ +The directory layout is expected to be like this: +``` +Anime 1 - Episode 1.mkv +Anime 1 - Episode 2.mkv +Anime 2 + Episode 1.mkv + Episode 2.mkv +Anime 3 + Season 1 + Episode 1.mkv + Episode 2.mkv + Season 2 + Episode 1.mkv + Episode 2.mkv +``` +Note that the episode names can be anything you want.\ +Local anime always uses your system mpv config. ## Environment variables If `xdg-open` is not installed then the `BROWSER` environment variable is used to open links in a browser.\ Set `QM_PHONE_FACTOR=1` to disable the room list side panel in matrix. -- cgit v1.2.3