Songs

From Performous

Performous currently supports songs in UltraStar (singing), Frets on Fire (singing, instruments) and StepMania (dancing) formats.

Contents 1 Finding songs 2 Installing songs 2.1 Adding own song folders 2.1.1 Option 1 2.1.2 Option 2 2.2 Mac OS X 3 Making songs 4 Visuals 4.1 File name rules

[edit] Finding songs

• Some free songs are available here
• Search the homepages / wikis / forums of the other games; e.g. there are some guitar-only songs at Frets on Fire website
• Use Google to search for songs / song torrents in specific format, e.g. UltraStar or FoF.
• Additionally, Performous comes with a tool named ss_extract that can be used for extracting your SingStar DVDs.

[edit] Installing songs

Performous looks for songs in the following paths:

DATADIR/songs/
~/.ultrastar/songs/
/usr/local/share/games/ultrastar/songs/
/usr/local/share/games/fretsonfire/data/songs/
/usr/share/games/ultrastar/songs/
/usr/share/games/fretsonfire/data/songs/

where DATADIR is all of Performous' data folders, including the installation directory and

C:\Users\USERNAME\AppData\Roaming\performous (Windows)
~/.local/share/games/performous/ (Most Linux distributions)
~/.local/share/performous/ (Gentoo from ebuild)

Note that the actual paths to Performous datadirs can vary, because they are modified by different platforms and distributions to suit their particular conventions. Also, if you are compiling the game from source, CMake variables CMAKE_INSTALL_PREFIX and SHARE_INSTALL affect the directories, e.g. user datadir is ~/.local/SHARE_INSTALL (unless XDG_DATA_HOME environment variable is set, in which case it is XDG_DATA_HOME/SHARE_INSTALL). You can see where Performous tries to find songs by launching it from a terminal and observing the output.

You can freely mix different formats in same songs-folder. In addition, Performous scans recursively, so a predefined folder structure is not required. Symbolic links (*nix stuff) are also followed, so it is possible to just create a link from one of Performous' dir to your real song folder.

[edit] Adding own song folders

Unfortunately there is not yet a graphical way to do this, but you only need to make the configuration once.

[edit] Option 1

Give song folders as command line arguments.

1. Open a terminal
2. Type in: performous /path/to/my/songdir
3. Hit enter
4. Go to the song browser to verify that you didn't mistype the path (songs appear)
5. Go to Configuration screen (from main menu) and hit Ctrl+S to save the setting

This writes the needed XML automatically and the next time you can start Performous from a shortcut or whatever, no need to specify the path again.

[edit] Option 2

Add folders directly to the config.xml (create it first by pressing Ctrl+S in the Configuration screen).

1. Find the configuration file:
   • ~/.config/performous/config.xml (*nix)
2. Open it in a text editor of your choice
3. Add the following entry between the <performous>-tags:

 <entry name="system/path_songs" type="string_list">
   <stringvalue>/first/path/to/add</stringvalue>
   <stringvalue>/perhaps/an/another/path</stringvalue>
 </entry>

Of course, modify the paths to suit your needs. So in the end, your config.xml should look a little like this:

 <?xml version="1.0" encoding="UTF-8"?>
 <performous>
   <entry name="system/path_songs" type="string_list">
     <stringvalue>/my/very/own/song/folder</stringvalue>
   </entry>
   <entry name="audio/playback" type="string_list">
     <stringvalue>rate=44100,frames=512@pulse</stringvalue>
   </entry>
   <entry name="audio/round-trip" type="float" value="0.16"/>
 </performous

The amount and type of other <entry>-tags varies between users depending on their configuration.

[edit] Mac OS X

Performous on Mac looks for songs in (among other places) ~/.local/share/games/performous/Songs. Placing all songs in this location allows the program to import songs.

[edit] Making songs

Performous does not currently contain (useful) song editor. UltraStar format songs can be modified with a text editor (StepMania too) or with one of the many available editors such as YASS. FoF format songs can be modified and created with a MIDI sequencer like Rosegarden, but there are also many custom editors. See Frets on Fire Wiki for more information plus tutorials and guides.

It is recommended to use an existing song as a template when making a new one. With all formats, you need audio tracks (background with or without vocals and preferably a separate track for each instrument) in MP3 or other supported format and it is also good to have a cover image and a background video or image.

Here is a list of tools that can aid in the creation of songs: Creation_tools

[edit] Visuals

Cover pictures, background images and music videos can be added in the way each format describes them. In addition, Performous can guess suitable files to use if the entries are missing or broken in the song metadata. This also allows you to simply drop media to the song folder so that it gets used without touching the songs themselves.

[edit] File name rules

• All rules are case-insensitive
• Cover: cover / album / label with extension png / jpeg / jpg / svg
• Background image: bg / background with extension png / jpeg / jpg / svg
• Video: any name with extension avi / mpg / mpeg / flv / mov / mp4