AnimeGo-DL

https://user-images.githubusercontent.com/11083531/174728256-b21e613e-a148-46f6-893d-fe9ac32ed223.mp4

Table of Contents:

• Dependencies
• Installation
• Usage
  • Streaming
  • Downloading
• Docker
• Contributing
• Development
  • Testing
• Disclaimer

Dependencies

:warning: Sorry Windows users, things have been tested on Linux & MacOS only. Support might be coming soon.

First, make sure you have the following installed on your machine:

• yt-dlp - a youtube download fork with additional fixes and features.
• nodejs - the latest LTS should be good

Installation

Install from NPM - recommended:

npm install -g animego-dl # remove with: npm uninstall -g animego-dl

- or -

Install with Docker (Linux only -- and those running XDM), to isolate the node runtime & bundle necessary dependencies:

• Pull the latest docker image: docker pull vinnya3/animego-dl
• Please refer to Docker Usage for running w/ Docker.

The docker image comes with yt-dlp (required for downloading), and the mpv player -- which is a lightweight video player to stream your anime!

- or -

Install from source:

1. Clone repo: git clone https://github.com/vinnyA3/animego-dl.git
2. Change into the project directory: cd animego-dl
3. Install script dependencies: npm install
4. Compile Typescript source: npm run build
5. optional - install command globally:
   • npm install -g .
   • to uninstall: npm uninstall -g animego-dl

Usage

Usage: animego-dl [options]

CLI tool to download your favorite anime series.

Options:
  -v, --version   output the current version
  -d, --download  choose to download your desired anime
  --debug         debug mode
  -h, --help      display help for command

note: if you installed the package globally, you can simply run:

animego-dl

If you did not install globally & installed from source (but do not want to link to your machine), you can run the following from the root of the project (after running npm run build - to compile from typescript):

node ./dist/bin

Streaming

To stream, just run the tool (animego-dl) and you're good to go! You will prompted to search for you desired anime, then will be presented a range(s) of episode numbers to select from. Using the CLI, input the episode number you wish to watch.

:notebook: The tool will try to spin up MPV by default. If MPV isn't detected, you'll receive the video source in the output -- you can use this source, and plug into a stream client of your choice (more default player support coming soon!)

Downloading

To download an anime episode, pass the -d option when starting the tool:

animego-dl -d

Next, search & select the episode you'd like to download via the cli. Enjoy!

:warning: The tool will download to your current working directory (where you ran the command), and under a directory named animego-dl -- options to choose your destination directory will be added soon!

Docker

:warning: The image requires a connection to your Pulseaudio & Xorg servers, so make sure you are running an Xdisplay & have Pulseaudio (or pipewire) on your host machine. If you're running Ubuntu, PopOS, or some debian derivative, you should be fine!

First, make sure you installed the Docker image.

To stream: you can run the following:

docker run --rm -it \
    --device /dev/dri \
    --network host \
    -e DISPLAY \
    -v /etc/machine-id:/etc/machine-id:ro \
    -v /run/user/1000/pulse:/run/user/1000/pulse \
    -v $HOME/.Xauthority:/home/mpv/.Xauthority \
    animego-dl /bin/sh

The aforementioned command will mount a few volumes that allow container to connect as a client to your host machine's Xorg and Pulseaudio servers.

After running the command, you'll be greeted with the container's shell prompt.

From here, to run animego-dl: npx animego-dl. When you are done, you can exit the container by typing exit.

To download:

First, create the necessary destination target in your current working directory: mkdir ./animego-dl.

Next, run (note the volume mount for ./animego-dl):

docker run --rm -it \
    --device /dev/dri \
    --network host \
    -e DISPLAY \
    -v /etc/machine-id:/etc/machine-id:ro \
    -v /run/user/1000/pulse:/run/user/1000/pulse \
    -v $HOME/.Xauthority:/home/mpv/.Xauthority \
    -v ${PWD}/animego-dl:/animego-dl \
    animego-dl /bin/sh

Finally, in the container's shell prompt, run: npx animego-dl -d

Contributing

All contributions are welcome! Please refer the contributing document for project practices and the Code of Conduct.

Also, checkout the list of the project's contributors!

Development

The project is built with Typescript. To compile the source into working JavaScript, you can run:

npm run build

The aforementioned will compile to /dist. For here, you can execute the program with:

node ./dist/bin

Testing

To run local tests: npm run test

To run tests in watch mode: npm run test:watch

:warning: Tests are few and far between at the moment. In fact, no test suites are live at this time - 2/13/22.

Disclaimer

This project, and it's owner, does not endorse piracy! Anime streaming services are :100:% supported!

animego-dl uses anime information & sources that is fully available to the public.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!