feat: added support for ani-skip to skip episode intros

[azureorangexyz]

Pull Request

Type of change

• Bug fix
• Feature
• Documentation update

Description

I saw the issue #1223 and sympathized with the idea of skipping intros.
So implemented the skipping function into ani-cli (it still needs ani-skip to be installed though.)

Skipping does not work for all anime I've tested, but does for some.
If ani-skip fails, ani-cli just prints a message stating, that it failed and proceeds as normal.

Also it only works with mpv (due to how ani-skip works) and this is noted in the help function as well as the man page.

Checklist

• any anime playing
• bumped version

---

• next, prev and replay work
• -c history and continue work
• -d downloads work
• -s syncplay works
• -q quality works
• -v vlc works
• -e select episode works
• -S select index works
• -r range selection works
• --dub and regular (sub) mode both work
• all providers return links (not necessarily on a single anime, use debug mode to confirm)

---

• -h help info is up to date
• Readme is up to date
• Man page is up to date

Additional Testcases

• The safe bet: One Piece
• Episode 0: Saenai Heroine no Sodatekata ♭
• Unicode: Saenai Heroine no Sodatekata ♭
• Non-whole episodes: Tensei shitara slime datta ken (ep. 24.5, ep. 24.9)

[Derisis13]

You did a nice job implementing the feature in a way that's consistent to the other parts of the script. There's just one thing missing: ani-skip install instructions in the readme. There should be a reference to their instructions with some description on what it does

[port19x]

Very nice implementation.
I have nothing to add to the review by @Derisis13

[synacktraa]

You did a nice job implementing the feature in a way that's consistent to the other parts of the script. There's just one thing missing: ani-skip install instructions in the readme. There should be a reference to their instructions with some description on what it does

Hi, I am opening a pull request to include the ani-skip directly into ani-cli. There's no need to include ani-skip as a dependency.

It would be nice, If this PR is merged first. I'll only have to replace the function.

[synacktraa]

I've also wrote a lua script for vlc player. VLC is not as flexible as MPV, We'll need to find a suitable way to pass in options or hard-code them.

[lasersPew]

Before you accept this pr, it would be better if you add ani-skip onto the features and the dependency requirements. Additionally, warn windows users as I get ani-skip not installed and there's no official app for it.

[synacktraa]

Before you accept this pr, it would be better if you add ani-skip onto the features and the dependency requirements. Additionally, warn windows users as I get ani-skip not installed and there's no official app for it.

I'll include the code directly into ani-cli script, you won't have to install ani-skip explicitly

[Derisis13]

Hi, I am opening a pull request to include the ani-skip directly into ani-cli. There's no need to include ani-skip as a dependency.

It would be nice, If this PR is merged first. I'll only have to replace the function.

I'm against including lines of code instead of an available solution: just as we outsourced our ui to fzf and rofi, I see no point in re-implementing ani-skip. The reason is we have to maintain our code, but dependencies take care of themselves.

This PR looks fine as is.

[Derisis13]

I've also wrote a lua script for vlc player. VLC is not as flexible as MPV, We'll need to find a suitable way to pass in options or hard-code them.

This is welcome once the PR is merged

[azureorangexyz]

Sorry about the thousend commits on the readme, it's definitely to late to work now ... haha.
Is there a script or something to do all the checks before commiting them?

You did a nice job implementing the feature in a way that's consistent to the other parts of the script. There's just one thing missing: ani-skip install instructions in the readme. There should be a reference to their instructions with some description on what it does

I did update the README as well, I've put everything under the dependencies section (should be fine I guess).

Before you accept this pr, it would be better if you add ani-skip onto the features and the dependency requirements. Additionally, warn windows users as I get ani-skip not installed and there's no official app for it.

I added a warning to the ani-skip description. I should work under Android and MacOS right? (Not shure about iOS though.)

[port19x]

I can test mac compatibility tomorrow, code and readme looks good.
I'm also against inclusion of ani-skip code in mainline, unless the expansion over the currently proposed solution would be negligible.
Either way I'm in favour of merging early and making concessions to windows users later.

[Derisis13]

I'm also against inclusion of ani-skip code in mainline, unless the expansion over the currently proposed solution would be negligible

it's 27 lines of shell scripting and another 27 lines of lua. Since we can't include the lua scrip anyway I'd leave ani-skip in the hands of its current maintainer.

[synacktraa]

I'm also against inclusion of ani-skip code in mainline, unless the expansion over the currently proposed solution would be negligible

it's 27 lines of shell scripting and another 27 lines of lua. Since we can't include the lua scrip anyway I'd leave ani-skip in the hands of its current maintainer.

Yes, lua scripts are another issue.

[71zenith]

Pls add the copying of ani-skip shell script to $PATH in the readme install instructions

[71zenith]

@synacktraa also pls implement skipping for outro as well

[71zenith]

