readme config line breaks

This commit is contained in:
2022-07-08 13:44:41 +02:00
parent 809b021062
commit 6bcb547098
+29 -14
View File
@@ -19,35 +19,50 @@ I'm using fetch, which is an experimental feature, it might work differently on
At first start it will create an empty config file `./novelConfig.conf`, adjust the setting according to comments below:
```
{
"downloadLocation": "", // New chapter download location, "./Download" as an absolute path recommended
"converterPath": "ebook-convert.exe", // Calibre eBook converter, I recommend adding it to you PATH, NOT tested when it's not in PATH
"ebookFormat": "epub", // Desired eBook format, Kindle started supporting epub so that's default
"downloadLocation": "", // New chapter download location, "./Download" as an absolute
// path recommended
"converterPath": "ebook-convert.exe", // Calibre eBook converter, I recommend adding it to you PATH,
// NOT tested when it's not in PATH
"ebookFormat": "epub", // Desired eBook format, Kindle started supporting epub so
// that's default
"sendEmail": false, // If the script should send eBooks via email
"emailToAddress": "", // Email where to send your eBooks
"emailFromAddress": "", // Important for Kindle deliveries, make sure you have it added in Kindle settings
"emailFromAddress": "", // Important for Kindle deliveries, make sure you have it added
// in Kindle settings
"emailProvider": "", // Gmail works fine, just need to set up 2FA and an app password
"emailUsername": "", // Username to your email account
"emailPassword": "", // Password to your email account
"emailAttachments": 25, // How many eBooks to attach to a single email
"supportedHosting": { // Enum to show which WebNovel host sites are supported, NOT configurable
"supportedHosting": { // Supported WN host sites, NOT configurable
"NF": "https://novelfull.com/"
},
"template": { // Template for a WebNovel entry in "novels" below
"novelURL": "", // WebNovel address, it's enough to copy this template to "novels" and fill only this field to start
"novelURL": "", // WebNovel address, it's enough to copy this template to
// "novels" and fill only this field to start
"title": "", // Autofill
"author": "", // Autofill
"coverURL": "", // Autofill
"lastChapterURL": false, // Autofill; Can be used if not starting from the first chapter, first chapter downloaded will be NEXT from this
"lastVolume": 0, // Autofill; Can be used if not starting from the first chapter, first eBook number created will be NEXT from this
"completed": false, // Autofill; Set to false with settings above to download chapters again; Set to true by hand to skip checking the novel
"lastChapterURL": false, // Autofill; Can be used if not starting from the first chapter,
// first chapter downloaded will be NEXT from this
"lastVolume": 0, // Autofill; Can be used if not starting from the first chapter,
// first eBook number created will be NEXT from this
"completed": false, // Autofill; Set to false with settings above to download
// chapters again; Set to true by hand to skip checking the novel
"hosting": "NF", // Hosting code, see "supportedHosting"
"volumeChapterCount": 5, // After how many new/unread chapters to send a new eBook, ignored if WebNovel is completed
"volumeChapterCount": 5, // After how many new/unread chapters to send a new eBook,
// ignored if WebNovel is completed
"completedVolumeChapterCount": 50, // How many chapters to pack per eBook
"redownload": false // Redownload all chapters, repack into volumes with completedVolumeChapterCount, do not send via email, intended for completed series archiving
"sendOnly": false, // TODO: only send epub files via email, for cases with external source of epub files
"sendOnlyRegex": ""(?<volume>\\d*). (?<title>.*); (?<author>.*)"" // TODO: metadata regex for extracting information from filename for external sources
"redownload": false // Redownload all chapters, repack into volumes, do not send via
// email, intended for completed series archiving
"sendOnly": false, // TODO: only send epub files via email, for cases with external
// source of epub files
"sendOnlyRegex": ""(?<volume>\\d*). (?<title>.*); (?<author>.*)"" // TODO: metadata regex for
// extracting information from filename for external sources
},
"novels": [] // Table of novels to process
"novels": [
// Table of novels to process, insert the template structure
// from above here
]
}
```
For some reason Amazon just forgets the cover and TOS on conversion from epub. Both features worked correctly with mobi, but that format is being phased out. From what I found, Amazon is being an ass about it and is ignoring built in metadata in favor of getting them from their book database. So sending books not bought from them is made intentionally inferior.