abridged-cli

Abridged Anime. But in the Terminal!
I use this CLI to manage and watch my local collection/archive of abridged anime.

Help

USAGE
    abridged-cli [OPTIONS]

Abridged Anime. But in the Terminal!

OPTIONS
    -s, --server
    Spring up an FTP server on 0.0.0.0:2121 for the abridged folder

    -f, --format
    Format default entry types as per the guideline

    -m, --metadata
    Check and fix video file metadata of all entries
    Optionally, specify entry type or entry path

TUI
    q - exit
    / - search
    o - open directory
    i - add/edit info.txt
    d - show description

    Use 'Left' and 'Right' arrows to navigate through entry types

Screenshots

Guidelines

File Structure

Abridged/
├─ Series/
│  ├─ [Kurosai] Boundary Bridge/
│  │  ├─ covers/
│  │  │  ├─ 1.jpg
│  │  │  ├─ 2.jpg
│  │  │  └─ ...
│  │  ├─ info.txt
│  │  ├─ Episode 1 - Suck that Meat of Mine.mkv
│  │  ├─ Episode 2 - Nigasaki in Paris.mkv
│  │  ├─ Episode 3~6 - The Crisis Mode.mkv
│  │  ├─ OVA 1 - Other.mkv
│  │  ├─ Movie 1 - Another.mkv
│  │  └─ ...
│  └─ ...
├─ Shots/
│  ├─ [2GS BootLegged] Talking To God/
│  │  ├─ info.txt
│  │  ├─ cover.jpg
│  │  └─ 1.mkv
│  └─ ...
└─ Shorts/
   ├─ [bearfist] Mekakucity Slackers/
   │  ├─ info.txt
   │  ├─ cover.jpg
   │  ├─ 1.mkv
   └─ ...

Abridged/Other/ <- This directory and all its contents are ignored by the TUI and formatters

General

[info.txt]
This file is completely optional.
It contains additional information about an entry.
Which may include archival notes, playlist descriptions etc.

[videos]
All videos contain metadata attached to the mkv.
This includes the video thumbnail, info.json file, general metadata.

[DESC] - Description
[MODEL] - File Structure
[EX] - Example

Series

[DESC]
A set of entries bound by a common relationship.
They may be common episodically.
Or common as in by the same creator.
Definition of common is flexible as long as the relation stands.
All series entries should have multiple videos.

[MODEL]
Directory follows "[creator] entry name" scheme
Covers are inside a "covers" directory
Individual cover names are flexible
Entry videos are in the "Type n.n - title" scheme
If there is no title, follow "Type n.n"
If there is no decimal, follow "Type n"
Where "Type" is one of "Episode", "OVA", "Movie"
Where "n.n" is the episode number
Optionally, use decimals for further classification
Optionally, use ~ when there are multiple entries in single file
May contain an "info.txt" file

[EX]
Series/
├─ [The Dastails] Nisekoi Abridged/
│  ├─ covers/
│  │  ├─ 1.jpg
│  │  ├─ 2.jpg
│  │  └─ ...
│  ├─ info.txt
│  ├─ Episode 1 - Pilot.mkv
│  ├─ Episode 1.5 - Takin it Slow.mkv
│  ├─ Episode 2 - Banana Tuesdays.mkv
│  ├─ Episode 4~5 - Combo Day.mkv
│  ├─ OVA 1 - BROsekoi.mkv
│  └─ Movie 1 - NiseBOO.mkv

Default

Both Shots and Shorts belong to this category.

[DESC]
Single videos that are not apart of a continuous series.
They may be random. Or may have a coherent plot.
What matters is its detachement from any other material.

[MODEL]
Directory follows "[creator] entry name" scheme
Cover is directly inside. Named "cover"
Entry video is named "1"
May contain an "info.txt" file

[EX]
Shots/
 ├─ [UntilDawnCreeps] Yuri Note/
 │  ├─ info.txt
 │  ├─ cover.jpg
 │  └─ 1.mkv

Archival

# command used to download videos
yt-dlp --remux-video mkv --sub-langs 'en.*,-live_chat' --embed-subs --embed-thumbnail --write-thumbnail --add-metadata --embed-info-json --convert-thumbnails png -f <format> <url>