<html> <head> <title>The Sakuraplayer Handbook</title> <META HTTP-EQUIV="content-type" CONTENT="text/html; charset=iso-8859-1"> <META NAME="keywords" CONTENT="Sakuraplayer sound player TFMX"> <META NAME="description" CONTENT="Documentation for Sakuraplayer"> </head> <body> <img src="../common/logotp3.png" alt="the K desktop environment" /> <p /> <h1>The Sakuraplayer Handbook</h1> <p /> If you need help concerning the installation, consult the README file. This should answer most of your questions. <p /> Comments, suggestions, wishes, etc. are always appreciated! <hr /> <!-- begin real docs --> <P> Sakuraplayer can be invoked in several ways: <ul> <li>by left-clicking on a TFMX song file (these files have the prefix mdat.) in Konqueror</li> <li>via the 'K' menu (in the 'Multimedia' secion)</li> <li>via the command-line:<br> "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). </ul> <p /> After you have started Sakuraplayer, you should see a window like the one below (with <b>your</b> theme settings of course):<p> <img src="sakurashot.png" alt="Sakuraplayer screenshot" /><p /> In this case you see that the file <code>/usr/local/AncientMods/tfmx/turrican3/mdat.t3main</code> 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).<br /> You can use drag-and-drop to drop any local TFMX mdat files onto Sakuraplayer. <p /> The interface should be pretty self-explainatory, but there are some things you might want to know: <ul> <li>First, the keyboard commands (the ones given after the slash are KDE standard accelerators): <ul> <li>H/F1 - help</li> <li>A - about box</li> <li>P - play</li> <li>S - stop</li> <li>O/Ctrl-O - open file</li> <li>Q/Ctrl-Q - quit</li> <li>1/PageDown - next subsong</li> <li>2/PageUp - previous subsong</li> <li>3 - 16 bit sound</li> <li>4 - 8 bit sound</li> <li>5 - frequency up</li> <li>6 - frequency down</li> <li>8 - stereo mix</li> <li>9 - headphones mix</li> <li>0 - mono mix</li> <li>T - toggle tooltips</li> <li>V - toggle oversampling</li> <li>C - clear focus (you can also do this by clicking on the passive parts of the main window)</li> </ul> </li> <li>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.</li> <li>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.</li> <li>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.</li> <li>When you quit Sakuraplayer, the following settings will be saved (and retrieved next time you start the program): <ul> <li>songfile (overridable by command-line argument)</li> <li>subsong (overridable by command-line argument)</li> <li>bits per sample</li> <li>frequency</li> <li>tooltips on/off</li> <li>oversampling on/off</li> <li>current directory (for the file-browser)</li> <li>channel separation</li> </ul> </li> <li>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.</li> </ul> <h3><i>So much for documentation, now listen to some cool tunes...</i>^_^</h3> You can get several TFMX files from <a href="http://exotica.fix.no">http://exotica.fix.no</a>. <br /> You may also want to check out <a href="http://darkstar.tabu.uni-bonn.de/~neo/audio.html">Sakura Audio</a>. <!-- end real docs --> <hr /> <center> © 2001 by <a href="mailto:david.banz@smail.inf.fh-rhein-sieg.de">David Banz</a> <br /> Sakuraplayer is released under terms of the <a href="../common/gpl-license.html">GPL</a> <br /> This documentation itself is released under terms of the <a href="../common/fdl-license.html">FDL</a> </center> </body> </html>