3 lsnes is SNES rerecording emulator based on bsnes core.
11 (b) accuracy or compatiblity core.
13 (c) Patched version (using included 6 patches)
25 7. sdlmain (SDL only, part of SDL)
27 8. boost_conversion (this is header-only library)
29 9. libswscale (wxwidgets graphics only)
31 10. Portaudio (portaudio sound only)
33 11. std::thread and co (for threaded dumper only, not needed if
34 std::thread is available)
36 12. Lua (if Lua support is needed).
38 • Version 5.1.X or 5.2X.
42 Building is via makefile, the following options are available:
44 • CROSS_PREFIX=<prefix>
46 – Prefix to apply to commands when building executables /
47 object files for the target architecture.
53 – Name of C++ compiler.
55 – CROSS_PREFIX is prepended if compiling for target
58 – This needs to be at least GCC 4.6.
60 – Set to 'g++-mp-4.6' if compiling on Mac OS X using GCC 4.6
67 – Name of host C++ compiler.
69 – Default is value of 'CC' option.
71 • USER_HOSTCCFLAGS=<flags>:
73 – Compiler flags to pass when compiling/linking for host
80 – Extra flags to pass when compiling for target architecture
84 • USER_LDFLAGS=<flags>:
86 – Extra flags to pass when linking for target architecture.
90 • USER_PLATFORM_CFLAGS=<flags>
92 – Extra flags to pass when compiling files using
93 platform-dependent code for target architecture.
97 • USER_PLATFORM_LDFLAGS=<flags>
99 – Extra flags to pass when linking files using
100 platform-dependent code for target architecture.
106 – Set the font file to use.
108 – Currently the valid values are:
110 ∗ cp437.hex: Standard VGA font (256 characters).
112 ∗ unifontfull-5.1.20080820.hex: GNU unifont (covers most of
115 – Default is 'unifontfull-5.1.20080820.hex'
119 – Package to use for Lua support.
121 – Usually valid value is 'lua' or 'lua5.1'.
123 – Default is not to build Lua support.
127 – Override platform default for dumper threading support.
129 – Threading is default on Linux.
131 – 'YES' tries to use threading (std::thread).
133 – 'BOOST' tries to use threading (boost::thread).
135 – 'NO' disables threading.
137 – Note: This has absolutely nothing to do with platform
140 • BSNES_IS_COMPAT=<anything>
142 – Signals that BSNES core used is compatiblity core, not
145 – Default is to assume accuracy core.
147 • JOYSTICK=<implementation>
149 – Set joystick implementation. Valid values are:
151 ∗ SDL: Use SDL for joystick (requires SDL graphics)
153 ∗ EVDEV: Use EVDEV for joystick (Linux only).
155 ∗ DUMMY: Disable joystick support.
159 • SOUND=<implementation>
161 – Set sound implementation. Valid values are:
163 ∗ SDL: Use SDL for sound (requires SDL graphics)
165 ∗ PORTAUDIO: Use Portaudio for sound.
167 ∗ DUMMY: Disable sound support
171 • GRAPHICS=<implementation>
173 – Set windowing library to use. Valid values are:
175 ∗ SDL: Use SDL for graphics
177 ∗ WXWIDGETS: Use wxWidgets for graphics.
181 4 Command line options
185 <kind> in the following can be one of:
187 • rom: Cartridge ROM (BIOS for special carts). This is required.
189 • bsx: BS-X (non-slotted) Game flash ROM.
191 • bsxslotted: BS-X (slotted) Game flash ROM.
195 • slot-a: Sufami Turbo Slot A ROM
197 • slot-b: Sufami Turbo Slot B ROM
199 4.1.1 --<kind>=<file> (lsnes/SDL, lsnes-avidump)
201 Load <file> as specified ROM (SFC/BS/DMG/ST file format).
203 4.1.2 --<kind>-xml=<file> (lsnes/SDL, lsnes-avidump)
205 Override hardware detection for ROM, reading the values from
206 <file> (BSNES XML format).
208 4.1.3 --ips-<kind>=<file> (lsnes/SDL, lsnes-avidump)
210 Apply BPS/IPS patch <file> to ROM <kind>. If specified multiple
211 times, the patches are applied in order.
213 4.1.4 --ips-<kind>-xml=<file> (lsnes/SDL, lsnes-avidump)
215 Apply BPS/IPS patch <file> to XML of ROM <kind>. If specified
216 multiple times, the patches are applied in order.
218 4.1.5 --ips-offset=<offset> (lsnes/SDL, lsnes-avidump)
220 Set offset to apply to IPS patches. May be negative. Handy for
221 applying headered IPS patches (use offset of -512 for this). The
222 offset must be 0 for BPS patches.
226 Force ROM to be considered PAL-only.
228 • Only works on SNES and SGB ROMs (not BS-X or Sufami Turbo).
230 • Attempting to load NTSC movie file will error out.
234 Force ROM to be considered NTSC-only.
236 • Attempting to load PAL movie file will error out.
240 4.2.1 <filename> (lsnes/SDL, lsnes-avidump, movieinfo)
242 Load <filename> as movie or savestate file. All other session
245 4.2.2 --port1=<device> (lsnes/SDL)
247 Set type of port1. Valid values are:
249 • none: No device connected
251 • gamepad: One gamepad (the default)
253 • multitap: Four gamepads (warning: makes most games refuse to
258 4.2.3 --port2=<type> (lsnes/SDL)
260 Set type of port2. Valid values are:
262 • none: No device connected (the default)
264 • gamepad: One gamepad
266 • multitap: Four gamepads.
270 • superscope: Super Scope
272 • justifier: One justifier
274 • justifiers: Two justifiers
276 4.2.4 --gamename=<name> (lsnes/SDL)
278 Set the name of game to <name>. Default is blank.
280 4.2.5 --author=<name> (lsnes/SDL)
282 Add author with full name of <name> (no nickname).
284 4.2.6 --author=|<name> (lsnes/SDL)
286 Add author with nickname of <name> (no full name).
288 4.2.7 --author=<fullname>|<nickname> (lsnes/SDL)
290 Add author with full name of <fullname> and nickname of
293 4.2.8 --rtc-second=<value> (lsnes/SDL)
295 Set RTC second (0 is 1st January 1970 00:00:00Z). Default is
298 4.2.9 --rtc-subsecond=<value> (lsnes/SDL)
300 Set RTC subsecond. Range is 0-. Unit is CPU cycle. Default is 0.
304 4.3.1 --run=<file> (lsnes/SDL)
306 After running main RC file, run this file. If multiple are
307 specified, these execute in order specified.
309 4.4 dump options (lsnes-dumpavi only)
311 4.4.1 --dumper=<dumper>
313 Set the dumper to use (required). Use 'list' for listing of known
318 Set the mode to use (required for dumpers with multiple modes,
319 forbidden otherwise). Use 'list' for known modes.
321 4.4.3 --prefix=<prefix>
323 Set dump prefix. Default is “avidump”.
325 4.4.4 --option=<name>=<value>
327 Set option <name> to value <value>.
329 4.4.5 --length=<length>
331 Set number of frames to dump. Mandatory.
335 Run specified lua script (lsnes-dumpavi does not have
336 initialization files).
338 5 Startup file lsnes.rc
340 Upon startup, lsnes (lsnes/SDL only) executes file lsnes.rc as
341 commands. This file is located in:
343 • Windows: %APPDATA%\lsnes\lsnes.rc (if %APPDATA% exists)
345 • Unix: $XDG_CONFIG_HOME/lsnes/lsnes.rc (if $XDG_CONFIG_HOME
348 • Unix: $HOME/.config/lsnes/lsnes.rc (if $HOME exists)
350 • All: ./lsnes.rc (fallback default).
352 If leading directories do not exist, attempt to create them is
357 • Commands beginning with '*' invoke the corresponding command
358 without alias expansion.
360 • If command starts with '+' (after possible '*'), the command is
361 executed as-is when button is pressed, and when button is
362 released, it is executed with '+' replaced by '-'.
364 • Commands without '+' execute only on negative edge (release).
368 Settings control various aspects of emulator behaviour.
370 6.1.1 set-setting <setting> <value>
372 Sets setting <setting> to value <value> (may be empty).
374 6.1.2 unset-setting <setting>
376 Try to unset setting <setting> (not all settings can be unset).
378 6.1.3 get-setting <setting>
380 Read value of setting <setting>
384 Print names and values of all settings.
388 Keybindings bind commands or aliases to keys (or pseudo-keys).
392 • Do not bind edge active (+/-) commands to keys with modifiers,
393 that won't work right!
395 • Names of keys and modifiers are platform-dependent.
397 • Be careful before binding pseudo-keys (such as joystick axes,
398 buttons or hats) with modifiers. That may or may not work
401 6.2.1 bind-key [<mod>/<modmask>] <key> <command>
403 Bind <command> to key <key> (activating if modifiers in <modmask>
404 (comma-seperated list) are set as <mod> (comma-seperated list).
406 The names of keys and modifiers are platform-dependent.
408 6.2.2 unbind-key [<mod>/<modmask>] <key>
410 Unbind command from <key> (with specified <mod> and <modmask>).
412 6.2.3 set-axis <axis> [disabled | axis | axis-inverse |
413 pressure0- | pressure0+ | pressure-0 | pressure-+ | pressure+0
414 | pressure+-] [minus=<val>] [zero=<val>] [plus=<val>]
417 Set axis parameters for axis <axis>.
419 • disabled: Disable axis
423 • axis-inverse: Inverse axis
425 • pressure0-: Pressure sensitive. Released at 0, pressed at -.
427 • pressure0+: Pressure sensitive. Released at 0, pressed at +.
429 • pressure-0: Pressure sensitive. Released at -, pressed at 0.
431 • pressure-+: Pressure sensitive. Released at -, pressed at +.
433 • pressure+0: Pressure sensitive. Released at +, pressed at 0.
435 • pressure+-: Pressure sensitive. Released at +, pressed at -.
437 • minus=<val>: Calibration at extreme minus position
440 • zero=<val>: Calibration at neutral position (-32768-32767)
442 • plus=<val>: Calibration at extreme plus position (-32768-32767)
444 • tolerance=<value>: Center band tolerance (0<x<1). The smaller
445 the value, the more sensitive the control is.
449 Print all key bindings in effect.
453 Aliases bind command to sequence of commands. After alias has
454 been defined, it replaces the command it shadows.
458 • You can't alias command to itself.
460 • Aliases starting with +/- are edge active just like ordinary
461 commands starting with +/-.
463 • One command can be aliased to multiple commands.
465 6.3.1 alias-command <command> <expansion>
467 Append <expansion> to alias <command>. If alias does not already
468 exist, it is created.
470 6.3.2 unalias-command <command>
472 Clear alias expansion for <command>.
476 Print all aliases and their expansions in effect.
478 6.4 run-script <script>
480 Run <script> as if commands were entered on the command line.
484 Following commands control video dumping:
486 6.5.1 dump-avi <prefix>
488 Dump AVI video to prefix <prefix> Notes:
490 • The codec is Camstudio Codec in gzip mode.
492 • Encoder and muxer are internal, available on all platforms.
494 • Audio enable/disable and framerate has no effect.
496 • The audio dumped to .avi is low-quality version. The
497 high-quality version is dumped to .sox file.
501 End current AVI video dump (closing the emulator also closes the
504 6.5.3 dump-jmd <file>
506 Dump JMD video to file <file>.
510 End the current JMD dump in progress.
512 6.5.5 dump-sdmp <prefix>
514 Dump SDMP to <prefix>, splitting at 2GB.
516 6.5.6 dump-sdmp-ss <file>
518 Dump SDMP to <file>, no splitting
522 End the current SDMP dump in progress.
524 6.5.8 dump-raw <prefix>
526 Dump raw audio (to <prefix>.audio, at 32040.5Hz) and video (to
527 <prefix>.video>, at nominal framerate and 512x448 / 512x478
532 End the current RAW dump in progress.
534 6.6 Memory manipulation
536 <address> may be decimal or hexadecimal (prefixed with '0x').
537 <value> can be hexadecimal (prefixed with '0x'), unsigned or
538 signed (prefixed with '-') decimal.
540 The available element <sizes> are:
550 When reading RAM and ROM, multi-byte reads/writes are big-endian.
551 When dealing with DSP memory, multi-byte reads/writes are
552 native-endian (do not use operand sizes exceeding DSP bitness,
553 except dword is OK for 24-bit memory).
555 6.6.1 read-<size> <address>
557 Read the value of byte in <address>.
559 6.6.2 read-s<size> <address>
561 Read the value of signed byte in <address>.
563 6.6.3 write-<size> <address> <value>
565 Write <value> to byte in address <address>.
567 6.6.4 search-memory reset
569 Reset the memory search
571 6.6.5 search-memory count
573 Print number of candidates remaining
575 6.6.6 search-memory print
577 Print all candidates remaining
579 6.6.7 search-memory <usflag><sizeflag><op>
581 Searches memory for addresses satisfying criteria.
601 • lt: < previous value.
603 • le: <= previous value.
605 • eq: = previous value.
607 • ne: != previous value.
609 • ge: >= previous value.
611 • gt: > previous value.
613 6.6.8 search-memory <sizeflag> <value>
615 Searches for addresses that currently have value <value>.
616 <sizeflag> is as in previous command.
620 These commands are not available in lsnesrc, but are available
621 after ROM has been loaded.
623 6.7.1 quit-emulator [/y]
625 Quits the emulator (asking for confirmation). If /y is given, no
626 confirmation is asked.
630 Toggle paused/unpaused
634 Advance frame. If the button is still held after configurable
635 timeout expires, game unpauses for the duration frame advance is
640 Advance subframe. If the button is still held after configurable
641 timeout expires, game unpauses for the duration frame advance is
644 6.7.5 advance-skiplag
646 Skip to first poll in frame after current.
650 Reset the SNES after this frame.
652 6.7.7 load <filename>
654 Load savestate <filename> in current mode.
656 6.7.8 load-state <filename>
658 Load savestate <filename> in readwrite mode.
660 6.7.9 load-readonly <filename>
662 Load savestate <filename> in readonly mode.
664 6.7.10 load-preserve <filename>
666 Load savestate <filename> in readonly mode, preserving current
669 6.7.11 load-movie <filename>
671 Load savestate <filename>, ignoring save part in readonly mode.
673 6.7.12 save-state <filename>
675 Save system state to <filename> as soon as possible.
677 6.7.13 save-movie <filename>
679 Save movie to <filename>.
691 Toggle between read-only and read-write modes.
693 6.7.17 set-gamename <name>
695 Set name of the game to <name>
699 Print the name of the game.
701 6.7.19 add-author <author>
703 Adds new author <author>. If <author> does not contain '|' it is
704 full name. If it contains '|', '|' splits the full name and
707 6.7.20 edit-author <num> <author>
709 Edit the author in slot <num> (0-based) to be <author> (see
710 add-author for format)
712 6.7.21 remove-author <num>
714 Remove author in slot <num>
720 6.7.23 test-1, test-2, test-3
722 Internal test commands. Don't use.
724 6.7.24 take-screenshot <filename>
726 Save screenshot to <filename>.
728 6.7.25 +controller<num><button>
730 Press button <button> on controller <num> (1-8). The following
731 button names are known:
765 6.7.26 controllerh<num><button>
767 Hold/unhold button <button> on controller <num> (1-8). See
768 +controller for button names.
770 6.7.27 autofire (<pattern>|-)...
772 Set autofire pattern. Each parameter is comma-separated list of
773 button names (in form of 1start, 1A, 2B, etc..) to hold on that
774 frame. After reaching the end of pattern, the pattern restarts
783 6.8.1 cycle-jukebox-backward
785 Cycle save jukebox backwards.
787 6.8.2 cycle-jukebox-forward
789 Cycle save jukebox forwards
791 6.8.3 add-jukebox-save <filename>
793 Add <filename> to jukebox saves.
797 Do load from jukebox (current mode).
801 Do state save to jukebox.
805 Only available if lua support is compiled in.
807 6.9.1 evaluate-lua <luacode>
809 Run Lua code <luacode> using built-in Lua interpretter.
811 6.9.2 run-lua <script>
813 Run specified lua file using built-in Lua interpretter.
817 6.10.1 add-watch <name> <expression>
819 Adds new watch (or modifies old one).
821 6.10.2 remove-watch <name>
827 6.11.1 enable-sound <on/off>
829 Enable/Disable sound.
831 6.11.2 set-sound-device <device>
833 Set sound device to <device>
835 6.11.3 show-sound-status
837 Show status of sound system.
839 6.11.4 show-sound-devices
841 Show all available devices.
843 6.12 SDL Platform commands
845 The following are valid on SDL platform.
849 Asks to press a key and then identifies that (pseudo-)key.
851 6.12.2 toggle-console
853 Toggle between windowed/fullscreen console.
857 Scroll messages window as far back as it goes.
859 6.12.4 scroll-fulldown
861 Scroll messages window as far forward as it goes.
865 Scroll messages window back one screenful.
869 Scroll messages window forward one screenful.
877 Set where bsnes looks for firmware files. Default is “.”.
881 Set the target fps. Numeric, range is 0.001 to “infinite”.
882 Default is native framerate.
884 7.1.3 savecompression
886 Set save compression level (integer 0-9). Default is 7 (0 is no
889 7.1.4 advance-timeout
891 Set the frame advance timeout in milliseconds. Numeric integer,
892 range is 0-999999999. Default is 500.
894 7.2 AVI dumper settings
898 AVI dumper: Always dump at 512x448 or 512x478 regardless of what
901 7.2.2 avi-left-border
903 AVI dumper: Set the default left border thickness (unless lua
904 overrides) for dumps. Range 0-8191. Default is 0.
906 7.2.3 avi-right-border
908 AVI dumper: Set the default right border thickness (unless lua
909 overrides) for dumps. Range 0-8191. Default is 0.
913 AVI dumper: Set the default top border thickness (unless lua
914 overrides) for dumps. Range 0-8191. Default is 0.
916 7.2.5 avi-bottom-border
918 AVI dumper: Set the default bottom border thickness (unless lua
919 overrides) for dumps. Range 0-8191. Default is 0.
923 AVI dumper: Maximum number of frames per dump segment (0 =>
924 unlimited). Range 0-999999999. Default is 0.
926 7.2.7 avi-compresison
928 AVI dumper: Compression level (0-18).
930 • Compression levels 10 and above are not compatible with stock
933 • Recomended level is 7.
937 AVI dumper: Set method of determining the sound rate.
939 • 0: Pick nearest of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48,
940 64, 88.2, 96, 128, 176.4 and 192 kHz.
942 • 1: Round down to nearest integer.
944 • 2: Round up to nearest ingeter.
950 JMD dumper: Compression level (0-9).
952 7.4 SDL platform settings
954 7.4.1 autorepeat-first-delay
956 Sets the delay for first character in typematic autorepeat.
958 7.4.2 autorepeat-subsequent-delay
960 Sets the delay for subsequent characters in typematic autorepeat.
964 8.1 Core (in main table)
968 Print line to message console.
970 8.1.2 exec(string command)
972 Run command as it was entered on the command line
976 Returns two values. First is time since some epoch in seconds,
977 the second is microseconds mod 10^6 since that epoch.
979 8.1.4 emulator_ready()
981 Returns true if emulator has finished booting, false if not
982 (on_startup() will be issued later).
984 8.1.5 set_idle_timeout(number timeout)
986 Set number of microseconds to block idle for. After this timeout
987 has expired, on_idle() will be called once.
989 8.1.6 set_timer_timeout(number timeout)
991 Set number of microseconds to block timer for. After this timeout
992 has expired, on_timer() will be called once.
996 Bitwise logical functions and related.
998 8.2.1 bit.none(number...) / bit.bnot(number...)
1000 48-bit bitwise NOT / NONE function (set bits that are set in none
1003 8.2.2 bit.any(number...) / bit.bor(number...)
1005 48-bit bitwise OR / ANY function (set bits that are set in any of
1008 8.2.3 bit.all(number...) / bit.band(number...)
1010 48-bit bitwise AND / ALL function (set bits that are set in all
1013 8.2.4 bit.parity(number...) / bit.bxor(number...)
1015 48-bit bitwise XOR / PARITY function (set bits that are set in
1016 odd number of the arguments).
1018 8.2.5 bit.lrotate(number base[, number amount[, number bits]])
1020 Rotate bits-bit (max 48, default 48) number left by amount
1023 8.2.6 bit.rrotate(number base[, number amount[, number bits]])
1025 Rotate bits-bit (max 48, default 48) number right by amount
1028 8.2.7 bit.lshift(number base[, number amount[, number bits]])
1030 Shift bits-bit (max 48, default 48) number left by amount
1031 (default 1) places. The new bits are filled with zeroes.
1033 8.2.8 bit.lrshift(number base[, number amount[, number bits]])
1035 Shift bits-bit (max 48, default 48) number logically right by
1036 amount (default 1) places. The new bits are filled with zeroes.
1038 8.2.9 bit.arshift(number base[, number amount[, number bits]])
1040 Shift bits-bit (max 48, default 48) number arithmetically right
1041 by amount (default 1) places. The new bits are shifted in with
1042 copy of the high bit.
1044 8.2.10 bit.extract(number base[, number bit0[, number bit1,...]])
1046 Returns number that has bit0-th bit as bit 0, bit1-th bit as 1
1051 • Bit numbers up to 51 should work reliably (then things start
1052 falling apart due to double precision issues).
1054 • There are two special bit positions, true and false, standing
1055 for always set bit and always clear bit.
1057 8.2.11 bit.value([number bit1[, number bit2,...]])
1059 Returns bitwise OR of 1 left shifted by bit1 places, 1 left
1060 shifted by bit2 places and so on. As special value, nil argument
1065 Most of these functions can only be called in on_paint and
1066 on_video callbacks. Exceptions are noted.
1068 Colors are 32-bit. Bits 0-7 are the blue component, bits 8-15 are
1069 the green component, bits 16-23 are the red component, bits 24-31
1070 are alpha component (0 is fully opaque, 255 is almost
1071 transparent). -1 is the fully transparent color. Alpha values
1072 greater than 127 do work.
1074 Origin of coordinates is at top left corner of game display area.
1075 Left and top gaps correspond to negative coordinates.
1077 8.3.1 gui.resolution()
1079 Returns 2-tuple (hresolution, vresolution).
1081 8.3.2 gui.<class>_gap(number gap)
1083 Set the <class> (left, right, top, bottom) gap to specified value
1086 8.3.3 gui.text(number x, number y, string text[, number fgc[,
1089 Draw specified text on the GUI (each character cell is 8 or 16
1090 wide and 16 high). Parameters:
1092 • x: X-coordinate to start the drawing from (and x-coordinate at
1093 begining of the lines).
1095 • y: Y-coordinate to start the drawing from.
1097 • text: The text to draw.
1099 • fgc: Text color (default is 0xFFFFFF (white))
1101 • bgc: Background color (default is -1 (transparent))
1103 8.3.4 gui.textH(number x, number y, string text[, number fgc[,
1106 Like gui.text, but draw using double-width.
1108 8.3.5 gui.textV(number x, number y, string text[, number fgc[,
1111 Like gui.text, but draw using double-height.
1113 8.3.6 gui.textHV(number x, number y, string text[, number fgc[,
1116 Like gui.text, but draw using double-width/double-height.
1118 8.3.7 gui.rectangle(number x, number y, number width, number
1119 height[, number thickness[, number outline[, number fill]]])
1121 Draw rectangle on the GUI. Parameters:
1123 • x: X-coordinate of left edge.
1125 • y: Y-coordinate of upper edge.
1127 • width: Width of rectangle.
1129 • height: Height of rectangle.
1131 • thickness: Thickness of outline (default is 1).
1133 • outline: Color of outline (default is 0xFFFFFF (white))
1135 • fill: Color of fil (default is -1 (transparent))
1137 8.3.8 gui.pixel(number x, number y[, number color])
1139 Draw one pixel on the GUI. Parameters:
1141 • x: X-coordinate of the pixel
1143 • y: Y-coordinate of the pixel
1145 • color: Color of the pixel (default is 0xFFFFFF (white))
1147 8.3.9 gui.crosshair(number x, number y[, number length[, number
1150 Draw a crosshair. Parameters:
1152 • x: X-coordinate of the crosshair
1154 • y: Y-coordinate of the crosshair
1156 • length: Length of the crosshair lines (default 10).
1158 • color: Color of the crosshair (default is 0xFFFFFF (white))
1160 8.3.10 gui.line(number x1, number y1, number x2, number y2[,
1163 Draw a thin line. Parameters:
1165 • x1: X-coordinate of one end.
1167 • y1: Y-coordinate of one end.
1169 • x2: X-coordinate of the other end.
1171 • y2: Y-coordinate of the other end.
1173 • color: Color of the line (default is 0xFFFFFF (white)).
1175 8.3.11 gui.circle(number x, number y, number r[, number thick[,
1176 number border[, number fil]]])
1178 Draw a circle. Parameters.
1180 • x: X-coordinate of the center
1182 • y: Y-coordinate of the center
1184 • r: The radius of the circle
1186 • thick: Border thickness
1188 • border: Border color (default is 0xFFFFFF (white))
1190 • fill: Fill color (default is -1 (transparent)).
1192 8.3.12 gui.bitmap_draw(number x, number y, bitmap bitmap, palette
1195 Draw a bitmap on screen with specified palette. Parameters:
1197 • x: X-coordinate of left edge.
1199 • y: Y-coordinate of top edge.
1201 • bitmap: The bitmap to draw
1203 • palette: The palette to draw the bitmap using.
1205 8.3.13 gui.bitmap_draw(number x, number y, dbitmap bitmap)
1207 Draw a bitmap on screen. Parameters:
1209 • x: X-coordinate of left edge.
1211 • y: Y-coordinate of top edge.
1213 • bitmap: The bitmap to draw
1215 8.3.14 gui.palette_new()
1217 Returns a new palette (initially all transparent). Can be used
1220 8.3.15 gui.bitmap_new(number w, number h, boolean direct[, bool
1223 Returns a new bitmap/dbitmap. Can be used anywhere. Parameters:
1225 • w: The width of new bitmap
1227 • h: The height of new bitmap
1229 • direct: If true, the returned bitmap is dbitmap, otherwise
1232 • icolor: Initital fill color (defaults to 0 on BITMAP, -1 on
1235 8.3.16 gui.bitmap_load(string file)
1237 Returns loaded bitmap/dbitmap (if bitmap, the second return value
1238 is palette for bitmap). Can be used anywhere. Parameters:
1240 • file: The name of file to load.
1242 8.3.17 gui.palette_set(palette palette, number index, number
1245 Sets color in palette. Can be used anywhere. Parameters:
1247 • palette: The palette to manipulate
1249 • index: Index of color (0-65535).
1251 • color: The color value.
1253 8.3.18 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y,
1256 Sets specified pixel in bitmap. Can be used anywhere. Parameters:
1258 • bitmap: The bitmap to manipulate
1260 • x: The x-coordinate of the pixel.
1262 • y: The y-coordinate of the pixel.
1264 • color: If bitmap is a bitmap, color index (0-65535). Otherwise
1267 8.3.19 gui.bitmap_size(bitmap/dbitmap bitmap)
1269 Get size of bitmap. Can be used anywhere. Parameters:
1271 • bitmap: The bitmap to query.
1273 The first return is the width, the second is the height.
1275 8.3.20 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy,
1276 bitmap/dbitmap src, number sx, number sy, number w, number h[,
1279 Blit a part of bitmap to another. Can be used anywhere.
1282 • dest: Destination to blit to.
1284 • dx: left edge of target
1286 • dy: Top edge of target
1288 • src: The source to blit from. Must be of the same type as
1291 • sx: left edge of source
1293 • sy: Top edge of source
1295 • w: Width of region
1297 • h: Height of region.
1299 • ck: Color key. Pixels of this color are not blitted.
1301 – If bitmaps are bitmaps, this is color index of colorkey.
1302 Values outside range 0-65535 cause no key to be used as
1305 – If bitmaps are dbitmaps, this color value of colorkey.
1307 – May be absent or nil for no colorkey blit.
1309 8.3.21 gui.repaint()
1311 Request on_repaint() to happen as soon as possible. Can be used
1314 8.3.22 gui.subframe_update(boolean on)
1316 Request subframe updates (calling on_paint() on subframes) to
1317 happen (on=true) or not happen (on=false). Can be used anywhere.
1319 8.3.23 gui.screenshot(string filename)
1321 Write PNG screenshot of the current frame (no drawings) to
1322 specified file. Can be used anywhere.
1324 8.3.24 gui.color(number r, number g, number b[, number a])
1326 Returns color (in notation Lua scripts use) corresponding to
1327 color (r,g,b), each component in scale 0-255. If a is specified,
1328 that is alpha (0 is fully transparent, 256(sic) is fully opaque).
1329 The default alpha is 256.
1331 8.3.25 gui.status(string name, string value)
1333 Set status field “L[<name>]” to <value> in status area. Can be
1338 Input handling. Only available in on_input callback.
1340 8.4.1 input.get(number controller, number index)
1342 Read the specified index (0-11) from specified controller (0-7).
1345 • Uses physical controller numbering. Gamepad in port 2 is
1346 controller 4, not 1!
1348 8.4.2 input.set(number controller, number index, number value)
1350 Write the specified index (0-11) from specified controller (0-7),
1351 storing value. Notes:
1353 • Uses physical controller numbering. Gamepad in port 2 is
1354 controller 4, not 1!
1356 8.4.3 input.geta(number controller)
1358 Get input state for entiere controller. Returns 13 return values.
1360 • 1st return value: Bitmask: bit i is set if i:th index is
1363 • 2nd-13th return value: value of i:th index.
1365 8.4.4 input.seta(number controller, number bitmask, number
1368 Set state for entiere controller. args is up to 12 values for
1369 indices (overriding values in bitmask if specified).
1371 8.4.5 input.controllertype(number controller)
1373 Get the type of controller as string. Valid values are:
1383 8.4.6 input.reset([number cycles])
1385 Execute reset. If cycles is greater than zero, do delayed reset.
1386 0 (or no value) causes immediate reset.
1388 • Only available with subframe flag false.
1392 Returns table of tables of all available keys and axes. The first
1393 table is indexed by key name (platform-dependent!), and the inner
1394 table has the following fields:
1396 • last_rawval: Last reported raw value for control.
1398 • ktype: Type of key (disabled, key, mouse, axis, axis-inverse,
1399 hat, pressure-m0, pressure-mp, pressure-0m, pressure-0p,
1400 pressure-pm, pressure-p0).
1402 • cal_left: Minimum calibration value. Only meaningful with axis
1405 • cal_center: Center calibration value. Only meaningful with axis
1408 • cal_right: Maximum calibration value. Only meaningful with axis
1411 • cal_tolerance: Dead zone tolerance. Only meaningful with axis
1414 8.4.8 input.keyhook(key, state)
1416 Requests that keyhook events to be sent for key (state=true) or
1417 not sent (state=false).
1419 8.5 Table hostmemory
1421 Host memory handling (extra memory saved to savestates). Host
1422 memory starts empty.
1424 8.5.1 hostmemory.read(number address)
1426 Reads hostmemory slot address. Slot numbers out of range return
1427 false instead of numeric.
1429 8.5.2 hostmemory.write(number address, number value)
1431 Writes hostmemory slot with 0-255. Slot numbers out of range
1432 cause extension of host memory slot space.
1434 8.5.3 hostmemory.readbyte(number address)
1436 Read unsigned byte (1 element) from given address. Slots out of
1439 8.5.4 hostmemory.writebyte(number address, number value)
1441 Write unsigned byte (1 element) to given slot. Slot numbers out
1442 of range cause extension.
1444 8.5.5 hostmemory.readsbyte(number address)
1446 Read signed byte (1 element) from given address. Slots out of
1449 8.5.6 hostmemory.writesbyte(number address, number value)
1451 Write signed byte (1 element) to given slot. Slot numbers out of
1452 range cause extension.
1454 8.5.7 hostmemory.readword(number address)
1456 Read unsigned word (2 elements) from given address. Slots out of
1459 8.5.8 hostmemory.writeword(number address, number value)
1461 Write unsigned word (2 elements) to given slot. Slot numbers out
1462 of range cause extension.
1464 8.5.9 hostmemory.readsword(number address)
1466 Read signed word (2 elements) from given address. Slots out of
1469 8.5.10 hostmemory.writesword(number address, number value)
1471 Write signed word (2 elements) to given slot. Slot numbers out of
1472 range cause extension.
1474 8.5.11 hostmemory.readdword(number address)
1476 Read unsigned doubleword (4 elements) from given address. Slots
1477 out of range return false.
1479 8.5.12 hostmemory.writedword(number address, number value)
1481 Write unsigned doubleword (4 elements) to given slot. Slot
1482 numbers out of range cause extension.
1484 8.5.13 hostmemory.readsdword(number address)
1486 Read signed doubleword (4 elements) from given address. Slots out
1487 of range return false.
1489 8.5.14 hostmemory.writesdword(number address, number value)
1491 Write signed doubleword (4 elements) to given slot. Slot numbers
1492 out of range cause extension.
1494 8.5.15 hostmemory.readqword(number address)
1496 Read unsigned quadword (8 elements) from given address. Slots out
1497 of range return false.
1499 8.5.16 hostmemory.writeqword(number address, number value)
1501 Write unsigned quadword (4 elements) to given slot. Slot numbers
1502 out of range cause extension.
1504 8.5.17 hostmemory.readsqword(number address)
1506 Read signed quadword (8 elements) from given address. Slots out
1507 of range return false.
1509 8.5.18 hostmemory.writesqword(number address, number value)
1511 Write signed quadword (8 elements) to given slot. Slot numbers
1512 out of range cause extension.
1518 8.6.1 movie.currentframe()
1520 Return number of current frame.
1522 8.6.2 movie.framecount()
1524 Return number of frames in movie.
1526 8.6.3 movie.readonly()
1528 Return true if in readonly mode, false if in readwrite.
1530 8.6.4 movie.set_readwrite()
1532 Set readwrite mode (does not cause on_readwrite callback).
1534 8.6.5 movie.frame_subframes(number frame)
1536 Count number of subframes in specified frame (frame numbers are
1537 1-based) and return that.
1539 8.6.6 movie.read_subframe(number frame, number subframe)
1541 Read specifed subframe in specified frame and return data as
1542 array (100 elements, numbered 0-99 currently).
1546 Routines for settings manipulation
1548 8.7.1 settings.get(string name)
1550 Get value of setting. If setting is blank, returns false. If
1551 setting value can't be obtained, returns (nil, error message).
1553 8.7.2 settings.set(string name, string value)
1555 Set value of setting. If setting can't be set, returns (nil,
1558 8.7.3 settings.is_set(string name)
1560 Returns if setting is set. If setting does not exist, returns
1561 (nil, error message).
1563 8.7.4 settings.blank(string name)
1565 Blanks a setting and returns true. If setting can't be blanked,
1566 returns (nil, error message).
1570 Contains various functions for managing memory
1572 8.8.1 memory.vma_count()
1574 Returns the number of VMAs
1576 8.8.2 memory.read_vma(number index)
1578 Reads the specified VMA (indices start from zero). Trying to read
1579 invalid VMA gives nil. The read VMA is table with the following
1582 • region_name (string): The readable name of the VMA
1584 • baseaddr (number): Base address of the VMA
1586 • lastaddr (number): Last address in the VMA.
1588 • size (number): The size of VMA in bytes.
1590 • readonly (boolean): True of the VMA corresponds to ROM.
1592 • native_endian (boolean): True if the VMA has native endian as
1593 opposed to little endian.
1595 8.8.3 memory.find_vma(number address)
1597 Finds the VMA containing specified address. Returns table in the
1598 same format as read_vma or nil if not found.
1600 8.8.4 memory.readbyte(number address)
1602 Reads the specified address as unsigned byte and returns the
1605 8.8.5 memory.readsbyte(number address)
1607 Reads the specified address as signed byte and returns the
1610 8.8.6 memory.writebyte(number address, number value)
1612 Writes the specified value (negative values undergo 2's
1613 complement) to specified address (as a byte).
1615 8.8.7 memory.readword(number address)
1617 Reads the specified address as unsigned word and returns the
1620 8.8.8 memory.readsword(number address)
1622 Reads the specified address as signed word and returns the
1625 8.8.9 memory.writeword(number address, number value)
1627 Writes the specified value (negative values undergo 2's
1628 complement) to specified address (as a word).
1630 8.8.10 memory.readdword(number address)
1632 Reads the specified address as unsigned doubleword and returns
1635 8.8.11 memory.readsdword(number address)
1637 Reads the specified address as signed doubleword and returns the
1640 8.8.12 memory.writedword(number address, number value)
1642 Writes the specified value (negative values undergo 2's
1643 complement) to specified address (as a doubleword).
1645 8.8.13 memory.readqword(number address)
1647 Reads the specified address as unsigned quadword and returns the
1650 8.8.14 memory.readsqword(number address)
1652 Reads the specified address as signed quadword and returns the
1655 8.8.15 memory.writeqword(number address, number value)
1657 Writes the specified value (negative values undergo 2's
1658 complement) to specified address (as a quadword).
1662 Contains copy of global variables from time of Lua
1663 initialization. Non-writeable.
1667 Various callbacks to Lua that can occur.
1669 8.10.1 Callback: on_paint(bool not_synth)
1671 Called when screen is being painted. Any gui.* calls requiring
1672 graphic context draw on the screen.
1674 not_synth is true if this hook is being called in response to
1675 received frame, false otherwise.
1677 8.10.2 Callback: on_video()
1679 Called when video dump frame is being painted. Any gui.* calls
1680 requiring graphic context draw on the video.
1682 8.10.3 Callback: on_frame_emulated()
1684 Called when emulating frame has completed and
1685 on_paint()/on_video() calls are about to be issued.
1687 8.10.4 Callback: on_frame()
1689 Called on each starting whole frame.
1691 8.10.5 Callback: on_startup()
1693 Called when the emulator is starting (lsnes.rc and --run files
1696 8.10.6 Callback: on_rewind()
1698 Called when rewind movie to beginning has completed.
1700 8.10.7 Callback: on_pre_load(string name)
1702 Called just before savestate/movie load occurs (note: loads are
1703 always delayed, so this occurs even when load was initiated by
1706 8.10.8 Callback: on_err_load(string name)
1708 Called if loadstate goes wrong.
1710 8.10.9 Callback: on_post_load(string name, boolean was_savestate)
1712 Called on successful loadstate. was_savestate gives if this was a
1713 savestate or a movie.
1715 8.10.10 Callback: on_pre_save(string name, boolean is_savestate)
1717 Called just before savestate save occurs (note: movie saves are
1718 synchronous and won't trigger these callbacks if called from
1721 8.10.11 Callback: on_err_save(string name)
1723 Called if savestate goes wrong.
1725 8.10.12 Callback: on_post_save(string name, boolean is_savestate)
1727 Called on successful savaestate. is_savestate gives if this was a
1728 savestate or a movie.
1730 8.10.13 Callback: on_quit()
1732 Called when emulator is shutting down.
1734 8.10.14 Callback: on_input(boolean subframe)
1736 Called when emulator is just sending input to bsnes core.
1737 Warning: This is called even in readonly mode, but the results
1740 8.10.15 Callback: on_reset()
1742 Called when SNES is reset.
1744 8.10.16 Callback: on_readwrite()
1746 Called when moving into readwrite mode as result of “set-rwmode”
1747 command (note: moving to rwmode by Lua won't trigger this, as per
1748 recursive entry protection).
1750 8.10.17 Callback: on_snoop(number port, number controller, number
1751 index, number value)
1753 Called each time bsnes asks for input. The value is the final
1754 value to be sent to bsnes core (readonly mode, autohold and
1755 autofire have been taken into account). Might be useful when
1756 translating movies to format suitable for console verification.
1757 Note: There is no way to modify the value to be sent.
1759 8.10.18 Callback: on_keyhook(string keyname, table state)
1761 Sent when key that has keyhook events requested changes state.
1762 Keyname is name of the key (group) and state is the state (same
1763 kind as table values in input.raw).
1765 8.10.19 Callback: on_idle()
1767 Called when requested by set_idle_timeout(), the timeout has
1768 expired and emulator is waiting.
1770 8.10.20 Callback: on_timer()
1772 Called when requested by set_idle_timeout() and the timeout has
1773 expired (regardless if emulator is waiting).
1775 9 Memory watch expression syntax
1777 Memory watch expressions are in RPN (Reverse Polish Notation). At
1778 the end of expression, the top entry on stack is taken as the
1783 • Evaluation order is strictly left to right.
1785 • a is the entry on top of stack
1787 • b is the entry immediately below top of stack
1789 • ; separates values to be pushed (no intermediate pop).
1791 • After end of element, all used stack slots are popped and all
1794 • When pushing multiple values, the pushes occur in order shown.
1796 The following operators are available:
1810 • b : read_signed_byte(a)
1814 • d : read_signed_dword(a)
1816 • i : quotent(a / b)
1821 • q : read_signed_qword(a)
1831 • w : read_signed_word(a)
1835 • B : read_unsigned_byte(a)
1837 • C<number>z : Push number <number> to stack.
1839 • D : read_unsigned_dword(a)
1841 • C0x<number>z : Push number <number> (hexadecimal) to stack.
1843 • Q : read_unsigned_qword(a)
1845 • R<digit> : round a to <digit> digits.
1847 • W : read_unsigned_word(a)
1851 C0x007e0878zWC0x007e002czW-
1853 1. Push value 0x7e0878 on top of stack (C0x007e0878z).
1855 2. Pop the value on top of stack (0x7e0878), read word value at
1856 that address and push the result,call it x1 (W).
1858 3. Push value 0x7e002c on top of stack (C0x007e002cz).
1860 4. Pop the value on top of stack (0x7e002c), read word value at
1861 that address and push the result,call it x2 (W).
1863 5. Pop the two top numbers on stack, x1 and x2, substract x1 from
1864 x2 and push x2 - x1 (-).
1866 6. Since the expression ends, the final memory watch result is
1867 the top one on stack, which is x2 - x1.
1869 10 Modifier and key names:
1873 10.1.1 Modifier names
1875 Following modifier names are known:
1877 • ctrl, lctrl, rctrl: Control keys
1879 • alt, lalt, ralt: ALT keys.
1881 • shift, lshift, rshift: Shift keys.
1883 • meta, lmeta, rmeta: Meta keys.
1885 • num, caps: Numlock/Capslock (these are sticky!)
1887 • mode: Mode select.
1891 Following key names are known:
1893 • backspace, tab, clear, return, pause, escape, space, exclaim,
1894 quotedbl, hash, dollar, ampersand, quote, leftparen,
1895 rightparen, asterisk, plus, comma, minus, period, slash, 0, 1,
1896 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
1897 greater, question, at, leftbracket, backslash, rightbracket,
1898 caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k,
1899 l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0,
1900 world_1, world_2, world_3, world_4, world_5, world_6, world_7,
1901 world_8, world_9, world_10, world_11, world_12, world_13,
1902 world_14, world_15, world_16, world_17, world_18, world_19,
1903 world_20, world_21, world_22, world_23, world_24, world_25,
1904 world_26, world_27, world_28, world_29, world_30, world_31,
1905 world_32, world_33, world_34, world_35, world_36, world_37,
1906 world_38, world_39, world_40, world_41, world_42, world_43,
1907 world_44, world_45, world_46, world_47, world_48, world_49,
1908 world_50, world_51, world_52, world_53, world_54, world_55,
1909 world_56, world_57, world_58, world_59, world_60, world_61,
1910 world_62, world_63, world_64, world_65, world_66, world_67,
1911 world_68, world_69, world_70, world_71, world_72, world_73,
1912 world_74, world_75, world_76, world_77, world_78, world_79,
1913 world_80, world_81, world_82, world_83, world_84, world_85,
1914 world_86, world_87, world_88, world_89, world_90, world_91,
1915 world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3,
1916 kp4, kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide,
1917 kp_multiply, kp_minus, kp_plus, kp_enter, kp_equals, up, down,
1918 right, left, insert, home, end, pageup, pagedown, f1, f2, f3,
1919 f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, numlock,
1920 capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt, lalt,
1921 rmeta, lmeta, lsuper, rsuper, mode, compose, help, print,
1922 sysreq, break, menu, power, euro, undo
1924 • Names of form 'key<n>' where <n> is 0-255 are interpretted as
1925 key having hardware-dependent scan code of <n> (useful to bind
1926 those keys that don't have symbolic names).
1928 10.1.3 Joystick pseudo-keys:
1930 • joystick<num>button<button>: Joystick <num> (0-based) button
1933 • joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat>
1936 • joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat>
1939 • joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat>
1942 • joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat>
1945 • joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis>
1946 negative position (axis modes axis and axis_inverse).
1948 • joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis>
1949 positive position (axis modes axis and axis_inverse).
1951 • joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis>
1952 pressure (axis modes pressure_*).
1954 10.1.4 Special buttons:
1956 • Escape: Enter/Exit Command mode, cancel modal dialogs.
1958 • Return (also KPEnter): Execute command, ok modal dialog.
1960 • Pgup/Up (also KP8/9 if no num lock; command mode): Previous
1961 command in command history
1963 • Pgdn/Down(also KP2/3 if no num lock; command mode): Next
1964 command in command history
1966 • Home (also KP7 if no num lock; command mode): Beginning of
1969 • End (also KP1 if no num lock; command mode): End of command.
1971 • Left (also KP4 if no num lock; command mode): Move cursor left.
1973 • Right (also KP6 if no num lock; command mode): Move cursor
1976 • Delete (also KP. if no num lock; command mode): Delete
1977 character to right of cursor.
1979 • Insert (also KP0 if no num lock; command mode): Toggle between
1980 insert / overwrite modes.
1982 • Backspace (command mode): Delete character to left of cursor.
1984 • LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump
1987 10.2 wxWidgets platform
1989 10.2.1 Modifier names:
1991 Following modifier names are known:
2001 • cmd (Mac OS X only)
2005 Following key names are known:
2007 • back, tab, return, escape, space, exclaim, quotedbl, hash,
2008 dollar, percent, ampersand, quote, leftparen, rightparen,
2009 asterisk, plus, comma, minus, period, slash, 0, 1, 2, 3, 4, 5,
2010 6, 7, 8, 9, colon, semicolon, less, equals, greater, question,
2011 at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t,
2012 u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
2013 underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m,
2014 n, o, p, q, r, s, t, u, v, w, x, y, z, leftcurly, pipe,
2015 rightcurly, tilde, delete, start, lbutton, rbutton, cancel,
2016 mbutton, clear, shift, alt, control, menu, pause, capital, end,
2017 home, lefT, up, right, down, select, print, execute, snapshot,
2018 insert, help, numpad0, numpad1, numpad2, numpad3, numpad4,
2019 numpad5, numpad6, numpad7, numpad8, numpad9, multiply, add,
2020 separator, subtract, decimal, divide, f1, f2, f3, f4, f5, f6,
2021 f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19,
2022 f20, f21, f22, f23, f24, numlock, scroll, pageup, pagedown,
2023 numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
2024 numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up,
2025 numpad_right, numpad_down, numpad_pageup, numpad_pagedown,
2026 numpad_end, numpad_begin, numpad_insert, numpad_delete,
2027 numpad_equal, numpad_multiply, numpad_add, numpad_separator,
2028 numpad_subtract, numpad_decimal, numpad_divide, windows_left,
2029 windows_right, windows_menu, command, special1, special2,
2030 special3, special4, special5, special6, special7, special8,
2031 special9, special10, special11, special12, special13,
2032 special14, special15, special16, special17, special18,
2033 special19, special20
2035 11 Movie file format
2037 Movie file is .zip archive in itself, normal ZIP archive tools
2038 work on it (note: If you recompress it, do not use compression
2039 methods other than store and deflate and especially do not use
2040 encryption of any kind).
2042 11.1 Detecting clean start/SRAM/Savestate
2044 • If file has member “savestate” it is savestate, otherwise:
2046 • If file has members with names starting “moviesram.” it is
2047 movie starting from SRAM, otherwise:
2049 • It is movie starting from clear state.
2051 11.2 Member: gametype
2053 Type of game ROM and region (as one line). Valid values are:
2056 +--------------+---------------------+--------+
2057 | Value | System | Region |
2058 +--------------+---------------------+--------+
2059 +--------------+---------------------+--------+
2060 | snes_pal | Super NES | PAL |
2061 +--------------+---------------------+--------+
2062 | sgb_pal | Super Game Boy | PAL |
2063 +--------------+---------------------+--------+
2064 | snes_ntsc | Super NES | NTSC |
2065 +--------------+---------------------+--------+
2066 | sgb_ntsc | Super Game Boy | NTSC |
2067 +--------------+---------------------+--------+
2068 | bsx | BS-X (non-slotted) | NTSC |
2069 +--------------+---------------------+--------+
2070 | bsxslotted | BS-X (slotted) | NTSC |
2071 +--------------+---------------------+--------+
2072 | sufamiturbo | Sufami Turbo | NTSC |
2073 +--------------+---------------------+--------+
2079 +---------+-----------------+
2080 | Region | Framerate (fps) |
2081 +---------+-----------------+
2082 +---------+-----------------+
2083 | PAL | 322445/6448 |
2084 +---------+-----------------+
2085 | NTSC | 10738636/178683 |
2086 +---------+-----------------+
2091 Contains type of port #1 (as one line). Valid values are 'none',
2092 'gamepad', 'multitap' and 'mouse'. If not present, defaults to
2097 Contains type of port #2 (as one line). Valid values are 'none',
2098 'gamepad', 'multitap', 'mouse', 'superscope', 'justifier' and
2099 'justifiers'. If not present, defaults to 'none'.
2101 11.5 Member: gamename
2103 Contains name of the game (as one line).
2105 11.6 Member: authors
2107 Contains authors, one per line. Part before '|' is the full name,
2108 part after is the nickname.
2110 11.7 Member: systemid
2112 Always “lsnes-rr1” (one line). Used to reject other saves.
2114 11.8 Member: controlsversion
2116 Always “0” (one line). Used to identify what controls are there.
2118 11.9 Member: “coreversion”
2120 Contains bsnes core version number (as one line).
2122 11.10 Member: projectid
2124 Contains project ID (as one line). Used to identify if two movies
2125 are part of the same project.
2127 11.11 Member: {rom,slota,slotb}{,xml}.sha256
2129 Contains SHA-256 of said ROM or ROM mapping file (as one line).
2130 Absent if corresponding file is absent.
2132 11.12 Member: moviesram.<name>
2134 Raw binary startup SRAM of kind <name>. Only present in
2135 savestates and movies starting from SRAM.
2137 11.13 Member: saveframe
2139 Contains frame number (as one line) of frame movie was saved on.
2140 Only present in savestates.
2142 11.14 Member: lagcounter
2144 Current value of lag counter (as one line). Only present in
2147 11.15 Member: pollcounters
2149 Contains poll counters (currently 100 of them), one per line.
2150 Each line is raw poll count if DRDY is set for it. Otherwise it
2151 is negative poll count minus one. Only present in savestates.
2153 11.16 Member: hostmemory
2155 Raw binary dump of host memory. Only present in savestates.
2157 11.17 Member: savestate
2159 The raw binary savestate itself. Savestate detection uses this
2160 file, only present in savestates.
2162 11.18 Member: screenshot
2164 Screenshot of current frame. Only present in savestates. First 2
2165 bytes are big-endian width of image, rest are 24-bit RGB image
2166 data. Height of image is inferred from the width and size of
2169 11.19 Member: sram.<name>
2171 Raw binary SRAM of kind <name> at time of savestate. Only present
2176 The actual input track, one line per subframe (blank lines are
2179 • If the first byte of each line is '.', ' ', <tab> or '|', then
2180 the line is part of same frame as previous, otherwise it starts
2183 • First subframe must start a new frame.
2185 Length of movie in frames is number of lines in input file that
2188 11.21 Member: rerecords
2190 Contains textual base-10 rerecord count (as one line; emulator
2191 just writes this, it doesn't read it) + 1.
2193 11.22 Member: rrdata
2195 This member stores set of load IDs. There is one load ID per
2196 rerecord (plus one corresponding to start of project).
2198 • This member constists of concatenation of records
2200 • Each record is 2-36 bytes long and can represent 1-16,843,009
2203 • IDs are interpretted as 256-bit big-endian integers with
2206 • Initial predicted ID is all zeroes.
2208 Format of each record is:
2210 • 1 byte: Opcode byte. Bits 0-4 are prefix length (prefixlen),
2211 bits 5-6 are count length (countlen). Bit 7 is unused.
2213 • 32-prefixlen bytes of ID.
2215 • countlen bytes of big-endian count (count).
2217 Records are processed as follows:
2219 • To form the first ID encoded by record, take the first
2220 prefixlen bytes predicted ID and append the read ID value to
2221 it. The result is the first ID encoded.
2223 • If countlen is 0, record encodes 1 ID.
2225 • If countlen is 1, record encodes 2+count IDs.
2227 • If countlen is 2, record encodes 258+count IDs.
2229 • If countlen is 3, record encodes 65794+count IDs.
2231 • The new predicted ID is the next ID after last one encoded by
2234 The number of rerecords + 1 is equal to the sum of number of IDs
2235 encoded by all records.
2237 11.23 Member: starttime.second
2239 Movie starting time, second part. Epoch is Unix epoch. Default is
2242 11.24 Member: starttime.subsecond
2244 Movie starting time, subsecond part. Unit is CPU clocks. Default
2247 11.25 Member: savetime.second
2249 Movie saving time, second part. Default is starttime.second. Only
2250 present in savestates.
2252 11.26 Member: savetime.subsecond
2254 Movie saving time, subsecond part. Default is
2255 starttime.subsecond. Only present in savestates.
2257 12 Quick'n'dirty encode guide
2259 1. Start the emulator and load the movie file.
2261 2. Set large AVI option 'set-setting avi-large on'
2263 3. Enable dumping 'dump-avi tmpdump'
2265 4. Unpause and let it run until you want to end dumping.
2267 5. Close the emulator (closing the window is the easiest way). Or
2270 6. For each tmpdump*.avi file created, on command prompt, do
2271 'x264 --crf 10 -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
2273 7. Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
2275 8. Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv +
2276 tmpdump_0000001.mkv + tmpdump_0000002.mkv' (list every
2277 tmpdump_<numbers>.mkv, with + in between).
2279 9. Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'. Now
2280 final.mkv contains quick'n'dirty encode.
2282 13 Axis configurations for some gamepad types:
2284 13.1 XBox360 controller:
2286 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be
2289 set-axis joystick0axis2 pressure-+
2291 set-axis joystick0axis5 pressure-+
2293 • This is needed for SDL only. EVDEV sets those types correctly.
2295 13.2 PS3 “sixaxis” controller:
2297 Axes 8-19 should be disabled.
2299 set-axis joystick0axis8 disabled
2301 set-axis joystick0axis9 disabled
2303 set-axis joystick0axis10 disabled
2305 set-axis joystick0axis11 disabled
2307 set-axis joystick0axis12 disabled
2309 set-axis joystick0axis13 disabled
2311 set-axis joystick0axis14 disabled
2313 set-axis joystick0axis15 disabled
2315 set-axis joystick0axis16 disabled
2317 set-axis joystick0axis17 disabled
2319 set-axis joystick0axis18 disabled
2321 set-axis joystick0axis19 disabled
2325 14.1 Problems from BSNES core:
2327 • The whole pending save stuff.
2329 • Lack of layer hiding.
2331 • It is slow (especially accuracy).
2333 • Firmwares can't be loaded from ZIP archives.
2335 14.2 Other problems:
2337 • Modifiers don't work with pseudo-keys (SDL, EVDEV).
2339 • Audio for last dumped frame is not itself dumped.
2341 • Audio in UI is pretty bad in quality if game doesn't run at
2344 • AVI compression levels 10-18 are not compatible with AVISynth
2347 • No menus, command based interface (SDL).
2349 • Long commands don't scroll.
2351 • Wxwidgets UI is still buggy.
2357 • Fix -Wall warnings
2359 • Fix dumper video corruption with levels 10-18.
2365 • Lots of code cleanups
2367 • Lua interface to settings
2369 • Allow specifying AVI borders without Lua
2371 • Fix scaling if vscale > 1 and originx > 0 (left border exists)
2373 • on_snoop lua callback
2375 • Faster movie loading and saving.
2385 • Save jukebox functionality.
2389 • Try to fix some nasty failing movie load edge cases
2391 • Allow specifying scripts to run on command line.
2395 • Major source code reorganization.
2397 • Backup savestates before overwriting.
2399 • Don't crash if loading initial state fails.
2403 • Fix firmware lookup
2405 • Fix author name parsing
2407 • Fix rerecord counting
2409 • (SDL) Print messages to console if SDL is uninitialized
2411 • Add movieinfo program
2413 • Fix loading movies starting from SRAM.
2417 • Add support for unattended dumping
2419 • Fix compiling for Win32
2421 • Don't lock up if sound can't be initialized
2423 • Strip trailing CR from commands
2425 • Don't try to do dubious things in global ctors (fix crash on
2430 • Small documentation tweaking
2434 • Fix major bug in modifier matching
2438 • Lots of documentation fixes
2440 • Use dedicated callbacks for event backcomm., not commands.
2442 • Ensure that the watchdog is not hit when executing delayed
2445 • Remove errant tab from joystick message.
2449 • Make autofire operate in absolute time, not linear time
2451 • Reinitialize controls when resuming from loadstate
2453 • Some more code cleanups
2455 • If Lua allocator fails, call OOM_panic()
2457 • Byte/word/dword/qword sized host memory write/read functions.
2459 • Dump at correct framerate if dumping interlaced NTSC
2464 • Actually include the complete source code
2470 • Document {save,start}time.{,sub}second.
2472 • Intercept time() from bsnes core.
2476 • Allow disabling time() interception (allow build on Mac OS X)
2478 • Use SDLMain on Mac OS X (make SDL not crash)
2480 • Disable delayed resets (just plain too buggy for now).
2484 • Use 16-bit for graphics/video instead of 32-bit.
2486 • gui.rectangle/gui.pixel
2490 • New CSCD writer implementation.
2494 • Fix interaction of * and +.
2496 • Manual improvements
2498 • Use gettimeofday()/usleep(), these seem portable enough.
2500 • Move joystick axis manipulation to keymapper code.
2502 • Changes to how read-only works.
2504 • Refactor controller input code.
2508 • Fix mouseclick scale compensation.
2510 • Draw area boundaries correctly in SDL code.
2514 • Fix CSCD output (buffer overrun and race condition).
2518 • JMD dumping support.
2520 • Allow unattended dumping to JMD.
2522 • Move to BSNES v083.
2524 • Switch back to 32-bit colors.
2526 • Add Lua function gui.color.
2528 • Use some new C++11 features in GCC 4.6.
2530 • Be prepared for core frequency changes.
2532 • Pass colors in one chunk from Lua.
2536 • New lua functions gui.line(), gui.status() and gui.circle(),
2537 memory.vma_count(), memory.read_vma() and memory.find_vma().
2539 • Numerious documentation fixups
2541 • RTC time format changed
2543 • Reformat flags display
2545 • Allow lua package name to be overridden
2547 • SDUMP (high-quality dumping).
2549 • Split platform support to plugins.
2551 • Make all sound plugins support basic sound commands
2553 • Support portaudio for sound.
2555 • Allow disable Lua/SDL searching.
2557 • Upconvert colors when copying lcscreen to screen.
2559 • Reorganize source tree.
2561 • Evdev joystick support.
2563 • Refactor more code into generic window code.
2567 • Refactor message handling.
2571 • Documentation fixes
2573 • Finish pending saves before load/quit.
2575 • Wxwidgets graphics plugin.
2579 • Get rid of win32-crap.[ch]pp.
2581 • Move files around a lot.
2583 • Get rid of need for host C++ compiler.
2587 • Refactor inter-component communication.
2591 • Fix crash on multiline aliases.
2593 • Load/Save settings in wxwidgets gui.
2597 • Patch problems in bsnes core
2599 • SNES is little-endian, not big-endian!
2601 • Fix memory corruption in lcscreen::load()
2605 • Fix interpretting repeat counts in rrdata loading.
2607 • New lua callback: on_frame()
2609 • Remove calls to runtosave() that aren't supposed to be there
2611 • Lua function: movie.read_rtc()
2613 • Ignore src/fonts/font.cpp
2615 • Fix more bsnes core problems
2617 • Control bsnes random seeding
2621 • Some bsnes core debugging features (state dump and state hash)
2623 • Fix titlebar version number (no, the last version wasn't
2624 'lsnes-0-beta21', it was 'lsnes rr0-beta21').
2628 • Fix memory corruption due to macro/field mixup
2630 • search-memory update
2632 • Allow direct-mapped framebuffer
2634 • SDL: Use SDL_ANYFORMAT if possible
2636 • SDMP2SOX: 2s delay modes.
2638 • Wxwidgets: Cleanups
2640 • Use sed -E, not sed -r. Fixes building on Mac OS X.
2642 • Wxwidgets: Save jukebox on exit
2644 • Fix RTC if using load-movie on savestate.
2646 • Fix crash related to full console mode.
2650 • Wxwidgets: Allow bringing application to foreground on Mac OS
2653 • Wxwidgets: Allow compiling on Mac OS X.
2655 • Use movie compare instead of movie hashing (faster save/load).
2657 • Lua: _SYSTEM table.
2661 • sdmp2sox: Pad soundtrack if using -l or -L.
2663 • sdmp2sox: Fix NTSC overscan.
2665 • sdmp2sox: Add AR correction mode.
2667 • call lua_close() when exiting.
2669 • Fix zip_writer bug causing warnings from info-zip and error
2674 • Fix IPS patching code (use bsnes core IPS patcher).
2676 • Implement BPS patching (using bsnes core IPS patcher).
2678 • Add feature to load headered ROMs.
2682 • Show command names when showing keybindings
2686 • Fix pause-on-end to be actually controllable
2688 • SDL: Poll all events in queue, not just first one (fixes
2689 slowness in command typing)
2691 • Wxwidgets: Fix ROM loading.
2695 • Lua: Add gui.textH, gui.textV, gui.textHV
2697 • Fix text colors on SDL on Mac OS X
2699 • Mode 'F' for finished in readonly mode.
2701 • Fix some WS errors.
2703 • Reliably pause after skip poll
2705 • Split UI and core into their own threads
2709 • Remove leftover dummy SRAM slot
2711 • Fix controller numbers.
2715 • Fix lsnes-dumpavi after interface change.
2717 • Also give BSNES patches for v085.
2719 • Pack movie data in memory.
2723 • Fix framecount/length given when loading movies.
2725 • Controller command memory leak fixes.
2727 • Don't leak palette if freeing screen object.
2733 • Wxwidgets: Allow controlling dumper from the menu.
2737 • Rewrite parts of manual
2739 • Lua: Make it work with Lua 5.2.
2743 • Win32: Fix compile errors.
2747 • Refactor controller input code.
2749 • Fix crash when using command line on SDL / Mac OS X.
2753 • Delete core/coroutine (obsolete)
2755 • Lag input display by one frame.
2757 • Rewind movie to beginning function.
2759 • Fix wrong frame number reported to Lua when repainting after
2762 • Support UI editing of jukebox
2764 • Wxwidgets: Save settings on exit.
2766 • Support ${project} for filenames
2768 • SDL: Fix command history
2772 • Fix some order-of-global-ctor bugs.
2776 • Fix crashes when quitting on Win32.
2780 • EVDEV: Queue keypresses from joystick, don't send directly
2782 • Wxwidgets: Load-Preserve that actually works.
2786 • Wxwidgets: GUI for memory search.
2788 • Warn about using synchronous queue in UI callback.
2792 • Remember last saved file for each ROM
2794 • Support MT dumping via boost.
2798 • Lua: input.keyhook
2800 • Make mouse be ordinary input instead of special-casing
2802 • SDL: Don't screw up commands with NUL codepoints.
2806 • Merge status panel and main window
2808 • True movie slot support (the rest of it)
2810 • SDL: Fix compilation error
2812 • Elminate cross calls in dump menu code.
2816 • Cancel pending saves command
2818 • Wxwidgets: Code refactoring
2820 • Wxwidgets: Fix system -> reset
2822 • Wxwidgets: Read watch expressions in the right thread
2826 • Wxwidgets: Don't prompt for member when running Lua script (Lua
2827 doesn't support that).
2829 • Wxwidgets: 128 -> 1024 Autohold slots (in case more are
2832 • Don't append trailing '-' to prefix when saving movie.
2834 • Fix ROM/savestate handling (don't let user mismatch ROM and
2839 • Document memory watch syntax.
2843 • Fix unattended dumping (lsnes-dumpavi)
2845 • Support RAW dumping
2847 • Use adv_dumper instead of the old interface in lsnes-dumpavi
2850 • Add option to control sample rate preturbation in AVI dumper
2854 • Wxwidgets: Fix dumper submodes
2856 • Set core controller types before loadstate
2858 15.49 rr1-delta2epsilon1
2860 • Fix compiling with bsnes v086.
2864 • Don't prompt before quitting
2866 • Start unpaused, preserve pause/unpause over load.
2868 • Try to autodetect if ROM is headered.
2870 • Wxwidgets: Only bring up ROM patching screen if specifically
2873 • Allow configuring some hotkeys.
2877 • Lots of code cleanups
2879 • Fix JMD compression (JMD dumping was broken)
2881 • Don't crash if Lua C function throws an exception.
2883 • Support bitmap drawing in Lua.
2885 • Fix bsnes v085/v086 patches.
2887 • Improve stability on win32.
2889 15.52 rr1-delta4epsilon1
2891 • Don't corrupt movie if movie length is integer multiple of
2896 • New Lua hooks: on_rewind, on_frame_emulated, on_idle, on_timer
2898 • New Lua functions: emulator_ready(), utime(),
2899 set_idle_timeout(), set_timer_timeout(), bit.extract(),
2900 bit.value(), input.geta(), input.seta() and
2901 input.controllertype()
2903 • Wxwidgets: Fix internal focus lost (hotkeys stop working)
2905 • Wxwidgets: Fix broken modifiers
2907 • on_paint has parameter now.
2909 • Optional initital fill for bitmaps
2911 • Fix palette changing.
2913 • Optimize rendering a bit.
2915 • Bsnes v087 support.
2917 15.54 rr1-delta5epsilon1
2919 • Movieinfo: Fix display of port #2 type.
2921 • Call on_input() after loadstate.
2923 15.55 rr1-delta5epsilon2
2925 • Fix writing port2 data to movie.