aniwrapper/README.md

Aniwrapper

Setup | Usage | Screenshots

Introduction

This is a fork of Dink4n's ani-cli, which itself is a fork of pystardust's old-ani-cli

This fork is a wrapper around a modified version of ani-cli and uses rofi to gather information and control the program

In addition to rofi, I've also changed the way saving history works by integrating a local sqlite3 database with a table for search and watch history

It is built around Dink4n's fork of ani-cli since at the time of creation, this is the version that has downloading working correctly

This tool scrapes the site gogoanime.

It is intended to be called from the wrapper script aniwrapper, however using the ani-cli script itself is also possible

Table of Contents

• Introduction
• Setup
  • Skip Intro Script
  • Installing
    • Arch Linux
    • Manual Install
      • Install the Dependencies
      • Clone the repo
      • Run the setup and install the script
• Aniwrapper Menus
  • Search Anime
  • Anime Selection
  • Episode Selection
• Usage
  • aniwrapper
    • Option 1: Streaming
    • Option 2: Download
    • Option 3: Continue
    • Option 4: Play from File
    • Option 5: Sync History
  • ani-cli Script
• Screenshots

Setup

These are the minimum dependences required to run aniwrapper

• grep
• curl
• sed
• mpv
• ffmpeg
• rofi
  • meh.rasi (installed in setup.sh)
• sqlite3

Skip Intro Script

This repo comes packaged with and will install the skip-intro.lua script for MPV during setup if it is not already installed

The script is activated with the TAB key

Upon activation, the skip-intro script will try its best to skip the episode introduction by skipping to the next moment of silence in the video

• If the video has not pre-loaded past the introduction, the script will not know what to do. Press TAB again to stop the script until the video has loaded enough, or just manually skip past the intro.
• If the video does not have a pause in audio (or a significant enough drop in audio volume) between the end of the introduction and the beginning of the video/episode, then the script may fail and skip to a random point in the video

Installing

Arch Linux

aniwrapper-git is available on the AUR for Arch users

paru -S aniwrapper-git
or
yay -S aniwrapper-git

Manual Install

To install manually, make sure the dependencies are installed first

Install the Dependencies

# Arch
pacman -S --needed grep curl sed mpv ffmpeg rofi sqlite3

# Debian
apt install grep curl sed mpv ffmpeg rofi sqlite3

Clone the repo

Use the following command to clone the Git repository locally and switch into the cloned directory

git clone https://github.com/ksyasuda/aniwrapper && cd aniwrapper

Run the setup and install the script

After switching into the aniwrapper directory, run the following commands to set up and install the script

chmod +x setup.sh
./setup.sh && sudo make install

Aniwrapper Menus

There are several menus used to drive the program forward

Search Anime

The first menu consists of a search box and a list of anime titles corresponding to past valid searches. Choose an option from the menu, or enter in a unique search query to search for a new anime. The result from this will be used to query against gogoanime and return similar named anime

Dealing with conflicting search queries / rofi grabbing from search list

I can write more about it later, but in this program, rofi is configured to search with case insensitivity and select the best match from the list if there are matches. This can make it difficult at times to write a search query that does not trigger a selection from the rofi menu

Once your history starts filling up, it becomes progressively more difficult to form unique search queries

The workaround for this is to prepend a dash - to the search query
The above output was produced by searching: isekai -

As of the update on 2022-01-01, if selecting an anime from the search history list, the anime selection menu will be skipped and the program will move on to episode selection

Anime Selection

The next menu is where you select the anime to watch from a narrowed down list. Elements that have a blue border and text color indicate which anime have been watched before

Episode Selection

In the episode selection menu, you can select an individual episode from the list, provide a single episode, or provide a range of episodes as two space separated integers start_episode end_episode. Like in the previous menu, any element with a blue border and text-color indicates that episode has been watched before

Usage

aniwrapper

# Launch menu (default video quality: best)
aniwrapper

# Launch menu with quality selection
aniwrapper -q

# Enable verbose logging
aniwrapper -v

# Use ani-cli command-line mode (rofi disabled)
aniwrapper -c

# Download anime in command-line mode
aniwrapper -d

# All flags can be used in command-line mode as well
# ex. The following command will launch aniwrapper in command-line download mode with quality selection
aniwrapper -cqd

Option 1: Streaming

• click here for an example showing streaming a new anime
• click here for an example showing streaming a previously watched anime

Streaming is the default option for the aniwrapper script and will prompt you with each of the menus specified in the aniwrapper Menus section

Option 2: Download

The default download location is $HOME/Videos/sauce and will be chosen as the download directory unless otherwise specified

After specifying the download directory (or leaving it blank for the default), you will be presented with the menus from the aniwrapper Menus section for selecting the anime and episode(s) to download

Option 3: Continue

The continue option queries the sqlite3 history databse and pulls the list of distinct anime names from the watch_history table. Select an option from the list and the most recently watched episode of the selected anime will play

Option 4: Play from File

This option prompts you to provide the path to your Videos directory. Any path can be provided, but the script will begin the search from the provided path. From there, follow the prompts to select the video you want to watch and it will be opened in mpv

Option 5: Sync History

This option allows you to sync your search/watch history across devices. It queries the database on the remote machine and inserts/updates the necessary rows

At the moment, the requirements are as follows:

• You must be able to ssh into the remote machine
• The username must be the same across both devices
• The history.sqlite3 file must be in the default location: $XDG_CONFIG_HOME/aniwrapper/history.sqlite3

ani-cli Script

# watch anime
ani-cli <query>

# download anime
ani-cli -d <download_directory>

# resume watching anime
ani-cli -H

# list searched anime
ani-cli -l

# playlist mode
ani-cli -P

# add to playlist
ani-cli -a

# sync history across devices
ani-cli -s

# run ani-cli in command-line mode (rofi disabled)
ani-cli -c

Multiple episodes can be viewed/downloaded by giving the episode range like so

Choose episode [1-13]: 1 6

This would open/download episodes 1 2 3 4 5 6

Screenshots

More to come soon... maybe