Download the latest version for your operating system from here.

Expand the "Assets" section at the bottom of the release if needed.

Unzip the archive and start UltraStar Play.exe — no further installation needed.

Unzip the archive and start the UltraStar Play executable — no further installation needed.

• Unzip the archive and execute the UltraStar Play.app file.
• There is a known issue (#249, #256) with file permissions on some MacOS versions.
  • To fix it, run the following commands from a terminal (change UltraStarPlay-v0.9.0-macOS.app as needed):

    chmod +x UltraStarPlay-v0.9.0-macOS.app
    chmod +x UltraStarPlay-v0.9.0-macOS.app/Contents/MacOS/UltraStar\ Play
    xattr -dr com.apple.quarantine UltraStarPlay-v0.9.0-macOS.app
    

• The app is available as open test release on the Google Play Store:

  • UltraStar Play: https://play.google.com/store/apps/details?id=com.ultrastar.UltraStarPlay
  • Companion App: https://play.google.com/store/apps/details?id=com.ultrastar.UltraStarPlayCompanion
  • Note that the apps can not yet be found by searching the Google Play store because it is a test release. Thus, you need to directly open the link to the app.

• As alternative to Google Play,

  • download the apk file from the release page
  • then open the downloaded apk file from your browser app or file system app to install it
  • If prompted, allow permissions to
    • (a) install software from unkown sources
    • (b) install software from your current app (typically your browser app or file system app)

Sadly, installing the pre-release app for iOS is not as easy as it is on other platforms. You can try one of the following solutions:

• Sideloadly: Available for Windows and MacOS. Some users say that this is the easiest solution for iOS (#311).
• Apple Configurator: Available for MacOS. Can be used to install apps on iPhone, iPad, etc.
• Build the project from source (see below) and upload it to your connected device. Note that the iOS build requires MacOS and additional compilation steps after the Unity build has finished.

Follow these steps to compile and run the Unity project from source code:

• Install Unity.
  • The required version can be found here.
  • Select an IDE (e.g. Visual Studio Code or Visual Studio)

• Install Git
  • On Windows, GitForWindows is recommended
  • You may also want to install a Git client, for example Github Desktop
• Clone the UltraStar Play Git repository: git clone https://github.com/UltraStar-Deluxe/Play.git

• Run the build.sh (Linux / macOS) respectively build.ps1 (Windows) script
  • Run the script from the project root folder. The script uses relative paths, which are messed up when started from another folder.
  • Call the script with --help to see available targets and options (e.g. ./build.sh --help).
  • The build uses Nuke build tool under the hood. It requires dotnet to be installed.
  • The location of the installation of the unity editor may vary and may need to be overridden. The install path can be displayed in the Unity Hub on the Install Page and can be passed to the build script using --unity-executable <path> (e.g. ./build.sh --unity-executable '/home/user/Unity/Hub/Editor/6000.1.0f1/Editor/Unity')
• First, restore dependencis
  • Main Game: build.sh RestoreMainGameDependencies
  • Companion App: build.sh RestoreCompanionAppDependencies
• Second, build the project. Note that the command depends on the target platform (Windows, Linux, Android, etc.)
  • Main Game for Windows: build.sh BuildMainGameWindows64
  • Companion App for Android: build.sh BuildCompanionAppAndroidApk

• After restoring dependencies (see above), you can open the projects in Unity editor.
  • Select the UltraStar Play respectively UltraStar Play Companion folder.
  • Open the main scene Assets/Scene/Main/MainScene.unity
• You can build the project from within the Unity editor.
  • Menu items have been prepared for this, e.g., Tools > Build > Windows64.

• Windows 7 SP1+, macOS 10.13+, Ubuntu 18.04+, Android 4.4 (API 19)+, iOS 12+
  • For more details, see the Unity documentation
• Speakers and microphones (e.g. headset, USB mic, UltraStar Play Companion App, WO Mic, etc.)