# lagradost/quicknovel architecture

> Architecture diagram of the GitHub repository lagradost/quicknovel, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/lagradost/quicknovel
- Repository: https://github.com/lagradost/quicknovel

## Overview

QuickNovel is an Android novel-discovery and download app that also reads EPUB books. Its user-facing journey is browsing or searching provider catalogs, opening a novel’s details and chapters, then downloading or reading content; history and settings support that journey. The tree and excerpts identify provider registration, API/repository abstractions, download work, reader activities, and EPUB components. Many UI-to-view-model and persistence details were not sampled, so those connections are omitted or marked unverified rather than inferred as calls.

Main entry points: [`app/src/main/java/com/lagradost/quicknovel/ReadActivity2.kt`](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ReadActivity2.kt) (Book reader), [`app/src/main/java/com/lagradost/quicknovel/APIRepository.kt`](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/APIRepository.kt) (API repository), [`app/src/main/java/com/lagradost/quicknovel/ui/home/HomeFragment.kt`](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ui/home/HomeFragment.kt) (Home browse), [`app/src/main/java/com/lagradost/quicknovel/ui/search/SearchFragment.kt`](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ui/search/SearchFragment.kt) (Catalog search)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_discovery["Novel discovery"]
  node_home["Home browse<br/>[HomeFragment.kt]"]
  node_search["Catalog search<br/>[SearchFragment.kt]"]
  node_catalog["Provider registry<br/>[Apis.kt]"]
  node_providers["Novel providers"]
  node_api["Provider API<br/>[MainAPI.kt]"]
  node_repository["API repository<br/>[APIRepository.kt]"]
  node_details["Novel details<br/>[ResultFragment.kt]"]
end

subgraph group_content["Content handling"]
  node_downloadui["Downloads UI"]
  node_work["Download worker"]
  node_downloader["Book downloader<br/>[BookDownloader2.kt]"]
  node_files["Local files<br/>[FileHelper.kt]"]
end

subgraph group_reading["Reading experience"]
  node_reader["Book reader<br/>[ReadActivity2.kt]"]
  node_readerstate["Reader state"]
  node_epub["EPUB engine<br/>[EpubReader.java]"]
  node_speech["Text to speech<br/>[TTSHelper.kt]"]
end

subgraph group_appdata["App and preferences"]
  node_main["Main navigation<br/>[MainActivity.kt]"]
  node_history["Reading history<br/>[HistoryFragment.kt]"]
  node_store[("App data store<br/>[DataStore.kt]")]
  node_settings["Settings"]
end

node_user(("Reader"))
node_web(("Provider websites"))

node_user -.->|"uses"| node_main
node_main -.->|"navigates"| node_home
node_user -.->|"searches"| node_search
node_search -.->|"queries"| node_repository
node_home -.->|"browses"| node_repository
node_catalog -->|"registers"| node_providers
node_repository -->|"delegates"| node_api
node_providers -.->|"scrapes"| node_web
node_repository -.->|"supplies results"| node_details
node_details -.->|"starts download"| node_downloadui
node_downloadui -->|"queues work"| node_work
node_work -->|"runs download"| node_downloader
node_downloader -.->|"writes files"| node_files
node_user -.->|"opens book"| node_reader
node_reader -.->|"reads EPUB"| node_epub
node_reader -.->|"updates state"| node_readerstate
node_reader -.->|"plays speech"| node_speech
node_reader -.->|"records progress"| node_history
node_settings -.->|"persists preferences"| node_store
node_user -.->|"configures"| node_settings

