Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/vivizzz007/vivi-music/llms.txt

Use this file to discover all available pages before exploring further.

VIVI Music ships with a fully self-contained Over-the-Air (OTA) updater, so you never need to visit GitHub manually to stay on the latest version. The updater fetches release metadata directly from the project’s GitHub Releases, displays the changelog in-app, and lets you download and install new APKs without leaving the app. The current stable release is version 6.0.5 (versionCode 74).

​
Checking for Updates

There are two ways to check for a new version:
  1. Update banner on the home screen — When an update is available and auto-check is enabled, VIVI Music displays an update banner prominently on the home screen. Tap it to go directly to the update screen.
  2. Settings > Update — Navigate to Settings, then tap Update (or System Update) to open the Update Settings screen manually. The screen immediately shows whether you are up to date or if a new version has been found.
The Update Settings screen (UpdateSettings.kt) shows:
  • System Update — the primary check item; displays “Update available” in red when a newer release exists, or “Up to date” otherwise.
  • App Version — the currently installed version name (for example, 6.0.5).
  • Flavour — whether you are running the FOSS build or the GMS build.
The FOSS variant (CAST_AVAILABLE = false) does not include Google Play update mechanisms. Updates in the FOSS build are delivered exclusively through the built-in GitHub-based OTA updater. On the FOSS flavour, tapping System Update opens the VIVI Music GitHub repository page in your browser instead of the in-app download flow.

​
Auto Update Check

Enable Auto Update Check to let VIVI Music query GitHub Releases every time you open the app:
  1. Go to Settings > Update.
  2. Toggle Auto Update Check on. The toggle shows a checkmark when active.
  3. If a new version is found, the update state is persisted and the home-screen banner appears immediately.
Disabling Auto Update Check also clears the stored “update available” flag so the banner disappears.

​
Beta Updates

VIVI Music publishes pre-release builds for early adopters. To opt in:
  1. Go to Settings > Update.
  2. Toggle Beta Updates on.
With beta updates enabled, the updater also considers pre-release tags when checking GitHub Releases.

​
In-App Changelog

Every release ships with a structured changelog.json file that the app reads and renders as a formatted screen. To view the changelog:
  • Go to Settings > Update > Changelog.
The changelog for the current release (6.0.5) includes the following sections: What’s New
  • Added floating navbar (disabled by default; enable in Appearance Settings)
  • Added option to disable album song listing via Appearance Settings
  • Added new UI to vivi-decrypter
  • Added new update banner (thanks to Aldeic)
Fixes & Improvements
  • Fixed Spotify login through Google
  • Fixed JioSaavn random song playing
You can also browse the full commit history by going to Settings > Update > Commits.

​
Auto-Backup Before Update

The AutoBackupBeforeUpdateKey preference (autoBackupBeforeUpdate, default: true) tells VIVI Music to automatically create a backup of your library immediately before applying any OTA update. This means you always have a restore point if anything goes wrong during the update process.
Keep Backup Before Update enabled (found under Settings > Backup & Restore > Auto Backup Settings). It runs silently in the background and takes only a few seconds, giving you a safety net every single time you update.

​
Managing Downloaded Update APKs

Once an update APK is downloaded it is cached locally. To view or clear cached APKs:
  1. Go to Settings > Update.
  2. The Clear Downloaded Updates item shows how many APK files are currently stored (for example, “2 APKs found” in red).
  3. Tap it to delete all cached update files. A toast message confirms success or failure.
The app also auto-clears old APKs each time the Update Settings screen is opened, keeping storage use minimal.

​
Installing a Specific Version Manually

If you prefer to install a particular release manually rather than using the built-in updater:
1

Open GitHub Releases

Visit https://github.com/vivizzz007/vivi-music/releases in a browser.
2

Choose the release and build variant

Each release lists multiple APK assets. Choose the one that matches your device architecture and preferred variant:
  • app-universal-foss-release.apk — works on all devices, no Google Play Services required
  • app-arm64-gms-release.apk — 64-bit ARM with Google Cast support
  • Other per-ABI variants: armeabi, x86, x86_64
3

Download and sideload the APK

Download the chosen APK, enable “Install from unknown sources” for your browser or file manager if prompted, and open the file to install it.

​
Notification Permissions

The OTA updater can send a notification when a new version is available. To configure this:
  1. Go to Settings > Update > Notification Settings.
  2. The item shows “Enabled” or “Disabled” based on both the system notification permission (Android 13+ requires explicit permission) and the in-app notifications toggle (EnableNotificationsKey).
  3. Tap the item to navigate to the notification permission flow and grant or revoke the permission.

Build docs developers (and LLMs) love

Get started for freeTalk to us