Update

Update 0.6.3
Arturo254 · Jun 12, 2024 · 4e878e3 · 4e878e3
1 parent 94e3c2f
commit 4e878e3
Show file tree

Hide file tree

Showing 64 changed files with 518 additions and 681 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: zionhuang
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: ['https://www.buymeacoffee.com/zionhuang']
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,99 @@
+name: Bug report
+description: Create a bug report to help us improve
+labels: [ bug ]
+body:
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      description: You should ensure the completion of the task before proceeding to check it off the checklist. Neglecting to do so may impede the efficiency of the issue resolution process. The developer has the right to delete the issue directly if you check the list blindly.
+      options:
+        - label: I am able to reproduce the bug with the [latest debug version](https://github.com/z-huang/InnerTune/actions).
+          required: true
+        - label: I've checked that there is no open or closed issue about this bug.
+          required: true
+        - label: This issue contains only one bug.
+          required: true
+        - label: The title of this issue accurately describes the bug.
+          required: true
+
+  - type: textarea
+    id: reproduce-steps
+    attributes:
+      label: Steps to reproduce the bug
+      description: What did you do for the bug to show up?
+      placeholder: |
+        Example:
+          1. Go to '...'
+          2. Click on '....'
+          3. Scroll down to '....'
+          4. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      placeholder: |
+        Example:
+          "This should happen..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual-behavior
+    attributes:
+      label: Actual behavior
+      placeholder: |
+        Example:
+          "This happened instead..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: sreen-media
+    attributes:
+      label: Screenshots/Screen recordings
+      description: |
+        A picture or video helps us understand the bug more.
+
+        You can upload them directly in the text box.
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs
+      description: |
+        Please use `adb logcat` or other ways to provide logs. This field is strongly recommended to be filled. Without this information, it's likely that the developer is unable to take any meaningful action or provide further assistance.
+    validations:
+      required: true
+
+  - type: input
+    id: app-version
+    attributes:
+      label: InnerTune version
+      description: |
+        You can find your InnerTune version in **Settings**.
+      placeholder: |
+        Example: "0.5.3"
+    validations:
+      required: true
+
+  - type: input
+    id: android-version
+    attributes:
+      label: Android version
+      description: |
+        You can find this somewhere in your Android settings.
+      placeholder: |
+        Example: "Android 12"
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional-information
+    attributes:
+      label: Additional information
+      placeholder: |
+        Additional details and attachments.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1 @@
+blank_issues_enabled: false
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,40 @@
+name: Feature request
+description: Suggest an idea for InnerTune
+labels: [enhancement]
+body:
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      description: You should ensure the completion of the task before proceeding to check it off the checklist. Neglecting to do so may impede the efficiency of the issue resolution process. The developer has the right to delete the issue directly if you check the list blindly.
+      options:
+        - label: I've checked that there is no other issue about this feature request.
+          required: true
+        - label: This issue contains only one feature request.
+          required: true
+        - label: The title of this issue accurately describes the feature request.
+          required: true
+
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: Feature description
+      description: What feature you want the app to have? Provide detailed description about what it should look like or where it should be added.
+    validations:
+      required: true
+
+  - type: textarea
+    id: why-is-the-feature-requested
+    attributes:
+      label: Why do you want this feature?
+      description: Describe the problem or limitation that motivates you to want this feature to be added.
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional-information
+    attributes:
+      label: Additional information
+      description: Add any other context or screenshots about the feature request here.
+      placeholder: |
+        Additional details and attachments.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,42 @@
+name: Build debug APK
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - '**'
+    paths-ignore:
+      - 'README.md'
+      - 'fastlane/**'
+      - 'assets/**'
+      - '.github/**/*.md'
+      - '.github/FUNDING.yml'
+      - '.github/ISSUE_TEMPLATE/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Decode Keystore
+        run: echo ${{ secrets.KEYSTORE }} | base64 -d >> app/music-debug.jks
+
+      - name: set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: 17
+          distribution: "zulu"
+          cache: 'gradle'
+
+      - name: Build debug APK and run jvm tests
+        run: ./gradlew assembleDebug lintFossDebug testFossDebugUnitTest --stacktrace -DskipFormatKtlint
+        env:
+          MUSIC_DEBUG_KEYSTORE_FILE: 'music-debug.jks'
+          MUSIC_DEBUG_SIGNING_STORE_PASSWORD: ${{ secrets.SIGNING_KEY_PASSWORD }}
+          MUSIC_DEBUG_SIGNING_KEY_PASSWORD: ${{ secrets.SIGNING_STORE_PASSWORD }}
+
+      - name: Upload APK
+        uses: actions/upload-artifact@v3
+        with:
+          name: app
+          path: app/build/outputs/apk/foss/debug/*.apk
diff --git a/.github/workflows/build_pr.yml b/.github/workflows/build_pr.yml
@@ -0,0 +1,29 @@
+name: Build PR
+on:
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          java-version: 11
+          distribution: "temurin"
+          cache: 'gradle'
+
+      - name: Build debug APK and run jvm tests
+        run: ./gradlew assembleDebug lintFullDebug testFullDebugUnitTest --stacktrace -DskipFormatKtlint
+        env:
+          PULL_REQUEST: 'true'
+
+      - name: Upload APK
+        uses: actions/upload-artifact@v3
+        with:
+          name: app
+          path: app/build/outputs/apk/full/debug/*.apk
diff --git a/README.md b/README.md
@@ -1,66 +1,85 @@
-
 # InnerTune
 
-<div align="center">
-  <img src="https://raw.githubusercontent.com/z-huang/InnerTune/dev/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp" alt="InnerTune Logo" width="120" height="120">
-  <br>
-  <p>Un cliente de YouTube Music con Material Design 3 para Android</p>
-  <a href="https://github.com/Arturo254/InnerTune/releases">
-    <img src="https://img.shields.io/github/v/release/Arturo254/InnerTune?style=flat-square" alt="Latest Release">
-  </a>
-  <a href="https://github.com/z-huang/InnerTune/blob/main/LICENSE">
-    <img src="https://img.shields.io/github/license/Arturo254/InnerTune?style=flat-square" alt="License">
-  </a>
-</div>
+<img src="https://raw.githubusercontent.com/Malopieds/InnerTune/dev/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp" height="72">
+
+A fork of InnerTune, A Material 3 YouTube Music client for Android
+
+[![Latest release](https://img.shields.io/github/v/release/Malopieds/InnerTune?include_prereleases)](https://github.com/Malopieds/InnerTune/releases)
+[![License](https://img.shields.io/github/license/Malopieds/InnerTune)](https://www.gnu.org/licenses/gpl-3.0)
+[![Downloads](https://img.shields.io/github/downloads/Malopieds/InnerTune/total)](https://github.com/Malopieds/InnerTune/releases)
+
+[<img src="https://github.com/machiav3lli/oandbackupx/blob/034b226cea5c1b30eb4f6a6f313e4dadcbb0ece4/badge_github.png" alt="Get it on GitHub" height="80">](https://github.com/Malopieds/InnerTune/releases/latest)
+<!---[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="80">](https://f-droid.org/packages/com.zionhuang.music)
+[<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png" height="80">](https://apt.izzysoft.de/fdroid/index/apk/com.zionhuang.music)
 
+[Compare versions](https://github.com/Malopieds/InnerTune/wiki/App-Versions) --->
 
-![mock](https://github.com/Arturo254/InnerTune/assets/87346871/672d6022-fd69-4347-bc0f-4d78720a1f0f)
+## Features
 
-## ✨ Características
+- Play songs from YT/YT Music without ads
+- Background playback
+- Search songs, videos, albums, and playlists from YouTube Music
+- Login support
+- Library management
+- Cache and download songs for offline playback
+- Synchronized lyrics
+- Lyrics translator (experimental)
+- Skip silence
+- Audio normalization
+- Adjust tempo/pitch
+- Dynamic theme
+- Localization
+- Android Auto support
+- Personalized quick picks
+- Material 3
 
-- 🎵 Reproduce canciones de YouTube y YouTube Music sin anuncios
-- 🔊 Reproducción en segundo plano
-- 🔍 Busque canciones, videos, álbumes y listas de reproducción de YouTube Music
-- 🔑 Soporte de inicio de sesión
-- 📚 Gestión de biblioteca
-- ⬇️ Almacenar en caché y descargar canciones para reproducirlas sin conexión
-- 🗣️ Letras sincronizadas
-- 🌐 Traductor de letras (experimental)
-- ⏩ Saltar el silencio
-- 🔊 Normalización de audio
-- ⏱️ Ajustar el tempo/tono
-- 🌗 Tema dinámico
-- 🌍 Localización
-- 🚗 Soporte para Android Auto
-- ⚡ Selecciones rápidas personalizadas
-- 💎 Material Design 3
+## Screenshots
 
-## 📦 Cómo reconstruir la aplicación
+<p float="left">
+  <img src="https://raw.githubusercontent.com/Malopieds/InnerTune/dev/fastlane/metadata/android/en-US/images/phoneScreenshots/01.jpg" width="200" />
+  <img src="https://raw.githubusercontent.com/Malopieds/InnerTune/dev/fastlane/metadata/android/en-US/images/phoneScreenshots/02.jpg" width="200" />
+  <img src="https://raw.githubusercontent.com/Malopieds/InnerTune/dev/fastlane/metadata/android/en-US/images/phoneScreenshots/03.jpg" width="200" />
+</p>
+<p float="left">
+  <img src="https://raw.githubusercontent.com/Malopieds/InnerTune/dev/fastlane/metadata/android/en-US/images/phoneScreenshots/04.jpg" width="200" />
+  <img src="https://raw.githubusercontent.com/Malopieds/InnerTune/dev/fastlane/metadata/android/en-US/images/phoneScreenshots/05.jpg" width="200" />
+</p>
 
-*Para Compilar la aplicacion necesitas:*
-- Gradle
-- Kotlin
-- Android Studio
+> **Warning**
+>
+>If you're in a region where YouTube Music is not supported, you won't be able to use this app
+***unless*** you have a proxy or VPN to connect to a YTM supported region.
 
-_Mediante CLI:_
+## FAQ
 
-```bash
-./gradlew assembleDebug
-```
+### Q: How to scrobble music to LastFM, LibreFM, ListenBrainz or GNU FM?
 
+Use other music scrobbler apps. I
+recommend [Pano Scrobbler](https://play.google.com/store/apps/details?id=com.arn.scrobble).
 
+### Q: Why InnerTune isn't showing in Android Auto?
 
-## 🌐 Contribuyendo con traducciones
+1. Go to Android Auto's settings and tap multiple times on the version in the bottom to enable
+   developer settings
+2. In the three dots menu at the top-right of the screen, click "Developer settings"
+3. Enable "Unknown sources"
 
-Siga las [instrucciones](https://developer.android.com/guide/topics/resources/localization) y cree una solicitud de extracción. Si es posible, cree la aplicación de antemano y asegúrese de que no haya errores antes de crear una solicitud de extracción.
+## Contributing Translations
 
-## 💰 Donar
+Follow the [instructions](https://developer.android.com/guide/topics/resources/localization) and
+create a pull request. If possible, please build the app beforehand and make sure there is no error
+before you create a pull request.
 
-Si te gusta InnerTune (fork), puedes enviar una donación. Las donaciones apoyarán el desarrollo, incluyendo correcciones de errores y nuevas funciones.
+<!--- ## Donate
 
-© 2023 Open Source Projects, Dev: [Arturo Cervantes](https://www.paypal.com/paypalme/ArturoCervantes254)
+If you like InnerTune, you're welcome to send a donation. Donations will support the development,
+including bug fixes and new features.
 
+<a href="https://liberapay.com/zionhuang"><img src="https://raw.githubusercontent.com/Malopieds/InnerTune/dev/assets/liberapay.png" alt="Liberapay" height="60" ></a>
+<a href="https://www.buymeacoffee.com/zionhuang"><img src="https://raw.githubusercontent.com/Malopieds/InnerTune/dev/assets/buymeacoffee.png" alt="Liberapay" height="60" ></a>
 
- https://innertune.vercel.app (alternativa web)
+## Credit
 
-### TAMBIEN PUEDEES CONVERTIRTE EN SPONSOR ❤️😊
+I want to give credit to [vfsfitvnm/ViMusic](https://github.com/vfsfitvnm/ViMusic) for being an
+example of Jetpack Compose music player. It helped me a lot on my way to learn Compose and
+Android development. --->