English | 中文

Noveltui

A tui novel reader, Powered by ratatui

Features

• Lightweight & Efficient: Small binary size, low memory usage
• Chapter Parsing: Automatically detects and navigates chapters by regex and generate toc
• Bookmarks: Add, remove, and manage bookmarks for easy navigation
• Auto-Read Mode: Hands-free reading with automatic scrolling
• Read from website: dzstui can read from website (WIP)

Installation

cargo install noveltui
# only install noveltui
cargo install noveltui --bin noveltui
# only install dzstui
cargo insatll noveltui --bin dzstui

Build from Source

git clone https://github.com/minxuanz/noveltui.git
cd noveltui
cargo build --release

target/release/noveltui read from local txt
target/release/dzstui read from website

Usage

./noveltui path/to/your/novel.txt

./dzstui --url website
#e.g.
./dzstui --url https://ixdzs8.com/read/508569/p1.html

Tips: dzstui only supoort https://ixdzs8.com/ now, and need install chrome

Supported

os

• windows
• linux
• macos (not test)

format & encoding

• txt (UTF-8, GBK, GB2312, etc.)

Chapter Detection(noveltui)

You can pass --regex <YOUR CUSTOM REGEX> to parse title.

./noveltui --regex="^(\d+)([\u4e00-\u9fff0-9]+)$" path/to/your/novel.txt

Keybindings(noveltui)

dzstui (online read) (WIP)

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.