Getting started

Welcome to the OuterTune wiki!

This is the first page, where you'll learn how to download and setup Outertune. You can always ask for help through my email (which will be included below) if you have any questions.

How to download

There are two primary ways to get the app. The first, which is for most people, is to simply download the .apk file from the repository. This is the simplest, and you can either click on the release button in the README file, or go to the Releases page (which is on the right for desktop, and right on the bottom for mobile. Once you click on the Releases page, scroll down to assets, and you will see three things which you can download. Click on the second one (which should be OuterTune-0.xx-core-universal-release-xx.apk). If you want to save space, then you can download the other .apk (which is for most mobile devices running an ARM64 (or AArch64 Architecture) chipset. Most if not all modern phones run this so it should be okay. The download should be around 10MB. Anything much larger than that, or much smaller, is NOT the .apk (the smallest .apk for this release is around 7-8MB). Make sure to download the latest release when updating (Latest should be in a green oval beside the name of the version). If you have a later build (NOT version, build, like release-xx is the build, so if you build is say 90, you CANNOT install an older version. You must create a backup and then uninstall the app, then install the older version. Your downloaded songs will NOT be part of the backup, so you will lose them and be required to redownload.

The second way, which is a lot harder, and is only for people who want to test out the absolute latest release, is to build the .apk yourself. This involves forking the repository, then going to the actions tab, clicking on the build patched APKs workflow and then keying in the parameters yourself. It is preferred to use the corerelease flavour, as the fullrelease flavour is signficantly larger (around 50MB) largely because of a .aar file which allows the app to parse and play more obscure audio tracks. If you use it as a YTM frontend or only play the normal files like mp3, flac and the other normal files, this is completely unnecessary. You can set the version NAME to anything you want, but the version code has to be higher than the one you're currently using. Once you've configured it, run workflow and then wait for the workflow to generate the .zip folder of the APKs, then download them and install the one you want.

Installation

Once you have your .apk, all you have to do is to install it. You can click on the .apk and install it. If you get a prompt which asks if you want to install from unknown sources, allow it but it is recommended to disable this feature afterwards in case you accidentally download a malicious app. There may be extra steps if Google Play Store wants to scan the app, and you will have to authorise it every time you install a new apk as an update, but I'm working on a fix. If you run into any problems, you can always ask the internet, any AI model, or email me for help. Note: For the older releases (earlier than v0.10.15) you will have to uninstall and reinstall the APK every time, as I had not configured the signing key yet.