migu/README.md
2024-08-12 21:29:41 +07:00

3.5 KiB
Raw Blame History

Migu

Stream anime torrents, real-time with no waiting for downloads

Migu is a fork of Miru that focused on better mobile experience with added features and polished the experience by a mile.

Features

Includes all original Miru features, plus:

  • Toggleable AMOLED theme
  • Optional Discord Rich Presence
  • Optional Auto-update
  • Free APK download on GitHub Releases
  • Split Android builds by CPU architecture
  • Auto-update with automatic CPU architecture selection
  • Independent seeding speed control
  • Close button on miniplayer
  • Miniplayer doesnt load on startup
  • Swipe gestures for brightness and volume control on Android
  • Scroll wheel for volume control on PC
  • Customizable seek duration
  • Proper back button functionality on Android
  • Redesigned Android navigation bar for improved usability
  • Correctly implemented fullscreen mode on Android
  • Safe area padding and margin adjustments on Android to avoid overlap with the status bar
  • Imported Default Extension and RSS feed settings from PC to Android
  • Auto fullscreen video playback on Android
  • Scrollable RSS feed for more anime visibility on Android
  • Double-tap to seek on Android
  • Default seek duration set to 5 seconds
  • Volume and brightness indicators for swipe and scroll gestures
  • Torrent sorting by size (+seeders) to reduce bandwidth usage
  • Default new release RSS set to "ASW" to minimize bandwidth usage
  • Double-click back button to exit
  • Moved toast close button to the bottom for better reachability on Android
  • Disabled smooth scrolling by default due to poor performance on my device
  • Gesture lock on Android to prevent misclick
  • Right click or long press on RSS Section will open the anime episode list
  • Toggleable auto skip intro/outro

Building and Development

dont.

Please do! I highly encourage this!

Requirements

  • PNPM (or any package manager)
  • NodeJS 20+
  • Docker (with WSL support if you're on Windows)
  • ADB
  • Android Studio (SDK 34)
  • Java 21 (JDK)

Building for PC (Electron)

  1. Navigate to the Electron directory:
    cd electron
    
  2. Install dependencies:
    pnpm install
    
  3. Development:
    pnpm start
    
  4. Release:
    pnpm build
    

Building for Android (Capacitor)

  1. Navigate to the Capacitor directory:
    cd capacitor
    
  2. Install dependencies:
    pnpm install
    
  3. Check what's missing:
    pnpm exec cap doctor
    
  4. (First time only) Build native code:
    • Windows:
      pnpm build:native-win
      
    • Linux:
      pnpm build:native
      
  5. (Optional) Generate assets (if built-in forked capacitor/assets doesnt work):
    pnpm dlx @capacitor/assets generate --iconBackgroundColor #20a2ff --iconBackgroundColorDark #20a2ff --splashBackgroundColor #20a2ff --splashBackgroundColorDark #20a2ff --android
    
  6. Open the Android project:
    pnpm exec cap open android
    
  7. Connect your phone with ADB.
  8. Development:
    pnpm dev:start
    
  9. Release:
    pnpm build:app
    

License

This project acknowledges and complies with the GPLv3 license.