小说下载器

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

使用方法

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

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

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

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

下载完成后，本脚本将会自动下载一个TXT文档及由HTML文件及图片组成的ZIP压缩包。

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

ZIP压缩包，请在解压后，直接双击打开HTML文件（index.html 为目录文件）进行阅读。

常见问题

Q：脚本运行出错了！

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

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

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

文件上传可使用： https://send.bgme.bid/
Q：希望支持某某网站。

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

目前支持小说网站

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

站点	公共章节	付费章节	备注
刺猬猫	✅	✅	VIP章节仅支持图片版。
SF轻小说	✅*	✅**	不支持对话小说，例：224282。 *VIP章节仅支持图片版。
起点中文网	✅	✅
起点女生网	✅	✅
晋江文学城	✅	✅	VIP章节使用晋江防盗字体对照表去除空格。当程序自带的防盗字体对照表未查找到相关字体时，脚本将尝试向云端请求数据，远程字体功能可通过 `enableJjwxcRemoteFont` 配置项手动关闭。
长佩文学	✅	✅	反爬较严，限制下载速度，每分钟约可下载6章，请耐心等待。长佩文学为单页应用，如打开书籍详情页右上角未出现下载图标，请按下F5重新加载当前页面。
书耽	✅	✅	VIP章节仅支持图片版。
海棠文化线上文学城	✅	✅
次元姬	✅	✅
米国度	✅	✅
寒武纪年原创网	✅	✅
哔哩哔哩漫画	✅	✅
轻之文库轻小说	✅	❌	VIP章节仅支持APP查看
纵横中文网	✅	❌
花语女生网	✅	❌
17K小说网	✅	❌
书海小说网	✅	❌
塔读文学	✅	❌
七猫中文网	✅	❌
废文网	✅	❎	部分小说或章节需登录后查看。
pixiv	✅	❎
动漫之家	✅	❎	需下载大量图片，速度较慢，请耐心等待。需占用大量内存，请保证最终生成文件4倍以上内存，即最终下载生成500MB ZIP文件，运行时请保证至少2GB内存空间。可使用筛选函数，分次下载。
Lofter	✅	❎	因本脚本会将博文中的图片也一同下载下来，对于图片特别多的博客，下载时请注意内存用量（800MB限制），根据实际情况使用筛选函数分次下载。部分博文内含视频内容，为节省内存使用，加快下载速度，本脚本将跳过视频内容。如您使用广告屏蔽器，可能会影响本脚本在Lofter的工作。
努努书坊	✅	❎	格式众多，如发现不支持页面敬请反馈。
真白萌	✅	❎
天涯书库	✅	❎

点击查看全部支持网站

站点	公共章节	付费章节	备注
カクヨム	✅	❎
小説家になろう	✅	❎
ハーメルン	✅	❎
禁忌书屋	✅	❎
UU看书网	✅	❎
亿软网	✅	❎	网站性能差，降低抓取频率，请耐心等待。
笔趣窝	✅	❎
书趣阁	✅	❎	网站性能差，降低抓取频率，请耐心等待。
顶点小说	✅	❎
星空中文	✅	❎
乐文小说网	✅	❎
可乐小说网	✅	❎
266看书	✅	❎
和图书	✅	❎
手打吧	✅	❎
阁笔趣	✅	❎
米趣小说	✅	❎
书书网	✅	❎
八一中文网	✅	❎	抓取速度慢，请耐心等待。
御书阁	✅	❎	部分文字被图片替换，请使用HTML版查看。
完本神站	✅	❎
得间小说	✅	❎
轻小说文库	✅	❎
西方奇幻小说网	✅	❎
棉花糖小说网	✅	❎
第二版主网	✅	❎
笔趣阁	✅	❎
红叶书斋	✅	❎
哩哔轻小说	✅	❎
落秋中文	✅	❎
一笔阁	✅	❎
腐书网	✅	❎
搜小说	✅	❎
腐国度	✅	❎
书包网	✅	❎
言情小说笔趣阁	✅	❎
恋上你看书	✅	❎
青果阅读	✅	❎
同人小说网	✅	❎
同人圈	✅	❎
精品小说网	✅	❎
妙笔阁	✅	❎
256文学	✅	❎
笔趣阁小说网	✅	❎
乐文小说网	✅	❎
悠久小说网	✅	❎
海棠小说网	✅	❎	部分文字被图片替换，请使用HTML版查看。如需替换清理图片，请自行生成图片文字对照表。
小说酷笔记	✅	❎
笔趣阁	✅	❎
25中文网	✅	❎
天域小说网	✅	❎
完本神站	✅	❎
燃文小说	✅	❎
望书阁	✅	❎
百合小说网	✅	❎
全书斋	✅	❎
蔷薇后花园	✅	❎
黑沼泽俱乐部	✅	❎
绿色小说网	✅	❎
笔趣阁	✅	❎
神凑轻小说	✅	❎
爱下书小说网	✅	❎
精彩小说网	✅	❎
笔趣读	✅	❎
爱下电子书	✅	❎
56书库	✅	❎
笔趣阁	✅	❎

特殊权限说明

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        unsafeWindow
// ==/UserScript==

(function() {
    'use strict';

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

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

自定义完成回调函数

interface customFinishCallback {
    (): void;
}

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

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

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

开发

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

License

AGPL-3.0

wuyutou / novel-downloader Goto Github PK

novel-downloader's Introduction

小说下载器

使用方法

常见问题

目前支持小说网站

特殊权限说明

高阶使用技巧

启用调试功能

自定义筛选函数

自定义保存参数

自定义完成回调函数

开发

License

novel-downloader's People

Contributors

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent