updated sdl docs

fceux-sdl-docs.html

@@ -23,7 +23,7 @@
 	<div id="page_content">
 
   <center><h1>FCEUX SDL Documentation</h1></center>
-  <center><i>Last updated November 30, 2008<br />Valid as of FCEUX 2.0.4</i><br>
+  <center><i>Last updated March 10, 2010<br />Valid as of FCEUX 2.2</i><br>
   <b>Please note that this document is INCOMPLETE and may be INACCURATE.
   Contributions welcome.</b></center>
  <p>
@@ -190,13 +190,13 @@ necessarily 100% accurate or complete):
  <tr><td>F3</td><td>Load lua script.</td></tr>
  <tr><td>F4</td><td>Toggle background rendering.</td></tr>
  <tr><td>F5</td><td>Save state.</td></tr>
- <tr><td>F6</td><td>Toggle skipping lag in frame advance.</td></tr>
+ <tr><td>F6</td><td>FDS select side.</td></tr>
  <tr><td>F7</td><td>Load state.</td></tr>
- <tr><td>F8</td><td>Toggle lag counter display.</td></tr>
+ <tr><td>F8</td><td>FDS eject.</td></tr>
- <tr><td>F9</td><td>Toggle movie frame counter.</td></tr>
+ <tr><td>.</td><td>Toggle movie frame counter.</td></tr>
  <tr><td>F10</td><td>Toggle movie subtitles.</td></tr>
- <tr><td>F11</td><td>Reset emulation.</td></tr>
+ <tr><td>F11</td><td>Reset emulator.</td></tr>
- <tr><td>F12</td><td>Save screen snapshot.</td></tr>
+ <tr><td>F12</td><td>Save screenshot (to basedir/snaps/).</td></tr>
  <tr><td>Shift + F5</td><td>Begin movie recording.</td></tr>
  <tr><td>Shift + F7</td><td>Open a movie for playback.</td></tr>
  <tr><td>0-9</td><td>Select save state slot.</td></tr>
@@ -204,11 +204,15 @@ necessarily 100% accurate or complete):
  <tr><td>=</td><td>Increase emulation speed.</td></tr>
  <tr><td>Pause</td><td>Pause emulation.</td></tr>
  <tr><td>\</td><td>Advance a single frame.</td></tr>
+ <tr><td>TAB</td><td>Hold for turbo emulation speed.</td></tr>
+ <tr><td>,</td><td>Toggle input display.</td></tr>
+ <tr><td>q</td><td>Toggle movie read-only</td></tr>
+ <tr><td>'</td><td>Advance a single frame.</td></tr>
  </table>
  </p>
  <a name="using-keys-vs"><h4>VS Unisystem</h4></a>
  <p> 
- Could someone test this please?
+ <B>NOTE: This is currently broken in SDL.</B>
  <table border>
  <tr><th>Key:</th><th>Action:</th></tr>
  <tr><td>F8</td><td>Insert coin.</td></tr>
@@ -226,18 +230,18 @@ necessarily 100% accurate or complete):
  </table>
  </p>
  <a name="using-keys-gamepad"><h4>Gamepad</h4></a>
- <p> These are the default keys for the first player gamepad.  These can
+ <p> These are the default keys for the P1 gamepad.  These can
- be remapped using the --inputcfg command line parameter or using gfceux.
+ be remapped using the --inputcfg command line parameter or the GTK GUI
  <table border>
  <tr><th>Key:</th><th nowrap>Button on Emulated Gamepad:</th></tr>
- <tr><td>K</td><td>B</td></tr>
+ <tr><td>D</td><td>B</td></tr>
- <tr><td>J</td><td>A</td></tr>
+ <tr><td>F</td><td>A</td></tr>
  <tr><td>Enter/Return</td><td>Start</td></tr>
- <tr><td>Tab</td><td>Select</td></tr>
+ <tr><td>S</td><td>Select</td></tr>
- <tr><td>W</td><td>Up</td></tr>
+ <tr><td>Keypad up</td><td>Up</td></tr>
- <tr><td>A</td><td>Left</td></tr>
+ <tr><td>Keypad left</td><td>Left</td></tr>
- <tr><td>S</td><td>Down</td></tr>
+ <tr><td>Keypad down</td><td>Down</td></tr>
- <tr><td>D</td><td>Right</td></tr>
+ <tr><td>Keypad right</td><td>Right</td></tr>
  </table>
  </p> 
  <a name="using-keys-powerpad"><h4>Power Pad</h4></a>
@@ -304,7 +308,7 @@ necessarily 100% accurate or complete):
  <p>
  <table border width="100%">
   <tr><th>Name:</th><th>Contribution(s):</th></tr>
-  <tr><td><a href="mailto:ltsmooth42 _at_ gmail _dot_ com">punkrockguy318</a></td>
+  <tr><td><a href="mailto:ltsmooth42 _at_ gmail _dot_ com">Lukas Sabota</a></td>
   <td>FCEUX SDL Documentation rewrite.</td></tr>
  </table>
  </p>

fceux-sdl-faq.html

@@ -23,56 +23,64 @@
 	<div id="page_content">
 
   <center><h1>FCEUX SDL FAQ</h1></center>
-  <center><i>Last updated November 30, 2008<br />Valid as of FCEUX 2.0.3</i> by punkrockguy318<br>
+  <center><i>Last updated March 3, 2010<br />Valid as of FCEUX 2.2.0</i> by punkrockguy318<br>
   </center>
  <p><b>Table of Contents:</b></p>
  <ul>
-  <li><a href="#win-vs-sdl">What's the difference between the windows and sdl ports?</a></li>
+  <li><a href="#svn">What is the subversion build and how can I get it?</a></li>
   <li><a href="#config">How do I configure a gamepad?</a></li>
