# legadoteam/legado architecture

> Architecture diagram of the GitHub repository legadoteam/legado, 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/legadoteam/legado
- Repository: https://github.com/legadoteam/legado

## Overview

Legado is an Android ebook reader whose main journey is selecting a configured book source, discovering and fetching a book and chapters, then reading and optionally listening or exporting content. Its broader documented domain includes local books and multiple importable reading formats, RSS, reviews, source management, and a local web/API surface. The tree and excerpts show models, source scripting, content processing, persistence, and audio/export services; many UI and domain implementations are unsampled, so uncertain links are omitted rather than inferred.

Main entry points: [`app/src/main/java/io/legado/app/model/ReadBook.kt`](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/model/ReadBook.kt) (Reading workflow), [`app/src/main/java/io/legado/app/ui/book/search/SearchActivity.kt`](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/ui/book/search/SearchActivity.kt) (Book search), [`app/src/main/java/io/legado/app/help/book/BookHelp.kt`](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/book/BookHelp.kt) (Book operations), [`app/src/main/java/io/legado/app/data/AppDatabase.kt`](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/data/AppDatabase.kt) (Book database)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_sources["Sources and discovery"]
  node_source_records["Source definitions<br/>[BookSource.kt]"]
  node_source_navigation["Source navigation"]
  node_search["Book search<br/>[SearchActivity.kt]"]
  node_source_api["Reader API<br/>[ReaderProvider.kt]"]
  node_script_engine["Source scripting<br/>[JsSourceEngine.kt]"]
  node_rss["RSS reading<br/>[RssSource.kt]"]
  node_reviews["Book reviews"]
end

subgraph group_reading["Books and reading"]
  node_book_model["Book model<br/>[Book.kt]"]
  node_chapter_model["Chapter model<br/>[BookChapter.kt]"]
  node_book_help["Book operations<br/>[BookHelp.kt]"]
  node_content_processor["Content processing"]
  node_reader_engine["Reading workflow<br/>[ReadBook.kt]"]
  node_book_db[("Book database<br/>[AppDatabase.kt]")]
  node_local_formats["Local book formats"]
end

subgraph group_media["Media and export"]
  node_read_aloud["Read aloud"]
  node_audio["Audio playback"]
  node_audio_cache["Audio cache"]
  node_export["Book export"]
end

subgraph group_platform["App platform"]
  node_app["Android app<br/>[App.kt]"]
  node_network["HTTP client<br/>[HttpHelper.kt]"]
  node_backup["Backup and restore<br/>[Backup.kt]"]
  node_webdav["WebDAV sync<br/>[AppWebDav.kt]"]
  node_settings["Reader settings<br/>[AppConfig.kt]"]
end

node_reader(("Reader user"))
node_external_source(("Book source service"))
node_external_tts(("Speech engine"))

node_reader -->|"uses"| node_app
node_app -.->|"opens"| node_search
node_search -.->|"selects"| node_source_records
node_search -.->|"navigates"| node_source_navigation
node_source_navigation -.->|"requests"| node_external_source
node_source_api -.->|"serves access"| node_external_source
node_source_records -->|"provides rules"| node_script_engine
node_script_engine -->|"uses requests"| node_network
node_search -.->|"produces books"| node_book_model
node_book_help -.->|"loads chapters"| node_chapter_model
node_book_help -.->|"reads and writes"| node_book_db
node_reader_engine -.->|"loads content"| node_book_help
node_reader_engine -.->|"processes text"| node_content_processor
node_reader_engine -->|"uses book state"| node_book_model
node_reader_engine -->|"uses chapters"| node_chapter_model
node_local_formats -.->|"provides content"| node_reader_engine
node_rss -.->|"persists articles"| node_book_db
node_reviews -.->|"fetches reviews"| node_external_source
node_reader_engine -.->|"supplies speech text"| node_read_aloud
node_read_aloud -.->|"requests speech"| node_external_tts
node_audio -->|"uses cache"| node_audio_cache
node_reader_engine -.->|"exports book"| node_export
node_backup -.->|"backs up data"| node_book_db
node_backup -.->|"transfers backup"| node_webdav
node_reader_engine -.->|"reads preferences"| node_settings

