How readium/kotlin-toolkit works
Project Type and Purpose
• This is a multi‑module Android/Kotlin library toolkit (Readium Kotlin Toolkit) providing an ecosystem for reading ebooks, audiobooks, comics and catalogs.
• It is not a single application but a set of Gradle modules (shared core, parser/“streamer,” navigator UI, adapters for rendering engines, LCP DRM, OPDS catalog support) plus a test‑app demo that ties them together.
High‑Level Module Structure
• readium-shared: Core data types, utilities, resource loading, OPDS/Publication models – the foundation for all other modules.
• readium-streamer: Publication parser services (EPUB, PDF, CBZ, audio metadata), positions services. Depends on shared.
• readium-navigator: UI layer to display publications (epub, pdf, cbz) in Android WebViews/Fragments, input handling, pagination, preferences. Depends on shared, streamer.
• readium-lcp: License acquisition, decryption, persistent storage, authentication flows. Depends on shared.
• readium-opds: OPDS feed parsers (1 & 2), feed-to-model mapping. Depends on shared.
• readium-adapters: Plugins that connect navigator to third‑party engines
• ExoPlayer audio adapter
• PDFium & PSPDFKit document and navigator adapters
• (Each adapter is its own submodule that depends on core navigator interfaces.)
• readium-navigators: Alternate navigator implementations (common, demo, media audio, TTS, web) illustrating different patterns and driver services.
• test-app: Sample Android application demonstrating integration of the above modules in a complete reader app, with its own data layer, UI screens, navigation graph, persistent storage, ViewModels, and dependency wiring.
Essential Elements to Capture
• All major Kotlin modules as separate components
• Adapter modules hooking into navigator interfaces
• test-app at the top, showing it orchestrates modules into a working reader