McSchneidar
48ffe4ccd5
* Add check for VC++ 2015-2022 * Remove Windows Vista * Remove Windows Vista * Add check for VC++ 2015-2022 * Add check for VC++ 2015-2022
187 lines
8.6 KiB
Plaintext
187 lines
8.6 KiB
Plaintext
Vocaluxe 0.4.1 README
|
||
----------------------------
|
||
|
||
=================================
|
||
= 1. About =
|
||
= 2. Release Notes =
|
||
= 3. Command-Line Parameters =
|
||
= 4. Controls =
|
||
= 5. Help & Support =
|
||
= 6. Source Code =
|
||
=================================
|
||
|
||
|
||
=================================
|
||
= 1. About =
|
||
=================================
|
||
|
||
Vocaluxe is a free and open source singing game. It allows up to three players (currently) to sing
|
||
along with music using microphones in order to score points, depending on the pitch of the voice
|
||
and the rhythm of singing.
|
||
|
||
Vocaluxe is an entirely new development in C#, inspired by the original UltraStar (developed by corvus5)
|
||
and the great Ultrastar Deluxe project.
|
||
|
||
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 additionally require VC++ 2015–2022)
|
||
|
||
|
||
=================================
|
||
= 2. Release Notes =
|
||
=================================
|
||
|
||
- The program supports 32bit and 64bit (appropriate download package) operating systems.
|
||
|
||
- When using installer, you can find all mentioned folder in 'Documents/Vocaluxe', otherwise
|
||
they should be created just next to 'Vocaluxe.exe'
|
||
|
||
- To add your existing song collection to Vocaluxe, put your songs into the 'Songs' subfolder.
|
||
|
||
Alternatively, you can add multiple song paths to Vocaluxe by editing your Config.xml:
|
||
|
||
<Game>
|
||
<!--SongFolder: Add each song folder in a seperate SongFolder entry-->
|
||
<SongFolder>C:\Vocaluxe\Songs</SongFolder>
|
||
<SongFolder>D:\EvenMore\Songs</SongFolder>
|
||
|
||
- To use your highscore database from UltraStar deluxe 1.0.1, UltraStar deluxe CMD Mod or
|
||
UltraStar deluxe 1.1, simply copy your Ultrastar.db (rename if necessary) into the main
|
||
directory. Your highscore database will be imported into the HighscoreDB.sqlite file when
|
||
Vocaluxe is started. Upon successful import, the old database is deleted.
|
||
|
||
- To add your own player avatars, simply add some picture files to the 'Profiles' subfolder.
|
||
Supported file types: png, jpg (jpeg), bmp.
|
||
Images should have square proportions, e.g. 400x400 px.
|
||
|
||
- You can use your WebCam to take profile pictures in the profile screen. Activate your camera
|
||
before you start the program. If Vocaluxe detects the camera a button "Webcam" appears in the
|
||
profile screen.
|
||
|
||
- Vocaluxe supports the Wiimotion remote control from Nintendo. Connect it with your bluetooth
|
||
connection manager and start Vocaluxe. If a Wiimote is recognized it will perform two short rumbles
|
||
and the third LED will lighten up.
|
||
If you have troubles to connect the Wiimote try this:
|
||
|
||
1. First connect the Wiimote normally but pressing 1+2 and let the bluetooth manager detect it.
|
||
2. Connect (a pin or password is not needed).
|
||
3. Disconnect.
|
||
4. Press 1+2 Again but DO NOT DO ANYTHING ELSE. Let the WIIMOTE blink, until it times out (stops blinking.)
|
||
5. THEN click connect in the bluetooth settings, when it says looking for device PRESS A or + or Z
|
||
(it doesn't matter), just get the thing to blink. (Just don't hit 1+2 or the Sync button, this resets
|
||
the sync info.)
|
||
It will then connect.
|
||
|
||
|
||
=================================
|
||
= 3. Command-Line Parameters =
|
||
=================================
|
||
The following command-line parameters may be passed to the game when starting it through a shortcut
|
||
or from the console:
|
||
|
||
-ConfigFile [Path\File]: Use [Path\File] as configuration file instead of Config.xml in the main folder.
|
||
The path to the file has to exist and needs to be an absolute path.
|
||
If only a filename is specified, the file is assumed to be in the current directory.
|
||
Examples: Vocaluxe.exe -ConfigFile MyConfig.xml
|
||
Vocaluxe.exe -ConfigFile C:\Vocaluxe\Configs\MyConfig.xml
|
||
|
||
-ScoreFile [Path\File] : Use [File] as score database instead of HighscoreDB.sqlite in the application's
|
||
main folder. The path to the file has to exist and needs to be an absolute path.
|
||
If only a filename is specified, the file is assumed to be in the current directory.
|
||
Examples: Vocaluxe.exe -ScoreFile MyHighscoreDB.sqlite
|
||
Vocaluxe.exe -Scorefile C:\Vocaluxe\Highscores\MyHighscoreDB.sqlite
|
||
|
||
-SongFolder [Path] : Use [Path] as song folder. The path has to exist and needs to be an absolute path.
|
||
Note that any song folders set in the config file will be ignored.
|
||
This parameter may be used multiple times to use different song folders.
|
||
Examples: Vocaluxe.exe -SongFolder D:\MySongCollection
|
||
Vocaluxe.exe -SongFolder D:\MySongCollection -SongFolder E:\MoreSongs
|
||
|
||
-SongPath [Path] : Deprecated, see SongFolder [Path]. This alias is provided for convenience.
|
||
|
||
-PlaylistFolder [Path] : Use [Path] as playlist folder. The path needs to be an absolute path. Vocaluxe will
|
||
load playlist from this path.
|
||
Example:
|
||
Vocaluxe.exe -PlaylistFolder D:\MyPlaylists
|
||
|
||
Complete example:
|
||
Vocaluxe.exe -ConfigFile MyConfig.xml -ScoreFile C:\Vocaluxe\Highscores\MyHighscoreDB.sqlite -SongFolder D:\MySongCollection -PlaylistFolder D:\MyPlaylists
|
||
|
||
|
||
=================================
|
||
= 4. Controls =
|
||
=================================
|
||
[Mouse] to navigate through the screens: Left button: select/manipulate elements,
|
||
Right button: go to previous screen.
|
||
[Cursor] to navigate through the screens.
|
||
[Enter] to confirm
|
||
[Escape] or [Back] to go to the previous screen.
|
||
|
||
[ALT] + [P] to take a ScreenShot. Screenshots are saved in the directory "Screenshots".
|
||
[ALT] + [ENTER] to toggle full screen mode.
|
||
[SHIFT] + [F1] to toggle theme edit mode. The theme edit mode is experimental. It allows you
|
||
to change the size and position of the element on the screens. You can save
|
||
your changes with [S] before leaving the theme edit mode.
|
||
[TAB] to open the background music controls (not on all screens).
|
||
[SHIFT] + [+] to increase volume
|
||
[SHIFT] + [-] to decrease volume
|
||
|
||
Song screen
|
||
[F3] to open/close the song search menu
|
||
[SPACE] to open/close the song menu
|
||
[TAB] to switch selection of song menu and playlist (if opened)
|
||
[CTRL] + [H] to show the highscore of the selected song
|
||
[CTRL] + [T] to toggle category / tabs view
|
||
[CTRL] + [1]..[0] to change the song sorting (just changed for runtime, not saved!), in order from keys 1 to 0:
|
||
folder, artist, artist by letter, title by letter, edition, genre, language, year, decade, date added
|
||
[CTRL] + [R] to select a random song
|
||
[CTRL] + [A] to sing all songs
|
||
[CTRL] + [S] to sing current song in medley version
|
||
[CTRL] + [V] to sing all songs from a category
|
||
[CTRL] + [L] to filter the song list to the current displayed playlist. Press again to remove this filter.
|
||
[NUM_1]..[NUM_6] to use a Joker for team 1..6
|
||
[A]..[Z] to jump to category/song title starting with that letters (multiple letters possible)
|
||
[PAGE UP] or [PAGE DOWN] to scroll one page up/down
|
||
[CTRL] + [PAGE UP or DOWN] to go inside next or previous category while being in a category
|
||
[HOME] or [END] to scroll up to first song or down to last song
|
||
|
||
Name selection screen
|
||
[1]..[6] to activate player selection.
|
||
[P] to activate fast player selection
|
||
[+] or [-] to increase/decrease number of player
|
||
[Cursor] to select a profile.
|
||
[Enter] to confirm a selection.
|
||
|
||
Sing screen
|
||
[P] to toggle pause.
|
||
[CTRL] + [S] to skip a song if there is another one in the playlist.
|
||
[SHIFT] + [RIGHT] to skip 10 seconds within the playing song (not in party modes).
|
||
[CTRL] + [RIGHT] to skip 30 seconds within the playing song (not in party modes).
|
||
[T] to change the time format of the timer.
|
||
[I] to change view of player information.
|
||
[W] to activate the configured webcam.
|
||
[V] to change video aspect ratio
|
||
|
||
Score and highscore screen
|
||
[LEFT] or [RIGHT] to show (high)scores of another round (if there is more than one)
|
||
if opened from song list screen: Switch between game modes (Normal, Medley, Duet, Short)
|
||
|
||
|
||
=================================
|
||
= 5. Help & Suppport =
|
||
=================================
|
||
Vocaluxe Homepage: https://vocaluxe.org
|
||
Bug Tracker: https://github.com/Vocaluxe/Vocaluxe/issues
|
||
Translations: https://www.transifex.com/projects/p/vocaluxe/
|
||
GitHub Wiki: https://github.com/Vocaluxe/Vocaluxe/wiki
|
||
Song-DataBase (USDB): http://usdb.animux.de/
|
||
|
||
|
||
=================================
|
||
= 6. Source Code =
|
||
=================================
|
||
Source Code (GitHub): https://github.com/Vocaluxe/Vocaluxe
|
||
SF.Net Page (outdated): http://sourceforge.net/projects/vocaluxe/
|