Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rkwyu authored Apr 24, 2024
1 parent 011cae2 commit a5bfe7c
Showing 1 changed file with 37 additions and 17 deletions.
54 changes: 37 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,64 @@
# anime-dl 動畫下載 ![GitHub last commit (branch)](https://img.shields.io/github/last-commit/rkwyu/anime-dl/main) [![Coverage Status](https://coveralls.io/repos/github/rkwyu/anime-dl/badge.svg?branch=main)](https://coveralls.io/github/rkwyu/anime-dl?branch=main)
# Anime-dl 動畫下載 ![GitHub last commit (branch)](https://img.shields.io/github/last-commit/rkwyu/anime-dl/main) [![Coverage Status](https://coveralls.io/repos/github/rkwyu/anime-dl/badge.svg?branch=main)](https://coveralls.io/github/rkwyu/anime-dl?branch=main)

[![License: GPLv3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![python](https://img.shields.io/badge/Python-3.11-3776AB.svg?style=flat&logo=python&logoColor=white)](https://www.python.org)

## About ##
## ▶️ About ##
A tool to get anime from different websites with CLI (Command Line Interface).
It currently supports following websites:
- [x] [anime1.in](https://anime1.in/)
- [x] [anime1.me](https://anime1.me/)
- [x] [yhdm.one](https://yhdm.one/)
- [x] [xgcartoon.com](https://www.xgcartoon.com/)
- [x] [lincartoon.com](https://www.lincartoon.com/)

Pending to supports:
- [ ] [kickassanime.mx](https://www1.kickassanime.mx/)
- [ ] [iyinghua.io](http://www.iyinghua.io/)

## Prerequisites ##
## ▶️ Prerequisites ##
To running this tool, please make sure the following prerequisites are ready:
* [FFmpeg](https://www.ffmpeg.org/)
- FFmpeg ([https://www.ffmpeg.org/](https://www.ffmpeg.org/))

## Usage (CLI) ##
## ▶️ Setup ##
1. Download repository
```console
git clone https://github.com/rkwyu/anime-dl
```
2. Install dependencies
```console
cd ./anime-dl
python -m pip install -r requirements.txt
```

## ▶️ Usage (CLI) ##
Before running the application, required packages need to be installed by following command:
```console
$ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY
$ cd ./anime-dl
$ python -m pip install -r requirements.txt
$ python run.py {URL}
python run.py {URL}
```

#### Example ####
鏈鋸人(電鋸人)第1季【日語】,
series URL: https://www.xgcartoon.com/detail/dianjurenriyu-tengbenshu
episode 1 URL: https://www.xgcartoon.com/user/page_direct?cartoon_id=dianjurenriyu-tengbenshu&chapter_id=vRsDVLPPou
《Chainsaw Man Season 1》,
- Series ([https://www.xgcartoon.com/detail/dianjurenriyu-tengbenshu](https://www.xgcartoon.com/detail/dianjurenriyu-tengbenshu))
- Episode 1 ([https://www.xgcartoon.com/user/page_direct?cartoon_id=dianjurenriyu-tengbenshu&chapter_id=vRsDVLPPou](https://www.xgcartoon.com/user/page_direct?cartoon_id=dianjurenriyu-tengbenshu&chapter_id=vRsDVLPPou))

Download all episodes:
```console
# download all episodes in the series
$ python run.py https://www.xgcartoon.com/detail/dianjurenriyu-tengbenshu
python run.py https://www.xgcartoon.com/detail/dianjurenriyu-tengbenshu
```

# download a single episode
$ python run.py https://www.xgcartoon.com/user/page_direct?cartoon_id=dianjurenriyu-tengbenshu&chapter_id=vRsDVLPPou
Download episode 1:
```console
python run.py https://www.xgcartoon.com/user/page_direct?cartoon_id=dianjurenriyu-tengbenshu&chapter_id=vRsDVLPPou
```

## ▶️ Usage (WebUI) ##
Before running the application, required packages need to be installed by following command:
```console
python webUI.py
```
![anime-al screenshot](docs/screenshot.png?raw=true "anime-al")


## License ##
## ▶️ License ##
[GNU GPL v3.0](LICENSE.md)

0 comments on commit a5bfe7c

Please sign in to comment.