diff options
| author | Yaohan Chen <yaohan.chen@gmail.com> | 2014-04-01 01:21:59 -0400 |
|---|---|---|
| committer | Yaohan Chen <yaohan.chen@gmail.com> | 2014-04-01 01:31:53 -0400 |
| commit | 23fcf1acc62e0f32f479c12c1916b2b1dd922199 (patch) | |
| tree | 96ddaf09bb3cb901a9d9a0300bf2c14a37586de9 /README | |
| parent | bb224302e1720bf7119c5b3a2e3c394ce989ecc7 (diff) | |
| download | hib-dlagent-23fcf1acc62e0f32f479c12c1916b2b1dd922199.tar.gz hib-dlagent-23fcf1acc62e0f32f479c12c1916b2b1dd922199.zip | |
Support the new Humble Bundle page
Use PhantomJS to handle the dynamically generated page and captchas.
Add options to specify the location of PhantomJS scripts and
configuration file.
Update README on requirements, usage, and debugging information.
Update CHANGELOG.
Diffstat (limited to 'README')
| -rw-r--r-- | README | 26 |
1 files changed, 22 insertions, 4 deletions
@@ -2,22 +2,32 @@ Tool to download Humble Indie Bundle binaries by file name Author: Eric Anderson <ejona86@gmail.com> Contributor: Thomas Riccardi <riccardi.thomas@gmail.com> Contributor: Devin J. Pohly <djpohly@gmail.com> +Contributor: Yaohan Chen <yaohan.chen@gmail.com> Description =========== Primarily for use as a DLAGENT in makepkg.conf in Arch Linux, but generally useful when needing to download a particular Humble Bundle file via a script. -The script does very little other than argument parsing; it effectively has only -two "real" lines of functionality. It also manages a storage directory where already downloaded file can be found. Installation and Usage ====================== -Run the script directly or copy the script to a location like /usr/bin/ for all -users to use. +This utility currently requires PhantomJS in order to extract links on Humble +Bundle webpages generated by JavaScript. It also uses 'display', part of +ImageMagick, to handle any captchas. (It does not solve captchas for you, but +only displays a screenshot of the web page and asks you to enter the answer.) + +To run hib-dlagent without installating it, add parameters '-S. -c.', which tells +it to look for scripts and the configuration file in the current directory. + +By default hib-dlagent assumes the .coffee scripts are installed in +/usr/share/hib-dlagent, and the .json configuration file is installed in +/etc/hib-dlagent. If they are installed in other locations, it is necessary +to either run hib-dlagent with the correct -S and -c parameters, or edit the +variables SCRIPT_PATH and CONFIG_PATH in hib-dlagent. The tool uses curl to download the file, or can simply provide the URL needed to download the file so a different HTTP downloader such a Wget can be used. @@ -28,3 +38,11 @@ DLAGENTS=(... ...) Run with the -h argument for more information. + +Troubleshooting +=============== + +Extracting URLs from Humble Bundle's mostly dynamically-generated website can be +error-prone, and time consuming. Currently it can take about 20 seconds for the +script to run. If the script fails or gets stuck, it may help to turn on logging +by setting the LOG environment variable to a non-empty value. |