Skip to content

A command line tool that allows query-based downloads from multiple Boorus

Notifications You must be signed in to change notification settings

ShyBot-SFM/BooruDownloader

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BooruDownloader

What is BooruDownloader?

BooruDownloader is a command line program that allows query (search) based downloads from different boorus.

What is needed to run BooruDownloader?

A Java installation that supports Java 8 or above.

What boorus are supported?

By default every standard booru is supported (see http://booru.org/). Additionally, BooruDownloader supports:

Why is the program stuck in "Fetching URLs..."?

Some boorus, such as https://e621.net/ or https://rule34.xxx/ provide an API that allows faster URL fetching. However, the default booru does not provide those eases. For each page returned from a query, the program has to retrieve and parse the HTML of that page plus the HTMLs corresponding to each picture. This is a really slow process, so in case you're trying to download from a booru not under the next list, you have to be patient.

Sped up boorus

How to use BooruDowloader

BooruDownloader needs:

  • The BooruDownloader.jar file.
  • The BooruQueries.txt file. The BooruDownloader realease files include a sample BooruQueries.txt file. A BooruQueries.txt file is created if it does not exist when the program is executed.

Please, use the command line to run the program. You can execute it using the "java -jar ./BooruDownloader.jar" command. If you don't, the program will still run correctly, but you won't be able to see what downloads failed once the program reaches the end of its execution.

BooruQueries.txt file format

"#" character

A line starting with a "#" is treated as a comment, and thus ignored by the program.

Queries

To indicate the program what it has to download, you have to provide the next information:

  • A booru's URL to its home page, preceeded by a ">" character. For example: ">https://rule34.xxx/". Please provide the full URL, including the final "/". URLs such as "rule34.xxx/" or "https://rule34.xxx" won't work.
  • A list of queries under the booru's URL, each in a different line. You have to type the queries as if you were typing them in the booru's search bar.
  • You can also indicate a list of queries under a ">" character followed by no URL to indicate the program that those queries must be searched in every booru provided in the file. Important: If the same query is specified under a booru and under common queries, the program searches the former.
Query arguments

Additionaly, you can add properties to a query using different flags. These are:

  • "--f": The program ignores if the files that match that query where previously cached, forcing their download.
  • "--c": The program downloads no files. Instead, it only stores in cache the URLs of the files that match that query.

About

A command line tool that allows query-based downloads from multiple Boorus

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages