Creepso/multi-downloader-nx_mirror
1
0
Fork 0
mirror of https://github.com/anidl/multi-downloader-nx.git synced 2026-04-21 00:12:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve readme

Browse source 
Adds instruction for DRM decryption, as well as some examples on how to use the CLI. It also splits up the dependencies as they are needed.
This commit is contained in:
AnimeDL 2024-02-04 15:55:15 -08:00
parent b146ee71ae
commit 27e02a8548
1 changed files with 48 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
docs/README.md
View file

@ -8,14 +8,10 @@ This downloader can download anime from different sites. Currently supported are
This application is not endorsed by or affiliated with *Funimation*, *Crunchyroll*, or *Hidive*. This application enables you to download videos for offline viewing which may be forbidden by law in your country. The usage of this application may also cause a violation of the *Terms of Service* between you and the stream provider. This tool is not responsible for your actions; please make an informed decision before using this application.
## Prerequisites
## Dependencies
* NodeJS >= 14.6.0 (https://nodejs.org/)
* NPM >= 6.9.0 (https://www.npmjs.org/)
* PNPM >= 7.0.0 (https://pnpm.io/)
* ffmpeg >= 4.0.0 (https://www.videohelp.com/software/ffmpeg)
* MKVToolNix >= 60.0.0 (https://www.videohelp.com/software/MKVToolNix)
* mp4decrypt >= Any (http://www.bento4.com/) - Only required for decrypting
### Paths Configuration
@ -28,19 +24,49 @@ By default this application uses the following paths to programs (main executabl
To change these paths you need to edit `bin-path.yml` in `./config/` directory.
### Node Modules
## CLI Information
After installing NodeJS with NPM go to directory with `package.json` file and type: `npm i`. Afterwards run `npm run tsc`. You can now find a lib folder containing the js code execute.
See [the documentation](https://github.com/anidl/multi-downloader-nx/blob/master/docs/DOCUMENTATION.md) for a complete list of what options are available. You can define defaults for the commands by editing the `cli-defaults.yml` file in the `./config/` directory.
* [check dependencies](https://david-dm.org/anidl/funimation-downloader-nx)
### Example usage
## CLI Options
#### Logging in
See [the documentation](https://github.com/anidl/multi-downloader-nx/blob/master/docs/DOCUMENTATION.md)
Most services require you to be logged in, in order to download from, an example of how you would login is:
## Build instructions
```shell
AniDL --service {ServiceName} --auth
```
Please note that nodejs, npm, and pnpm must be installed in your system. For instructions on how to install pnpm, check (https://pnpm.io/installation)
#### Searching
In order to find the IDs to download, you can search from each service by using the `--search` flag like this:
```shell
AniDL --service {ServiceName} --search {SearchTerm}
```
#### Downloading
Once you have the ID which you can obtain from using the search or other means, you are ready to download, which you can do like this:
```shell
AniDL --service {ServiceName} -s {SeasonID} -e {EpisodeNumber}
```
## Building and running from source
### Build Dependencies
Dependencies that are only required for running from code. These are not required if you are using the prebuilt binaries.
* NodeJS >= 14.6.0 (https://nodejs.org/)
* NPM >= 6.9.0 (https://www.npmjs.org/)
* PNPM >= 7.0.0 (https://pnpm.io/)
### Build Instructions
Please note that NodeJS, NPM, and PNPM must be installed on your system. For instructions on how to install pnpm, check (https://pnpm.io/installation)
First clone this repo `git clone https://github.com/anidl/multi-downloader-nx.git`.
@ -50,3 +76,13 @@ Afterwards run `pnpm run tsc false [true if you want gui, false otherwise]`.
If you want the `js` files you are done. Just `cd` into the `lib` folder, and run `node index.js --help` to get started with the CLI, or run `node gui.js` to run the GUI
If you want to package the application, run pnpm run build-`{platform}`-`{type}` where `{platform}` is the operating system (currently the choices are windows, ubuntu, macos, and arm) and `{type}` is cli or gui.
## DRM Decryption
### Decryption Requirements
* mp4decrypt >= Any (http://www.bento4.com/) - Only required for decrypting
### Instructions
In order to decrypt DRM content, you will need to have a dumped CDM, after that you will need to place the CDM files (`device_client_id_blob` and `device_private_key`) into the `./widevine/` directory. For legal reasons we do not include the CDM with the software, and you will have to source one yourself.