Added config command to docs and README (#515)
* Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update config.rst * Update README.md * Update config.rst * Update config.rst * Update config.rst * Update config.rst * Update config.rst * Update config.rst * Update config.rst * Update config.rst * Update config.rst * Update README.md * Update config.rst * Update config.rst * Update config.rst * Update config.rst * Update config.rst * Update config.rst * Update config.rst * Update config.rst * Update config.rst * Update config.rst * Update config.rst * Update config.rst * Update README.md * Update config.rst Co-authored-by: Iggy <44432163+IguanasInPyjamas@users.noreply.github.com>master
Arjix
GitHub
parent
021785e935
commit
b27f853677
|
|
@ -109,16 +109,20 @@ If you have trouble installing, see extended installation instructions [here](ht
|
|||
|
||||
See [docs](https://anime-downlader.readthedocs.io/en/latest/usage/dl.html).
|
||||
|
||||
Anime Downloader has two sub-commands, `dl` and `watch`.
|
||||
Anime Downloader has five (5) sub-commands, `dl` and `watch`, `config`, `ezdl`, `test`.
|
||||
|
||||
- [dl](https://anime-downlader.readthedocs.io/en/latest/usage/dl.html): `dl` can download anime.
|
||||
- ezdl: Uses metadata agents to unify providers and also auto select a result if the search argument is close to the anime title.
|
||||
- [watch](https://anime-downlader.readthedocs.io/en/latest/usage/watch.html): `watch` can manage your anime watch list. Needs [mpv](https://mpv.io).
|
||||
- [config](https://anime-downlader.readthedocs.io/en/latest/usage/config.html): can manage the configuration for anime dl.
|
||||
- test: Tests all the providers, not the most reliable command as the results may be faulty.
|
||||
|
||||
**To use `anime_downloader` in your package:**
|
||||
|
||||
This tool can be used as a library. This means you can import it into your own applications and search for anime and do many other wonderful things.
|
||||
See [documentation](https://anime-downlader.readthedocs.io/en/latest/usage/api.html).
|
||||
|
||||
|
||||
**Development Instructions:**
|
||||
|
||||
See [development instructions](https://anime-downlader.readthedocs.io/en/latest/advanced/custom_site.html).
|
||||
|
|
|
|||
|
|
@ -1,22 +1,96 @@
|
|||
Config
|
||||
------
|
||||
|
||||
You can configure the tool to suit your needs by using ``config.json``.
|
||||
You can configure the tool to suit your needs by using ``anime config`` or by editing the config.json.
|
||||
|
||||
This can be found under:
|
||||
|
||||
anime config
|
||||
------
|
||||
|
||||
|
||||
This command lets you change the configuration for anime dl from within your terminal.
|
||||
::
|
||||
+--------+------------+
|
||||
| 4 | watch |
|
||||
| 3 | siteconfig |
|
||||
| 2 | ezdl |
|
||||
| 1 | dl |
|
||||
|--------+------------|
|
||||
| SlNo | settings |
|
||||
+--------+------------+
|
||||
Select Option [1]:
|
||||
|
||||
|
||||
|
||||
This lists all options in the config, and lets you change their values by entering them.
|
||||
If you select 1 (one) then it will bring all the sub-keys for that selected choice.
|
||||
::
|
||||
+--------+------------------------------------+
|
||||
| 16 | url |
|
||||
| 15 | speed_limit |
|
||||
| 14 | skip_download |
|
||||
| 13 | selescrape_driver_binary_path |
|
||||
| 12 | selescrape_browser_executable_path |
|
||||
| 11 | selescrape_browser |
|
||||
| 10 | quality |
|
||||
| 9 | provider |
|
||||
| 8 | player |
|
||||
| 7 | force_download |
|
||||
| 6 | file_format |
|
||||
| 5 | fallback_qualities |
|
||||
| 4 | external_downloader |
|
||||
| 3 | download_dir |
|
||||
| 2 | chunk_size |
|
||||
| 1 | aria2c_for_torrents |
|
||||
|--------+------------------------------------|
|
||||
| SlNo | dl settings |
|
||||
+--------+------------------------------------+
|
||||
Select Option [1]:
|
||||
|
||||
|
||||
Selecting a setting that has no sub-keys will get you to the value input mode.
|
||||
::
|
||||
+--------+------------------------------------+
|
||||
| 16 | url |
|
||||
| 15 | speed_limit |
|
||||
| 14 | skip_download |
|
||||
| 13 | selescrape_driver_binary_path |
|
||||
| 12 | selescrape_browser_executable_path |
|
||||
| 11 | selescrape_browser |
|
||||
| 10 | quality |
|
||||
| 9 | provider |
|
||||
| 8 | player |
|
||||
| 7 | force_download |
|
||||
| 6 | file_format |
|
||||
| 5 | fallback_qualities |
|
||||
| 4 | external_downloader |
|
||||
| 3 | download_dir |
|
||||
| 2 | chunk_size |
|
||||
| 1 | aria2c_for_torrents |
|
||||
|--------+------------------------------------|
|
||||
| SlNo | dl settings |
|
||||
+--------+------------------------------------+
|
||||
Select Option [1]:
|
||||
Current value: False
|
||||
Input new value for aria2c_for_torrents: True
|
||||
|
||||
|
||||
config.json
|
||||
------
|
||||
|
||||
|
||||
If you want you can directly edit the config.json.
|
||||
It can be found under:
|
||||
|
||||
- ``~/.config/anime-downloader`` on Linux
|
||||
|
||||
- ``C:\Users\[Username]\AppData\Roaming\anime downloader`` on Windows
|
||||
- ``%appdata%\anime downloader`` on Windows
|
||||
|
||||
- ``~/Library/Application Support/anime downloader`` on MacOS
|
||||
|
||||
You can override the settings in the ``config.json`` with the following command line
|
||||
arguments.
|
||||
|
||||
The default config file is given below.
|
||||
|
||||
.. code:: json
|
||||
::
|
||||
|
||||
{
|
||||
"dl": {
|
||||
|
|
|
|||
Loading…
Reference in New Issue