Menu
▾
▴
Tree [8382a0] master / History
larsen255
Read Me
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="de" lang="de">
<head>
<title>OpenSoundboard README</title>
<meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
<style type="text/css">
p {width:700px;}
h4 {margin-top:50px;}
h5 {margin-bottom:-10px;}
/* Number the h4/h5 - doesn't work on older browsers (copied from ghostscript readme) */
h4 {
counter-increment: h4-count;
counter-reset: h5-count;
}
h4:before {
content: counter(h4-count) ". ";
}
h5 {
counter-increment: h5-count;
}
h5:before {
content: counter(h4-count) "." counter(h5-count) ". ";
}
</style>
</head>
<body>
<h2>OpenSoundboard</h2>
<a href="http://sourceforge.net/projects/opensoundboard/">http://sourceforge.net/projects/opensoundboard/</a>
<br />
<br />
Copyright 2010-2012 Lars Monsees<br />
OpenSoundboard is free software distributed under the GNU GPL.<br />
Read LICENSE.txt for more infomation about the license.<br />
<br />
<br />
<h3 id="contents">Contents</h3>
<ol>
<li><a href="#overview">Overview</a></li>
<li><a href="#installation">Installation</a></li>
<li><a href="#configuration">Configuration</a></li>
<li><a href="#clo">Command line options</a></li>
<li><a href="#issues">Known Issues</a></li>
<li><a href="#soundfiles">Sound files</a></li>
<li><a href="#credits">Credits</a></li>
<li><a href="#feedback">Feedback</a></li>
</ol>
<h4 id="overview">Overview</h4>
<p>OpenSoundboard plays sound files when the user presses hotkeys. Files and hotkeys can be freely assigned. This project was inspired by "GIGA F-Tasten" that only supported 34 keys without modifiers and was therefore interfering with normal programs´ shortcuts.</p>
<h4 id="installation">Installation</h4>
<p>You will need the <a href="http://www.oracle.com/technetwork/java/javase/downloads/index-jsp-138363.html#javasejdk">Java 7 Runtime Environment (JRE)</a> and the <a href="http://www.oracle.com/technetwork/java/javafx/downloads/index.html">JavaFX Runtime</a>. The latter should be bundled with the first, but this wasn´t the case for the Java 7u2 release. So, if OpenSoundboard is complaining about not being able to load JavaFX simply download and install it.</p>
<h4 id="configuration">Configuration</h4>
<h5>Mapping file</h5>
<p>When you first start OpenSoundboard, it creates a file named <code>"mapping.properties"</code> in it´s application data folder:</p>
<ul>
<li><code>C:\Documents and Settings\<username>\Application Data\OpenSoundboard</code> (Win XP)</li>
<li><code>C:\Users\<username>\AppData\Roaming\OpenSoundboard</code> (Windows Vista, etc.)</li>
</ul>
<p>OpenSoundboard will automatically reload the file if it has changed. You can also reload it by using the appropriate entry from the tray icon´s context menu.</p>
<h5>Hotkeys</h5>
<p>You have to open the mapping file in a text editor and configure mappings from a shortcut to a filename. You can do this from the tray icon´s context menu. When specifying a hotkey use <code>"+"</code> as a separator, e.g. <code>"Ctrl+Alt+S"</code>. The file contains some example mappings. For more detailed information on the available hotkeys please have a look at the code in function <code>getKey2KeycodeMapping()</code> from <a href="http://melloware.com/products/jintellitype/xref/com/melloware/jintellitype/JIntellitype.html">JIntellitype</a>. If you specify a hotkey multiple times, only the last one will be used. As the Java VM uses the system´s encoding, make sure to save the file with that encoding. It won´t work when the file has UTF-8 encoding, but your OS doesn´t.</p>
<h5>Special functions</h5>
<p>You can also specify special functions by using the following (including the asterisk) as a mapping:</p>
<ul>
<li><code>*StopAll</code>: stops all sounds currently being played</li>
<li><code>*OpenMapping</code>: opens the mapping file</li>
<li><code>*ReloadMapping</code>: reloads the mapping file</li>
<li><code>*ExitProgram</code>: closes the program</li>
<li><code>*EnableDisableHotkeys</code>: enables or disables the hotkeys</li>
</ul>
<h5>Configuration file</h5>
<p>The configuration file <code>"OpenSoundboard.properties"</code> offers the possibility to override the default values. It is created at startup in the application data folder if it doesn´t exist and filled with some example data. Most of the options that can be set via <a href="#clo">command line options</a> can also be set via the config file. See the config file itself for details.</p>
<h4 id="clo">Command line options</h4>
<p>You can use command line options to override the values from the config file or the default values.</p>
<ul>
<li><code>-h, --hideicon</code>: Hide the system tray icon</li>
<li><code>-s, --showicon</code>: Show the system tray icon</li>
<li><code>-m <filename>, --mapping=<filename></code>: The mapping file to use</li>
<li><code>-c <filename>, --config=<filename></code>: The config file to use</li>
<li><code>-i <filename>, --icon=<filename></code>: The icon file to use (<code>GIF</code>, <code>JPEG</code> or <code>PNG</code>)</li>
<li><code>-l <language>, --language=<language></code>: The language to use (ISO 639)</li>
<li><code>-v <volume level>, --volume=<volume level></code>: The volume to use specified from 0.0 (muted) to 1.0 (full volume)</li>
</ul>
<h4 id="issues">Known Issues</h4>
<p>With a 64-bit JVM if the mapping file´s extension is not already associated to a program, it´s not possible to open the mapping file from the context menu. This is due to a 64-bit version of JDIC not being available.</p>
<p>Some hotkey combinations don´t work as they are reserved by Windows (see <a href="http://support.microsoft.com/kb/126449">Microsoft Knowledgebase</a>). Some common hotkeys known not to work are:</p>
<ul>
<li><code>F12</code></li>
<li><code>Win+F1</code></li>
<li><code>Ctrl+Alt+Delete</code></li>
<li><code>Win+D</code> (Desktop), <code>Win+E</code> (Explorer), <code>Win+F</code> (Find), <code>Win+L</code> (Lock), <code>Win+R</code> (Run), <code>Win+U</code> (Utility-Manager)</li>
</ul>
<h4 id="soundfiles">Sound files</h4>
<p>OpenSoundboard supports the audio formats that are supported by <a href="http://docs.oracle.com/javafx/2.0/api/javafx/scene/media/package-summary.html#SupportedMediaTypes">JavaFX</a>, i.d. <code>MP3</code> and <code>WAV</code>.
</p>
<p>You can find some sound files at:</p>
<ul>
<li><a href="http://www.soundboard.com">http://www.soundboard.com</a></li>
<li><a href="http://www.instantsfun.es">http://www.instantsfun.es</a></li>
</ul>
<p>You could also play videos from e.g. <a href="http://www.youtube.com">YouTube</a> and use <a href="http://audacity.sourceforge.net">Audacity</a> to record and edit sounds.</p>
<h4 id="credits">Credits</h4>
<ul>
<li>Emil Lefkof for developing <a href="http://melloware.com/products/jintellitype">JIntellitype</a></li>
<li>The author of the <a href="http://www.dezinerfolio.com/2008/08/28/on-stage-free-vector-psd-icon-set/">tray icon</a></li>
<li>The <a href="http://jargs.sourceforge.net">jargs project</a></li>
</ul>
<h5>Translations</h5>
<ul>
<li>Arabic - Mohammad Abdallah</li>
<li>Chinese - Ce Tian</li>
<li>Danish - Peter Laursen</li>
<li>Dutch - Arjan Beumer</li>
<li>Italian - Gabriele "Damage92"</li>
<li>Hebrew - Yusif Goabra</li>
<li>Russian - Eugenie Ewert</li>
<li>Turkish - Timurhan Sungur</li>
</ul>
<h4 id="feedback">Feedback</h4>
<p>Your feedback on OpenSoundboard is very welcome. In case you want to submit a bug report or request a new feature please <a href="https://sourceforge.net/apps/trac/opensoundboard/newticket">create a ticket</a>.
There is also a <a href="https://sourceforge.net/projects/opensoundboard/forums/forum/1126897">forum</a>.
</p>
</body>
</html>