Scrapes the web serial Worm and its sequel Ward into an eBook format

Find a file

Domenic Denicola 3905965134 Fix missing periods at the end of quotations		2020-10-26 21:58:41 -04:00
covers	Add per-book covers	2020-07-01 17:23:05 -04:00
lib	Fix missing periods at the end of quotations	2020-10-26 21:58:41 -04:00
scaffolding	Add per-book covers	2020-07-01 17:23:05 -04:00
.editorconfig	Make a nicer command-line interface	2015-05-21 02:17:43 -04:00
.eslintrc.json	Fix the capitalization of "Dad" when used as a name	2020-10-17 20:17:31 -04:00
.gitignore	Start generalizing to work for Ward too	2020-07-01 15:17:52 -04:00
.travis.yml	Update dependencies	2020-07-01 14:36:14 -04:00
LICENSE.txt	Update dependencies	2020-07-01 14:36:14 -04:00
npm-shrinkwrap.json	Improve conversion speed using a worker pool	2020-10-26 21:58:40 -04:00
package.json	Improve conversion speed using a worker pool	2020-10-26 21:58:40 -04:00
README.md	Improve conversion speed using a worker pool	2020-10-26 21:58:40 -04:00

README.md

Worm Scraper

Scrapes the web serial Worm and its sequel Ward into an eBook format.

How to use

First you'll need a modern version of Node.js. Install whatever is current (not LTS); at least v12.10.0 is necessary.

Then, open a terminal (Mac documentation, Windows documentation) and install the program by typing

npm install -g worm-scraper

This will take a while as it downloads this program and its dependencies from the internet. Once it's done, try to run it, by typing:

worm-scraper --help

If this outputs some help documentation, then the installation process went smoothly. You can move on to assemble the eBook by typing

worm-scraper download convert scaffold zip

This will take a while, but will eventually produce a Worm.epub file!

If you'd like to get Ward instead of Worm, use --book=ward, e.g.

worm-scraper download convert scaffold zip --book=ward

EPUB vs. other formats

EPUB is one of the primary eBook formats, but it is not recognized by all readers, including most Amazon Kindle devices. You can use an online converter or other tool to convert EPUB to Kindle MOBI, or any other format.

Alternately, if you are a developer, a pull request adding support for MOBI output would be appreciated; please open an issue to discuss how you plan to proceed.

Text fixups

This project makes a lot of fixups to the original text, mostly around typos, punctuation, capitalization, and consistency. You can get a more specific idea of what these are via the code; there's convert-worker.js, where some things are handled generally, and substitutions.json, for one-off fixes.

This process is designed to be extensible, so if you notice any problems with the original text that you think should be fixed, file an issue to let me know, and we can update the fixup code so that the resulting eBook is improved. (Or better yet, send a pull request!)