diff --git a/README.md b/README.md index a69bb12..1702ad0 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # Derpibooru Downloader ## Instalation and configuration -- There are two ways to run Derpibooru_dl, a windows executable or directly from the script itself. +There are two ways to run Derpibooru_dl, a windows executable or directly from the script itself. ### Standalone executable version for Windows - Suggested for anyone without programming experience. -- Download from https://github.com/woodenphone/Derpibooru-dl/releases - This only contains the downloader itself. +- Download the latest version (In green at the top) from https://github.com/woodenphone/Derpibooru-dl/releases +- Extract the contents of the .zip into a folder +- Read the configuration section for the next steps ### Python scripts - This is only suggested for those with experience in using python. @@ -13,12 +15,14 @@ ](https://www.python.org/download/) - Then you need pip installed. [See here for the docs](http://pip.readthedocs.org/en/latest/installing.html). - Then in your command line, do `pip install mechanize`. +- Read the configuration section for the next steps ### Configuration for all versions - We need to run derpibooru_dl to create settings files. - On Windows, using the standalone executable version, run `derpibooru_dl.exe` - On Windows, run `python derpibooru_dl.py` - On Mac and GNU/Linux, run `python derpibooru_dl_nix.py` +- Without a valid API key you will not be able to download anything not visible in the default guest view. - Copy your API key from [https://derpibooru.org/users/edit](https://derpibooru.org/users/edit) - Past it to the appropriate line in the `derpibooru_dl_config.cfg` inside the `config` folder. (e.g. `api_key = Ap1k3Yh3Re`) - Put the tags you want to download in `derpibooru_dl_tag_list.txt` always in the `config` file, one tag per line e.g. @@ -31,8 +35,8 @@ T4g 4 ```` - Run your derpibooru_dl like before again to download your set. - After a tag has been processed, it will be written to the file `derpibooru_done_list.txt`, again in the `config` folder. +- Derpibooru-dl will close itself after it has finished. -The API used for the tag mode is depricated, use search mode instead. It should behave the same. @@ -61,3 +65,32 @@ skip_glob_duplicate_check = **You should probably not use this unless you know w move_on_fail_verification = **Should files that fail the verification be moved? If false they will only be copied.** save_comments = **Should image comments be requested and saved, uses more resources on both client and server.** ```` + +### Example of typical settings +- This configuration should be fine for most users +- Make sure to use your own API key, the one here is just an example +```` +[Login] +api_key = useyourownkey + +[Settings] +reverse = False +output_folder = download +download_submission_ids_list = True +download_query_list = True +output_long_filenames = False +input_list_path = config\derpibooru_dl_tag_list.txt +done_list_path = config\derpibooru_done_list.txt +failed_list_path = config\derpibooru_failed_list.txt +save_to_query_folder = True +skip_downloads = False +sequentially_download_everything = False +go_backwards_when_using_sequentially_download_everything = False +download_last_week = False +skip_glob_duplicate_check = False +skip_known_deleted = True +deleted_submissions_list_path = config\deleted_submissions.txt +move_on_fail_verification = False +save_comments = False + +````