modify the script to redirect stderr if the script cannot find the anime

dont rely on a edge case

[71zenith]

did none of u check if this runs, modify ani-cli or ani-skip to discard the (n episodes)
MAL is already extremely picky and does not have the best search engine, it will never give the right results if we add unnecessary metadata to the query

[synacktraa]

modify the script to redirect stderr if the script cannot find the anime

dont rely on a edge case

Isn't die function already redirecting it to stderr?

[synacktraa]

did none of u check if this runs, modify ani-cli or ani-skip to discard the (n episodes)

MAL is already extremely picky and does not have the best search engine, it will never give the right results if we add unnecessary metadata to the query

I haven't tested ani-skip with ani-cli yet, been just resolving ani-skip issues

[71zenith]

my bad, it looks like it does discard the (n episodes) however it seems that u try to match the exact title name in the mal results. this however will more than likely not work for anime with >1 seasons and those which are named differently in allanime

[synacktraa]

did none of u check if this runs, modify ani-cli or ani-skip to discard the (n episodes)

MAL is already extremely picky and does not have the best search engine, it will never give the right results if we add unnecessary metadata to the query

I haven't tested ani-skip with ani-cli yet, been just resolving ani-skip issues

Tell me if you're modifying ani-cli, else I'll do something with ani-skip

[synacktraa]

Someone will have to first take me through ani-cli code, especially the episode range parsing thing.

[port19x]

Suggested change

	version_number="4.7"
	version_number="4.7.0"

[azureorangexyz]

sorry, my bad, is done.

[port19x]

3 digit version number please

[synacktraa]

@synacktraa also pls implement skipping for outro as well

Here you go. synacktraa/ani-skip@657a1de @71zenith

[port19x]

I plan to merge and release sometime later today

[port19x]

Looks good and works on my end

Needs sign off from @Derisis13 due to requested changes

[Derisis13]

Code is good, readme is a bit too verbose. Sorry for going back and forth on this, my goal is not to need to update the readme if ani-skip changes their installation method (eg. gets packed as an aur package) and to be in line with the current readme. The way it is now sticks out like a sore thumb

Code is still good, tested and works.

[lasersPew]

Imma test some stuff with windows and WSL.

[synacktraa]

Imma test some stuff with windows and WSL.

ani-skip is working in Wsl
Try gitbash too if possible

[manorit2001]

I am on Manjaro, not sure if that affects but getting the following output for ani-skip and one piece, am I doing something wrong? I tried the same with this PR as well but didn't see any skip so tried to do this.

ani-skip "1P (1084 episodes)" 341
--script-opts= '--script=/home/user/.config/mpv/scripts/skip.lua'

[synacktraa]

I am on Manjaro, not sure if that affects but getting the following output for ani-skip and one piece, am I doing something wrong? I tried the same with this PR as well but didn't see any skip so tried to do this.

ani-skip "1P (1084 episodes)" 341

--script-opts= '--script=/home/user/.config/mpv/scripts/skip.lua'

update ani-skip once. sudo ani-skip -U

[lasersPew]

I am on Manjaro, not sure if that affects but getting the following output for ani-skip and one piece, am I doing something wrong? I tried the same with this PR as well but didn't see any skip so tried to do this.

ani-skip "1P (1084 episodes)" 341

--script-opts= '--script=/home/user/.config/mpv/scripts/skip.lua'

update ani-skip once. sudo ani-skip -U

This actually doesn't solve the problem. tried using One Piece instead of 1P (1084 episodes) and got the script opts:

[71zenith]

works nicely (would have preferred to run it in background)
about the one piece thing. im afraid there is so much we can do about it. they likely do it to not get noticed by the big corp daddies.

[synacktraa]

This actually doesn't solve the problem. tried using One Piece instead of 1P (1084 episodes) and got the script opts:

If there was no error, it means there was an entry related to 1P, it's just that parsing is not working well. I'll do something about it. If it was python, we could have used vectors or ngrams to get most relevant entry.

[Derisis13]

Totally didn't just forgot this

[NKTMQ]

Imma test some stuff with windows and WSL.

ani-skip is working in Wsl Try gitbash too if possible

For any windows users that setup ani-cli with scoop, the likely best way is to use scoop to create a shim for ani-skip as well.

step 1
scoop install { "version": "1.0", "url": "https://raw.githubusercontent.com/synacktraa/ani-skip/master/ani-skip", "bin": "ani-skip" }

step 2
Place https://raw.githubusercontent.com/synacktraa/ani-skip/master/skip.lua
Into the mpv scripts folder.

Scripts folder autoruns any lua files in it so we can ignore the "--script=$HOME/.config/mpv/scripts/skip.lua" component of the ani-skip output as mpv will ignore it (with an error message saying file not found).

Otherwise if you'd like to have the script elsewhere you can edit the ani-skip's 4th line from the scoop install to be a windows folder path instead.