# ankidroid/anki-android architecture

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

- Interactive diagram: https://gitdiagram.com/ankidroid/anki-android
- Repository: https://github.com/ankidroid/anki-android

## Overview

1. **Overall shape**
   This is a large multi-module Android application: AnkiDroid, a flashcard/spaced-repetition client that is mostly offline-first but syncs with AnkiWeb. The repo is organized around a core app module plus shared libraries for the backend engine, cross-module utilities, compatibility shims, and API surface.

2. **Top-level module boundaries**
   The main runtime app is `AnkiDroid/`. Supporting modules are `libanki/` for the collection/scheduler engine, `common/` and `anki-common/` for shared Kotlin utilities and navigation abstractions, `compat/` for API-level/platform shims, `api/` for the external add-card contract, `vbpd/` for view-binding helpers, and `lint-rules/` for project-specific static checks. These modules keep Android UI code separated from engine logic and platform compatibility code.

3. **Core domain engine**
   `libanki/` is the heart of the app’s data model and scheduling logic. It owns collections, decks, cards, notes, note types, media, storage, sync, import/export, undo, and the scheduler/FSRS-related logic. If you’re drawing the architecture, treat this as the canonical domain layer and persistence engine beneath the UI.

4. **UI and feature entry points**
   `AnkiDroid/src/main/java/com/ichi2/anki/` contains the Android-facing presentation layer: activities, fragments, view models, dialogs, custom views, and feature packages. Major user-facing areas include deck picking, reviewing, card browser, note editor, notetype management, statistics, settings, shared decks, previewers, multimedia editing, review reminders, and widgets.

5. **Card review pipeline**
   The review flow is a distinct subsystem: reviewer UI classes, gesture/button mappings, answer timers, whiteboard, audio recording/playback, TTS, and type-answer support. Card content is rendered through WebView-backed card viewer components, using HTML/CSS/JS assets plus a JS bridge (`AnkiDroidJsAPI`) to connect template scripts and Android-native actions.

6. **Content authoring and browsing**
   Card creation and editing are centered around the note editor, multimedia editor, image cropping/occlusion, notetype editor, tag dialogs, and card browser/search. The browser subsystem supports advanced filtering, saved searches, bulk operations, and column selection, while the previewer and template previewer provide inspection/editing paths for note/card templates.

7. **Storage and profile model**
   User data is stored in Anki collections and media files, with profile-aware storage paths and restrictions managed by the multiprofile layer. The app also keeps separate local stores for app metadata, preferences, and review reminders; this means the diagram should distinguish collection data from application settings and auxiliary databases.

8. **Background/system integration**
   Long-running or deferred work is handled by services, workers, alarms, and broadcast receivers. Key examples are sync workers, notification scheduling, boot/day-rollover handling, media sync, and widgets; these are the boundary where Android system events re-enter the app and trigger domain work.

9. **External integrations**
   The primary external service is AnkiWeb for synchronization. The app also integrates with crash reporting/analytics, system TTS/STT, Android permissions/scoped storage, and notification APIs; there is also support for add-ons and external content import via intents and provider-style interfaces.

10. **Shared platform abstractions**
   `common/`, `anki-common/`, and `compat/` exist to reduce duplication and isolate platform-specific behavior. `common/` provides time/json/filesystem utilities and annotations; `compat/` wraps Android version differences; `anki-common/` carries shared navigation destination abstractions; and `vbpd/` supports view binding ergonomics across the app.

11. **Public API surface**
   The `api/` module exposes a separate, smaller API for external callers to create or inspect notes/cards. This is a deliberate boundary: external apps should interact with the API module, not with the main app internals or `libanki` directly.

12. **Build, quality, and localization**
   The repo is heavily tooling-driven: Gradle multi-module builds, custom lint rules, extensive unit/instrumentation tests, and GitHub Actions workflows. The UI is localized via a large resource set and uses theme/resource overlays to support many languages, tablet layouts, night modes, and device-specific variants.

