MilkFeng/lumina

简体中文 | English

Lumina

https://raw.githubusercontent.com/MilkFeng/lumina/HEAD/docs/icon.png

A lightweight EPUB e-book reader built with Flutter, supporting both Android and iOS platforms.

Flutter License Platform

CHANGELOG

🚧 Early Development Stage

Please note that this project is currently in Alpha. Breaking changes to the database schema may occur without migration scripts in early versions.

✨ Key Features

• 📚 EPUB Reading - Supports EPUB 2.0/3.0 formats with smooth page turning, automatic reading progress saving, and complete EPUB rendering based on WebView
• 🗂️ Bookshelf Management - Custom grouping, multi-dimensional sorting, and batch operations
• 🎨 Elegant Interface - Light/dark theme switching for comfortable reading experience
• ⚡ Efficient Architecture - Streaming loading of EPUB compressed files for fast startup

📱 Screenshots

https://raw.githubusercontent.com/MilkFeng/lumina/HEAD/docs/shelf.jpg Shelf	https://raw.githubusercontent.com/MilkFeng/lumina/HEAD/docs/about.jpg About	https://raw.githubusercontent.com/MilkFeng/lumina/HEAD/docs/reader.jpg Reader	https://raw.githubusercontent.com/MilkFeng/lumina/HEAD/docs/detail.jpg Book Details
https://raw.githubusercontent.com/MilkFeng/lumina/HEAD/docs/toc.jpg Table of Contents	https://raw.githubusercontent.com/MilkFeng/lumina/HEAD/docs/style.jpg Style Settings	https://raw.githubusercontent.com/MilkFeng/lumina/HEAD/docs/footnote.jpg Footnote Support	https://raw.githubusercontent.com/MilkFeng/lumina/HEAD/docs/vertical.jpg Vertical Reading Support

🚀 Quick Start

Visit the Releases page to download the latest version.

• Android Users: Download the .apk file and install it directly.
• iOS Users: Download the .ipa file and install it via sideloading.
  • Recommended Tools: AltStore (Recommended), Sideloadly, or TrollStore (for supported iOS versions).
  • Note: If using a free Apple ID, you will typically need to refresh the app signature every 7 days.

🔧 Developer Guide

Requirements

• Flutter SDK ≥ 3.10.8
• Dart SDK ≥ 3.10.8
• iOS 12.0+ / Android 5.0+ (API Level 21+)

Build from Source

1. Clone the Repository

git clone https://github.com/MilkFeng/lumina.git
cd lumina

2. Install Dependencies

flutter pub get

3. Run the App

flutter run

Or specify a device:

flutter run -d <device-id>

Build Release Version

Android APK

flutter build apk --release

iOS

flutter build ios --release

🗺️ Roadmap

• [x] Basic EPUB parsing and rendering
• [x] Stream-from-Zip streaming loading
• [x] Smooth page turning animations
• [x] Automatic reading progress saving
• [x] Bookshelf grouping management
• [x] Table of contents navigation
• [x] Adaptive light/dark themes
• [x] Internationalization support (Chinese/English)
• [x] Avoid duplicate page turns when two NCX navigation points are on the same page
• [x] Long press images to view full-size
• [x] Simple swipe page turning mode
• [x] Improve screenshot speed during page turns on iOS
• [x] Import folders
• [x] Optimize initial loading lag when opening the first book
• [x] Export library
• [x] Test import/export functionality on iOS
• [x] Bookshelf homepage can switch between "Compact, Comfortable" layout modes, and can set whether to show book reading progress bars
• [x] Vertical and RTL support
• [x] Associate with epub format for direct opening of epub files
• [x] Edit book metadata (title, author, etc.)
• [x] Reading settings (font size, background color, etc.)
• [x] Footnote support
• [x] Link handling
• [ ] Better color rendering
• [ ] Cloud sync (WebDAV)
• [ ] Search functionality
• [ ] Annotation and bookmarking features
• [ ] Edit book covers
• [ ] More reading settings options
• [ ] Chinese support for error messages

🙏 Acknowledgements

This project uses the following excellent open-source projects:

• Flutter - Google's UI toolkit
• Riverpod - Reactive state management
• Isar - High-performance NoSQL database

Thanks to all contributors for their support!

---

⭐ If this project helps you, feel free to star it!

Issues and pull requests are welcome