How wjhhm2003/readx works
ReadX is an offline Android reader for locally imported EPUB, TXT, and PDF files. The main workflow is opening the library, importing or selecting a book, and reading it with format-specific navigation; annotations and reading state are stored locally. PDF conversion is a separate opt-in background workflow: configure OCR, extract text or recognize pages, package an EPUB, then add or export the result. README capability descriptions fill in some unsampled implementation details; edges based on them are cited to the README.
Main entry points: LibraryRepository.kt Book import and library · LibraryViewModel.kt Library ViewModel · PdfActivity.kt PDF activity and routing · PdfConversionWorker.kt Background conversion worker
Components 26
App and library
- App entry
app/src/main/java/io/readx/app/MainActivity.kt - Library and navigation UI
app/src/main/java/io/readx/app/ui/ReadXApp.kt - Library ViewModel
app/src/main/java/io/readx/app/ui/LibraryViewModel.kt - Book import and library
app/src/main/java/io/readx/app/data/LibraryRepository.kt
Text reading
- Reader screen
app/src/main/java/io/readx/app/ui/ImmersiveReaderScreen.kt - EPUB and TXT parser
app/src/main/java/io/readx/app/reader/BookParser.kt - Local web reader
app/src/main/java/io/readx/app/reader/LocalWebReader.kt - Pagination coordinator
app/src/main/java/io/readx/app/reader/BookPagination.kt - Page index cache
app/src/main/java/io/readx/app/reader/PageIndexCache.kt - Text anchors and selection
app/src/main/java/io/readx/app/reader/TextAnchor.kt
PDF reading
- PDF activity and routing
app/src/main/java/io/readx/app/pdf/PdfActivity.kt - Advanced PDF viewer
app/src/main/java/io/readx/app/pdf/HorizontalPdfScreen.kt - PDF fallback viewer
app/src/main/java/io/readx/app/pdf/FallbackPdfScreen.kt - PDF annotation overlay
app/src/main/java/io/readx/app/pdf/PdfAnnotationOverlay.kt
PDF conversion
- Conversion controls
app/src/main/java/io/readx/app/ui/PdfConversionUi.kt - Conversion task manager
app/src/main/java/io/readx/app/conversion/PdfConversionRepository.kt - OCR model manager
app/src/main/java/io/readx/app/conversion/OcrModelManager.kt - Background conversion worker
app/src/main/java/io/readx/app/conversion/PdfConversionWorker.kt - PDF page extraction
app/src/main/java/io/readx/app/conversion/PdfPageExtractor.kt - OCR and text flow
app/src/main/java/io/readx/app/conversion/PdfTextFlow.kt - EPUB packaging
app/src/main/java/io/readx/app/conversion/EpubOutput.kt
Local state
- Application services
app/src/main/java/io/readx/app/ReadXApplication.kt - Library database
app/src/main/java/io/readx/app/data/LibraryDatabase.kt - Reader preferences
app/src/main/java/io/readx/app/ui/ReaderPreferences.kt
Other components
- Reader
- System file picker
Connections 34
- Reader → App entry: opens app
- App entry → Library and navigation UI: sets content
app/src/main/java/io/readx/app/MainActivity.kt - Library and navigation UI → Library ViewModel: presents state
app/src/main/java/io/readx/app/ui/ReadXApp.kt - Library ViewModel → Book import and library: manages books
app/src/main/java/io/readx/app/ui/LibraryViewModel.kt - System file picker → Book import and library: provides files
- Book import and library → EPUB and TXT parser: parses imports
app/src/main/java/io/readx/app/data/LibraryRepository.kt - Book import and library → Library database: stores book data
app/src/main/java/io/readx/app/data/LibraryRepository.kt - Library and navigation UI → Reader screen: opens reader
app/src/main/java/io/readx/app/ui/ReadXApp.kt - Reader screen → Local web reader: renders text
- Reader screen → Pagination coordinator: requests pages
- Pagination coordinator → EPUB and TXT parser: measures chapters
app/src/main/java/io/readx/app/reader/BookPagination.kt - Pagination coordinator → Page index cache: uses layout cache
app/src/main/java/io/readx/app/reader/BookPagination.kt - Local web reader → Text anchors and selection: resolves selections
app/src/main/java/io/readx/app/reader/LocalWebReader.kt - Library ViewModel → Library database: saves annotations
app/src/main/java/io/readx/app/ui/LibraryViewModel.kt - Library and navigation UI → PDF activity and routing: opens PDF
app/src/main/java/io/readx/app/ui/ReadXApp.kt - PDF activity and routing → Advanced PDF viewer: routes supported devices
app/src/main/java/io/readx/app/pdf/PdfActivity.kt - PDF activity and routing → PDF fallback viewer: routes fallback devices
- PDF activity and routing → PDF annotation overlay: attaches overlay
app/src/main/java/io/readx/app/pdf/PdfActivity.kt - Library ViewModel → Conversion controls: exposes task state
app/src/main/java/io/readx/app/ui/PdfConversionUi.kt - Conversion controls → Conversion task manager: starts and controls
- Library ViewModel → Conversion task manager: starts conversion
app/src/main/java/io/readx/app/ui/LibraryViewModel.kt - Conversion task manager → OCR model manager: checks OCR models
app/src/main/java/io/readx/app/conversion/PdfConversionRepository.kt - Conversion task manager → Background conversion worker: enqueues work
app/src/main/java/io/readx/app/conversion/PdfConversionRepository.kt - Background conversion worker → PDF page extraction: extracts pages
app/src/main/java/io/readx/app/conversion/PdfConversionWorker.kt - Background conversion worker → OCR and text flow: processes page text
app/src/main/java/io/readx/app/conversion/PdfConversionWorker.kt - Background conversion worker → EPUB packaging: packages result
app/src/main/java/io/readx/app/conversion/PdfConversionWorker.kt - Background conversion worker → Book import and library: imports completed EPUB
app/src/main/java/io/readx/app/conversion/PdfConversionWorker.kt - App entry → Application services: uses app services
app/src/main/java/io/readx/app/ReadXApplication.kt - Application services → Library database: creates database
app/src/main/java/io/readx/app/ReadXApplication.kt - Application services → Book import and library: creates repository
app/src/main/java/io/readx/app/ReadXApplication.kt - Application services → Conversion task manager: creates conversion manager
app/src/main/java/io/readx/app/ReadXApplication.kt - Application services → OCR model manager: deploys bundled models
app/src/main/java/io/readx/app/ReadXApplication.kt - Reader screen → Reader preferences: reads reader settings
- PDF activity and routing → Reader preferences: reads PDF settings
app/src/main/java/io/readx/app/pdf/PdfActivity.kt