The Sakuraplayer Handbook

If you need help concerning the installation, consult the README file. This should answer most of your questions.

Comments, suggestions, wishes, etc. are always appreciated!

Sakuraplayer can be invoked in several ways:

• by left-clicking on a TFMX song file (these files have the prefix mdat.) in Konqueror
• via the 'K' menu (in the 'Multimedia' secion)
• via the command-line:
  "sakuraplayer mdat.mysong 2" for example will load the file mdat.mysong straight away and select subsong 2 in this file (the command-line arguments for songfile and subsong are of course optional).

After you have started Sakuraplayer, you should see a window like the one below (with your theme settings of course):

In this case you see that the file /usr/local/AncientMods/tfmx/turrican3/mdat.t3main is currently loaded and being played. Also you can see the current subsong (0), bits per sample (16), frequency (44 kHz), oversampling (inactive), channel separation (Headphones) and tooltip-settings (off).
You can use drag-and-drop to drop any local TFMX mdat files onto Sakuraplayer.

The interface should be pretty self-explainatory, but there are some things you might want to know:

• First, the keyboard commands (the ones given after the slash are KDE standard accelerators):
  • H/F1 - help
  • A - about box
  • P - play
  • S - stop
  • O/Ctrl-O - open file
  • Q/Ctrl-Q - quit
  • 1/PageDown - next subsong
  • 2/PageUp - previous subsong
  • 3 - 16 bit sound
  • 4 - 8 bit sound
  • 5 - frequency up
  • 6 - frequency down
  • 8 - stereo mix
  • 9 - headphones mix
  • 0 - mono mix
  • T - toggle tooltips
  • V - toggle oversampling
  • C - clear focus (you can also do this by clicking on the passive parts of the main window)
• When no file is open and you hit the play button, you will automatically get a file-browser where you can select the file to be played. Otherwise, the selected subsong of the current file will be played. The buttons/keys for subsong, frequency and bits per sample will only restart the player if it has been active at the time you pushed the button/key.
• There is no way for tfmx-play to pass the correct subsong numbers to the frontend (simply because tfmx-play sometimes extracts the wrong numbers), therefore all numbers available. This means you can select any number from 0 to 31 - but don't worry, in almost any file all subsongs are in a straight row from 0 to 5 or 7. If you should hit a nonexistent subsong, you will simply hear nothing but silence. That's all.
• The frequency and bps settings are merely treated as a suggestion by tfmx-play. This means that if your card should not be able to handle the desired frequency/bps, the player will automatically select the highest possible setting, so the display may be incorrect.
• When you quit Sakuraplayer, the following settings will be saved (and retrieved next time you start the program):
  • songfile (overridable by command-line argument)
  • subsong (overridable by command-line argument)
  • bits per sample
  • frequency
  • tooltips on/off
  • oversampling on/off
  • current directory (for the file-browser)
  • channel separation
• TFMX files in their original format always come in pairs: one songfile (e.g. mdat.mysong) and one samplefile (smpl.mysong). Both files need to be in the same directory.

So much for documentation, now listen to some cool tunes...^_^