Skip to content

Latest commit

 

History

History
56 lines (44 loc) · 3.28 KB

README.md

File metadata and controls

56 lines (44 loc) · 3.28 KB

Vocaluxe Logo

Build status Nightly build Latest stable release Known bugs Feature requests License

1. About
2. Download
3. Contributing
4. Help & Support

1. About

Vocaluxe is a free and open source singing game, inspired by the original UltraStar (developed by corvus5) and the great Ultrastar Deluxe project - yet it is an entirely new development in C#.
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. It features mouse, keyboard, gamepad and Wiimote navigation, a multi-language interface, and singer profiles with avatars and supports songs in CP1250/52 and UTF8 encodings.
Vocaluxe offers diversified party modes and can optionally be controlled via a browser (desktop and mobile supported).

Supported Operating Systems / Requirements:

  • Windows Vista, Windows 7, Windows 8, Windows 8.1 and Windows 10 with .NET 4.0
  • Linux (no official support)
  • 1 GHz CPU, 512 MB RAM, Graphics card with OpenGL 2.1 or DirectX 9.0 support
  • Visual C++ Redistributable Package 2010

2. Download

You can download precompiled Windows binaries at here: https://vocaluxe.org/#download

3. Contributing

You want to fix a bug or add a cool new feature to Vocaluxe? Awesome!

Build Vocaluxe

Building Vocaluxe is easy:
Just follow the guide on our wiki to clone the repository and create your own Vocaluxe build:
Build Vocaluxe (Windows)

Submit your change

Upload your changes to your fork and open a new pull request.

The development of Vocaluxe uses this git branching model:
http://nvie.com/posts/a-successful-git-branching-model/

Questions

You have a problem or a question implementing your change?
Just open an issue or mention @Vocaluxe in a comment on GitHub.

4. Help & Support

Vocaluxe Homepage: https://vocaluxe.org/
GitHub Wiki: https://github.com/Vocaluxe/Vocaluxe/wiki
GitHub Issues Tracker: https://github.com/Vocaluxe/Vocaluxe/issues
Translations: https://www.transifex.com/projects/p/vocaluxe/
Support Forum (German): http://www.ultra-star.de
Song-Database (USDB): http://usdb.animux.de/