ktuberling/sounds/soundthemes.HOWTO

0001 **********************************************
0002 * How to create a new KTuberling sound theme *
0003 **********************************************
0004
0005 To create a new KTuberling theme you have to:
0006  * Record the sounds in OGG Vorbis rc3 file format
0007
0008  * Create a "yourLanguageTwoLetterCode".soundtheme file, it has to follow this schema
0009   <language code="yourLanguageTwoLetterCode">
0010     <sound name="soundName" file="relativePath" />
0011     ...
0012     ...
0013     ...
0014   </language>
0015
0016    - yourLanguageTwoLetterCode is your language two letter code, for example gl for Galician
0017    - For each sound a <sound> entry. soundName should match with the soundName specified
0018      in the playground theme (see themes.HOWTO). relativePath should be the relative path you
0019      are going to install the file with this sound to, typically it will be
0020      someUniquePath/soundName.format (someUniquePath can be your language two letter code for
0021      example)
0022
0023  * If you are adding the sound theme to KTuberling SVN:
0024    - Add the sound files and the "yourLanguageTwoLetterCode".soundtheme files to the data/kdegames/ktuberling directory
0025      of your language translations
0026    - On that very same dir you need a CMakeLists.txt describing how to install the files, typically it will be
0027      FILE(GLOB datafiles *.ogg)
0028      install( FILES ${datafiles} DESTINATION ${DATA_INSTALL_DIR}/ktuberling/sounds/"yourLanguageTwoLetterCode" )
0029      install( FILES "yourLanguageTwoLetterCode".soundtheme DESTINATION ${DATA_INSTALL_DIR}/ktuberling/sounds/ )
0030
0031  * If you want to install it for yourself:
0032    - Place "yourLanguageTwoLetterCode".soundtheme files in `kde4-config --prefix`/share/apps/ktuberling/sounds
0033    - Place yourSoundFiles in `kde4-config --prefix`/share/apps/ktuberling/sounds/"yourLanguageTwoLetterCode"