# Legado with MD3

<p align="left">
  <a href="https://github.com/HapeLee/legado-with-MD3">简体中文</a> ｜ 
  <a href="https://github.com/HapeLee/legado-with-MD3/blob/main/English.md">English</a>
</p>

---

## 📖 Introduction

**Legado with MD3** is a Material Design 3–styled refactor based on the open-source project
👉 [Legado (阅读)](https://github.com/gedoor/legado).

In addition to a visual redesign of the UI, this project introduces multiple branch-specific
features.
It is also gradually migrating from the traditional **View system** to **Jetpack Compose**, aiming
to deliver a more modern, smooth, and consistent reading experience.

> [!CAUTION]
> **Important Notes**
>
> Due to the theme system being rebuilt on top of the **Monet engine**, themes from the official
> version are **not compatible** with this fork.
>
> **Devices below Android 12:**
> Custom themes and dynamic color features are currently unavailable.
> This limitation will be addressed after the Jetpack Compose migration is completed.
> (Due to limited developer resources, this process may take a considerable amount of time.)

---

## ✨ Branch Features

Compared to the official version, this project provides the following exclusive features:

* **New Theme System:**
  A fully redesigned Material Design 3 UI, with support for **predictive back gestures** and *
  *shared element transitions**.
* **Reading Interface:**
  More personalized reading layouts and menu configurations.
* **Reading Records:**
  Detailed reading statistics with **timeline** and **chapter-based** views.
* **Enhanced Experience:**
  Improved experiences for **comic reading**, **audiobooks**, and **discovery** pages.
* **Bookshelf Layouts:**
  More bookshelf layout options, with dedicated UI optimizations for **tablet devices**.
* **Practical Features:**
  Added book notes and **smart companion groups** (automatically categorizing read / unread books).

---

## 🛠️ Core Features

1. **Custom Book Sources**
   A powerful crawling engine with simple and flexible rules for fetching web content.
2. **Multiple Format Support**
   Supports local TXT and EPUB files, with automatic local file scanning.
3. **Highly Customizable Reading Experience**
   Font, background, line spacing, paragraph spacing, bold text, simplified/traditional Chinese
   conversion, and more.
4. **Content Subscription**
   Not limited to books — subscribe to any content you want to read.
5. **Content Filtering & Replacement**
   Powerful ad removal and content replacement rules.
6. **Page Turning Modes**
   Multiple page turning modes including cover, simulation, sliding, and scrolling.
7. **Fully Open Source**
   Ad-free and continuously improved.

---

## 🤝 Community & Support

The following communities belong to the **original project**.
Due to limited developer availability, this fork currently does **not** have an independent
community.

* **Official Wiki:**
  [Book Source Rule Tutorial](https://mgz0227.github.io/The-tutorial-of-Legado/)
* **Community Channels:**
  [Telegram](https://t.me/legado_channels) ｜ [Discord](https://discord.gg/VtUfRyzRXn) ｜ [Yuque Wiki](https://www.yuque.com/legado/wiki/community)
* **Related Documents:**
  [Disclaimer](https://gedoor.github.io/Disclaimer) 

---

## ❤️ Acknowledgements

Special thanks to the following excellent open-source projects for inspiration and technical
support:

* [gedoor/legado](https://github.com/gedoor/legado) *(the legendary original project)*
* [Luoyacheng/legado](https://github.com/Luoyacheng/legado) *(providing extended features)*
* [komikku-app/komikku](https://github.com/komikku-app/komikku) *(UI inspiration and Compose
  components)*
* [FoedusProgramme/Gramophone](https://github.com/FoedusProgramme/Gramophone) *(UI inspiration and
  View-based cover color extraction)*
* [jordond/MaterialKolor](https://github.com/jordond/MaterialKolor) *(excellent dynamic color
  implementation for Jetpack Compose)*
* [Calvin-LL/Reorderable](https://github.com/Calvin-LL/Reorderable) *(drag-and-drop reordering for
  Jetpack Compose)*
* And many more open-source projects...

---


## ⚠️ Disclaimer

This project is a **non-official fork** of Legado and is intended for learning,
personal use, and experimentation only.