小说下载器

因现实事务繁忙，本项目暂时仅进行最低限度维护。

如需添加新站点，可自行按照现有规则文件书写，同时欢迎各位PR。

一个可扩展的通用型小说下载器。

关于404小说文库项目

在这个404##，由于种种原因，起点、晋江、刺猬猫、SF等小说网站上的小说经常毫无征兆的消失。即使该小说已经入V，即使你已经订阅了该小说。

这样的例子数不胜数。随便打开笔趣阁等转载网站，首发于起点，但现在起点上找不到该小说的情形比比皆是。像轻文轻小说这种整个网站都上天了的情况也不是没有。

如果小说消失时被笔趣阁等转载网站转载了，后来的读者尚且能一睹其风采，但如果小说发布的网站不是起点，小说也不够热，根本就没有转载网站转载，那后来者想一睹该小说的风采，就相当困难了。

404小说文库项的目的是：保存这些质量上乘，但不够热门，没有被其他网站转载，彻底从互联网上消失的作品。

本脚本为404小说文库项目的组成部分之一，对于无登录墙的小说网站，如您同意，本脚本将会尝试将当前书籍详情页及目录页（如果存在）存档至互联网档案馆（archive.org），以备日后（被删除后）查看。

存档过程中将会搜集并上报您如下信息：IP地址、User-Agent、Referer、当前书籍详情页URL、当前书籍目录页URL（如果存在）、当前小说下载器脚本版本、当前脚本管理器版本。除上述信息外，不会搜集您任何其他信息。

安装

本软件为油猴脚本，需先在浏览器安装脚本管理器（Greasemonkey、Violentmonkey、Tampermonkey），再安装本脚本。具体可参见：如何安装用户脚本。

本脚本地址：

• github版：启用代码压缩，更新最快。
• greasyfork版：无代码压缩，更新可能有延迟。

使用方法

本脚本执行下载任务时将播放无声音频，以保证脚本后台运行时不被休眠。

如果本脚本支持该小说网站，当打开小说目录页时，网页右上角会出现下载图标，点击该图标即可开始下载。

如果你要下载的小说章节较多，等待时间可能较长，此时请耐心等待。

你通过右下角进度条了解当前下载进度，或者按下 F12，打开网页控制台查看当前下载状态。

下载完成后，本脚本将会自动下载一个TXT文档及EPUB文件。

TXT文档请使用记事本或其它阅读软件进行阅读。

EPUB文件请使用相应阅读器阅读。

常见问题

• Q：脚本运行出错了！

  A：在反馈之前，请保证您当前运行的脚本版本为最新版，如不是最新版，请更新脚本。

  如最新版脚本仍出现错误，请说明具体网址，有无特殊操作以及其他附加说明，并附上调试日志，协助开发者明确出错原因。调试日志为下载生成的zip文件中的 debug.log 文件。

  如需反馈问题，请至本项目支持页面提交issue， 对于greasyfork评论区的反馈跟进不及时敬请谅解。

  文件上传可使用： https://send.bgme.bid/

• Q：希望支持某某网站。

  A：请提交issue并附上以上信息，网站URL，原创网站或转载网站，有无收费章节，有无如登录墙等额外限制，希望添加的理由等。开发者将视情况，酌情添加。

目前支持小说网站

特别提醒：如欲下载支持列表中网站的##章节，请登录相应网站帐户，并确定已购买相应##章节。未登录网站帐户，或未购买的##章节，下载时将直接忽略，无法进行下载。

特殊权限说明

• unsafeWindow：用于获取自定义筛选函数、自定义保存参数等设置。
• GM_info/GM.info： 获取并输出脚本运行环境。
• GM_xmlhttpRequest/GM.xmlHttpRequest：用于跨域HTTP请求。
• GM_setValue/GM.setValue、GM_getValue/GM.getValue、GM_deleteValue/GM.deleteValue： 用于统计模块，本地统计运行次数。

高阶使用技巧

启用调试功能

设置菜单中按击开启。

自定义筛选函数

如欲只下载部分章节，请在点击运行按钮前，按下 F12 打开开发者工具，在 window 下创建 chapterFilter 函数，具体格式如下：

declare enum Status {pending = 0,downloading = 1,failed = 2,finished = 3,aborted = 4,saved = 5}interface ChapterAdditionalMetadate {lastModified?: number;}declare class Chapter {bookUrl: string;bookname: string;chapterUrl: string;chapterNumber: number;chapterName: string | null;isVIP: boolean;isPaid: boolean | null;sectionName: string | null;sectionNumber: number | null;sectionChapterNumber: number | null;chapterParse: BaseRuleClass["chapterParse"];charset: string;options: object;status: Status;retryTime: number;contentRaw: HTMLElement | null;contentText: string | null;contentHTML: HTMLElement | null;contentImages: attachmentClass[] | null;additionalMetadate: ChapterAdditionalMetadate | null;chapterHtmlFileName: string | number;constructor(bookUrl: string, bookname: string, chapterUrl: string, chapterNumber: number, chapterName: string | null, isVIP: boolean, isPaid: boolean | null, sectionName: string | null, sectionNumber: number | null, sectionChapterNumber: number | null, chapterParse: BaseRuleClass["chapterParse"], charset: string, options: object);init(): Promise<this>;private parse;}declare class attachmentClass {url: string;name: string;mode: "naive" | "TM";headers?: {[index: string]: string;};private defaultHeader;status: Status;retryTime: number;imageBlob: Blob | null | void;constructor(imageUrl: string, name: string, mode: "naive" | "TM");init(): Promise<Blob | null>;private downloadImage;private tmDownloadImage;}interface chapterFilter {(chapter: Chapter): boolean;}

