cosmere-books/README.md

164 lines
7.4 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:
2018-07-26 19:08:56 +00:00
1. Oathbringer (Serialized till Chapter 32)
2. Way of Kings Reread
3. Words of Radiance Reread
4. Edgedancer Reread
5. Way of Kings Prime
6. Oathbringer 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
2017-10-18 00:51:31 +00:00
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/.
The script figures out all the chapter URLs, so I just run it every Tuesday now (it doesn't need updates).
2017-09-15 07:39:54 +00:00
## Way of Kings Reread
2017-09-17 05:01:00 +00:00
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 07:39:54 +00:00
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-17 05:01:00 +00:00
## Edgedancer Reread
Join Alice Arneson and Lyndsey Luther for a reread of Brandon Sandersons Cosmere novella, Edgedancer, which fills in some of the details for Lift and Nalan between their appearances in Words of Radiance and the next time we see them in Oathbringer.
More details at https://www.tor.com/series/edgedancer-reread-brandon-sanderson/
2017-09-25 09:45:39 +00:00
## Way of Kings: Prime
2018-07-26 19:08:56 +00:00
> For it([Altered Perceptions anthology](https://www.indiegogo.com/projects/altered-perceptions)), Im letting people see—for the first time—a large chunk of the original version of The Way of Kings, which I wrote in 20022003. This version is very different, and involves a different course in life for Kaladin as a character—all due to a simple decision he makes one way in this book, but a completely different way in the published novel.
2017-09-25 09:45:39 +00:00
2018-07-26 19:08:56 +00:00
> These chapters are quite fun, as I consider what happened in The Way of Kings Prime (as I now call it) to be an "alternate reality" version of the events in the published books. The characters are almost all exactly the same people, but their backstories are different, and that has transformed who they are and how they react to the world around them. Roshar is similar, yet wildly different, as this was before I brought in the spren as a major world element.
2017-09-25 09:45:39 +00:00
You can read more at the announcement at [BrandonSanderson.com](https://brandonsanderson.com/chapters-from-the-original-draft-of-the-way-of-kings-available-in-anthology-to-benefit-robison-wells/)
2018-07-26 19:08:56 +00:00
# Oathbringer Reread
> Join Alice Arneson and Lyndsey Luther for a reread of Brandon Sandersons Oathbringer, the third novel in the Stormlight Archive epic fantasy series.
More details at https://www.tor.com/series/oathbringer-reread-brandon-sanderson/
# Skyward
> Skyward by #1 New York Times bestselling author Brandon Sanderson is the first book in an epic new series about a girl who dreams of becoming a pilot in a dangerous world at war for humanitys future. We know you can't wait for the book to finally hit shelves on 11/6/18, so we're releasing new chapters here every week!
See more details at [underlined](https://www.getunderlined.com/read/excerpt-reveal-start-reading-skyward-by-brandon-sanderson/) or [brandonsanderson.com](https://brandonsanderson.com/books/skyward/skyward/)
2017-09-08 14:27:36 +00:00
## Requirements
Either [Docker](https://docs.docker.com/install/) installed or the following setup:
2017-09-08 14:27:36 +00:00
- Ruby
- Nokogiri gem installed (`gem install nokogiri`)
2017-09-15 06:17:48 +00:00
- `pandoc` installed and available (for all 3 formats)
2017-09-20 23:00:25 +00:00
- Paru gem installed (`gem install paru`)
2017-09-15 06:17:48 +00:00
- (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
### Notes
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-20 23:00:25 +00:00
- Windows users need wget. Download the latest wget.exe from https://eternallybored.org/misc/wget/ and add it's directory to the PATH environment variable or put it directly in C:\Windows.
2017-09-08 14:27:36 +00:00
2017-09-15 07:39:54 +00:00
## Generation
If you have `docker` setup, run the following command inside an empty directory. This will download
all the books from scratch and copy the final books into it.
docker run --rm --volume "$(pwd):/output" captn3m0/cosmere-books:latest [bookname]
The last is an optional bookname, which can be one of the following:
```
edgedancer-reread
oathbringer
oathbringer-reread
skyward
wok-prime
wok-reread
wor-reread
```
If none is passed, all books will be generated.
2017-09-15 07:39:54 +00:00
## 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-17 05:01:00 +00:00
## Edgedancer Reread
To generate the book:
ruby edgedancer-reread.rb
2017-09-25 09:45:39 +00:00
All the generated files will be saved with the filename `books/edgedancer-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.
## Way of Kings Prime
ruby wok-prime.rb
All the generated files will be saved with the filename `books/wok-prime.{epub|pdf|mobi|html}`. This generation might take a while the script attempts to strip out unnecessary HTML.
2017-09-17 05:01:00 +00:00
2018-07-26 19:08:56 +00:00
## Oathbringer Reread
ruby oathbringer-reread.rb
All the generated files will be saved with the filename `books/oathbringer-reread.{epub|pdf|mobi|html}`. This generation might take a while the script attempts to strip out unnecessary HTML.
## Skyward
ruby skyward.rb
All the generated files will be saved with the filename `books/skyward.{epub|pdf|mobi|html}`. This generation might take a while the script attempts to strip out unnecessary HTML.
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.