Skip to content

Frequently Asked Questions (FAQ)

Jump to bottom
Andreas edited this page Mar 22, 2023 · 12 revisions

Songs

Where can I find more songs?

  • The wiki names some sources for songs: https://github.com/UltraStar-Deluxe/Play/wiki/Songs#finding-songs

    • However, usually some effort is required to get these working.

  • UltraStar Play by default is distributed without any audio/video/lyrics content. We only develop the software, not the content.

    • Third parties can create and distribute content. For example, third parties may sell song packages for their region according to license requirements.
    • For development and testing, we use either self-made content or Creative Commons licensed content. This is what you typically see in published screenshots of the game.

The file format is open and very easily structured, so that creating custom content is easy and fast. This is why some similar games also support this file format.

How to add songs?

  • An UltraStar song consists of at least
    • (a) an audio file
    • (b) a txt file (plain text file) with information about the song (audio file, artist, title, lyrics, notes, etc.)
    • other files are optional (cover image, background video, etc.)
  • If you have all files of an UltraStar song, you can
    • add a new song folder in the settings that points to your UltraStar song
    • or add your UltraStar song to an existing song folder
  • You can create the txt file for a new UltraStar song using the integrated song editor of UltraStar Play.

Is there a database to download new songs?

  • There is no official song service yet for UltraStar songs due to copyright issues.

Can I share songs?

  • There is no official platform to share UltraStar songs due to copyright issues.

Can I use songs from YouTube?

  • No, not directly. YouTube does not allow to use their content this way. And Unity does not support streaming from YouTube directly.

Platforms

How to install it on iOS / iPhone / iPad?

Does it run on Raspberry Pi?

  • No, there is no dedicated binary for Raspberry Pi because Unity does not support this platform.
  • However, someone successfully installed Android on Raspberry Pi to run UltraStar Play.
    • See #356 "installed LineageOS from KonstaKANG on the Raspberry Pi and installed the Android version of UltraStar Play."

Configuration

How to assign different channels of a recording device to different players?

  • This is not possible at the moment because of Unity API restrictions.
    • However, the PortAudio library could be used to solve this issue on desktop platforms, for details see #85
  • However, you can configure as many mics as you have devices. For example, from a headset, USB microphone, or smartphone.

How to use SingStar Wireless Microphones?

  • At the moment it is only possible to use one of the mics due to a limitation of the Unity game engine.
    • Unity does not allow to record different channels of a device (see above), which is needed for the SingStar Wireless microphones.
  • However, you can configure as many mics as you have devices. For example, from a headset, USB microphone, or smartphone.

Contribution

Is there are a way to support your work with a donation or another way?

  • Yes, see the GitHub Sponsors page of the developer who does (by far!) most of the work.

Is there a guide how to import the project into Unity?

Why UltraStar Play? How is it different from UltraStar Deluxe (USDX)?

  • UltraStar Play builds on the Unity game engine. This new technological base has several advantages compared to USDX.

    • The technical advantage and platform support of USPlay can make it evolve and grow faster compared to USDX and its forks. Thus, the future will be USPlay, it's just a matter of time.
    • People got sick of having to fix the tools for building USDX every time there is some new Mac/Linux/Windows version, even having to submit fixes to the freepascal compiler a couple of times, and also having to deal with the objective pascal language. Eventually people wanted to start a new project for implementing a sing-along karaoke game that competes with the existing games and hopefully turns out better than them.

  • USDX and USPlay are two separate games with different goals.

    • The goal for UltraStar Play was never to implement all features that are supported by UltraStar Deluxe. USDX has a bit of feature creep and is not easy to do microphone configuration and so on. There is no need to copy that into UltraStar Play, which has more of a focus on typical gaming consoles, smartphones, smart TVs and similar platforms.

Why Melody Mania? How is it different from UltraStar Play?

  • Melody Mania is a commercial fork of UltraStar Play to finance further developments.
  • Melody Mania includes additional features and assets, some of which cannot be made available under MIT license. For example, it includes assets from the Unity Asset Store.
  • The name Melody Mania was chosen because sadly the name UltraStar Play could not be used due to legal (brand) reasons.

Known Issues

Visit the wiki page for Known Issues

Did you found what you're looking for? If you still got questions look into ❔Common FAQ or go to 💬UltraStar Play Discord. There is also a 👋🏻central help desk of UltraStar/Vocaluxe/Performous-Community on Discord.

👋🏻 Getting Started

📘 User Documentation

⚙️ Development

Clone this wiki locally