Download and Install UltraStar Play

Download the latest version for your operating system from here.

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

Installation - Windows

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

Installation - Linux

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

Installation - MacOS

• 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
    

Installation - Android

• 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)

Installation - iOS

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.

Download and Build from Source Code

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

Install Unity

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

Clone the Git Repository

• 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

Download Dependencies

• Run the tools/setup.sh shell script
  • Run the script from the tools folder. The script uses relative paths, which are messed up when run from another folder.
  • Call the script as sh setup.sh.
  • If you are on Windows, you can run this script from git-bash or a similar Unix shell emulation (e.g. Cygwin, Cmder, ...).
    • Note that git-bash is installed as part of GitForWindows
  • This script will create files in UltraStar Play/Assets/Plugins respectively UltraStar Play Companion/Assets/Plugins

Build and Run

• Start the Unity editor and open the UltraStar Play or UltraStar Play Companion project
• Open the main scene Assets/Scene/Main/MainScene.unity
  • If you do not have any scene open then the build may fail with an error message such as No TranslationManager found. Not creating properties file constants.
• Open File > Build Settings. In the dialog that opens, select the desired target platform and click Build and Run.

System Requirements

• 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.)