-  <li><a href="#lua">Why do I need lua5.1 to compile/run FCEUX?</a></li>
+  <li><a href="#sound">My sound is stuttery/laggy.  How can I fix this?</a></li>
- </ul>
+  <li><a href="#hotkeys1">How can I change my hotkey bindings?</a></li>
-  
+  <li><a href="#hotkeys2">Can I map hotkeys to my gamepad?</a></li>
- <a name="intro"><h2>What's the difference between the windows and sdl ports?</h2></a>
- <p>A lot of work that has been done on the FCE code base was been windows only, so 
- some features have not been implemented into the more portable SDL version. </p>
- <p>Here is a list of planned features that are currently in the Win32 build 
- but are missing from the SDL build:</p>
- <ul>
-   <li>Autosaving</li>
-   <li>Hotkey mapping</li>
-   <li>More graphical ways of configuring FCEUX</li>
- </ul>
- <p>I'm going to reiterate that much of the work that has been done of the FCEUX 
- code base has been windows only, so some features will probably never be ported 
- to the SDL version.  If you are a casual user that just wants to play old NES games, the SDL 
- build will be sufficient for you.  However, if you want to use the extensive
- TAS and debugging features that FCEUX has to offer, you are better of using
- the windows build in <a href=http://winehq.org>wine</a>.  Here is a list of features
- that will most likely never be ported to the SDL port.</p>
- <ul>
-   <li />Memory watch
-   <li />Ram filter
-   <li />TAS edit
-   <li />Most of the debugging features
  </ul>
+ <a name="subversion"><h3>What is the subversion build and how can I get it?</h3></a>
+ <p>The latest and greatest changes to fceuX are reflected immediately on our
+ sourceforge subversion server.  You can checkout our source code and build
+ fceuX with the latest changes that have been made.  Use this command:</p>
+ <p><b>svn co https://fceultra.svn.sourceforge.net/svnroot/fceultra fceultra</b></p>
  <a name="config"><h3>How do I configure a gamepad?</h3></a>
  <p>
-  You can configure the first gamepad by running <b>fceux --inputcfg gamepad1</b> </p>
+ <p>If you have the GTK GUI compiled in, you can configure the gamepad by
-  <p>When you do this, you'll be presented with a black window with a titlebar
+ selecting Options...Gamepad in the menu.</p>
-  indicating what button to map.  FCEUX will look for two
+  You can allso configure the first gamepad by running <b>fceux --inputcfg gamepad1</b> </p>
+  <p>When you configure a button you will be presented with a black window with a titlebar
+  indicating what button to map.  FceuX will look for two
   of the same keypress/joystick event in a row.  If it doesn't find two of the same 
-  keypresses in a row, it will allow you to map the button to four seperate keys.</p>
+  keypresses in a row, it will allow you to map the button to two seperate keys.</p>
-  <p>Input configuration is planned for gfceux.</p>
  </p>
- <a name="lua"><h4>Why do I need lua5.1 to compile/run fceux?</h4></a>
+ <a name="sound"><h3>My sound is stuttery/laggy.  How can I fix this?</h3></a>
- <p>You don't! As of version 2.0.3, lua is optional.  However, the lua scritping 
+ <p>Try using different SDL audio drivers.  You can set the SDL audio driver with
- engine in fceux is very powerful, and will be used more and more by fceux in the future.</p>
+ the following command</p>
+ <p><b>export SDL_AUDIODRIVER=driver</b></p>
+ <p>where driver is: esd,oss,alsa,pulse,nas,arts  .  You should probably 
+ try them in that order.  esd is the best choice if you are using pulseaudio 
+ or the esound daemon.  OSS (with ALSA being seond here)is best if you have
+ no sound daemon running.  I can't confirm if nas or arts work at all (but
+ I'd definately avoid arts altogether). SDL's pulse driver has a lot of issues if you are using
+ older versions of SDL or pulseaudio.  If you are having problems and you use 
+ pulseaudio try the esd SDL driver.
+ </p>
+ <a name="hotkeys1"><h3>How can I change my hotkey bindings?</h3></a>
+ <p>You need to edit your ~/.fceux/fceux.cfg file.  The SDL.Hotkeys.* values
+ are SDL keysyms, which can be found in SDL_keysym.h (probably
+ /usr/include/SDL/SDL_keysym.h on your system).  At the time of writing,
+ hotkeys are not mappable from the GUI in sdl.
+ </p>
+ <a name="hotkeys2"><h3>Can I map hotkeys to my gamepad?</h3></a>
+ <p>No, not from within fceuX.  However, there is a great script available
+ called jkeys that will convert joystick button presses and axis movements to keyboard
+ keypresses.  You can map your joystick buttons to whatever hotkey you'd like.
+ <a href="http://code.google.com/p/jkeys/">Jkeys</a> works great with fceuX.
+ There aren't any releases on the website, but don't let that scare you.
+ You can easily obtain the script via subversion:</p>
+ <p><b>svn checkout http://jkeys.googlecode.com/svn/trunk/ jkeys-read-only</b></p>
+
         
  <a name="credits"><h2>Credits</h2></a>
  <p>
  <table border width="100%">
   <tr><th>Name:</th><th>Contribution(s):</th></tr>
-  <tr><td><a href="mailto:ltsmooth42 _at_ gmail _dot_ com">punkrockguy318</a></td>
+  <tr><td><a href="mailto:ltsmooth42 _at_ gmail _dot_ com">Lukas Sabota</a></td>
   <td>Author of this document</td></tr>
  </table>
  </p>