UltraStar Play Development README

1. About

UltraStar Play is a free and open source karaoke singing game for Windows, Linux, Android, Xbox, PlayStation and other modern platforms. The game plays the audio file, displays singing lyrics, notes and optionally a background video or picture, while the singers sing the songs and thus try to hit the notes to get points depending on how close they get to the perfect pitches. The game uses the Unity 2D framework and mostly c# (mono/.Net) as software development language.

2. Minimal Game Requirements

• Windows 7 SP1+, macOS 10.12+, Ubuntu 16.04+
• Graphics card with DX10 (shader model 4.0) capabilities.
• iOS player requires iOS 9.0 or higher.
• Android: OS 4.1 or later; ARMv7 CPU with NEON support or Atom CPU; OpenGL ES 2.0 or later.
• Speakers, USB microphones (or similar)

3. Development Requirements

• See Unity system requirements
• Plenty of free time

4. Documentation

• See the project wiki

5. How to contribute

• See CONTRIBUTING.md and also How to Compile the Game
• See How to Compile the Game

6. Support

• If you just want to play sing-along karaoke, please use UltraStar Deluxe or Performous or Vocaluxe instead.
• See documentation sources mentioned above
• Issue Tracker
• "The code is documentation enough" << sorry, this project just started, there will be more places for support later on