summaryrefslogtreecommitdiffstats
path: root/games/sms_sdl/sms_sdl.pod
diff options
context:
space:
mode:
Diffstat (limited to 'games/sms_sdl/sms_sdl.pod')
-rw-r--r--games/sms_sdl/sms_sdl.pod71
1 files changed, 51 insertions, 20 deletions
diff --git a/games/sms_sdl/sms_sdl.pod b/games/sms_sdl/sms_sdl.pod
index f099cfa821..6d78dd3f13 100644
--- a/games/sms_sdl/sms_sdl.pod
+++ b/games/sms_sdl/sms_sdl.pod
@@ -56,7 +56,7 @@ Disable sound.
=item B<--filter> <mode>
-Render using a filter. Available modes:
+Scales the display to 200% size. Available modes:
=over 4
@@ -78,6 +78,10 @@ Render using a filter. Available modes:
=back
+Note that the B<1> to B<8> keys can be used to change the filter
+while the emulator is running, but I<only> if it was started
+with the B<--filter> option.
+
=back
=head1 KEYBOARD
@@ -86,47 +90,48 @@ Render using a filter. Available modes:
=item B<F1>
-Screenshot in BMP format
+Save screenshot in BMP format (in B<~/.sms_sdl>).
=item B<F2>
-Save state
+Save state.
=item B<F3>
-Load state
+Load state.
=item B<F4/F5>
-Dec/inc frame skip value
+Decrease/increase frame skip value.
=item B<F6/F7>
-Dec/inc state slot
+Decrease/increase state slot.
=item B<1..8>
-Switch rendering filter
+Switch rendering filter. Only works if the emulator was started
+with the B<--filter> option.
=item B<C>
-Button 1
+Controller button 1.
=item B<V>
-Button 2
+Controller button 2.
=item B<ENTER>
-Start (GG) / pause (SMS)
+Start (GG) / pause (SMS).
=item B<ARROWS>
-Directional pad
+Directional pad.
=item B<TAB>
-Console hard reset
+Console hard reset.
=back
@@ -136,8 +141,11 @@ The key bindings may not be remapped.
ROM image files may be in raw dump format, or may have a header
(details are system-specific). Also, ROM images may be zipped (not
-gzipped), in which case the first file in the zip file's directory must
-be the ROM image (any other files are ignored).
+gzipped), in which case the first file in the zip file's directory
+that matches I<*.sms>, I<*.gg>, I<*.rom>, I<*.bin> (case-insensitive)
+will be used as the ROM image. Other files are ignored. If nothing
+in the zip file matches, the first file in the zip directory will
+be used.
B<sms_sdl> looks at the filename to determine the type of ROM image
in use. Any file whose name ends in I<.gg> (case-insensitive match) is
@@ -146,13 +154,13 @@ Master System ROM. In the case of a zipped image, this refers to the
file inside the zip file; the zip file itself doesn't have any special
naming requirements.
-Screenshot filenames (F1 key) are generated by replacing the filename
+Screenshot filenames (B<F1> key) are generated by replacing the filename
extension with I<-NNN.bmp>, where NNN is a 3-digit number (000 for the
first screenshot, 001 for the second, etc). The numbering starts at 000
every time the emulator is started, and existing files will be overwritten
without confirmation.
-State save filenames (F2 key) are generated by replacing the filename
+State save filenames (B<F2> key) are generated by replacing the filename
extension with I<.stN>, where N is the number of the save slot (one or
more digits). Again, existing files are overwritten without confirmation.
@@ -161,10 +169,15 @@ Screenshots and savestates are stored in I<~/.sms_sdl>.
=head1 CONFIG FILE
B<sms_sdl> is launched by a shell script wrapper which reads the file
-I<~/.sms_sdl/config> if it exists. Any of the options above may be placed
-in this file (one option per line, with or without the leading B<-->
-characters). These options will be passed as command-line arguments to
-the real B<sms_sdl> binary every time it runs.
+I<~/.sms_sdl/config> if it exists. Any of the options above may be
+placed in this file (one option per line, with or without the leading
+B<--> characters). These options will be passed as command-line
+arguments to the real B<sms_sdl> binary every time it runs. Any
+arguments passed to the script will appear after the ones read from
+the config file.
+
+If there's no I<~/.sms_sdl/config>, a default one will be created,
+which enables B<--joystick>, B<--fm>, and B<--filter 2x>.
See B</usr/doc/sms_sdl-VERSION/sample_config> for further information.
@@ -196,6 +209,24 @@ Wrapper script, supports config file and snapshots/savestates in ~/.sms_sdl (scr
=back
+=head1 LIMITATIONS
+
+=over 4
+
+=item -
+
+There are no controls mapped for the player 2 controller. Only one
+joystick is supported, and the keyboard only has player 1 mappings.
+
+=item -
+
+The only supported resolutions are tiny, by modern desktop PC
+standards. By default, SMS games run at 256x192 and GG games run at
+160x144. With B<--filter>, the window/screen size is doubled: 512x384
+and 320x288.
+
+=back
+
=head1 AUTHORS
The original SMS is (C) Charles Mac Donald in 1998, 1999, 2000.