Skip to content

Commit cf48c97

Browse files
committed
docs: update README, manpage and help to reflect celluloid capabilities
1 parent 38d9aa3 commit cf48c97

File tree

3 files changed

+11
-9
lines changed

3 files changed

+11
-9
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -537,12 +537,14 @@ Ani-skip is a script to automatically skip anime opening sequences, making it ea
537537

538538
For install instructions visit [ani-skip](https://github.com/synacktraa/ani-skip).
539539

540-
Ani-skip uses the external lua script function of mpv and as such – for now – only works with mpv.
540+
Ani-skip uses the external lua script function of mpv and as such – for now – only works with mpv and celluloid.
541541

542542
**Warning:** For now, ani-skip does **not** seem to work under Windows.
543543

544544
**Note:** It may be, that ani-skip won't know the anime you're trying to watch. Try using the `--skip-title <title>` command line argument. (It uses the [aniskip API](https://github.com/lexesjan/typescript-aniskip-extension/tree/main/src/api/aniskip-http-client) and you can contribute missing anime or ask for including it in the database on their [discord server](https://discord.com/invite/UqT55CbrbE)).
545545

546+
**Note:** To get ani-skip to work under celluloid, copy the `skip.lua` to celluloid's script folder. This is usually `~/.config/celluloid/scripts`. The `skip.lua` file can be found in the root directory of ani-skip's repository if you installed via source, or in mpv's script directory `~/.config/mpv/scripts` if you installed it using the AUR.
547+
546548
## FAQ
547549
<details>
548550

ani-cli

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,11 @@ help_info() {
7373
--rofi
7474
Use rofi instead of fzf for the interactive menu
7575
--skip
76-
Use ani-skip to skip the intro of the episode (mpv only)
76+
Use ani-skip to skip the intro of the episode (mpv and celluloid only)
7777
--no-detach
78-
Don't detach the player (useful for in-terminal playback, mpv only)
78+
Don't detach the player (useful for in-terminal playback, mpv and celluloid only)
7979
--exit-after-play
80-
Exit the player, and return the player exit code (useful for non interactive scenarios, works only if --no-detach is used, mpv only)
80+
Exit the player, and return the player exit code (useful for non interactive scenarios, works only if --no-detach is used, mpv and celluloid only)
8181
--skip-title <title>
8282
Use given title as ani-skip query
8383
-N, --nextep-countdown

ani-cli.1

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,12 @@ Play the dubbed version. Without this flag, it'll always play the subbed version
5959
Use rofi instead of fzf for the interactive menu
6060
.TP
6161
\fB\--skip\fR
62-
Use ani-skip to skip the intro of the episode (mpv only)
62+
Use ani-skip to skip the intro of the episode (mpv and celluloid only)
6363
.TP
6464
\fB\--no-detach\fR
65-
Don't detach the player (useful for in-terminal playback, mpv only)
65+
Don't detach the player (useful for in-terminal playback, mpv and celluloid only)
6666
\fB\--exit-after-play\fR
67-
Exit the player, and return the player exit code (useful for non interactive scenarios, works only if --no-detach is used, mpv only)
67+
Exit the player, and return the player exit code (useful for non interactive scenarios, works only if --no-detach is used, mpv and celluloid only)
6868
.TP
6969
\fB\--skip-title\fR \fI\,<title>\/\fR
7070
Specify the title to use for ani-skip
@@ -108,10 +108,10 @@ Controls the directory ani-cli uses for storing history. A /ani-cli subfolder is
108108
Controls the default source. Valid is history (equivalent to -c), everything else means search. Default is search.
109109
.TP
110110
\fBANI_CLI_SKIP_INTRO\fR
111-
Controls if ani-skip is used to skip intros (works with mpv only). Can be 0 (disabled) or 1 (enabled). Default is 0.
111+
Controls if ani-skip is used to skip intros (works with mpv and celluloid only). Can be 0 (disabled) or 1 (enabled). Default is 0.
112112
.TP
113113
\fBANI_CLI_NO_DETACH\fR
114-
Controls if mpv is detached from the main process for playback, which can be useful for use with terminal renderers such as kitty. (works with mpv only). Can be 0 (disabled) or 1 (enabled). Default is 0.
114+
Controls if mpv is detached from the main process for playback, which can be useful for use with terminal renderers such as kitty. (works with mpv and celluloid only). Can be 0 (disabled) or 1 (enabled). Default is 0.
115115
.TP
116116
\fBANI_CLI_SKIP_TITLE\fR
117117
Overrides the anime title to query for skip times. Can be any string value. Default is empty, resolving to the anime title as given by ani-cli.

0 commit comments

Comments
 (0)