UltraStar Deluxe

Official Project Website: https://usdx.eu/

1. About

UltraStar Deluxe (USDX) is a free and open source karaoke game. It allows up to six players to sing along with music using microphones in order to score points, depending on the pitch of the voice and the rhythm of singing. UltraStar Deluxe is a fork of the original UltraStar (developed by corvus5). Many features have been added like party mode, theme support and support for more audio and video formats. The improved stability and code quality of USDX enabled ports to Linux and Mac OS X.

2. Installation

Currently, the following installation channels are offered:

• installer (or portable version) for the latest release
• flatpak from flathub
• Arch Linux AUR

3. Configuration

• To set additional song directories change your config.ini like this:

  [Directories]
  SongDir1=C:\Users\My\Music\MyUSDXSongs
  SongDir2=F:\EvenMoreUSDXSongs
  SongDir...=... (some more directories)

• To enable joypad support change config.ini Joypad=Off to Joypad=On
• To enable 2 or 3 player each on 2 screens, disable the full screen mode, extend your desktop horizontally and set the resolution to fill one screen. Then, in the config.ini set Screens=2 and restart the game.
• The primary folder for songs on OS X is $HOME/Music/UltraStar Deluxe, which is created when UltraStar Deluxe is run for the first time.
• On OS X, by default the config.ini file is created in $HOME/Library/Application Support/UltraStarDeluxe when UltraStar Deluxe is run for the first time.

4. Command-Line Parameters

See https://github.com/UltraStar-Deluxe/USDX/wiki/Command-Line-Parameters

5. Controls

See https://github.com/UltraStar-Deluxe/USDX/wiki/Controls

6. Compiling

There are two main ways to compile the game:

1. Lazarus IDE
2. ./autogen.sh && ./configure && make

The executable will be game/ultrastardx[.exe].

For extended information, dependencies, OS-specific notes and configure flags, see COMPILING.md.

7. Making a release

See RELEASING.md