Some checks failed
Tests / test (ubuntu-latest, 3.10) (push) Successful in 44s
Tests / test (ubuntu-latest, 3.8) (push) Failing after 4m3s
Tests / test (ubuntu-latest, 3.9) (push) Successful in 14m4s
Tests / test (macos-latest, 3.10) (push) Has been cancelled
Tests / test (macos-latest, 3.8) (push) Has been cancelled
Tests / test (macos-latest, 3.9) (push) Has been cancelled
Tests / test (windows-latest, 3.10) (push) Has been cancelled
Tests / test (windows-latest, 3.8) (push) Has been cancelled
Tests / test (windows-latest, 3.9) (push) Has been cancelled
Jimaku-DL
A tool for downloading Japanese subtitles for anime from Jimaku
Features
- Download subtitles from Jimaku.cc
- Automatic subtitle synchronization with video (requires ffsubsync)
- Playback with MPV player and Japanese audio track selection
- On-screen notification when subtitle synchronization is complete
- Background synchronization during playback
- Cross-platform support (Windows, macOS, Linux)
- Smart filename and directory parsing for anime detection
- Cache AniList IDs for faster repeat usage
- Interactive subtitle selection with fzf
Installation
pip install jimaku-dl
Requirements
- Python 3.8+
- fzf for interactive selection menus (required)
- MPV for video playback (optional)
- ffsubsync for subtitle synchronization (optional)
Usage
# Basic usage - Download subtitles for a video file
jimaku-dl /path/to/your/anime.mkv
# Download subtitles and play video immediately
jimaku-dl /path/to/your/anime.mkv --play
# Download, play, and synchronize subtitles in background
jimaku-dl /path/to/your/anime.mkv --play --sync
# Download subtitles for all episodes in a directory
jimaku-dl /path/to/your/anime/season-1/
# Specify custom destination directory
jimaku-dl /path/to/your/anime.mkv --dest-dir /path/to/subtitles
API Token
You'll need a Jimaku API token to use this tool. Set it using one of these methods:
-
Command line option:
jimaku-dl /path/to/anime.mkv --token YOUR_TOKEN_HERE
-
Environment variable:
export JIMAKU_API_TOKEN="your-token-here" jimaku-dl /path/to/anime.mkv
Command-Line Options
usage: jimaku-dl [options] MEDIA_PATH
positional arguments:
MEDIA_PATH Path to media file or directory
options:
-h, --help Show this help message and exit
-v, --version Show program version number and exit
-t TOKEN, --token TOKEN
Jimaku API token (can also use JIMAKU_API_TOKEN env var)
-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}, --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}
Set logging level
-d DEST_DIR, --dest-dir DEST_DIR
Destination directory for subtitles
-p, --play Play media with MPV after download
-a ANILIST_ID, --anilist-id ANILIST_ID
AniList ID (skip search)
-s, --sync Sync subtitles with video in background when playing
File Naming
Jimaku Downloader supports various file naming conventions to extract show title, season, and episode information. It is recommended to follow the Trash Guides recommended naming schema for best results.
Examples
Show Title - S01E02 - Episode Name [1080p].mkv
Show.Name.S01E02.1080p.mkv
Show_Name_S01E02_HEVC.mkv
/path/to/Show Name/Season-1/Show Name - 02 [1080p].mkv
Development
To contribute to Jimaku Downloader, follow these steps:
-
Clone the repository:
git clone https://github.com/yourusername/jimaku-dl.git cd jimaku-dl
-
Create a virtual environment and activate it:
python -m venv venv source venv/bin/activate # On Windows, use `venv\Scripts\activate`
-
Install the dependencies:
pip install -r requirements.txt pip install -r requirements_dev.txt
-
Run the tests:
pytest
License
Jimaku Downloader is licensed under the GPLv3 License. See the LICENSE file for more information.
Languages
Python
100%