自定义筛选函数示例：

只下载该本小说前100章内容：

function chapterFilter(chapter) {return chapter.chapterNumber <= 100}

只下载第一卷内容：

function chapterFilter(chapter) {return chapter.sectionNumber === 1}

只下载章节名称中含有“#器”的章节：

function chapterFilter(chapter) {return chapter.chapterName.includes("#器")}

自定义保存参数

自定义保存参数允许您修改保存文件的样式，章节标题等内容。

使用方法大致同自定义筛选函数，即在 window 下创建 saveOptions 对象，具体格式如下：

declare class saveBook {protected book: Book;mainStyleText: string;tocStyleText: string;constructor(book: Book);saveTxt(): void;saveLog(): void;saveZip(runSaveChapters?: boolean): Promise<void>;addChapter(chapter: Chapter): void;getchapterName(chapter: Chapter): string;genSectionText(sectionName: string): string;genChapterText(chapterName: string, contentText: string): string;genSectionHtmlFile(chapterObj: Chapter): Blob;genChapterHtmlFile(chapterObj: Chapter): Blob;chapterSort(a: Chapter, b: Chapter): 0 | 1 | -1;}interface saveOptions {mainStyleText?: saveBook["mainStyleText"];tocStyleText?: saveBook["tocStyleText"];getchapterName?: saveBook["getchapterName"];genSectionText?: saveBook["genSectionText"];genChapterText?: saveBook["genChapterText"];genSectionHtmlFile?: saveBook["genSectionHtmlFile"];genChapterHtmlFile?: saveBook["genChapterHtmlFile"];chapterSort?: saveBook["chapterSort"];}

自定义保存参数示例：

将章节名称格式修改为 第xx章 xxxx ：

const saveOptions = {getchapterName: (chapter) => {if (chapter.chapterName) {return `第${chapter.chapterNumber.toString()}章 ${chapter.chapterName}`;} else {return `第${chapter.chapterNumber.toString()}章`;}}}window.saveOptions = saveOptions

更改ZIP文档中章节HTML文件样式：

const saveOptions = {"mainStyleText": `p {text-indent: 4em;display: block;line-height: 1.3em;margin-top: 0.4em;margin-bottom: 0.4em;}`}window.saveOptions = saveOptions

txt文档每个自然段前加两个空格

const saveOptions = {genChapterText: (chapterName, contentText) => {contentText = contentText.split('\n').map(line => {if (line.trim() === "") {return line} else {return line.replace(/^/,'    ')}}).join('\n')return `## ${chapterName}\n\n${contentText}\n\n`;}}window.saveOptions = saveOptions

保存章节时倒序排列

const saveOptions = {chapterSort: (a, b) => {if (a.chapterNumber > b.chapterNumber) {return -1;}if (a.chapterNumber === b.chapterNumber) {return 0;}if (a.chapterNumber < b.chapterNumber) {return 1;}return 0;}}window.saveOptions = saveOptions

使用用户脚本自动注入自定义保存参数：

如您总是想使用某一自定义保存参数，你可以使用如下用户脚本（根据实际需要修改相应数值），自动向页面注入自定义保存参数。

// ==UserScript==// @name         auto inject saveOptions// @namespace    http://tampermonkey.net/// @version      0.1// @description  auto inject saveOptions// @author       You// @match        *://*/*// @grant        none// ==/UserScript==(function() {'use strict';const saveOptions = {getchapterName: (chapter) => {if (chapter.chapterName) {return `第${chapter.chapterNumber.toString()}章 ${chapter.chapterName}`;} else {return `第${chapter.chapterNumber.toString()}章`;}}}window.saveOptions = saveOptions})();

自定义筛选函数同理也可使用用户脚本自动注入。

自定义完成回调函数

interface customFinishCallback {(): void;}

自定义完成回调函数将在下载完成并生成ZIP文件后自动执行。

使用自定义完成回调函数可在下载完成后自动完成某些工作，例如：关闭当前窗口。

function customFinishCallback(book: Book) {window.close();}window.customFinishCallback = customFinishCallback;

开发

1. git clone https://github.com/yingziwu/novel-downloader.git 将项目克隆至本地（访问github可能需要使用代理）。
2. yarn install 安装依赖。
3. 继承 BaseRuleClass 类，实现 bookParse、chapterParse 抽象方法，在 router/download.ts 文件中添加相应选择规则，在 header.json 文件 match字段添加相应的匹配规则。
4. yarn run build 编译生成最终脚本文件 dist/bundle.user.js。

License

AGPL-3.0

致谢

感谢 JetBrains 向本项目提供 WebStorm IDE。