* feat: add RSVP speed reading feature Implements Rapid Serial Visual Presentation (RSVP) speed reading mode: - Display words one at a time with ORP (Optimal Recognition Point) highlighting - Adjustable WPM speed (100-1000) with keyboard/button controls - Punctuation pause settings (25-200ms) - Progress tracking with chapter navigation - Context panel showing surrounding text when paused - Keyboard shortcuts (Space, Escape, arrows) and touch gestures - Chapter selector for quick navigation - Respects current theme colors - Persists settings (WPM, pause duration, position) per book New files: - services/rsvp/RSVPController.ts - Main controller with playback logic - services/rsvp/types.ts - TypeScript interfaces - components/rsvp/RSVPOverlay.tsx - Full-screen RSVP reader UI - components/rsvp/RSVPControl.tsx - Integration component - components/rsvp/RSVPStartDialog.tsx - Start position selection Closes #3111 * test(rsvp): add Playwright e2e tests for RSVP feature - Set up Playwright test infrastructure with config - Add comprehensive e2e tests for RSVP speed reading: - Opening RSVP from View menu - Start dialog options - Play/pause toggle - Speed adjustment - Skip navigation - Keyboard shortcuts - Progress bar - Chapter navigation - Accessibility tests - Add test data attributes and ARIA labels to RSVPOverlay - Add test scripts to package.json * refactor: remove test files, unsure of use case for now * chore: remove Playwright e2e test scripts from package.json - Deleted e2e test scripts related to Playwright from package.json as they are no longer needed. - Removed Playwright as a dev dependency to streamline the project. * chore: sync pnpm-lock.yaml after removing @playwright/test * fix: lint errors and timezone-aware date formatting * fix(rsvp): restore correct position when exiting RSVP mode Fix bug where exiting RSVP after changing speed would navigate to wrong position (several pages backwards). The issue was that Range objects become stale if the document re-renders, and the position recovery used global word index instead of per-document index. - Add docWordIndex to track word position within each document - Add docTotalWords to RsvpStopPosition for accurate recovery - Validate Range before using it, recreate from current DOM if stale - Use same word extraction logic as RSVPController for consistency * fix(rsvp): prevent arrow keys from changing chapter dropdown Arrow keys during RSVP mode were inadvertently navigating the chapter dropdown instead of controlling RSVP speed. Fixed by using capture phase for keyboard events and stopping propagation to prevent native elements from receiving the events. * chore: remove playwright-mcp screenshots from repo * chore: update gitignore * fix(i18n): wrap all RSVP overlay strings with translation function Restore missing translation wrappers for all user-facing strings: - Close RSVP button labels and tooltips - Select Chapter dropdown - WPM display - Context panel header - Ready state text - Chapter Progress label - Words count and time remaining - Reading progress slider - Pause/punctuation label - Skip back/forward buttons - Play/Pause button - Speed control buttons * fix(rsvp): use CFI-based position tracking for accurate page positioning - Add CFI generation for each extracted word during RSVP processing - Implement CFI path and character offset comparison for precise position matching - Update startFromCurrentPosition to use CFI matching instead of word index - Add extractFullDocPathWithOffset to handle CFI character offsets - Simplify RSVPControl by removing unused helper functions - Remove word index from RsvpPosition in favor of CFI-only tracking * fix(ViewMenu): re-enable Speed Reading Mode in production environment * refactor(ViewMenu, RSVPController): clean up code formatting and improve readability * refactor(ViewMenu): remove unused IoSpeedometer import * refactor(RSVPController): streamline CFI handling and improve section comparison - Removed redundant logic and re-using CFI util functions for CFI operations * refactor(RsvpPosition): remove legacy wordIndex field for cleaner type definition
Readest
Readest is an open-source ebook reader designed for immersive and deep reading experiences. Built as a modern rewrite of Foliate, it leverages Next.js 16 and Tauri v2 to deliver a smooth, cross-platform experience across macOS, Windows, Linux, Android, iOS, and the Web.
Features • Planned Features • Screenshots • Downloads • Getting Started • Troubleshooting • Support • License
Features
| Feature | Description | Status |
|---|---|---|
| Multi-Format Support | Support EPUB, MOBI, KF8 (AZW3), FB2, CBZ, TXT, PDF (experimental) | ✅ |
| Scroll/Page View Modes | Switch between scrolling or paginated reading modes. | ✅ |
| Full-Text Search | Search across the entire book to find relevant sections. | ✅ |
| Annotations and Highlighting | Add highlights, bookmarks, and notes to enhance your reading experience. | ✅ |
| Excerpt Text for Note-Taking | Easily excerpt text from books for detailed notes and analysis. | ✅ |
| Dictionary/Wikipedia Lookup | Instantly look up words and terms when reading. | ✅ |
| Parallel Read | Read two books or documents simultaneously in a split-screen view. | ✅ |
| Customize Font and Layout | Adjust font, layout, theme mode, and theme colors for a personalized experience. | ✅ |
| File Association and Open With | Quickly open files in Readest in your file browser with one-click. | ✅ |
| Sync across Platforms | Synchronize book files, reading progress, notes, and bookmarks across all supported platforms. | ✅ |
| Accessibility | Provides full keyboard navigation and supports for screen readers such as VoiceOver, TalkBack, NVDA, and Orca. | ✅ |
| Translate with DeepL and Yandex | From a single sentence to the entire book—translate instantly. | ✅ |
| Text-to-Speech (TTS) Support | Enjoy smooth, multilingual narration—even within a single book. | ✅ |
| Library Management | Organize, sort, and manage your entire ebook library. | ✅ |
| OPDS/Calibre Integration | Integrate OPDS/Calibre to access online libraries and catalogs. | ✅ |
| Code Syntax Highlighting | Read software manuals with rich coloring of code examples. | ✅ |
Planned Features
| Feature | Description | Priority |
|---|---|---|
| Sync with Koreader | Synchronize reading progress, notes, and bookmarks with Koreader devices. | 🛠 |
| AI-Powered Summarization | Generate summaries of books or chapters using AI for quick insights. | 🛠 |
| Audiobook Support | Extend functionality to play and manage audiobooks. | 🔄 |
| Handwriting Annotations | Add support for handwriting annotations using a pen on compatible devices. | 🔄 |
| Advanced Reading Stats | Track reading time, pages read, and more for detailed insights. | 🔄 |
| In-Library Full-Text Search | Search across your entire ebook library to find topics and quotes. | 🔄 |
Stay tuned for continuous improvements and updates! Contributions and suggestions are always welcome—let's build the ultimate reading experience together. 😊
Screenshots
Downloads
Mobile Apps
Platform-Specific Downloads
- macOS / iOS / iPadOS : Search and install Readest on the App Store, also available on TestFlight for beta test (send your Apple ID to readestapp@gmail.com to request access).
- Windows / Linux / Android: Visit and download Readest at https://readest.com or the Releases on GitHub.
- Linux users can also install Readest on Flathub.
- Web: Visit and use Readest for Web at https://web.readest.com.
Requirements
- Node.js and pnpm for Next.js development
- Rust and Cargo for Tauri development
For the best experience to build Readest for yourself, use a recent version of Node.js and Rust. Refer to the Tauri documentation for details on setting up the development environment prerequisites on different platforms.
nvm install v22
nvm use v22
npm install -g pnpm
rustup update
Getting Started
To get started with Readest, follow these steps to clone and build the project.
1. Clone the Repository
git clone https://github.com/readest/readest.git
cd readest
2. Install Dependencies
# might need to rerun this when code is updated
git submodule update --init --recursive
pnpm install
# copy vendors dist libs to public directory
pnpm --filter @readest/readest-app setup-vendors
3. Verify Dependencies Installation
To confirm that all dependencies are correctly installed, run the following command:
pnpm tauri info
This command will display information about the installed Tauri dependencies and configuration on your platform. Note that the output may vary depending on the operating system and environment setup. Please review the output specific to your platform for any potential issues.
For Windows targets, “Build Tools for Visual Studio 2022” (or a higher edition of Visual Studio) and the “Desktop development with C++” workflow must be installed. For Windows ARM64 targets, the “VS 2022 C++ ARM64 build tools” and "C++ Clang Compiler for Windows" components must be installed. And make sure clang can be found in the path by adding C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\VC\Tools\Llvm\x64\bin for example in the environment variable Path.
4. Build for Development
# Start development for the Tauri app
pnpm tauri dev
# or start development for the Web app
pnpm dev-web
# preview with OpenNext build for the Web app
pnpm preview
For Android:
# Initialize the Android environment (run once)
pnpm tauri android init
pnpm tauri android dev
# or if you want to dev on a real device
pnpm tauri android dev --host
For iOS:
# Set up the iOS environment (run once)
pnpm tauri ios init
pnpm tauri ios dev
# or if you want to dev on a real device
pnpm tauri ios dev --host
5. Build for Production
pnpm tauri build
pnpm tauri android build
pnpm tauri ios build
6. Setup dev environment with Nix
If you have Nix installed, you can leverage flake to enter a development shell with all the necessary dependencies:
nix develop ./ops # enter a dev shell for the web app
nix develop ./ops#ios # enter a dev shell for the ios app
nix develop ./ops#android # enter a dev shell for the android app
7. More information
Please check the wiki of this project for more information on development.
Troubleshooting
1. Readest Won’t Launch on Windows (Missing Edge WebView2 Runtime)
Symptom
- When you double-click readest.exe, nothing happens. No window appears, and Task Manager does not show the process.
- This can affect both the standard installer and the portable version.
Cause
- Microsoft Edge WebView2 Runtime is either missing, outdated, or improperly installed on your system. Readest depends on WebView2 to render the interface on Windows.
How to Fix
- Check if WebView2 is installed
- Open “Add or Remove Programs” (a.k.a. Apps & features) on Windows. Look for “Microsoft Edge WebView2 Runtime.”
- Install or Update WebView2
- Download the WebView2 Runtime directly from Microsoft: link.
- If you prefer an offline installer, download the offline package and run it as an Administrator.
- Re-run Readest
- After installing/updating WebView2, launch readest.exe again.
- If you still encounter problems, reboot your PC and try again.
Additional Tips
- If reinstalling once doesn’t work, uninstall Edge WebView2 completely, then reinstall it with Administrator privileges.
- Verify your Windows installation has the latest updates from Microsoft.
Still Stuck?
- See Issue readest/readest#358 for further details, or head over to our Discord server and open a support discussion with detailed logs of your environment and the steps you’ve taken.
Contributors
Readest is open-source, and contributions are welcome! Feel free to open issues, suggest features, or submit pull requests. Please review our contributing guidelines before you start. We also welcome you to join our Discord community for either support or contributing guidance.
Support
If Readest has been useful to you, consider supporting its development. You can become a sponsor on GitHub, donate via Stripe, or contribute with crypto. Your contribution helps us squash bugs faster, improve performance, and keep building great features.
Sponsors
License
Readest is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. See the LICENSE file for details.
The following libraries and frameworks are used in this software:
- foliate-js, which is MIT licensed.
- zip.js, which is licensed under the BSD-3-Clause license.
- fflate, which is MIT licensed.
- PDF.js, which is licensed under Apache License 2.0.
- daisyUI, which is MIT licensed.
- marked, which is MIT licensed.
- next.js, which is MIT licensed.
- react-icons, which has various open-source licenses.
- react, which is MIT licensed.
- tauri, which is MIT licensed.
The following fonts are utilized in this software, either bundled within the application or provided through web fonts:
Bitter, Fira Code, Literata, Merriweather, Noto Sans, Roboto, LXGW WenKai, MiSans, Source Han, WenQuanYi Micro Hei





