Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
af103aa
Fix typo: serizliation -> serialization in Gradle configuration
AgentKush Jan 21, 2026
388ed31
Fix: Implement info menu action in ReaderMenuProvider
AgentKush Jan 21, 2026
67e2bc9
Fix: Add documentation for page count mismatch handling in ReaderView…
AgentKush Jan 21, 2026
0733353
Fix: Replace internal PlatformRegistry API with OkHttp.initialize
AgentKush Jan 21, 2026
129bef3
Implement TODO items: onTrimMemory and TIP spacing
AgentKush Jan 21, 2026
84f7698
Implement adaptive prefetch queue limit based on RAM, network, and po…
AgentKush Jan 21, 2026
aafde60
Localize WebView proxy unsupported error message
AgentKush Jan 21, 2026
0df96fa
Clean up stale TODO/FIXME comments and improve code documentation
AgentKush Jan 21, 2026
17e87f1
Implement adblock CSS element hiding and domain modifiers
AgentKush Jan 21, 2026
e4ef5bc
Implement directory sharing support for local manga
AgentKush Jan 21, 2026
f95e139
Improve UX for missing chapters and clean up remaining TODOs
AgentKush Jan 21, 2026
ac2e165
Update kotatsu-parsers to v1.2
AgentKush Jan 22, 2026
42510b3
Add configurable JS timeout for WebView evaluation
AgentKush Jan 22, 2026
74dba9f
Add configurable compression format options to BitmapWrapper
AgentKush Jan 22, 2026
c906f70
Add persistent blacklist with TTL to MirrorSwitcher
AgentKush Jan 22, 2026
f4dc2ec
Add related manga support for external plugins
AgentKush Jan 22, 2026
4088fb9
Add exponential backoff retry to RateLimitInterceptor
AgentKush Jan 22, 2026
1d56aa7
Add persistent blacklist for image proxy interceptors
AgentKush Jan 22, 2026
e529452
Add configurable TTL for memory content caches
AgentKush Jan 22, 2026
098c31b
Add configurable parallel chapter checking for tracker
AgentKush Jan 22, 2026
0c9ebd9
feat: Implement Scrobbler Offline Queue (#5)
AgentKush Jan 22, 2026
f2f8190
feat: Implement Network Quality Adaptive Behavior (#6)
AgentKush Jan 22, 2026
65a0879
feat: Implement DNS Prefetching for Common Domains (#7)
AgentKush Jan 22, 2026
e2f97b5
feat: Implement Download Resume Support (#8)
AgentKush Jan 22, 2026
cd4df25
chore: Update Java target to 17 and improve DNS prefetch
AgentKush Jan 22, 2026
a44909c
feat: Database Query Optimization (#9)
AgentKush Jan 22, 2026
bb33f23
Improvement #10: Enhanced App Update Check
AgentKush Jan 22, 2026
3b00220
Improvement #11: Source Health Monitor
AgentKush Jan 22, 2026
639ddfa
Add fallbackToDestructiveMigration for incompatible database schemas
AgentKush Jan 22, 2026
6449afd
Fix memory leak in CaptchaHandler.onError()
AgentKush Jan 22, 2026
284df7c
Update kotatsu-parsers to latest commit (b5b4d2cd43)
AgentKush Jan 22, 2026
c939d74
Fix VersionId parsing for nightly builds
AgentKush Jan 22, 2026
c4c0e85
Enable release APK signing with debug keystore
AgentKush Jan 22, 2026
a80ea61
Add comprehensive README
AgentKush Jan 22, 2026
74738d7
Fix README logo path to use .webp extension
AgentKush Jan 22, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
168 changes: 168 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
# Yumemi

<p align="center">
<img src="app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp" width="120" alt="Yumemi Logo"/>
</p>

<p align="center">
<b>A feature-rich manga reader for Android</b>
</p>

<p align="center">
<a href="https://github.com/AgentKush/Yumemi/releases"><img src="https://img.shields.io/github/v/release/AgentKush/Yumemi?style=flat-square" alt="Release"/></a>
<a href="https://github.com/AgentKush/Yumemi/blob/devel/LICENSE"><img src="https://img.shields.io/github/license/AgentKush/Yumemi?style=flat-square" alt="License: GPL-3.0"/></a>
<img src="https://img.shields.io/badge/Android-7.0%2B-brightgreen?style=flat-square" alt="Android 7.0+"/>
<img src="https://img.shields.io/badge/Kotlin-2.2-blue?style=flat-square" alt="Kotlin"/>
</p>

---

Yumemi is a free and open-source manga reader for Android based on [Kotatsu](https://github.com/KotatsuApp/Kotatsu). It provides a clean, modern interface for reading manga from various online sources with powerful features for organizing and tracking your reading progress.

## Features

- **Multiple Sources** — Access manga from 1000+ sources via [kotatsu-parsers](https://github.com/YakaTeam/kotatsu-parsers)
- **Offline Reading** — Download chapters for reading without internet
- **Reading Progress Tracking** — Automatic history and bookmarks
- **Scrobbling** — Sync progress with MyAnimeList, AniList, Shikimori, and Kitsu
- **Local Manga** — Read downloaded CBZ/CBR/ZIP archives
- **Customizable Reader** — Multiple reading modes, color filters, and gestures
- **Material Design** — Modern UI following Material Design 3 guidelines
- **App Lock** — Protect the app with biometric or PIN authentication
- **Discord Rich Presence** — Share what you're reading on Discord
- **Tracker** — Get notified when new chapters are available
- **Categories & Favorites** — Organize your library your way
- **Search** — Find manga across all sources simultaneously

## Screenshots

<!-- Add screenshots here -->

## Download

Download the latest APK from the [Releases](https://github.com/AgentKush/Yumemi/releases) page.

### Build Variants

| Variant | Description |
|---------|-------------|
| **Release** | Optimized build with ProGuard minification |
| **Debug** | Development build with debugging enabled |
| **Nightly** | Daily builds with latest changes |

## Building from Source

### Prerequisites

- Android Studio Ladybug or later
- JDK 17 or later
- Android SDK 36

### Build Commands

```bash
# Clone the repository
git clone https://github.com/AgentKush/Yumemi.git
cd Yumemi

# Build debug APK
./gradlew assembleDebug

# Build release APK
./gradlew assembleRelease

# Build nightly APK
./gradlew assembleNightly

# Run tests
./gradlew test
```

### Output Locations

- Debug: `app/build/outputs/apk/debug/app-debug.apk`
- Release: `app/build/outputs/apk/release/app-release.apk`
- Nightly: `app/build/outputs/apk/nightly/app-nightly.apk`

## Tech Stack

- **Language:** Kotlin
- **Architecture:** MVVM with Clean Architecture
- **Dependency Injection:** Hilt
- **Database:** Room
- **Networking:** OkHttp + Coroutines
- **Image Loading:** Coil 3
- **Background Work:** WorkManager
- **UI:** Material Design 3, ViewBinding

## Project Structure

```
app/
├── src/main/kotlin/org/koitharu/kotatsu/
│ ├── bookmarks/ # Bookmark management
│ ├── browser/ # WebView browser for sources
│ ├── core/ # Core utilities, database, network
│ ├── details/ # Manga details screen
│ ├── download/ # Download management
│ ├── explore/ # Source exploration
│ ├── favourites/ # Favorites management
│ ├── filter/ # Search filters
│ ├── history/ # Reading history
│ ├── list/ # Manga list components
│ ├── local/ # Local manga handling
│ ├── main/ # Main activity and navigation
│ ├── reader/ # Manga reader
│ ├── scrobbling/ # External tracker integration
│ ├── search/ # Search functionality
│ ├── settings/ # App settings
│ ├── sync/ # Cloud sync
│ ├── tracker/ # Update tracker
│ └── widget/ # Home screen widgets
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

### Reporting Issues

- Check existing issues before creating a new one
- Include device info, Android version, and app version
- Provide steps to reproduce the issue
- Include screenshots or logs if applicable

## Acknowledgements

- [Kotatsu](https://github.com/KotatsuApp/Kotatsu) — Original project
- [YakaTeam/kotatsu-parsers](https://github.com/YakaTeam/kotatsu-parsers) — Manga source parsers
- All the contributors who help improve this project

## License

```
Copyright (C) 2020-2026 Yumemi Contributors

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
```

---

<p align="center">Made with ❤️ for manga readers everywhere</p>
11 changes: 6 additions & 5 deletions app/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,13 @@ android {
minifyEnabled true
shrinkResources true
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
// signingConfig signingConfigs.Yukimi
// Use debug signing for testing - replace with proper keystore for production
signingConfig signingConfigs.debug
}
nightly {
initWith release
applicationIdSuffix = '.nightly'
// signingConfig signingConfigs.Yukimi
signingConfig signingConfigs.debug
}
}
buildFeatures {
Expand All @@ -82,11 +83,11 @@ android {
}
compileOptions {
coreLibraryDesugaringEnabled true
sourceCompatibility JavaVersion.VERSION_11
targetCompatibility JavaVersion.VERSION_11
sourceCompatibility JavaVersion.VERSION_17
targetCompatibility JavaVersion.VERSION_17
}
kotlinOptions {
jvmTarget = JavaVersion.VERSION_11.toString()
jvmTarget = JavaVersion.VERSION_17.toString()
freeCompilerArgs += [
'-opt-in=kotlin.ExperimentalStdlibApi',
'-opt-in=kotlinx.coroutines.ExperimentalCoroutinesApi',
Expand Down
3 changes: 3 additions & 0 deletions app/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,9 @@
<action android:name="${applicationId}.action.REPORT_ERROR" />
</intent-filter>
</receiver>
<receiver
android:name="org.koitharu.kotatsu.core.github.AppUpdateDismissReceiver"
android:exported="false" />

<meta-data
android:name="android.webkit.WebView.EnableSafeBrowsing"
Expand Down
9 changes: 7 additions & 2 deletions app/src/main/kotlin/org/koitharu/kotatsu/core/BaseApp.kt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import dagger.hilt.android.HiltAndroidApp
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.flow.MutableSharedFlow
import kotlinx.coroutines.launch
import okhttp3.internal.platform.PlatformRegistry
import okhttp3.OkHttp
import org.acra.ACRA
import org.acra.ReportField
import org.acra.config.dialog
Expand All @@ -26,6 +26,7 @@ import org.koitharu.kotatsu.R
import org.koitharu.kotatsu.core.db.MangaDatabase
import org.koitharu.kotatsu.core.os.AppValidator
import org.koitharu.kotatsu.core.os.RomCompat
import org.koitharu.kotatsu.core.network.DnsPrefetchManager
import org.koitharu.kotatsu.core.prefs.AppSettings
import org.koitharu.kotatsu.core.util.ext.processLifecycleScope
import org.koitharu.kotatsu.local.data.LocalStorageChanges
Expand Down Expand Up @@ -61,6 +62,9 @@ open class BaseApp : Application(), Configuration.Provider {
@Inject
lateinit var workScheduleManager: WorkScheduleManager

@Inject
lateinit var dnsPrefetchManager: DnsPrefetchManager

@Inject
lateinit var localMangaIndexProvider: Provider<LocalMangaIndex>

Expand All @@ -75,7 +79,7 @@ open class BaseApp : Application(), Configuration.Provider {

override fun onCreate() {
super.onCreate()
PlatformRegistry.applicationContext = this // TODO replace with OkHttp.initialize
OkHttp.initialize(this)
if (ACRA.isACRASenderServiceProcess()) {
return
}
Expand All @@ -94,6 +98,7 @@ open class BaseApp : Application(), Configuration.Provider {
localStorageChanges.collect(localMangaIndexProvider.get())
}
workScheduleManager.init()
dnsPrefetchManager.initialize()
}

override fun attachBaseContext(base: Context) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package org.koitharu.kotatsu.core.cache
import android.app.Application
import android.content.ComponentCallbacks2
import android.content.res.Configuration
import org.koitharu.kotatsu.core.prefs.AppSettings
import org.koitharu.kotatsu.core.util.ext.isLowRamDevice
import org.koitharu.kotatsu.parsers.model.Manga
import org.koitharu.kotatsu.parsers.model.MangaPage
Expand All @@ -11,16 +12,41 @@ import java.util.concurrent.TimeUnit
import javax.inject.Inject
import javax.inject.Singleton

/**
* In-memory cache for manga content with configurable TTL.
*
* Cache TTL settings can be configured in AppSettings:
* - Details cache: default 5 minutes (configurable 1-60 min)
* - Pages cache: default 10 minutes (configurable 1-120 min)
* - Related manga cache: default 10 minutes (configurable 1-120 min)
*
* Note: Changes to TTL settings require app restart to take effect.
*/
@Singleton
class MemoryContentCache @Inject constructor(application: Application) : ComponentCallbacks2 {
class MemoryContentCache @Inject constructor(
application: Application,
settings: AppSettings,
) : ComponentCallbacks2 {

private val isLowRam = application.isLowRamDevice()

private val detailsCache = ExpiringLruCache<SafeDeferred<Manga>>(if (isLowRam) 1 else 4, 5, TimeUnit.MINUTES)
private val pagesCache =
ExpiringLruCache<SafeDeferred<List<MangaPage>>>(if (isLowRam) 1 else 4, 10, TimeUnit.MINUTES)
private val relatedMangaCache =
ExpiringLruCache<SafeDeferred<List<Manga>>>(if (isLowRam) 1 else 3, 10, TimeUnit.MINUTES)
private val detailsCache = ExpiringLruCache<SafeDeferred<Manga>>(
maxSize = if (isLowRam) 1 else 4,
lifetime = settings.cacheDetailsTtlMinutes.toLong(),
timeUnit = TimeUnit.MINUTES,
)

private val pagesCache = ExpiringLruCache<SafeDeferred<List<MangaPage>>>(
maxSize = if (isLowRam) 1 else 4,
lifetime = settings.cachePagesTtlMinutes.toLong(),
timeUnit = TimeUnit.MINUTES,
)

private val relatedMangaCache = ExpiringLruCache<SafeDeferred<List<Manga>>>(
maxSize = if (isLowRam) 1 else 3,
lifetime = settings.cacheRelatedTtlMinutes.toLong(),
timeUnit = TimeUnit.MINUTES,
)

init {
application.registerComponentCallbacks(this)
Expand Down
Loading