cosmere-books/README.md

81 lines
3.3 KiB
Markdown
Raw Normal View History

2017-09-15 07:39:54 +00:00
# cosmere-books
2017-09-08 14:27:36 +00:00
2017-09-16 13:34:35 +00:00
![Books in the Cosmere](https://i.imgur.com/NymmBq4.png)
2017-09-15 07:39:54 +00:00
Scripts to generate books from the [Cosmere]() using various public sources. Currently supports the following books:
1. Oathbringer (Serialized till Chapter 32)
2. Way of Kings Reread
2017-09-17 04:30:34 +00:00
3. Words of Radiance Reread
2017-09-08 14:27:36 +00:00
2017-09-15 07:39:54 +00:00
For obvious reasons, the converted ebooks are not part of this repo. You must download
2017-09-08 14:27:36 +00:00
and run the script on your own machine to generate the copies.
The code for this is mostly adapted from [hoshruba](https://github.captnemo.in/hoshruba).
2017-09-15 06:17:48 +00:00
You can download sample files (Lorem Ipsum) from <http://ge.tt/8R61oXm2> to see a sample of how the generated files look.
2017-09-15 07:39:54 +00:00
## Oathbringer
Tor.com is publishing Oathbringer in serialized form till Chapter 32. This script
downloads all of these posts and converts them into a publishable format, including
epub, mobi, pdf and html. You can find the tor.com announcement at https://www.tor.com/2017/08/15/brandon-sanderson-oathbringer-serialization-announcement/
## Way of Kings Reread
>Join Michael Pye (aka The Mad Hatter) and Carl Engle-Laird as they dive into the details of Sandersons complex new world of Roshar. Find out more at https://www.tor.com/features/series/the-way-of-kings-reread-on-torcom/
2017-09-15 08:28:26 +00:00
## Words of Radiance Reread
Welcome to the reread of Brandon Sandersons second Stormlight Archive series book Words of Radiance! This reread will be a collaborative effort between Tor.coms own editorial assistant Carl Engle-Laird and long-time Tor.com commenter and Sanderson beta-reader Alice Arneson. This new partnership promises to be as potent as that between spren and Radiant. Join them in the Storm Cellar as they evaluate, discuss, question, and generally kibitz their way through the Words of Radiance.
More details at https://www.tor.com/series/words-of-radiance-reread-on-torcom/
2017-09-08 14:27:36 +00:00
## Requirements
- Ruby
- Nokogiri gem installed (`gem install nokogiri`)
- Unix system with `wget` installed
2017-09-15 06:17:48 +00:00
- `pandoc` installed and available (for all 3 formats)
- (mobi only): `ebook-convert` (from calibre) available to generate the mobi file
- (pdf) `wkhtmltopdf` for converting html to pdf
- (pdf) `pdftk` to stitch the final PDF file
2017-09-15 07:30:37 +00:00
- The final 2 tools can be skipped if you don't care about the PDF generation.
2017-09-15 06:17:48 +00:00
- You can also skip calibre if you only want the EPUB file.
2017-09-15 08:28:26 +00:00
- Edit the last line in `*.rb` to `:epub` / `:mobi`, `:pdf` to only trigger the specific builds
2017-09-08 14:27:36 +00:00
2017-09-15 07:39:54 +00:00
## Generation
## Oathbringer
2017-09-08 14:27:36 +00:00
After downloading the repo and installing the requirements, just run
2017-09-15 08:28:26 +00:00
ruby oathbringer.rb
2017-09-08 14:27:36 +00:00
All the generated files will be saved with the filename `Oathbringer.{epub|pdf|mobi|html}`
2017-09-15 07:32:31 +00:00
## Way of Kings Reread
To generate the book:
ruby wok-reread.rb
All the generated files will be saved with the filename `wok-reread.{epub|pdf|mobi|html}`
2017-09-15 08:28:26 +00:00
## Words of Radiance Reread
To generate the book:
ruby wor-reread.rb
All the generated files will be saved with the filename `books/wok-reread.{epub|pdf|mobi|html}`. This generation might take a while because it contains a lot of images. It doesn't have the best possible index either, but is still pretty readable.
2017-09-16 13:34:35 +00:00
## Extra
If you'd like to see any other books covered here, please create an issue, or reach out to me: <https://captnemo.in/contact/>
2017-09-08 14:27:36 +00:00
# LICENSE
This is licensed under WTFPL. See COPYING file for the full text.