Merge pull request #294 from Vocaluxe/update_Readme
Update readme for new release
This commit is contained in:
Florian Küpper authored and GitHub committed
commit
6fbe545d32
3 files changed
+51
-24
No files matched your search
+28
-13
@@ -1,4 +1,4 @@
|
||||
Vocaluxe 0.3 README
|
||||
Vocaluxe 0.4 README
|
||||
----------------------------
|
||||
|
||||
=================================
|
||||
@@ -23,25 +23,29 @@ Vocaluxe is an entirely new development in C#, inspired by the original UltraSta
|
||||
and the great Ultrastar Deluxe project.
|
||||
|
||||
Supported Operating Systems / Requirements:
|
||||
- WinXP, Vista, Windows 7 or Windows 8 with .NET 4.0
|
||||
- Windows Vista, Windows 7, Windows 8 or 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 Packages 2008 and 2012
|
||||
- Visual C++ Redistributable Package 2010
|
||||
|
||||
|
||||
=================================
|
||||
= 2. Release Notes =
|
||||
=================================
|
||||
|
||||
- The program supports 32bit and 64bit (Vocaluxe_x64.exe) operating systems.
|
||||
- The program supports 32bit and 64bit (appropriate download package) operating systems.
|
||||
|
||||
- To add your existing song collection to Vocaluxe, put your songs into the 'Songs' subfolder.
|
||||
- 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: SongFolder1, SongFolder2, SongFolder3, ...-->
|
||||
<SongFolder1>C:\Vocaluxe\Songs</SongFolder1>
|
||||
<SongFolder2>D:\EvenMore\Songs</SongFolder2>
|
||||
<!--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
|
||||
@@ -101,6 +105,8 @@ or from the console:
|
||||
load playlist from this path.
|
||||
Example:
|
||||
Vocaluxe.exe -PlaylistFolder D:\MyPlaylists
|
||||
|
||||
-OldTheme yes : Try to load theme that is created for vocaluxe 0.2 or older (or some pre-release version of 0.3). Enter theme editor and save your theme to convert every file to new syntax. This will be removed in a future version.
|
||||
|
||||
|
||||
Complete example:
|
||||
@@ -128,14 +134,18 @@ Vocaluxe.exe -ConfigFile MyConfig.xml -ScoreFile C:\Vocaluxe\Highscores\MyHighsc
|
||||
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] + [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
|
||||
[NUM_1]..[NUM_6] to use a Joker for team 1..6
|
||||
[A]..[Z] to jump to category/song title starting with that letter
|
||||
|
||||
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.
|
||||
|
||||
@@ -145,20 +155,25 @@ Sing screen
|
||||
[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)
|
||||
|
||||
|
||||
=================================
|
||||
= 5. Help & Suppport =
|
||||
=================================
|
||||
Bug Tracker: http://84.200.73.138/redmine/projects/vocaluxe
|
||||
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
|
||||
Support Forum (German): http://www.ultra-star.de
|
||||
Song-DataBase (USDB): http://usdb.animux.de/
|
||||
Support Forum (German): http://www.ultra-star.de
|
||||
Song-DataBase (USDB): http://usdb.animux.de/
|
||||
|
||||
|
||||
=================================
|
||||
= 6. Source Code =
|
||||
=================================
|
||||
Source Code (GitHub): https://github.com/Vocaluxe/Vocaluxe
|
||||
SF.Net Page: http://sourceforge.net/projects/vocaluxe/
|
||||
Source Code (GitHub): https://github.com/Vocaluxe/Vocaluxe
|
||||
SF.Net Page (outdated): http://sourceforge.net/projects/vocaluxe/
|
||||
@@ -1,4 +1,11 @@
|
||||
|
||||
|
||||
|
||||
[](https://ci.appveyor.com/project/VocaluxeBuildBot/vocaluxe/branch/develop)
|
||||
[](https://vocaluxe.org/#download)
|
||||
[](https://vocaluxe.org/#download)
|
||||
[](https://github.com/Vocaluxe/Vocaluxe/labels/bug)
|
||||
[](https://github.com/Vocaluxe/Vocaluxe/labels/feature%20request)
|
||||
[](https://github.com/Vocaluxe/Vocaluxe/blob/develop/LICENSE.txt)
|
||||
|
||||
[1. About](#1-about)
|
||||
[2. Download](#2-download)
|
||||
@@ -12,17 +19,15 @@ It features mouse, keyboard, gamepad and Wiimote navigation, a multi-language in
|
||||
Vocaluxe offers diversified party modes and can optionally be controlled via a browser (desktop and mobile supported).
|
||||
|
||||
Supported Operating Systems / Requirements:
|
||||
- WinXP, Vista, Windows 7, Windows 8, Windows 8.1 and Windows 10 with .NET 4.0
|
||||
- Linux (tested on Arch Linux)
|
||||
- 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:
|
||||
http://vocaluxe.sourceforge.net/index.php?p=download
|
||||
|
||||
Nightly builds are available here:
|
||||
https://github.com/Vocaluxe/Vocaluxe/releases
|
||||
https://vocaluxe.org/#download
|
||||
|
||||
## 3. Contributing
|
||||
You want to fix a bug or add a cool new feature to Vocaluxe? Awesome!
|
||||
@@ -43,6 +48,7 @@ You have a problem or a question implementing your change?
|
||||
Just [open an issue](https://github.com/Vocaluxe/Vocaluxe/issues/new) 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/
|
||||
|
||||
@@ -88,18 +88,24 @@
|
||||
- Spectrum Analyzer (Record Screen and Player Selection Screen)
|
||||
- WiiMote Support
|
||||
|
||||
+ v0.3.0 Shining Heaven (reached: ??.0?.2013):
|
||||
+ v0.3.0 Shining Heaven (release skipped):
|
||||
- Party Mode Support
|
||||
- Party Mode: Challenge Mode (with more than 2 player at once)
|
||||
- Party Mode: Challenge Medley Mode
|
||||
- Party Mode: Tic, Tac, Toe
|
||||
- GStreamer Audio Support
|
||||
- Smartphone control (webserver)
|
||||
- Dynamic cover generation
|
||||
- New Song View: List
|
||||
|
||||
+ v0.4.0 (reached: ??.??.201?):
|
||||
+ v0.4.0 Blue Sunrise (reached: ??.??.201?):
|
||||
- A lot of restructered and rewritten lines of code
|
||||
- Some minor and bigger improvements and additions
|
||||
- Updated audio and video libs
|
||||
- New infrastructure: CI with nightly builds, new homepage, updated installer
|
||||
|
||||
-----------------
|
||||
just some ideas:
|
||||
- Installer
|
||||
- More Song List Views
|
||||
- Tile Board: Show title and artist under each tile
|
||||
- OnScreen Keyboard?
|
||||
@@ -121,4 +127,4 @@ some feature wishes:
|
||||
|
||||
- Party Modes:
|
||||
* add sing modes: hide notes, hide lyrics, ...
|
||||
* add a party mode where you can assign song categories and/or playlists to the profiles
|
||||
* add a party mode where you can assign song categories and/or playlists to the profiles
|
||||
Reference in new issue
Block a user