diff --git a/README.md b/README.md index 6151ccf..a4634d9 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@

BatchLinks Downloader

- Batch-downloading models in SD webui colab made simple. + Batch-downloading models and stuff in SD webui colab made simple.

@@ -19,7 +19,8 @@ -

+ + + + + + +
+ Table of Contents +
    +
  1. Installation
    2. +
  2. About
    3. +
  3. Example
    4. +
  4. Syntax
    5. + + + + + + + +
  5. Additional Syntax
    6. + + + + +
  6. Gradio Queue
    7. + + + + +
  7. Other Features
    8. + + + + +
  8. Latest release: v3.0.0
    9. + + + +
  9. Roadmap
    10. +
  10. Known Bugs
    11. +
  11. Contributing
    12. +
  12. Contact
    13. +
  13. Acknowledgments
    14. + +
+
@@ -89,7 +169,7 @@ Using `--gradio-queue` on the launch.py argument is highly recommended, as it en You can also run this extension in [SDless mode](https://github.com/etherealxx/batchlinks-webui#sdless-mode) btw. -While it's not recommended to use this extension on your local installation, you can use this extension on Windows. [More here](https://github.com/etherealxx/batchlinks-webui#local-installation-support) +While it's not recommended to use this extension on your local installation, you can use this extension on Windows. [More here.](https://github.com/etherealxx/batchlinks-webui#local-installation-support) ## About @@ -128,29 +208,33 @@ When the download is complete, the downloaded file will be listed
## Syntax -**Hashtag** - Hashtag means change current output directory to this directory. `#model` means every links below this hashtag, will be downloaded to _/content/stable-diffusion-webui/models/Stable-diffusion_, until it hits another hashtag, which will change the output directory again. See below for valid hashtags. +#### Hashtag +- Hashtag means change current output directory to this directory. `#model` means every links below this hashtag, will be downloaded to _/content/stable-diffusion-webui/models/Stable-diffusion_, until it hits another hashtag, which will change the output directory again. See [below](https://github.com/etherealxx/batchlinks-webui#valid-hashtags) for valid hashtags. -Note: If you use some colab that doesn't support native LoRA on webui (that means, using `sd-webui-additional-networks` extension in order to work), like [camenduru's v1.6](https://github.com/camenduru/stable-diffusion-webui-colab) colab, use `#addnetlora` instead of `#lora`. It will download the lora to where it supposed to be. + Note: If you use some colab that purposefully uses `sd-webui-additional-networks` extension to load Lora, use `#addnetlora` instead of `#lora`. It will download the lora to where it supposed to be. -**Links** - Links are the main things you wants to be downloaded. Current supported links are from: -- Huggingface (https://huggingface.co/) -- MEGA (https://mega.nz/) {using `mega-cmd`} -- CivitAI (https://civitai.com/) -- Discord attachments (https://cdn.discordapp.com/attachments/) -- catbox (https://files.catbox.moe) -- Github (https://github.com or https://raw.githubusercontent.com) -- Google Drive (https://drive.google.com) {using `gdown`} -- Pixeldrain (https://pixeldrain.com/u/) -- Mediafire (https://www.mediafire.com/file) {using `mediafire-dl`} -- anonfiles (https://anonfiles.com) +#### Links +- Links are the main things you wants to be downloaded. Current supported links are from: + - Huggingface (https://huggingface.co/) + - MEGA (https://mega.nz/) {using `mega-cmd`} + - CivitAI (https://civitai.com/) + - Discord attachments (https://cdn.discordapp.com/attachments/) + - catbox (https://files.catbox.moe) + - Github (https://github.com or https://raw.githubusercontent.com) + - Google Drive (https://drive.google.com) {using `gdown`} + - Pixeldrain (https://pixeldrain.com/u/) + - Mediafire (https://www.mediafire.com/file) {using `mediafire-dl`} + - anonfiles (https://anonfiles.com) -Every links other than that will be ignored. Keep in mind the only supported links are direct download links (see [here](https://github.com/etherealxx/batchlinks-downloader/blob/main/howtogetthedirectlinks.md)). For Huggingface, Civitai (model link method), Discord attachments, catbox, pixeldrain, and anonfiles, there will be four different method of downloading offered (see [below](https://github.com/etherealxx/batchlinks-webui#huggingfaces-download-method)). For MEGA, it will use `mega-cmd` to download. For Github, if, the link is a raw file, it will download the file. Else, it will use `git clone`, useful to clone extension repo into the webui extension folder. + Every links other than that will be ignored. Keep in mind the only supported links are direct download links (see [here](https://github.com/etherealxx/batchlinks-downloader/blob/main/howtogetthedirectlinks.md)). For Huggingface, Civitai (model page link method), Discord attachments, catbox, pixeldrain, and anonfiles, there will be four different method of downloading offered (see [below](https://github.com/etherealxx/batchlinks-webui#huggingfaces-download-method)). For MEGA, it will use `mega-cmd` to download. For Github, if, the link is a raw file, it will download the file. Else, it will use `git clone`, useful to clone extension repo into the webui extension folder. -More about CivitAI download method [here](https://github.com/etherealxx/batchlinks-webui#civitais-download-method). + More about CivitAI download method [here](https://github.com/etherealxx/batchlinks-webui#civitais-download-method). -**Double Hashtag** - Double hashtag means comment. You can put double hashtag in the same line of the link and it will be ignored (keep in mind to put the link first then the double hashtag) +#### Double Hashtag +- Double hashtag means comment. You can put double hashtag in the same line of the link and it will be ignored (keep in mind to put the link first then the double hashtag) -**Others** - Other texts will be ignored. +#### Others +- Other texts will be ignored. ### Valid Hashtags @@ -170,6 +254,8 @@ More about CivitAI download method [here](https://github.com/etherealxx/batchlin `#controlnet` or `#cnet` will put the downloaded file to _/content/stable-diffusion-webui/extensions/sd-webui-controlnet/models_ +`#upscale` or `#upscaler` will put the downloaded file to _/content/stable-diffusion-webui/models/ESRGAN_ + Github links (if it does not contain `/raw/` in it) doesn't need hashtag. It will always considered as webui extension, and the repository will be cloned to _/content/stable-diffusion-webui/extensions/(reponame)_ ### How to get the direct links (Important!) @@ -178,19 +264,19 @@ See [here](https://github.com/etherealxx/batchlinks-downloader/blob/main/howtoge ### Huggingface's download method -So there's four supported method: `gdown`, `wget`, `curl` and `aria2`. Use whatever, really. The difference between them are actually little. Myself love using `gdown` since the output is cleaner than the others. Some says `aria2` has the fastest download speed. +So there's four supported method: `gdown`, `wget`, `curl` and `aria2`. Use whatever, really. The difference between them are actually little. Myself love using `gdown` since the output is cleaner than the others. `aria2` has the fastest download speed though. -### Civitai's download method + +## Additional Syntax ### Rename Downloaded Files Using `>` symbol, you can rename files. Take this for example
Log
@@ -213,6 +300,24 @@ You can run shell commands by using `!` in front of the command you want, just l Log
You can run many lines at once too! +### Extract Everyting (`@extract`) +You can use `@extract` to extract every `*.7z`, `*.rar`, and `*.zip` on current directory). +``` +#lora + +@extract +#embed +``` +This will extract everything on Lora folder, since the code runs from top to bottom, and when the `@extract` executes, the current directory is still on Lora folder. + +### Custom Hashtag Path (`@new`) +You can use `@new ` to make a new usable hashtag and assign a directory path to it.
For example, you type this and press the `Download All!` button: +``` +@new #private /content/stable-diffusion-webui/outputs +#private + +``` +This will make a new hashtag `#private`, make it points to _/content/stable-diffusion-webui/outputs_, set `#private` as current directory, then download whatever into it. You can check if the new hashtag is assigned successfully by looking at the hashtag table on the right/bottom of the screen.