so-novel

Project Overview

So Novel is a general-purpose web content processing and export tool that helps users extract structured information from web pages and export it into EPUB, TXT, PDF, and other standard e-book formats, often used for web novel downloading, scraping, and e-book creation.

Key Features

• Parse and download novels from multiple source sites
• Export to EPUB, TXT, PDF, and other e-book formats
• Three interfaces: TUI, CLI, and Web
• Docker and Docker Compose deployment, ideal for NAS
• Custom JVM options via -Dmode and -Dconfig.file
• Run with a local JDK/JRE or the bundled runtime

Target Audience

• Web novel readers and e-book enthusiasts
• Users who need to scrape and convert web content in bulk
• Users running self-hosted services on NAS or Docker

Quick Start

1. Download the archive for your platform from GitHub Releases, or install via the official script, Homebrew, or Scoop
2. Docker users can run the one-click install script or deploy with Docker Compose on port 7765
3. Adjust config.ini and the rules directory as needed
4. Run the program and download or export e-books in the TUI, CLI, or Web interface

Core Advantages

• Cross-platform: Windows, Linux, and macOS
• Multiple e-book export formats
• Bundled runtime, ready to use out of the box
• Docker and NAS friendly deployment

System Requirements

• OS: Windows, Linux, macOS
• Architecture: x64, arm64
• Additional dependencies: JDK 21 and Maven required to build from source

Notes

• Use this project only for lawful purposes such as learning and communication
• Readest, Koodo Reader, or Calibre are recommended for a better reading experience
• Calibre or online converters can help convert to other formats