imgbrd-grabber/README.md

148 lines
13 KiB
Markdown
Raw Permalink Normal View History

2020-05-26 07:15:10 +08:00
<p align="center"><img src="src/gui/resources/images/readme-icon.png" alt="" /></p>
2017-02-25 21:35:52 +08:00
2018-03-27 08:18:15 +08:00
<h1 align="center">Grabber</h1>
2020-11-29 23:36:13 +08:00
[![Discord chat](https://img.shields.io/discord/780466420877361156?logo=discord&logoColor=white)](https://discord.gg/pWnY5eW3rz)
2015-08-07 01:01:18 +08:00
[![GitHub release](https://img.shields.io/github/release/Bionus/imgbrd-grabber.svg)](https://github.com/Bionus/imgbrd-grabber/releases/latest)
[![GitHub downloads](https://img.shields.io/github/downloads/Bionus/imgbrd-grabber/latest/total.svg)](https://github.com/Bionus/imgbrd-grabber/releases/latest)
2016-08-23 00:11:18 +08:00
[![GitHub downloads](https://img.shields.io/github/downloads/Bionus/imgbrd-grabber/total.svg)](https://github.com/Bionus/imgbrd-grabber/releases)
[![GitHub issues](https://img.shields.io/github/issues/Bionus/imgbrd-grabber.svg)](https://github.com/Bionus/imgbrd-grabber/issues)
[![Donate with PayPal](https://img.shields.io/badge/paypal-donate-orange.svg)](https://www.paypal.me/jvasti)
2015-11-29 06:26:08 +08:00
[![Donate with Patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://www.patreon.com/bionus)
2022-12-31 03:12:55 +08:00
[![Build Status](https://img.shields.io/github/actions/workflow/status/Bionus/imgbrd-grabber/build.yml)](https://github.com/Bionus/imgbrd-grabber/actions)
2016-08-23 00:11:18 +08:00
[![Code Coverage](https://img.shields.io/codecov/c/github/Bionus/imgbrd-grabber.svg)](https://codecov.io/gh/Bionus/imgbrd-grabber)
2024-01-23 17:14:46 +08:00
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/3ab9cd9af181458fad287a2663129d98)](https://app.codacy.com/gh/Bionus/imgbrd-grabber/dashboard)
2016-08-23 00:11:18 +08:00
[![Project license](https://img.shields.io/github/license/bionus/imgbrd-grabber.svg)](https://raw.githubusercontent.com/Bionus/imgbrd-grabber/develop/LICENSE)
2018-03-27 08:18:15 +08:00
Imageboard/booru downloader which can download thousands of images from multiple boorus very easily.
2017-02-25 20:41:05 +08:00
Thanks to its powerful naming features, you just have to set your filename and save directory using all the tokens available, and the program will generate a filename using the image's information. With this, you can store and manage your pictures in advanced directory structures, and save image with custom filenames!
2018-03-27 08:18:15 +08:00
Grabber works on Windows, Mac, and Linux. It is available in English, French, Russian, simplified Chinese, and Spanish.
2015-11-30 03:29:45 +08:00
## Download
You can download the latest release [here](https://github.com/Bionus/imgbrd-grabber/releases/latest), or find all previous releases [here](https://github.com/Bionus/imgbrd-grabber/releases).
2017-11-23 04:02:07 +08:00
For users interested, a nightly version is built automatically on every commit on the `develop` branch, and can be downloaded [here](https://github.com/Bionus/imgbrd-grabber/releases/nightly). Note that it might be less stable than official releases, so use at your own risk.
* [Install steps for Windows](https://www.bionus.org/imgbrd-grabber/docs/install/windows.html)
* [Install steps for Linux](https://www.bionus.org/imgbrd-grabber/docs/install/linux.html)
* [Install steps for macOS](https://www.bionus.org/imgbrd-grabber/docs/install/macos.html)
* [Install steps for Android](https://www.bionus.org/imgbrd-grabber/docs/install/android.html)
2018-03-27 08:18:15 +08:00
## Features
### Browse
2018-03-28 05:00:57 +08:00
[<img src="https://www.bionus.org/imgbrd-grabber/assets/img/screenshots/search-basic-thumb.png" align="right" />](https://www.bionus.org/imgbrd-grabber/assets/img/screenshots/search-basic.png)
2018-03-28 05:00:57 +08:00
* Tabs to make multiple searches at the same time
* Able to show results from multiple imageboards at the same time in a single tab
2018-03-27 08:18:15 +08:00
* Remove duplicate results from multiple-imageboard searches
* Auto-completion of tags in the search field
* Blacklisting of tags to mark or hide images you don't want to see
* Proxy support
2018-03-28 05:00:57 +08:00
* Post-filtering (when the imageboard search is limited)
2018-03-27 08:18:15 +08:00
* Auto-download images as you search according to a whitelist
### Download
2018-03-28 05:00:57 +08:00
[<img src="https://www.bionus.org/imgbrd-grabber/assets/img/screenshots/download-thumb.png" align="right" />](https://www.bionus.org/imgbrd-grabber/assets/img/screenshots/download.png)
2018-03-28 05:00:57 +08:00
2018-03-27 08:18:15 +08:00
* Download thousands of images at once
* Download single images using their MD5 or ID
* Command line interface to download images
<p>&nbsp;</p>
<p>&nbsp;</p>
<p>&nbsp;</p>
<p>&nbsp;</p>
<p>&nbsp;</p>
### Customize
2018-03-28 05:00:57 +08:00
[<img src="https://www.bionus.org/imgbrd-grabber/assets/img/screenshots/sources-thumb.png" align="right" />](https://www.bionus.org/imgbrd-grabber/assets/img/screenshots/sources.png)
2018-03-28 05:00:57 +08:00
2018-03-27 08:18:15 +08:00
* Add your own imageboards very easily
* Authentication for sources behind a login wall
* Theme support using CSS. See [Themes](https://www.bionus.org/imgbrd-grabber/docs/plugins/theme.html) for details.
* Lots of options to customize the program's behaviour
2018-03-27 08:18:15 +08:00
<p>&nbsp;</p>
<p>&nbsp;</p>
<p>&nbsp;</p>
### Organize
2018-03-28 05:00:57 +08:00
[<img src="https://www.bionus.org/imgbrd-grabber/assets/img/screenshots/filename-thumb.png" align="right" />](https://www.bionus.org/imgbrd-grabber/assets/img/screenshots/filename.png)
2018-03-28 05:00:57 +08:00
* Save images using a custom format, for example `%artist%/%copyright%/%character%/%md5%.%ext%`, or using JavaScript code. See [Filename](https://www.bionus.org/imgbrd-grabber/docs/filename.html) for details.
2018-03-27 08:18:15 +08:00
* Favorite tags to keep track of new images
* "View it later" tags to save a search for later
* Support saving images directly to a local booru, such as [Szurubooru](https://www.bionus.org/imgbrd-grabber/docs/commands/szurubooru.html), [MyImouto](https://www.bionus.org/imgbrd-grabber/docs/commands/my-imouto.html), [Gelbooru](https://www.bionus.org/imgbrd-grabber/docs/commands/gelbooru.html), or [Shimmie](https://www.bionus.org/imgbrd-grabber/docs/commands/shimmie.html).
* Can add entries to a database for each image or tag while downloading. See [Commands](https://www.bionus.org/imgbrd-grabber/docs/commands/) for details.
2018-03-27 08:18:15 +08:00
* Conditional filenames triggered by a tag
* Rename already downloaded images
2016-02-01 07:10:27 +08:00
## Default sources
You can add additional sources very easily, but here's a short list of some sources that are included and supported by default:
* Danbooru
* Gelbooru
* E-Hentai
* Pixiv
* yande.re
* Shimmie
* e621
* Konachan
* rule34
* safebooru
* Anime-Pictures
* behoimi
* Zerochan
* Twitter
2016-02-01 07:10:27 +08:00
2016-02-24 05:25:15 +08:00
## Compilation
See the [Compilation](https://bionus.github.io/imgbrd-grabber/docs/compilation.html) documentation to know how to build Grabber.
* Linux: run `./build.sh` at the root of the repository
* macOS: run `./build-mac.sh` at the root of the repository
2018-08-15 07:05:41 +08:00
## Contributors
2024-01-23 17:14:46 +08:00
<!-- ALL-CONTRIBUTORS-LIST:START -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://github.com/Bionus"><img src="https://avatars2.githubusercontent.com/u/882719?s=122?s=122" width="122px;" alt=""/><br /><sub><b>Jack Vasti</b></sub></a><br /><a href="https://github.com/Bionus/imgbrd-grabber/commits?author=Bionus" title="Code">💻</a> <a href="https://github.com/Bionus/imgbrd-grabber/commits?author=Bionus" title="Documentation">📖</a> <a href="https://github.com/Bionus/imgbrd-grabber/commits?author=Bionus" title="Tests">⚠️</a></td>
<td align="center"><a href="https://github.com/Zzzyyzzyxx"><img src="https://avatars0.githubusercontent.com/u/16903308?s=122?s=122" width="122px;" alt=""/><br /><sub><b>YMI</b></sub></a><br /><a href="https://github.com/Bionus/imgbrd-grabber/issues?q=author%3AYMI" title="Bug reports">🐛</a> <a href="#ideas-YMI" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center"><a href="https://github.com/SultrySamthepennanceman"><img src="https://avatars2.githubusercontent.com/u/12085184?s=122?s=122" width="122px;" alt=""/><br /><sub><b>SultrySamthepenna&hellip;</b></sub></a><br /><a href="https://github.com/Bionus/imgbrd-grabber/issues?q=author%3ASultrySamthepennanceman" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/BarryMode"><img src="https://avatars1.githubusercontent.com/u/5648875?s=122?s=122" width="122px;" alt=""/><br /><sub><b>BarryMode</b></sub></a><br /><a href="https://github.com/Bionus/imgbrd-grabber/commits?author=BarryMode" title="Code">💻</a> <a href="https://github.com/Bionus/imgbrd-grabber/issues?q=author%3ABarryMode" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/Flat"><img src="https://avatars3.githubusercontent.com/u/2048861?s=122?s=122" width="122px;" alt=""/><br /><sub><b>Ken Swenson</b></sub></a><br /><a href="https://github.com/Bionus/imgbrd-grabber/commits?author=Flat" title="Code">💻</a> <a href="#platform-Flat" title="Packaging/porting to new platform">📦</a></td>
<td align="center"><a href="https://github.com/larry-he"><img src="https://avatars0.githubusercontent.com/u/18506295?s=122?s=122" width="122px;" alt=""/><br /><sub><b>Larry He</b></sub></a><br /><a href="https://github.com/Bionus/imgbrd-grabber/commits?author=larry-he" title="Code">💻</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/brodycas3"><img src="https://avatars3.githubusercontent.com/u/19770864?s=122?s=122" width="122px;" alt=""/><br /><sub><b>brodycas3</b></sub></a><br /><a href="https://github.com/Bionus/imgbrd-grabber/issues?q=author%3Abrodycas3" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/sanddudu"><img src="https://avatars1.githubusercontent.com/u/1650692?s=122?s=122" width="122px;" alt=""/><br /><sub><b>Klion Xu</b></sub></a><br /><a href="#translation-sanddudu" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/MasterPetrik"><img src="https://avatars2.githubusercontent.com/u/22294259?s=122?s=122" width="122px;" alt=""/><br /><sub><b>MasterPetrik</b></sub></a><br /><a href="https://github.com/Bionus/imgbrd-grabber/issues?q=author%3AMasterPetrik" title="Bug reports">🐛</a> <a href="#translation-MasterPetrik" title="Translation">🌍</a> <a href="#ideas-MasterPetrik" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center"><a href="https://github.com/dyskette"><img src="https://avatars3.githubusercontent.com/u/6687927?s=122?s=122" width="122px;" alt=""/><br /><sub><b>Eddy Castillo</b></sub></a><br /><a href="#translation-dyskette" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/MrAndre96"><img src="https://avatars0.githubusercontent.com/u/6564956?s=122?s=122" width="122px;" alt=""/><br /><sub><b>MrAndre96</b></sub></a><br /><a href="https://github.com/Bionus/imgbrd-grabber/issues?q=author%3AMrAndre96" title="Bug reports">🐛</a></td>
<td align="center"><a href="https://github.com/brazenvoid"><img src="https://avatars1.githubusercontent.com/u/8722533?s=122?s=122" width="122px;" alt=""/><br /><sub><b>Umair Ahmed</b></sub></a><br /><a href="https://github.com/Bionus/imgbrd-grabber/issues?q=author%3Abrazenvoid" title="Bug reports">🐛</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/ccppoo"><img src="https://avatars0.githubusercontent.com/u/46418312?s=122?s=122" width="122px;" alt=""/><br /><sub><b>ccppoo</b></sub></a><br /><a href="#translation-ccppoo" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/yami-no-tusbas"><img src="https://avatars2.githubusercontent.com/u/3921598?v=4?s=122" width="122px;" alt=""/><br /><sub><b>YamiNoSho</b></sub></a><br /><a href="https://github.com/Bionus/imgbrd-grabber/issues?q=author%3Ayami-no-tusbas" title="Bug reports">🐛</a> <a href="#question-yami-no-tusbas" title="Answering Questions">💬</a> <a href="#ideas-yami-no-tusbas" title="Ideas, Planning, & Feedback">🤔</a></td>
<td align="center"><a href="https://github.com/waitingmoon"><img src="https://avatars.githubusercontent.com/u/16256443?v=4?s=122" width="122px;" alt=""/><br /><sub><b>waitingmoon</b></sub></a><br /><a href="#translation-waitingmoon" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/Penguin-Guru"><img src="https://avatars.githubusercontent.com/u/22182988?v=4?s=122" width="122px;" alt=""/><br /><sub><b>Penguin-Guru</b></sub></a><br /><a href="https://github.com/Bionus/imgbrd-grabber/commits?author=Penguin-Guru" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/lucas-04"><img src="https://avatars.githubusercontent.com/u/95548091?v=4?s=122" width="122px;" alt=""/><br /><sub><b>lucas</b></sub></a><br /><a href="#translation-lucas-04" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/adem4ik"><img src="https://avatars.githubusercontent.com/u/4707112?v=4?s=122" width="122px;" alt=""/><br /><sub><b>Andrei Stepanov</b></sub></a><br /><a href="#translation-adem4ik" title="Translation">🌍</a> <a href="https://github.com/Bionus/imgbrd-grabber/issues?q=author%3Aadem4ik" title="Bug reports">🐛</a> <a href="#ideas-adem4ik" title="Ideas, Planning, & Feedback">🤔</a></td>
</tr>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
2018-08-15 07:05:41 +08:00
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.
Contributions of any kind are welcome!