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>
93 lines
3.3 KiB
C#
93 lines
3.3 KiB
C#
#region license
|
|
// This file is part of Vocaluxe.
|
|
//
|
|
// Vocaluxe is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Vocaluxe is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Vocaluxe. If not, see <http://www.gnu.org/licenses/>.
|
|
#endregion
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using VocaluxeWeb.Remote;
|
|
|
|
namespace VocaluxeWeb
|
|
{
|
|
/// The only view the webserver has on the game. Implemented by Vocaluxe.
|
|
/// Methods marked as main-thread-only must be called through <see cref="Dispatching.CMainThreadDispatcher" />.
|
|
public interface IVocaluxeRemote
|
|
{
|
|
/// Full version text of the running Vocaluxe. Thread-safe.
|
|
string Version { get; }
|
|
|
|
/// False while the game is still loading (songs, playlists). Main thread only.
|
|
bool IsReady { get; }
|
|
|
|
/// Current state of the game. Main thread only.
|
|
RemoteState GetState();
|
|
|
|
#region profiles
|
|
/// All profiles, sorted by name. Main thread only.
|
|
IList<RemoteProfile> GetProfiles();
|
|
|
|
/// Creates a profile and returns its id. Main thread only.
|
|
Guid CreateProfile(ProfileChange change);
|
|
|
|
/// Changes the given fields of a profile. Main thread only.
|
|
void UpdateProfile(Guid profileId, ProfileChange change);
|
|
|
|
/// Deletes a profile including its file. Main thread only.
|
|
void DeleteProfile(Guid profileId);
|
|
|
|
/// Avatars that come with Vocaluxe or were put into the profile folder (not the ones uploaded with the WebApp). Main thread only.
|
|
IList<RemoteAvatar> GetAvatars();
|
|
#endregion
|
|
|
|
#region songs
|
|
/// Changes whenever songs are added or (re)loaded. Main thread only.
|
|
int SongLibraryVersion { get; }
|
|
|
|
/// All songs. Main thread only.
|
|
IList<RemoteSong> GetSongs();
|
|
#endregion
|
|
|
|
#region playlists
|
|
/// All playlists with their songs. Main thread only.
|
|
IList<RemotePlaylist> GetPlaylists();
|
|
|
|
/// Creates an empty playlist and returns its id. Main thread only.
|
|
int CreatePlaylist(string name);
|
|
|
|
/// Main thread only.
|
|
void RenamePlaylist(int playlistId, string name);
|
|
|
|
/// Main thread only.
|
|
void DeletePlaylist(int playlistId);
|
|
|
|
/// Replaces all songs of a playlist and saves it. Main thread only.
|
|
void SetPlaylistEntries(int playlistId, IList<RemotePlaylistEntry> entries);
|
|
#endregion
|
|
|
|
#region game
|
|
/// Starts singing a song with the given players (skipping the player selection if possible). Main thread only.
|
|
ERemoteStartResult StartSong(RemoteStartRequest request);
|
|
#endregion
|
|
|
|
#region input
|
|
/// Sends a key press to the game as if it came from a keyboard. Thread-safe.
|
|
void SendKey(ERemoteKey key);
|
|
|
|
/// Types text into the game. Thread-safe.
|
|
void SendText(string text);
|
|
#endregion
|
|
}
|
|
}
|