Skip to content

elpideus/tadako

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

npm Version GitHub release GitHub code size in bytes GitHub all releases npm downloads GitHub GitHub commit activity GitHub last commit GitHub Repo stars GitHub forks GitHub watchers

Tadako - An unofficial AnimeWorld API

This is a library inspired by MainKronos' AnimeWorld-API. Tadako is still under development and as such expect changes and relatively frequent refactoring.


Installation

This library depends on axios and cheerio.
We love and support bun and as such the library is tailored to work perfectly with it.

Installation via bun:

bun install -g tadako

Installation via npm:

npm install -g tadako

If you want to use the cli remember to install mpv as well on your system. To do that you can use one of the following commands:

Windows

There are many different ways you can install mpv depending on your preferences.

chocolatey:

choco install mpvio.install

scoop:

scoop bucket add extras
scoop install extras/mpv

You can also download the official first-party nightly build by clicking here.

Linux

Arch (Manjaro / SteamOS*):

sudo pacman -S mpv

Debian (Ubuntu):

sudo apt update
sudo apt install mpv

Fedora:

sudo dnf install mpv

OpenSuse:

sudo zypper install mpv

Gentoo:

sudo emerge media-video/mpv

Void Linux

sudo xbps-install -S mpv

Flatpak*

flatpak install flathub io.mpv.Mpv
flatpak run io.mpv.Mpv
The * indicates a distro/method that hasn't been tested thoroughly.

Mac OS

We didn't test any of the following sources and cannot provide support for Mac OS.

Mac OS 13 (Intel) -> Download
Mac OS 14 (Arm) -> Download
Mac OS 15 (Arm) -> Download


CLI Usage

Streaming

It is possible to watch anime directly through tadako.

tadako "violet evergarden"

Downloading

Downloading anime from AnimeWorld has never been as easy.

tadako "violet evergarden" download

Library Usage

Importing

You can import the library into your project and just start working with it.

import Tadako from "tadako";

Fetching

We tried to make the entire process of fetching data as straightforward as possible, while at the same time sending as few requests as possible to AnimeWorld.
As such some data like the title or the poster are fetched directly from the search request, as shown below:

Tadako.search("re:zero").then(data => {
    console.log(data.results[0].title)
});

However, as some data needs to be fetched from other locations, forcing us to make another request. That doesn't happen automatically as it would send a lot of useless requests to the server. We can manually call an update with the remaining data by using .init() or .data() on any Anime object.

Tadako.search("re:zero").then(data => {
    data.results[0].data().then(remainingResults => {
        console.log(remainingResults.episodes[0].getDownloadURL());
    })
});

We highly recommend working with asynchronous functions as it highly reduces nesting and verbosity.

const main = async () => {
    const search = await Tadako.search("re:zero");
    const anime = await search.results[0].data();
    console.log(anime.episodes[0].getDownloadURL());
}

main();

Filtering

All the filters usable on the official AnimeWorld website are also available here.

We tried to make filters as easy to use as possible. We went as far as to creating an enumerator for all the available studios, so you don't even have to remember how they are called exactly, and you don't even have to bother remembering the correct casing. We handle it all.

import Tadako, {Studio} from "./index";

const main = async () => {
    const search = await Tadako.search("re:zero", {studio: Studio.WHITE_FOX});
    const animeList = search.results;
    animeList.forEach(anime => console.log(anime.title));
}

main();

Depending on your environment and the IDE/Text Editor you are using, intellisense will help you find the studio you are searching for in seconds. In the screenshot below we are using Jetbrains' Webstorm. ./assets/img/studio_intellisense_screenshot.png

We are actively working on compiling small snippets of information for each and every studio and we also cite all the sources that are helping us in doing so. studio_intellisense_jsdoc_description_screenshot.png


TODO:

These are things that we still need to implement in no specific order.

  • Add support for different download servers
  • Create documentation website
  • Finish descriptions of all the studios.
  • Automatic download of platform-specific dependencies (like mpv)