McSchneidarandFlorian Ostertag
336d08040e
* Replace the WCF webserver with an ASP.NET Core webserver (VocaluxeWeb) - New project VocaluxeWeb: ASP.NET Core 2.3 (Kestrel) on .NET Framework 4.8.1, HTTP or HTTPS with a self-signed certificate, REST API (/api/v1) with Swagger, live events (Server-Sent Events) - Access to the game only through IVocaluxeRemote; requests run on the main thread once per frame - Sessions with roles (guest, player, admin) and configurable permissions, PINs hashed with PBKDF2 - Queue as a playlist with requesters and singers, fair order (one song per person and round) - Admin: settings, server status, logged-in devices, activate/deactivate and delete profiles - Profile pictures: own photo or one of the Vocaluxe avatars - Game: WebApp queue screen (song options, playlist group) to start the next song with the chosen singers, return to it after singing, warning when the webserver is off, remote keyboard - Old WCF server, WebserverInitalConfig and URL reservations removed; libraries moved to libs/managed - Unit tests for PIN hashing, settings and permissions, queue order and device names - AppVeyor: Visual Studio 2022 image and Node.js 24 (the build compiles the WebApp) - Documentation in VocaluxeWeb/README.md * New WebApp (Vue 3, TypeScript, Vite) replacing the old jQuery Mobile website - Login with profile and PIN, create profiles - Songs with search, filters, sorting and 30 second previews - Queue: add songs with game mode, audio and singers, edit, reorder, start in the game - Playlists: create, edit, add to the queue - Now playing with live updates, remote control and keyboard - Players: own profile with picture (photo or Vocaluxe avatar), roles for admins - Admin settings: permissions, server status, devices, profiles - Help page, responsive layout for phones, tablets and desktops, light and dark mode - Texts in WebApp/src/locales/en.json, translated with Transifex - Old website and PhoneGap config removed --------- Co-authored-by: Florian Ostertag <flokuep@users.noreply.github.com>
3.7 KiB
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 7, Windows 8, Windows 8.1, Windows 10 and Windows 11 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
Nightly Builds:
- Windows 10 (version 20H2 or later) and Windows 11 with .NET Framework 4.8.1
- Visual C++ Redistributable 2015–2022
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! Check out milestones or our Game Design Document!
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)
The WebApp and the webserver (build with Node.js, development, REST API, translations) are described in VocaluxeWeb/README.md.
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
General FAQ: https://www.open-music-games.org/help/frequently-asked-questions Discord Help Desk: https://discord.gg/tNEXZw2QJX 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/ Song-Database (USDB): http://usdb.animux.de/