performous(6)
NAME
performous - The free karaoke game
DESCRIPTION
Performous is a free cross-platform clone of the Playstation 2 game
Singstar.
While Performous might be classified as a karaoke program, it is actually much more than that. Instead of just displaying the lyrics, notes
are also displayed and the performance is scored based on how well you
hit the notes and you can see your own singing pitch on screen.
Performous was previously known as UltraStar Next Generation (USNG)
because it supports the UltraStar song format. It is not a fork of the
Delphi-based UltraStar games, as Performous is rewritten from scratch
in C++.
- If you have trouble with the program (no songs found, audio not working, etc), try running it on a terminal. Some useful debug information
is printed there.
- Generic options:
- -h [ --help ]
you are viewing it
- -v [ --version ]
display version number
- Configuration options:
- -t [ --theme ] arg
set theme (name or absolute path)
- -f [ --fs ]
enable full screen mode
- --fps benchmark rendering speed also disable 100 FPS limit
- --songlist arg
save a list of songs in the specified folder
- -W [ --width ] arg
set horizontal resolution
- -H [ --height ] arg
set vertical resolution
- --fs-width arg
set fullscreen horizontal resolution
- --fs-height arg
set fullscreen vertical resolution
- --michelp
detailed help for --mics and a list of available audio devices
- --mics arg
specify microphones to use
- --pdevhelp
detailed help for --pdev and a list of available audio devices
- --pdev arg
specify a playback device
- -s [ --songdir ] arg
additional song folders to scan may be specified without -s or -songdir too
NAVIGATION
- In-game navigation uses the following keys:
- Global shortcuts:
- Esc Exit the current screen
- Alt+Enter
Switch between full screen and windowed modes
- Main menu:
- S Sing: single player game
- P Practice: displays the tones detected and a VU meter for check
ing microphone recording levels
- C Configuration: adjust settings
- Song selection:
- Enter Pick the currently selected song
- Left/Right/PgUp/PgDn
Browse the list of songs
- Up/Down
Switch the sort order (song name, artist, edition, genre or song folder path)
- Any text
Search for songs (write the text to find, uses regexp format)
- Pause or Space
Pause song preview and automatic song switching
- Tab Randomize songs (sort them again)
- Ctrl+R Refresh song list (reload from disk)
- F4 Enter jukebox mode (play songs entirely, hide song browser,
allow seeking with Up/Down)
- Esc Exit to main menu, exit jukebox mode or quit search mode
- Singing screen:
- Left/Right/Up/Down/Home
Fast forward or rewind the song
- Enter Skip long instrumental breaks, or get the grading instantly at
the end of song.
- Pause or Space
Pause the game
- F4 Toggle synth mode (synthesized tone for notes)
- F5/F6 Adjust audio/video sync. Use if the notes pass the black line at
incorrect time.
- F7/F8 Adjust audio roundtrip latency. Use if the pitch wave does not
match the notes, when you match your timing to what you hear.
- F9 Toggle karaoke mode (hide notes and scores)
- F10 Toggle pitch wave rendering (only when karaoke mode is disabled)
- Ctrl+R Hot reload song from disk (useful for making or repairing songs)
- Configuration:
- Left/Right/Up/Down/Enter
Modify options
- Ctrl+S Save current configuration to configuration file
AUDIO DEVICE CONFIGURATION
Performous normally autodetects microphones and playback devices correctly, but if this fails on your machine, you will need to configure
them from command line because in-game configuration is not yet implemented. Once you have them working, enter the configuration menu and
press Ctrl+S to save them to your config file so that they don't need
to specified when starting the program.
Additionally, the current version prints a list of ALSA devices
detected to console. Use this as a reference for your configuration.
SEE ALSO
- You can find more information at http://performous.org/ or
http://sourceforge.net/projects/performous/