13. **How the data flows end-to-end**
   Typical flows start in an Activity/Fragment, pass through a ViewModel or service layer, then into `libanki` for collection operations, scheduling, or sync. Results come back as model state/UI state, while side effects fan out to storage, media files, notifications/widgets, or external sync endpoints.

Main entry points: [`libanki/src/main/java/com/ichi2/anki/libanki/LibAnki.kt`](https://github.com/ankidroid/anki-android/blob/main/libanki/src/main/java/com/ichi2/anki/libanki/LibAnki.kt) (LibAnki), [`AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidApp.kt`](https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidApp.kt) (App shell), [`AnkiDroid/src/main/java/com/ichi2/anki/DeckPicker.kt`](https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/DeckPicker.kt) (Deck picker), [`AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/reviewer/ReviewerFragment.kt`](https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/reviewer/ReviewerFragment.kt) (Reviewer)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Android app"]
  node_app_entry["App shell<br/>android app<br/>[AnkiDroidApp.kt]"]
  node_deck_picker["Deck picker<br/>home ui<br/>[DeckPicker.kt]"]
  node_review_flow["Reviewer<br/>study ui"]
  node_reviewer_web["Card viewer<br/>webview render<br/>[AnkiDroidJsAPI.kt]"]
  node_note_editor["Note editor<br/>authoring ui"]
  node_browser["Card browser<br/>search ui"]
  node_settings["Settings<br/>preferences ui"]
  node_widgets["Widgets<br/>[AddNoteWidget.kt]"]
  node_background["System work<br/>services/workers<br/>[BootService.kt]"]
  node_storage_profile["Storage & profile<br/>storage boundary<br/>[ProfileManager.kt]"]
  node_sync_integration["Sync & import<br/>sync integration<br/>[Sync.kt]"]
end

subgraph group_engine["Core engine"]
  node_libanki_core[("LibAnki<br/>domain engine<br/>[LibAnki.kt]")]
  node_scheduler["Scheduler<br/>spaced repetition<br/>[Scheduler.kt]"]
  node_collection_storage[("Collection store<br/>persistence<br/>[Collection.kt]")]
  node_templates_media["Templates & media<br/>content engine<br/>[TemplateManager.kt]"]
end

subgraph group_shared["Shared modules"]
  node_common_utils["Common utils<br/>shared kotlin<br/>[TimeManager.kt]"]
  node_compat_layer["Compat layer<br/>platform shims<br/>[Compat.kt]"]
  node_api_surface["Public API<br/>external api<br/>[AddContentApi.kt]"]
  node_navigation_shared["Nav shared<br/>shared navigation<br/>[Navigator.kt]"]
  node_viewbinding["VB helpers<br/>ui helper"]
end

subgraph group_tooling["Tooling"]
  node_lint_rules["Lint rules<br/>quality tooling<br/>[IssueRegistry.kt]"]
end

node_app_entry -->|"starts at"| node_deck_picker
node_app_entry -->|"receives system events"| node_background
node_app_entry -->|"selects storage"| node_storage_profile
node_deck_picker -->|"opens"| node_review_flow
node_deck_picker -->|"navigates to"| node_browser
node_deck_picker -->|"creates cards"| node_note_editor
node_review_flow -->|"renders cards"| node_reviewer_web
node_review_flow -->|"grades cards"| node_scheduler
node_review_flow -->|"plays media"| node_templates_media
node_note_editor -->|"edits notes"| node_libanki_core
node_browser -->|"queries collection"| node_libanki_core
node_settings -->|"configures profiles"| node_storage_profile
node_widgets -->|"refreshes via"| node_background
node_background -->|"runs sync"| node_sync_integration
node_sync_integration -->|"syncs collection"| node_libanki_core
node_libanki_core -->|"persists in"| node_collection_storage
node_libanki_core -->|"uses scheduler"| node_scheduler
node_libanki_core -->|"manages templates"| node_templates_media
node_common_utils -->|"shared by"| node_app_entry
node_common_utils -->|"shared by"| node_libanki_core
node_compat_layer -->|"supports"| node_app_entry
node_api_surface -.->|"separates from"| node_libanki_core
node_navigation_shared -->|"shared by"| node_app_entry
node_viewbinding -->|"supports UI"| node_app_entry
node_lint_rules -->|"checks"| node_app_entry
node_lint_rules -.->|"checks"| node_common_utils

click node_app_entry "https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidApp.kt"
click node_deck_picker "https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/DeckPicker.kt"
click node_review_flow "https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/reviewer/ReviewerFragment.kt"
click node_reviewer_web "https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidJsAPI.kt"
click node_note_editor "https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/NoteEditorActivity.kt"
click node_browser "https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/browser/CardBrowserFragment.kt"
click node_settings "https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/preferences/SettingsFragment.kt"
click node_widgets "https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/widget/AddNoteWidget.kt"
click node_background "https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/services/BootService.kt"
click node_storage_profile "https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/multiprofile/ProfileManager.kt"
click node_sync_integration "https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/Sync.kt"
click node_libanki_core "https://github.com/ankidroid/anki-android/blob/main/libanki/src/main/java/com/ichi2/anki/libanki/LibAnki.kt"
click node_scheduler "https://github.com/ankidroid/anki-android/blob/main/libanki/src/main/java/com/ichi2/anki/libanki/sched/Scheduler.kt"
click node_collection_storage "https://github.com/ankidroid/anki-android/blob/main/libanki/src/main/java/com/ichi2/anki/libanki/Collection.kt"
click node_templates_media "https://github.com/ankidroid/anki-android/blob/main/libanki/src/main/java/com/ichi2/anki/libanki/TemplateManager.kt"
click node_common_utils "https://github.com/ankidroid/anki-android/blob/main/common/src/main/java/com/ichi2/anki/common/time/TimeManager.kt"
click node_compat_layer "https://github.com/ankidroid/anki-android/blob/main/compat/src/main/java/com/ichi2/anki/compat/Compat.kt"
click node_api_surface "https://github.com/ankidroid/anki-android/blob/main/api/src/main/java/com/ichi2/anki/api/AddContentApi.kt"
click node_navigation_shared "https://github.com/ankidroid/anki-android/blob/main/anki-common/src/main/java/com/ichi2/anki/common/destinations/Navigator.kt"
click node_viewbinding "https://github.com/ankidroid/anki-android/blob/main/vbpd/src/main/java/dev/androidbroadcast/vbpd/ViewBindingProperty.kt"
click node_lint_rules "https://github.com/ankidroid/anki-android/blob/main/lint-rules/src/main/java/com/ichi2/anki/lint/IssueRegistry.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_app_entry,node_deck_picker,node_review_flow,node_reviewer_web,node_note_editor,node_browser,node_settings,node_widgets,node_background,node_storage_profile,node_sync_integration toneBlue
class node_libanki_core,node_scheduler,node_collection_storage,node_templates_media toneAmber
class node_common_utils,node_compat_layer,node_api_surface,node_navigation_shared,node_viewbinding toneMint
class node_lint_rules toneRose
```

## Components

### Android app

Main AnkiDroid runtime, UI, and Android integration.

- [App shell](https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidApp.kt): android app · Application bootstrap, lifecycle, intent handling, and top-level navigation. · `AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidApp.kt`
- [Deck picker](https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/DeckPicker.kt): home ui · Entry screen for selecting decks, starting study, and reaching key app areas. · `AnkiDroid/src/main/java/com/ichi2/anki/DeckPicker.kt`
- [Reviewer](https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/reviewer/ReviewerFragment.kt): study ui · Review session UI, answer controls, gestures, timers, audio, TTS, and whiteboard. · `AnkiDroid/src/main/java/com/ichi2/anki/ui/windows/reviewer/ReviewerFragment.kt`
- [Card viewer](https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidJsAPI.kt): webview render · Template rendering and JS bridge for card question/answer content. · `AnkiDroid/src/main/java/com/ichi2/anki/AnkiDroidJsAPI.kt`
- [Note editor](https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/NoteEditorActivity.kt): authoring ui · Card and note creation/editing, field management, and media editing entry points. · `AnkiDroid/src/main/java/com/ichi2/anki/NoteEditorActivity.kt`
- [Card browser](https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/browser/CardBrowserFragment.kt): search ui · Browse, filter, search, bulk edit, and inspect cards and notes. · `AnkiDroid/src/main/java/com/ichi2/anki/browser/CardBrowserFragment.kt`
- [Settings](https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/preferences/SettingsFragment.kt): preferences ui · Preference screens, reviewer controls, sync settings, and profile-related settings. · `AnkiDroid/src/main/java/com/ichi2/anki/preferences/SettingsFragment.kt`
- [Widgets](https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/widget/AddNoteWidget.kt): android widgets · Home screen widgets and their configuration flows. · `AnkiDroid/src/main/java/com/ichi2/widget/AddNoteWidget.kt`
- [System work](https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/services/BootService.kt): services/workers · Boot, alarms, notifications, scheduled sync, and other deferred Android entry points. · `AnkiDroid/src/main/java/com/ichi2/anki/services/BootService.kt`
- [Storage & profile](https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/multiprofile/ProfileManager.kt): storage boundary · Collection location, profile isolation, metadata storage, and local app databases. · `AnkiDroid/src/main/java/com/ichi2/anki/multiprofile/ProfileManager.kt`
- [Sync & import](https://github.com/ankidroid/anki-android/blob/main/AnkiDroid/src/main/java/com/ichi2/anki/Sync.kt): sync integration · AnkiWeb sync, import/export, backups, and media synchronization orchestration. · `AnkiDroid/src/main/java/com/ichi2/anki/Sync.kt`

### Core engine

Collection, scheduling, media, and sync domain logic.

- [LibAnki](https://github.com/ankidroid/anki-android/blob/main/libanki/src/main/java/com/ichi2/anki/libanki/LibAnki.kt): domain engine · Collection model, scheduling, decks/cards/notes, media, storage, sync, and templates. · `libanki/src/main/java/com/ichi2/anki/libanki/LibAnki.kt`
- [Scheduler](https://github.com/ankidroid/anki-android/blob/main/libanki/src/main/java/com/ichi2/anki/libanki/sched/Scheduler.kt): spaced repetition · Due calculation, card states, deck counts, and scheduling rules including FSRS-related logic. · `libanki/src/main/java/com/ichi2/anki/libanki/sched/Scheduler.kt`
- [Collection store](https://github.com/ankidroid/anki-android/blob/main/libanki/src/main/java/com/ichi2/anki/libanki/Collection.kt): persistence · Collection files, DB access, storage helpers, and media-backed domain persistence. · `libanki/src/main/java/com/ichi2/anki/libanki/Collection.kt`
- [Templates & media](https://github.com/ankidroid/anki-android/blob/main/libanki/src/main/java/com/ichi2/anki/libanki/TemplateManager.kt): content engine · Card templates, HTML/template filters, LaTeX, audio/TTS, and media handling. · `libanki/src/main/java/com/ichi2/anki/libanki/TemplateManager.kt`

### Shared modules

Reusable utilities, compatibility layers, API surface, and UI helpers.

- [Common utils](https://github.com/ankidroid/anki-android/blob/main/common/src/main/java/com/ichi2/anki/common/time/TimeManager.kt): shared kotlin · Shared time, JSON, file, and utility primitives used across modules. · `common/src/main/java/com/ichi2/anki/common/time/TimeManager.kt`
- [Compat layer](https://github.com/ankidroid/anki-android/blob/main/compat/src/main/java/com/ichi2/anki/compat/Compat.kt): platform shims · Android API-level compatibility helpers and file/package abstractions. · `compat/src/main/java/com/ichi2/anki/compat/Compat.kt`
- [Public API](https://github.com/ankidroid/anki-android/blob/main/api/src/main/java/com/ichi2/anki/api/AddContentApi.kt): external api · Separate contract for external callers to add or inspect notes/cards. · `api/src/main/java/com/ichi2/anki/api/AddContentApi.kt`
- [Nav shared](https://github.com/ankidroid/anki-android/blob/main/anki-common/src/main/java/com/ichi2/anki/common/destinations/Navigator.kt): shared navigation · Reusable destination and navigator abstractions shared by app modules. · `anki-common/src/main/java/com/ichi2/anki/common/destinations/Navigator.kt`
- [VB helpers](https://github.com/ankidroid/anki-android/blob/main/vbpd/src/main/java/dev/androidbroadcast/vbpd/ViewBindingProperty.kt): ui helper · View binding property helpers used across Android UI code. · `vbpd/src/main/java/dev/androidbroadcast/vbpd/ViewBindingProperty.kt`

### Tooling

Build, quality, lint, and release support.

- [Lint rules](https://github.com/ankidroid/anki-android/blob/main/lint-rules/src/main/java/com/ichi2/anki/lint/IssueRegistry.kt): quality tooling · Project-specific static analysis rules and lint registry. · `lint-rules/src/main/java/com/ichi2/anki/lint/IssueRegistry.kt`

## Connections

- App shell → Deck picker: starts at · Bootstraps the main home/navigation flow.
- App shell → System work: receives system events · Application lifecycle and broadcast entry points re-enter through services and receivers.
- App shell → Storage & profile: selects storage · Chooses profile-aware paths and collection access.
- Deck picker → Reviewer: opens · Starts a study session from selected decks.
- Deck picker → Card browser: navigates to · Moves into card browsing and search workflows.
- Deck picker → Note editor: creates cards · Launches editing and note creation flows.
- Reviewer → Card viewer: renders cards · Uses the web-backed viewer for question/answer display and JS bridge actions.
- Reviewer → Scheduler: grades cards · Pulls due state and applies answer outcomes through scheduling logic.
- Reviewer → Templates & media: plays media · Handles audio, TTS, video, and template-driven content.
- Note editor → LibAnki: edits notes · Creates and updates notes, fields, notetypes, and cards in the collection.
- Card browser → LibAnki: queries collection · Searches, filters, and bulk-edits collection data.
- Settings → Storage & profile: configures profiles · Manages preferences and profile-scoped settings.
- Widgets → System work: refreshes via · Widget updates are scheduled and refreshed by alarms and workers.
- System work → Sync & import: runs sync · Deferred jobs trigger syncing, media sync, reminders, and notifications.
- Sync & import → LibAnki: syncs collection · Synchronizes collection and media state through the engine.
- LibAnki → Collection store: persists in · Stores the collection, decks, notes, cards, and media metadata.
- LibAnki → Scheduler: uses scheduler · Domain engine delegates spaced-repetition calculations to scheduler logic.
- LibAnki → Templates & media: manages templates · Owns templates, rendering helpers, and media-related domain logic.
- Common utils → App shell: shared by · App code depends on shared time, JSON, file, and utility primitives.
- Common utils → LibAnki: shared by · Core engine shares common primitives and test utilities.
- Compat layer → App shell: supports · Wraps Android version differences for app runtime behavior.
- Public API → LibAnki: separates from · Public API is a deliberate boundary and should not expose app internals directly.
- Nav shared → App shell: shared by · Navigation abstractions are reused across app modules.
- VB helpers → App shell: supports UI · Provides view binding ergonomics for Android screens and fragments.
- Lint rules → App shell: checks · Static analysis enforces project-specific app code conventions.
- Lint rules → Common utils: checks · Static analysis also enforces shared-module conventions and API hygiene.
