Skip to content
This repository has been archived by the owner on May 27, 2023. It is now read-only.

Latest commit

 

History

History
122 lines (104 loc) · 3.94 KB

README.md

File metadata and controls

122 lines (104 loc) · 3.94 KB

AnimDL

This project is a C# port of justfoolingaround/animdl

Installation

  1. dotNET CLI (Global)
    dotnet tool install --global AnimDL
    
  2. dotNET CLI (Local)
    dotnet new tool-manifest # if you are setting up this repo
    dotnet tool install --local AnimDL
    
  3. Cake
    #tool dotnet:?package=AnimDL
    
  4. NUKE
    nuke :add-package AnimDL
    

Usage

Usage:
  AnimDL [command] [options]

Options:
  --version       Show version information
  -?, -h, --help  Show help and usage information

Commands:
  config          configure options for application
  grab <Title>    grabs stream links
  search <Title>  search anime on provider
  stream <Title>  stream anime

The stream option is disabled automatically if the project cannot find any of the supported streamers.

stream / grab

These commands are the main set of command in the project. All of them scrape the target site, the only difference is how it is used.

  • The stream option tosses the stream url to a player so that you can seamlessly binge your anime.
    Description:
        stream anime
    
    Usage:
        AnimDL stream [<Title>] [options]
    
    Arguments:
        <Title>  Title of anime to search
    
    Options:
        -p, --provider <AnimeOut|AnimePahe|AnimixPlay|GogoAnime|Tenshi|Zoro>  provider name [default: AnimixPlay]
        -r, --range <range>                                                   range of episodes [default: 0..^0]
        --player <Vlc>                                                        media player to stream. [default: Vlc]
        -?, -h, --help                                                        Show help and usage information
    
  • The grab option simply streams the stream url to the stdout stream.
    • This is useful for external usage and testing.
    Description:
        grabs stream links
    
    Usage:
        AnimDL grab [<Title>] [options]
    
    Arguments:
        <Title>  Title of anime to search
    
    Options:
        -p, --provider <AnimeOut|AnimePahe|AnimixPlay|GogoAnime|Tenshi|Zoro>  provider name [default: AnimixPlay]
        -r, --range <range>                                                   range of episodes [default: 0..^0]
        -?, -h, --help                                                        Show help and usage information
        ```
    
    
animdl stream "One Piece" 

Providers can be specified by using provider prefix, stream "One Piece" -p gogoanime, will use the GogoAnime provider.

-r / --range argument

This argument is shared by stream and grab, it can be used to hand over custom ranges for selecting episodes.
uses c# range and indices syntax.

2..5    // episodes from [2-5]
5..     // episodes from 5 till end.
5       // 5th episode
^3      // 3rd episode from end
^3..    // last 3 episodes

if you don't provide a value for this argument, all available episodes will be taken.

Configuration

configuration file can be found in installation director or at %userprofile%/.animdl/appsettings.json

{
  "DefaultProvider": "AnimixPlay",
  "DefaultMediaPlayer": "VLC",
  "UseRichPresense": false,
  "MediaPlayers": {
    "VLC": {
      "Executable": "%ProgramFiles%\\VideoLAN\\VLC\\vlc.exe"
    }
  }
}

Third party dependencies