mirror of
https://github.com/ksyasuda/aniwrapper.git
synced 2024-10-28 04:44:11 -07:00
Compare commits
4 Commits
5c7af5c36d
...
86acb7d731
| Author | SHA1 | Date | |
|---|---|---|---|
|
86acb7d731 | ||
|
|
1268855077 | ||
|
|
087fb9d355 | ||
|
|
42db51371b |
81
README.md
81
README.md
@ -29,23 +29,23 @@ This tool scrapes the site [gogoanime](https://gogoanime.cm).
|
||||
|
||||
**Table of Contents**
|
||||
|
||||
- [Aniwrapper](#aniwrapper)
|
||||
- [Introduction](#introduction)
|
||||
- [MPV Extension - Skip Intro Script](#mpv-extension---skip-intro-script)
|
||||
- [Installing](#installing)
|
||||
- [Manual Install](#manual-install)
|
||||
- [Aniwrapper Menus](#aniwrapper-menus)
|
||||
- [Dealing with conflicting search queries / rofi grabbing from search list](#dealing-with-conflicting-search-queries--rofi-grabbing-from-search-list)
|
||||
- [Usage](#usage)
|
||||
- [aniwrapper](#aniwrapper-1)
|
||||
- [Option 1: Streaming](#option-1-streaming)
|
||||
- [Option 2: Download](#option-2-download)
|
||||
- [Option 3: Continue](#option-3-continue)
|
||||
- [Option 4: Play from File](#option-4-play-from-file)
|
||||
- [Option 5: Sync History](#option-5-sync-history)
|
||||
- [Option 6: Choose Theme](#option-6-choose-theme)
|
||||
- [ani-cli](#ani-cli)
|
||||
- [Themes](#themes)
|
||||
- [Aniwrapper](#aniwrapper)
|
||||
- [Introduction](#introduction)
|
||||
- [MPV Extension - Skip Intro Script](#mpv-extension---skip-intro-script)
|
||||
- [Installing](#installing)
|
||||
- [Manual Install](#manual-install)
|
||||
- [Aniwrapper Menus](#aniwrapper-menus)
|
||||
- [Dealing with conflicting search queries / rofi grabbing from search list](#dealing-with-conflicting-search-queries--rofi-grabbing-from-search-list)
|
||||
- [Usage](#usage)
|
||||
- [aniwrapper](#aniwrapper-1)
|
||||
- [Option 1: Streaming](#option-1-streaming)
|
||||
- [Option 2: Download](#option-2-download)
|
||||
- [Option 3: Continue](#option-3-continue)
|
||||
- [Option 4: Play from File](#option-4-play-from-file)
|
||||
- [Option 5: Sync History](#option-5-sync-history)
|
||||
- [Option 6: Choose Theme](#option-6-choose-theme)
|
||||
- [ani-cli](#ani-cli)
|
||||
- [Themes](#themes)
|
||||
|
||||
<!-- markdown-toc end -->
|
||||
|
||||
@ -135,38 +135,25 @@ The above output was produced by searching: `isekai -`
|
||||
## aniwrapper
|
||||
|
||||
```
|
||||
# Launch menu (default video quality: best)
|
||||
aniwrapper
|
||||
|
||||
# Launch menu with quality selection
|
||||
aniwrapper -q
|
||||
|
||||
# Enable verbose logging
|
||||
aniwrapper -v
|
||||
|
||||
# Connect to history database
|
||||
aniwrapper [-cdhpqvS] [-t <theme> or -T <config_path>] <query>
|
||||
aniwrapper [-cvS] [-t <theme> or -T <config_path>] -f <path_to_directory>
|
||||
aniwrapper -Q <query>
|
||||
aniwrapper -C
|
||||
|
||||
# Enable silent mode (suppress output to stdout) [cannot be used with -v]
|
||||
aniwrapper -S
|
||||
|
||||
# Query the history database
|
||||
aniwrapper -Q <query>
|
||||
|
||||
# Choose rofi theme from presets
|
||||
aniwrapper -t <aniwrapper (default)|dracula|doomone|fancy|flamingo|material|nord|onedark>
|
||||
|
||||
# Specify custom rofi config
|
||||
aniwrapper -T <path_to_config>
|
||||
|
||||
# Specify starting directory for play_from_file mode, bypassing main menu
|
||||
aniwrapper -f <starting_directory>
|
||||
|
||||
# Use ani-cli command-line mode (rofi disabled)
|
||||
aniwrapper -c
|
||||
|
||||
# Download anime in command-line mode
|
||||
aniwrapper -d
|
||||
aniwrapper <query> # Run in stream mode, searching for <query>
|
||||
aniwrapper -c # Use ani-cli command-line mode (rofi disabled)
|
||||
aniwrapper -C # Connect to history database
|
||||
aniwrapper -d # Download anime in command-line mode
|
||||
aniwrapper -d <query> # Run in download mode (best quality), searching for <query>
|
||||
aniwrapper -f <starting_directory> # Specify starting directory for play_from_file mode, bypassing main menu
|
||||
aniwrapper -h # Show help menu
|
||||
aniwrapper -p # Enable player selection menu
|
||||
aniwrapper -q # Launch menu with quality selection
|
||||
aniwrapper -Q <query> # Query the history database
|
||||
aniwrapper -S # Enable silent mode (suppress output to stdout) [cannot be used with -v]
|
||||
aniwrapper -t <theme> # Choose rofi theme from presets
|
||||
aniwrapper -T <path_to_config> # Specify custom rofi config
|
||||
aniwrapper -v # Enable verbose logging
|
||||
```
|
||||
|
||||
See [aniwrapper menus](docs/aniwrapper-menus.md) for more information about the menus used in the following options
|
||||
|
||||
15
aniwrapper
15
aniwrapper
@ -38,22 +38,23 @@ help_text() {
|
||||
printf "%s\n" "$line"
|
||||
done <<< "
|
||||
Usage:
|
||||
aniwrapper [-cdhvqS] [-t <theme> or -T <config_path>]
|
||||
aniwrapper [-cdhpqvS] [-t <theme> or -T <config_path>]
|
||||
aniwrapper [-cvS] [-t <theme> or -T <config_path>] -f <path_to_directory>
|
||||
aniwrapper -Q <query>
|
||||
aniwrapper -C
|
||||
Options:
|
||||
-h show this help text
|
||||
-q enable quality selection
|
||||
-c enable command-line mode (rofi disabled)
|
||||
-d download episode in command-line mode
|
||||
-C connect to history database
|
||||
-d download episode in command-line mode
|
||||
-f <path_to_directory> (no trailing slash) specify starting directory for play for file mode
|
||||
-h show this help text
|
||||
-p enable player selection menu
|
||||
-q enable quality selection
|
||||
-Q <query> query the history database
|
||||
-v verbose output
|
||||
-S silent mode (suppress output to stdout) [cannot be used with -v]
|
||||
|
||||
-t <aniwrapper (default)|dracula|doomone|fancy|flamingo|material|onedark> change rofi theme
|
||||
-T <config_path> specify custom rofi theme
|
||||
-f <path_to_directory> (no trailing slash) specify starting directory for play for file mode
|
||||
-Q <query> query the history database
|
||||
"
|
||||
}
|
||||
|
||||
|
||||
@ -8,8 +8,8 @@ aniwrapper - A rofi wrapper around ani-cli: a command-line tool to
|
||||
browser, download, and stream anime
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\f[B]aniwrapper\f[R] [-cdhvqS] [-t \f[I]theme\f[R] | -T
|
||||
\f[I]config_path\f[R]]
|
||||
\f[B]aniwrapper\f[R] [-cdhpqvS] [-t \f[I]theme\f[R] | -T
|
||||
\f[I]config_path\f[R]] [\f[I]query\f[R]]
|
||||
.PD 0
|
||||
.P
|
||||
.PD
|
||||
@ -33,6 +33,14 @@ browser, download, and stream anime
|
||||
control the program flow, as well as a a \f[B]sqlite3\f[R] database for
|
||||
tracking search/watch history.
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
Defaults:
|
||||
.IP \[bu] 2
|
||||
\f[B]rofi\f[R] enabled
|
||||
.IP \[bu] 2
|
||||
aniwrapper.rasi theme
|
||||
.IP \[bu] 2
|
||||
best quality
|
||||
.TP
|
||||
\f[B]-c\f[R]
|
||||
Enable command-line mode (disable \f[B]rofi\f[R])
|
||||
@ -50,6 +58,9 @@ Specify the starting search directory for \[lq]Play from File\[rq] mode
|
||||
\f[B]-h\f[R]
|
||||
Display the help message
|
||||
.TP
|
||||
\f[B]-p\f[R]
|
||||
Enable video player selection menu
|
||||
.TP
|
||||
\f[B]-q\f[R]
|
||||
Enable quality selection
|
||||
.TP
|
||||
@ -60,7 +71,7 @@ Run a query on the history databse
|
||||
Enable silent mode (suppress all output) [cannot be used with
|
||||
\f[B]-v\f[R]]
|
||||
.TP
|
||||
\f[B]-t\f[R] \f[I]<aniwrapper (default)|dracula|doomone|fancy|flamingo|material|nord|onedark>\f[R]
|
||||
\f[B]-t\f[R] \f[I]aniwrapper (default)|dracula|doomone|fancy|flamingo|material|nord|onedark\f[R]
|
||||
Choose theme from presets
|
||||
.TP
|
||||
\f[B]-T\f[R] \f[I]path_to_theme\f[R]
|
||||
@ -71,17 +82,21 @@ Verbose output
|
||||
.SH EXAMPLES
|
||||
.TP
|
||||
\f[B]aniwrapper\f[R]
|
||||
Run with default options (rofi enabled, best video quality, default
|
||||
theme)
|
||||
Launch main menu with default options
|
||||
.TP
|
||||
\f[B]aniwrapper -q\f[R]
|
||||
Run with quality selection enabled
|
||||
\f[B]aniwrapper konosuba\f[R]
|
||||
Run in stream mode with a search query: \[lq]konosuba\[rq]
|
||||
.TP
|
||||
\f[B]aniwrapper -qd naruto\f[R]
|
||||
Run in download mode with quality selection enabled and a search query:
|
||||
\[lq]naruto\[rq]
|
||||
.TP
|
||||
\f[B]aniwrapper -vqt doomone\f[R]
|
||||
Run with quality selection menu and \f[I]doomone\f[R] theme
|
||||
.TP
|
||||
\f[B]aniwrapper -cd\f[R]
|
||||
Download an anime in command-line mode (\f[B]rofi\f[R] disabled)
|
||||
Enable downloading an anime in command-line mode (\f[B]rofi\f[R]
|
||||
disabled)
|
||||
.TP
|
||||
\f[B]aniwrapper -Q \[lq]SELECT * FROM watch_history ORDER BY watch_date DESC LIMIT 10;\[rq]\f[R]
|
||||
Query history database for your 10 most recently watched anime
|
||||
@ -89,6 +104,10 @@ Query history database for your 10 most recently watched anime
|
||||
\f[B]aniwrapper -f /media/videos\f[R]
|
||||
Run in \[lq]Play from File\[rq] mode starting the search from the
|
||||
\f[I]/media/videos\f[R] directory
|
||||
.TP
|
||||
\f[B]aniwrapper -S\f[R]
|
||||
Run in quiet mode (suppress all output to stdout and disable
|
||||
notifications)
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\f[B]rofi(1), rofi-theme(5), rofi-keys(5), sqlite3(1)\f[R]
|
||||
|
||||
@ -12,7 +12,7 @@ aniwrapper - A rofi wrapper around ani-cli: a command-line tool to browser, down
|
||||
|
||||
# SYNOPSIS
|
||||
|
||||
**aniwrapper** [-cdhvqS] [-t _theme_ | -T *config_path*]\
|
||||
**aniwrapper** [-cdhpqvS] [-t _theme_ | -T *config_path*] [*query*]\
|
||||
**aniwrapper** [-cvS] [-t *theme* | -T *config_path*] -f _path_to_directory_\
|
||||
**aniwrapper** -Q _query_\
|
||||
**aniwrapper** -C\
|
||||
@ -25,6 +25,12 @@ a **sqlite3** database for tracking search/watch history.
|
||||
|
||||
# OPTIONS
|
||||
|
||||
Defaults:
|
||||
|
||||
- **rofi** enabled
|
||||
- aniwrapper.rasi theme
|
||||
- best quality
|
||||
|
||||
**-c**
|
||||
: Enable command-line mode (disable **rofi**)
|
||||
|
||||
@ -40,6 +46,9 @@ a **sqlite3** database for tracking search/watch history.
|
||||
**-h**
|
||||
: Display the help message
|
||||
|
||||
**-p**
|
||||
: Enable video player selection menu
|
||||
|
||||
**-q**
|
||||
: Enable quality selection
|
||||
|
||||
@ -49,7 +58,7 @@ a **sqlite3** database for tracking search/watch history.
|
||||
**-S**
|
||||
: Enable silent mode (suppress all output) [cannot be used with **-v**]
|
||||
|
||||
**-t** _<aniwrapper (default)|dracula|doomone|fancy|flamingo|material|nord|onedark>_
|
||||
**-t** _aniwrapper (default)|dracula|doomone|fancy|flamingo|material|nord|onedark_
|
||||
: Choose theme from presets
|
||||
|
||||
**-T** _path_to_theme_
|
||||
@ -61,16 +70,20 @@ a **sqlite3** database for tracking search/watch history.
|
||||
# EXAMPLES
|
||||
|
||||
**aniwrapper**
|
||||
: Run with default options (rofi enabled, best video quality, default theme)
|
||||
: Launch main menu with default options
|
||||
|
||||
**aniwrapper -q**
|
||||
: Run with quality selection enabled
|
||||
**aniwrapper konosuba**
|
||||
: Run in stream mode with a search query: "konosuba"
|
||||
|
||||
**aniwrapper -qd naruto**
|
||||
: Run in download mode with quality selection enabled and a search query:
|
||||
"naruto"
|
||||
|
||||
**aniwrapper -vqt doomone**
|
||||
: Run with quality selection menu and _doomone_ theme
|
||||
|
||||
**aniwrapper -cd**
|
||||
: Download an anime in command-line mode (**rofi** disabled)
|
||||
: Enable downloading an anime in command-line mode (**rofi** disabled)
|
||||
|
||||
**aniwrapper -Q "SELECT \* FROM watch_history ORDER BY watch_date DESC LIMIT 10;"**
|
||||
: Query history database for your 10 most recently watched anime
|
||||
@ -78,6 +91,9 @@ a **sqlite3** database for tracking search/watch history.
|
||||
**aniwrapper -f /media/videos**
|
||||
: Run in "Play from File" mode starting the search from the _/media/videos_ directory
|
||||
|
||||
**aniwrapper -S**
|
||||
: Run in quiet mode (suppress all output to stdout and disable notifications)
|
||||
|
||||
# SEE ALSO
|
||||
|
||||
**rofi(1), rofi-theme(5), rofi-keys(5), sqlite3(1)**
|
||||
|
||||
Loading…
Reference in New Issue
Block a user