click node_main "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/MainActivity.kt"
click node_home "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ui/home/HomeFragment.kt"
click node_search "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ui/search/SearchFragment.kt"
click node_catalog "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/util/Apis.kt"
click node_providers "https://github.com/lagradost/quicknovel/tree/master/app/src/main/java/com/lagradost/quicknovel/providers"
click node_api "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/MainAPI.kt"
click node_repository "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/APIRepository.kt"
click node_details "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ui/result/ResultFragment.kt"
click node_downloadui "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ui/download/DownloadFragment.kt"
click node_work "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/DownloadFileWorkManager.kt"
click node_downloader "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/BookDownloader2.kt"
click node_files "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/FileHelper.kt"
click node_reader "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ReadActivity2.kt"
click node_readerstate "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ReadActivityViewModel.kt"
click node_epub "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/me/ag2s/epublib/epub/EpubReader.java"
click node_speech "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/TTSHelper.kt"
click node_history "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ui/history/HistoryFragment.kt"
click node_store "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/DataStore.kt"
click node_settings "https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ui/settings/SettingsFragment.kt"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_home,node_search,node_catalog,node_providers,node_api,node_repository,node_details toneBlue
class node_downloadui,node_work,node_downloader,node_files toneAmber
class node_reader,node_readerstate,node_epub,node_speech toneMint
class node_main,node_history,node_store,node_settings toneRose
class node_user,node_web toneIndigo
```

## Components

### Novel discovery

- [Home browse](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ui/home/HomeFragment.kt): `app/src/main/java/com/lagradost/quicknovel/ui/home/HomeFragment.kt`
- [Catalog search](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ui/search/SearchFragment.kt): `app/src/main/java/com/lagradost/quicknovel/ui/search/SearchFragment.kt`
- [Provider registry](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/util/Apis.kt): `app/src/main/java/com/lagradost/quicknovel/util/Apis.kt`
- [Novel providers](https://github.com/lagradost/quicknovel/tree/master/app/src/main/java/com/lagradost/quicknovel/providers): `app/src/main/java/com/lagradost/quicknovel/providers`
- [Provider API](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/MainAPI.kt): `app/src/main/java/com/lagradost/quicknovel/MainAPI.kt`
- [API repository](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/APIRepository.kt): `app/src/main/java/com/lagradost/quicknovel/APIRepository.kt`
- [Novel details](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ui/result/ResultFragment.kt): `app/src/main/java/com/lagradost/quicknovel/ui/result/ResultFragment.kt`

### Content handling

- [Downloads UI](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ui/download/DownloadFragment.kt): `app/src/main/java/com/lagradost/quicknovel/ui/download/DownloadFragment.kt`
- [Download worker](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/DownloadFileWorkManager.kt): `app/src/main/java/com/lagradost/quicknovel/DownloadFileWorkManager.kt`
- [Book downloader](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/BookDownloader2.kt): `app/src/main/java/com/lagradost/quicknovel/BookDownloader2.kt`
- [Local files](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/FileHelper.kt): `app/src/main/java/com/lagradost/quicknovel/FileHelper.kt`

### Reading experience

- [Book reader](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ReadActivity2.kt): `app/src/main/java/com/lagradost/quicknovel/ReadActivity2.kt`
- [Reader state](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ReadActivityViewModel.kt): `app/src/main/java/com/lagradost/quicknovel/ReadActivityViewModel.kt`
- [EPUB engine](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/me/ag2s/epublib/epub/EpubReader.java): `app/src/main/java/me/ag2s/epublib/epub/EpubReader.java`
- [Text to speech](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/TTSHelper.kt): `app/src/main/java/com/lagradost/quicknovel/TTSHelper.kt`

### App and preferences

- [Main navigation](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/MainActivity.kt): `app/src/main/java/com/lagradost/quicknovel/MainActivity.kt`
- [Reading history](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ui/history/HistoryFragment.kt): `app/src/main/java/com/lagradost/quicknovel/ui/history/HistoryFragment.kt`
- [App data store](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/DataStore.kt): `app/src/main/java/com/lagradost/quicknovel/DataStore.kt`
- [Settings](https://github.com/lagradost/quicknovel/blob/master/app/src/main/java/com/lagradost/quicknovel/ui/settings/SettingsFragment.kt): `app/src/main/java/com/lagradost/quicknovel/ui/settings/SettingsFragment.kt`

### Other components

- **Reader**
- **Provider websites**

## Connections

- Reader → Main navigation: uses
- Main navigation → Home browse: navigates
- Reader → Catalog search: searches
- Catalog search → API repository: queries
- Home browse → API repository: browses
- Provider registry → Novel providers: registers (evidence: `app/src/main/java/com/lagradost/quicknovel/util/Apis.kt`)
- API repository → Provider API: delegates (evidence: `app/src/main/java/com/lagradost/quicknovel/APIRepository.kt`)
- Novel providers → Provider websites: scrapes
- API repository → Novel details: supplies results
- Novel details → Downloads UI: starts download
- Downloads UI → Download worker: queues work (evidence: `app/src/main/java/com/lagradost/quicknovel/DownloadFileWorkManager.kt`)
- Download worker → Book downloader: runs download (evidence: `app/src/main/java/com/lagradost/quicknovel/DownloadFileWorkManager.kt`)
- Book downloader → Local files: writes files (evidence: `app/src/main/java/com/lagradost/quicknovel/BookDownloader2.kt`)
- Reader → Book reader: opens book
- Book reader → EPUB engine: reads EPUB
- Book reader → Reader state: updates state
- Book reader → Text to speech: plays speech
- Book reader → Reading history: records progress
- Settings → App data store: persists preferences
- Reader → Settings: configures