click node_app "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/App.kt"
click node_source_records "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookSource.kt"
click node_source_navigation "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/source/SourceNavigationBridge.kt"
click node_search "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/ui/book/search/SearchActivity.kt"
click node_source_api "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/api/ReaderProvider.kt"
click node_network "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/http/HttpHelper.kt"
click node_script_engine "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/model/jsSource/JsSourceEngine.kt"
click node_book_model "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/data/entities/Book.kt"
click node_chapter_model "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookChapter.kt"
click node_book_help "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/book/BookHelp.kt"
click node_content_processor "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/book/ContentProcessor.kt"
click node_reader_engine "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/model/ReadBook.kt"
click node_book_db "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/data/AppDatabase.kt"
click node_rss "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/data/entities/RssSource.kt"
click node_reviews "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/api/controller/ReviewController.kt"
click node_local_formats "https://github.com/legadoteam/legado/blob/master/modules/book/src/main/java/me/ag2s/epublib/epub/BookProcessorPipeline.java"
click node_read_aloud "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/service/BaseReadAloudService.kt"
click node_audio "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/service/AudioPlayService.kt"
click node_audio_cache "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/audio/AudioCacheManager.kt"
click node_export "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/service/ExportBookService.kt"
click node_backup "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/storage/Backup.kt"
click node_webdav "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/AppWebDav.kt"
click node_settings "https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/config/AppConfig.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_source_records,node_source_navigation,node_search,node_source_api,node_script_engine,node_rss,node_reviews,node_reader toneBlue
class node_book_model,node_chapter_model,node_book_help,node_content_processor,node_reader_engine,node_book_db,node_local_formats toneAmber
class node_read_aloud,node_audio,node_audio_cache,node_export toneMint
class node_app,node_network,node_backup,node_webdav,node_settings toneRose
class node_external_source,node_external_tts toneIndigo
```

## Components

### Sources and discovery

- [Source definitions](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookSource.kt): `app/src/main/java/io/legado/app/data/entities/BookSource.kt`
- [Source navigation](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/source/SourceNavigationBridge.kt): `app/src/main/java/io/legado/app/help/source/SourceNavigationBridge.kt`
- [Book search](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/ui/book/search/SearchActivity.kt): `app/src/main/java/io/legado/app/ui/book/search/SearchActivity.kt`
- [Reader API](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/api/ReaderProvider.kt): `app/src/main/java/io/legado/app/api/ReaderProvider.kt`
- [Source scripting](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/model/jsSource/JsSourceEngine.kt): `app/src/main/java/io/legado/app/model/jsSource/JsSourceEngine.kt`
- [RSS reading](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/data/entities/RssSource.kt): `app/src/main/java/io/legado/app/data/entities/RssSource.kt`
- [Book reviews](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/api/controller/ReviewController.kt): `app/src/main/java/io/legado/app/api/controller/ReviewController.kt`

### Books and reading

- [Book model](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/data/entities/Book.kt): `app/src/main/java/io/legado/app/data/entities/Book.kt`
- [Chapter model](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookChapter.kt): `app/src/main/java/io/legado/app/data/entities/BookChapter.kt`
- [Book operations](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/book/BookHelp.kt): `app/src/main/java/io/legado/app/help/book/BookHelp.kt`
- [Content processing](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/book/ContentProcessor.kt): `app/src/main/java/io/legado/app/help/book/ContentProcessor.kt`
- [Reading workflow](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/model/ReadBook.kt): `app/src/main/java/io/legado/app/model/ReadBook.kt`
- [Book database](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/data/AppDatabase.kt): `app/src/main/java/io/legado/app/data/AppDatabase.kt`
- [Local book formats](https://github.com/legadoteam/legado/blob/master/modules/book/src/main/java/me/ag2s/epublib/epub/BookProcessorPipeline.java): `modules/book/src/main/java/me/ag2s/epublib/epub/BookProcessorPipeline.java`

### Media and export

- [Read aloud](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/service/BaseReadAloudService.kt): `app/src/main/java/io/legado/app/service/BaseReadAloudService.kt`
- [Audio playback](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/service/AudioPlayService.kt): `app/src/main/java/io/legado/app/service/AudioPlayService.kt`
- [Audio cache](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/audio/AudioCacheManager.kt): `app/src/main/java/io/legado/app/help/audio/AudioCacheManager.kt`
- [Book export](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/service/ExportBookService.kt): `app/src/main/java/io/legado/app/service/ExportBookService.kt`

### App platform

- [Android app](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/App.kt): `app/src/main/java/io/legado/app/App.kt`
- [HTTP client](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/http/HttpHelper.kt): `app/src/main/java/io/legado/app/help/http/HttpHelper.kt`
- [Backup and restore](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/storage/Backup.kt): `app/src/main/java/io/legado/app/help/storage/Backup.kt`
- [WebDAV sync](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/AppWebDav.kt): `app/src/main/java/io/legado/app/help/AppWebDav.kt`
- [Reader settings](https://github.com/legadoteam/legado/blob/master/app/src/main/java/io/legado/app/help/config/AppConfig.kt): `app/src/main/java/io/legado/app/help/config/AppConfig.kt`

### Other components

- **Reader user**
- **Book source service**
- **Speech engine**

## Connections

- Reader user → Android app: uses (evidence: `README.md`)
- Android app → Book search: opens
- Book search → Source definitions: selects
- Book search → Source navigation: navigates
- Source navigation → Book source service: requests
- Reader API → Book source service: serves access
- Source definitions → Source scripting: provides rules (evidence: `app/src/main/java/io/legado/app/model/jsSource/JsSourceEngine.kt`)
- Source scripting → HTTP client: uses requests (evidence: `app/src/main/java/io/legado/app/model/jsSource/JsSourceEngine.kt`)
- Book search → Book model: produces books
- Book operations → Chapter model: loads chapters
- Book operations → Book database: reads and writes
- Reading workflow → Book operations: loads content (evidence: `app/src/main/java/io/legado/app/model/ReadBook.kt`)
- Reading workflow → Content processing: processes text (evidence: `app/src/main/java/io/legado/app/model/ReadBook.kt`)
- Reading workflow → Book model: uses book state (evidence: `app/src/main/java/io/legado/app/data/entities/Book.kt`)
- Reading workflow → Chapter model: uses chapters (evidence: `app/src/main/java/io/legado/app/data/entities/BookChapter.kt`)
- Local book formats → Reading workflow: provides content
- RSS reading → Book database: persists articles
- Book reviews → Book source service: fetches reviews
- Reading workflow → Read aloud: supplies speech text (evidence: `app/src/main/java/io/legado/app/model/ReadBook.kt`)
- Read aloud → Speech engine: requests speech
- Audio playback → Audio cache: uses cache (evidence: `app/src/main/java/io/legado/app/help/audio/AudioCacheManager.kt`)
- Reading workflow → Book export: exports book (evidence: `app/src/main/java/io/legado/app/service/ExportBookService.kt`)
- Backup and restore → Book database: backs up data
- Backup and restore → WebDAV sync: transfers backup
- Reading workflow → Reader settings: reads preferences (evidence: `app/src/main/java/io/legado/app/model/ReadBook.kt`)
