A comprehensive Kotlin Android application for manga and anime enthusiasts, featuring AI-powered tools, local media management, and seamless online content discovery built with modern Android architecture.
Features • Tech Stack • Architecture • Getting Started • Contributing • Roadmap
- Multi-format Support: .cbz/.cbr manga archives and .mp4/.mkv anime files (.avi legacy support)
- Smart Organization: Automatic metadata extraction and library organization
- Offline First: Full functionality without internet connection
- Advanced Search: Powerful filtering and discovery within your collection
- OCR Translation: Real-time manga translation with AI-powered OCR
- Art Style Matching: Intelligent categorization based on visual analysis
- Smart Recommendations: AI-driven content suggestions based on reading patterns
- Scene Analysis: Automatic chapter and scene recognition
- Extensible Sources: Plugin architecture for multiple content providers
- Global Search: Search across all configured sources simultaneously
- Download Manager: Queue management with pause/resume functionality
- Sync & Backup: Cloud synchronization for settings and progress
- Multiple Reading Modes: Single page, double page, continuous scroll, webtoon
- Customizable Interface: Themes, typography, and layout preferences
- Progress Tracking: Detailed reading statistics and completion tracking
- Collections System: Organize content with custom collections and tags
Project Myriad is built with cutting-edge Android technologies:
- Kotlin 2.2.20 - Primary development language with latest features
- Jetpack Compose 2025.09.00 - Declarative UI with Material 3 design
- Android Gradle Plugin 8.13.0 - Latest build toolchain
- Clean Architecture - Domain/Data/Presentation layer separation
- Room Database 2.8.0 - Local persistence for offline-first functionality
- Hilt DI 2.57.1 - Dependency injection framework
- ExoPlayer 1.8.0 - Advanced video/audio playback
- Retrofit 3.0.0 - Type-safe HTTP client
📖 Complete Technology Stack Details
Automated Quality: ktlint, Detekt, Android Lint, JaCoCo coverage with CI/CD on every push.
📖 Complete Workflow Documentation
Comprehensive APK Builds: Multiple automated workflows for building and distributing the completed application:
- Build APK: Full builds with testing and validation for completed features
- Quick APK Build: Fast debug builds optimized for testing the finished app
- Auto Error Handling: Intelligent compilation error resolution
- GitHub Releases: Automated APK distribution for the completed application
Project Myriad follows Clean Architecture principles with MVVM pattern for maintainable, testable code:
- Presentation Layer: Jetpack Compose + ViewModels + Type-safe Navigation
- Domain Layer: Use Cases + Repository Interfaces + Domain Models
- Data Layer: Room Database + Retrofit API + File System
Key Principles: Single Source of Truth, Unidirectional Data Flow, Separation of Concerns
📖 Complete Architecture Documentation
- Android Studio Jellyfish (2023.3.1) or later
- JDK 17 or higher
- Android SDK with API levels 24-36
- Git for version control
- Android SDK with API 24-36
- 4GB+ RAM recommended
-
Clone and Build
git clone https://github.com/Heartless-Veteran/Project-Myriad.git cd Project-Myriad ./gradlew build -
Install and Run
./gradlew installDebug
📖 Complete Development Setup Guide
🎉 Current Status: ALL PHASES COMPLETE - Project Myriad development finished!
✅ Completed Features (2024-2025):
- 🏗️ Foundation: Modern Kotlin architecture with Clean Architecture (100% Complete)
- 📚 Enhanced Reader: Advanced manga reading with all features (100% Complete)
- 🤖 AI Integration: OCR translation, recommendations, and analysis (100% Complete)
- 📥 Download Manager: Complete content management system (100% Complete)
- 🧭 Full Navigation: Comprehensive app navigation and screens (100% Complete)
- 🏠 Vault System: Local media management for manga and anime (100% Complete)
Key Achievements:
- ✅ Complete phases 1-6 implementation with all major features
- ✅ Enhanced reader with comprehensive manga support
- ✅ AI-powered translation and recommendation engine
- ✅ Integrated download manager for content management
- ✅ Full navigation system across all app screens
- ✅ Modern Kotlin architecture with Jetpack Compose UI
- ✅ Comprehensive APK build workflows for distribution
# Run unit tests
./gradlew test
# Run instrumentation tests
./gradlew connectedAndroidTest
# Generate test coverage report
./gradlew jacocoTestReportCurrent Test Coverage: 25% (Expanding to 70%+ target)
We welcome contributions from the community! Whether you're fixing bugs, adding features, or improving documentation, your help is appreciated.
- Check Issues - Look for
good first issuelabels - Read Guidelines - Review our Contributing Guide
- Fork & Clone - Set up your development environment
- Make Changes - Follow our coding standards
- Submit PR - Create a pull request with detailed description
- 🐛 Report Bugs - Help us identify and fix issues
- 💡 Suggest Features - Share ideas for new functionality
- 📝 Improve Docs - Enhance documentation and guides
- 🎨 Design UI/UX - Contribute to the visual experience
- 🧪 Write Tests - Improve code coverage and reliability
- 🌐 Translations - Help localize the app
All contributors are recognized in release notes and commit history.
This project is licensed under the MIT License - see the LICENSE file for details.
- 🌐 Documentation Website - Comprehensive documentation site with API reference
- 📖 Documentation Index - Complete documentation navigation guide
- 📖 Development Guide - Detailed development setup
- 🔍 Code Analysis - Current implementation status
- 📋 Feature Requests - Suggest new features
- 🐛 Bug Reports - Report issues
- GitHub Issues - Technical problems and feature requests
- GitHub Discussions - General questions and community chat
- Discord Server - Real-time community support (Coming Soon)
- Documentation - Comprehensive guides and API reference
- ⭐ Star this repo to show your support
- 👁️ Watch releases for update notifications
- 🍴 Fork the project to contribute
- 📱 Follow us for development updates