ColorTxt  by ssnangua

AI-enhanced local reader for novels with text coloring and RAG

Created 3 months ago
520 stars

Top 59.7% on SourcePulse

GitHubView on GitHub
Project Summary

Summary ColorTxt 2.0 AI+ is a cross-platform desktop application enhancing local TXT novel and EPUB reading. It targets readers seeking advanced customization and AI-driven literary analysis, offering unique visual features and intelligent content interaction.

How It Works The application's core innovation is its text-coloring engine, applying custom highlighting rules to personalize the reading interface. This is achieved by converting various ebook formats (EPUB, MOBI, PDF, etc.) into plain TXT, discarding original styling for consistent processing. It features stream-based file reading for large documents, automatic encoding detection, and robust chapter recognition. AI integration includes a Reading Assistant for plot analysis/Q&A and a Character Card Generator leveraging text-to-image models. Advanced formatting options like empty line compression and indentation refine the user experience.

Quick Start & Requirements ColorTxt is a cross-platform desktop app for macOS, Windows, and Linux. Key requirements:

  • AI: Local/remote LLM endpoints (OpenAI-compatible) and text-to-image interfaces (WebUI/ComfyUI).
  • Linux: Manual installation of common Chinese font packages.
  • macOS: System settings for dock icon hiding. No direct quick-start guides or demos found in README.

Highlighted Details

  • AI Literary Tools: Reading Assistant (plot analysis/Q&A), Character Card Generation (AI summaries, text-to-image portraits).
  • Format Conversion: Handles .txt, .md, and converts .epub, .mobi, .azw3, .fb2, .fbz, .pdf, .chm to plain text.
  • "Moyu" (Slacking) Mode: Shortcut to hide the application window and taskbar/dock icon.
  • Extensive Customization: Text coloring, highlighting rules, fonts, themes, layout.

Maintenance & Community Project acknowledges icon contributions ('豆包', 'iconfont'). No community channels (Discord, Slack), roadmap, sponsorships, or partnerships detailed in README.

Licensing & Compatibility Software license is not explicitly stated. Bundled '京華老宋体' font is for 'learning/exchange only; commercial use requires license.' Compatible with macOS, Windows, Linux. Commercial use implications unclear due to unspecified software license.

Limitations & Caveats Global shortcuts non-functional on Linux Wayland. 'Advanced word-wrapping' causes high memory overhead and performance issues with large files. Ebook conversion discards original styling. Local AI model configuration requires manual intervention.

Health Check
Last Commit

2 weeks ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
12
Star History
157 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.