Menu
▾
▴
[Performous-commit] Lasse Karkkainen : Updated manual
|
From: Lasse Kärkkäi. <tr...@us...> - 2009-11-29 11:38:10
|
Module: web Branch: master Commit: eeaa8e0fcdd1a1c08e314d8a970487466b8e2784 Author: Lasse Karkkainen <tro...@tr...> Date: Sun Nov 29 13:37:58 2009 +0200 Updated manual --- htdocs-source/manual.txt | 28 ++++++++++++++++++---------- 1 files changed, 18 insertions(+), 10 deletions(-) diff --git a/htdocs-source/manual.txt b/htdocs-source/manual.txt index 8409d3a..9b16efe 100644 --- a/htdocs-source/manual.txt +++ b/htdocs-source/manual.txt @@ -1,24 +1,24 @@ Documentation -:h2:Configuration file +:h2:Installing songs -All the settings that can be used from command line may also be set from a configuration file. Create file <strong>~/.config/performous.conf</strong>, where ~/.config is a hidden folder in your home directory. In this file, specify a setting per line in the format param=value. A value needs to be specified even when the switch doesn't take any parameters, e.g. --fs is equal to fs=X. - -Use <strong>performous --help</strong> to see the list of options. - -The latest versions use XML configuration file <strong>~/.config/performous.xml</strong> which can be created by saving the configuration in the config menu. Press <strong>Ctrl+S</strong> to save the config. Notice that this also includes the audio devices configured from command line, even though they are not visible in the menu. +You may put all songs to ~/.ultrastar/songs or to /usr/local/share/games/ultrastar/songs, even if they are not in UltraStar format. In future versions we will provide something Performous-specific and possibly also look for Frets on Fire song folders. :h2:Setting up audio output -Usually Performous can automatically figure out how to output audio, but if you have multiple sound cards or otherwise problematic setup, you may need to specify it manually. Use --pdev <device name> to set the audio API (alsa, pulse, jack, ...) and --prate <sampling rate> to set the sampling rate (by default set to 48000 Hz or to the nearest available value). Use --pdev help to get a list of available devices. Some devices also take parameters, e.g. alsa:plughw:0,2 will use driver alsa with ALSA device string "plughw:0,2" (conversion plugin + first sound card and the third subdevice of that). +Usually Performous can automatically figure out how to output audio, but if you have multiple sound cards or otherwise problematic setup, you may need to specify it manually. Use --pdev <device string> to set the audio API (alsa, pulse, jack, ...). Some devices also take parameters, e.g. alsa:plughw:0,2 will use driver alsa with ALSA device string "plughw:0,2" (conversion plugin + first sound card and the third subdevice of that). Use --pdevhelp to get the list of available devices and further help. :h2:Setting up mics -The inputs are defined by the mics commandline or config file parameter. It takes the number of mics (number of players) and optionally other settings. E.g. Singstar microphones using ALSA can be used by --mics 2@alsa:hw:default (the SS mics display as alsa hw device named "default"). You may also specify the mics option multiple times to use more than one sound card, if you have many. +The same as audio outputs, mics are normally detected automatically. --mics may be used for manual configuration and --michelp displays the list of devices and their usage. You may also specify the mics option multiple times to use more than one sound card, if you have many. + +If you don't specify anything, Performous defaults to two microphones and will prefer the SingStar or Rock Band ones, if available. + +:h2:Instruments -Use --michelp to get more detailed help about this. +Any connected Guitar Hero and Rock Band instruments are detected automatically. By default the keyboard is used as a guitar controller too, but this can be disabled in the config menu. -If you don't specify anything, Performous defaults to two microphones and will prefer the Singstar ones, if available. +Before a song starts, you have a few seconds to choose your difficulty level. Do this by picking a fret or by beating a drum pad. The leftmost fret/pad is for easy, the one next to that is medium and so on. If the song has multiple guitar tracks (e.g. guitar and bass), picking the orange fret (with one of the others to choose difficulty) switches between tracks. If you select anything incorrectly, you will get to play, but the difficulty will default to easy. :h2:Adjusting audio sync @@ -42,3 +42,11 @@ In order to see your singing on screen as realtime as possible, you should try t Using analog connection to your stereo instead of S/PDIF can also often reduce the latency slightly. +:h2:Configuration menu + +Most settings are modifiable via the config menu but unfortunately it does not currently allow modifying any options with text in them. These may need to be specified with commandline options or input directly to the XML config file. + +Press Ctrl+S to save the currently active settings after changes or to store the --pdev and --mics settings you entered permanently. + +See the keys page for more information. + |
