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 4.4.7 --load-library=<library>
340 Load the specified shared object / dynamic library / dynamic link
343 5 Startup file lsnes.rc
345 Upon startup, lsnes (lsnes/SDL only) executes file lsnes.rc as
346 commands. This file is located in:
348 • Windows: %APPDATA%\lsnes\lsnes.rc (if %APPDATA% exists)
350 • Unix: $XDG_CONFIG_HOME/lsnes/lsnes.rc (if $XDG_CONFIG_HOME
353 • Unix: $HOME/.config/lsnes/lsnes.rc (if $HOME exists)
355 • All: ./lsnes.rc (fallback default).
357 If leading directories do not exist, attempt to create them is
362 • Commands beginning with '*' invoke the corresponding command
363 without alias expansion.
365 • If command starts with '+' (after possible '*'), the command is
366 executed as-is when button is pressed, and when button is
367 released, it is executed with '+' replaced by '-'.
369 • Commands without '+' execute only on negative edge (release).
373 Settings control various aspects of emulator behaviour.
375 6.1.1 set-setting <setting> <value>
377 Sets setting <setting> to value <value> (may be empty).
379 6.1.2 unset-setting <setting>
381 Try to unset setting <setting> (not all settings can be unset).
383 6.1.3 get-setting <setting>
385 Read value of setting <setting>
389 Print names and values of all settings.
393 Keybindings bind commands or aliases to keys (or pseudo-keys).
397 • Do not bind edge active (+/-) commands to keys with modifiers,
398 that won't work right!
400 • Names of keys and modifiers are platform-dependent.
402 • Be careful before binding pseudo-keys (such as joystick axes,
403 buttons or hats) with modifiers. That may or may not work
406 6.2.1 bind-key [<mod>/<modmask>] <key> <command>
408 Bind <command> to key <key> (activating if modifiers in <modmask>
409 (comma-seperated list) are set as <mod> (comma-seperated list).
411 The names of keys and modifiers are platform-dependent.
413 6.2.2 unbind-key [<mod>/<modmask>] <key>
415 Unbind command from <key> (with specified <mod> and <modmask>).
417 6.2.3 set-axis <axis> [disabled | axis | axis-inverse |
418 pressure0- | pressure0+ | pressure-0 | pressure-+ | pressure+0
419 | pressure+-] [minus=<val>] [zero=<val>] [plus=<val>]
422 Set axis parameters for axis <axis>.
424 • disabled: Disable axis
428 • axis-inverse: Inverse axis
430 • pressure0-: Pressure sensitive. Released at 0, pressed at -.
432 • pressure0+: Pressure sensitive. Released at 0, pressed at +.
434 • pressure-0: Pressure sensitive. Released at -, pressed at 0.
436 • pressure-+: Pressure sensitive. Released at -, pressed at +.
438 • pressure+0: Pressure sensitive. Released at +, pressed at 0.
440 • pressure+-: Pressure sensitive. Released at +, pressed at -.
442 • minus=<val>: Calibration at extreme minus position
445 • zero=<val>: Calibration at neutral position (-32768-32767)
447 • plus=<val>: Calibration at extreme plus position (-32768-32767)
449 • tolerance=<value>: Center band tolerance (0<x<1). The smaller
450 the value, the more sensitive the control is.
454 Print all key bindings in effect.
458 Aliases bind command to sequence of commands. After alias has
459 been defined, it replaces the command it shadows.
463 • You can't alias command to itself.
465 • Aliases starting with +/- are edge active just like ordinary
466 commands starting with +/-.
468 • One command can be aliased to multiple commands.
470 6.3.1 alias-command <command> <expansion>
472 Append <expansion> to alias <command>. If alias does not already
473 exist, it is created.
475 6.3.2 unalias-command <command>
477 Clear alias expansion for <command>.
481 Print all aliases and their expansions in effect.
483 6.4 run-script <script>
485 Run <script> as if commands were entered on the command line.
489 Following commands control video dumping:
491 6.5.1 start-dump <dumper> [<mode>] <prefix/filename>
493 Start dumping using dumper <dumper>. If mode is present or not
494 and if prefix or filename is present depends on the dumper and
497 The following dumpers are available:
499 • INTERNAL-AVI-CSCD: Internal CSCD in .avi dumper.
501 – Mode: uncompressed/pcm: Uncompressed video, PCM audio. Takes
504 – Mode: cscd/pcm: CSCD video, PCM audio. Takes prefix.
506 • INTERNAL-JMD: Internal .jmd dumper.
508 – Does not take mode.
512 • INTERNAL-RAW: Internal RAW dumper.
514 – Does not take mode.
518 – Sound is big-endian signed 16-bit, usually at 32040.5Hz.
520 – Video is always upscaled to double resolution (512x448 / 512
523 – Video framerate is usually 322445/6448 fps for PAL and
524 10738636/178683 fps for NTSC.
526 • INTERNAL-SDMP: Internal SDMP dumper.
528 – Mode 'ms': Multi-segment. Takes prefix.
530 – Mode 'ss': Single-segment. Takes filename.
532 6.5.2 end-dump <dumper>
534 End dumping using <dumper>
536 6.5.3 show-dumpers [<dumper>]
538 Show the list of dumpers or list of modes for <dumper>
540 6.6 Memory manipulation
542 <address> may be decimal or hexadecimal (prefixed with '0x').
543 <value> can be hexadecimal (prefixed with '0x'), unsigned or
544 signed (prefixed with '-') decimal.
546 The available element <sizes> are:
556 When reading RAM and ROM, multi-byte reads/writes are big-endian.
557 When dealing with DSP memory, multi-byte reads/writes are
558 native-endian (do not use operand sizes exceeding DSP bitness,
559 except dword is OK for 24-bit memory).
561 6.6.1 read-<size> <address>
563 Read the value of byte in <address>.
565 6.6.2 read-s<size> <address>
567 Read the value of signed byte in <address>.
569 6.6.3 write-<size> <address> <value>
571 Write <value> to byte in address <address>.
573 6.6.4 search-memory reset
575 Reset the memory search
577 6.6.5 search-memory count
579 Print number of candidates remaining
581 6.6.6 search-memory print
583 Print all candidates remaining
585 6.6.7 search-memory <usflag><sizeflag><op>
587 Searches memory for addresses satisfying criteria.
607 • lt: < previous value.
609 • le: <= previous value.
611 • eq: = previous value.
613 • ne: != previous value.
615 • ge: >= previous value.
617 • gt: > previous value.
619 6.6.8 search-memory <sizeflag> <value>
621 Searches for addresses that currently have value <value>.
622 <sizeflag> is as in previous command.
626 These commands are not available in lsnesrc, but are available
627 after ROM has been loaded.
629 6.7.1 quit-emulator [/y]
631 Quits the emulator (asking for confirmation). If /y is given, no
632 confirmation is asked.
636 Toggle paused/unpaused
640 Advance frame. If the button is still held after configurable
641 timeout expires, game unpauses for the duration frame advance is
646 Advance subframe. If the button is still held after configurable
647 timeout expires, game unpauses for the duration frame advance is
650 6.7.5 advance-skiplag
652 Skip to first poll in frame after current.
656 Reset the SNES after this frame.
658 6.7.7 load <filename>
660 Load savestate <filename> in current mode.
662 6.7.8 load-state <filename>
664 Load savestate <filename> in readwrite mode.
666 6.7.9 load-readonly <filename>
668 Load savestate <filename> in readonly mode.
670 6.7.10 load-preserve <filename>
672 Load savestate <filename> in readonly mode, preserving current
675 6.7.11 load-movie <filename>
677 Load savestate <filename>, ignoring save part in readonly mode.
679 6.7.12 save-state <filename>
681 Save system state to <filename> as soon as possible.
683 6.7.13 save-movie <filename>
685 Save movie to <filename>.
697 Toggle between read-only and read-write modes.
699 6.7.17 set-gamename <name>
701 Set name of the game to <name>
705 Print the name of the game.
707 6.7.19 add-author <author>
709 Adds new author <author>. If <author> does not contain '|' it is
710 full name. If it contains '|', '|' splits the full name and
713 6.7.20 edit-author <num> <author>
715 Edit the author in slot <num> (0-based) to be <author> (see
716 add-author for format)
718 6.7.21 remove-author <num>
720 Remove author in slot <num>
726 6.7.23 test-1, test-2, test-3
728 Internal test commands. Don't use.
730 6.7.24 take-screenshot <filename>
732 Save screenshot to <filename>.
734 6.7.25 +controller<num><button>
736 Press button <button> on controller <num> (1-8). The following
737 button names are known:
771 6.7.26 controllerh<num><button>
773 Hold/unhold button <button> on controller <num> (1-8). See
774 +controller for button names.
776 6.7.27 autofire (<pattern>|-)...
778 Set autofire pattern. Each parameter is comma-separated list of
779 button names (in form of 1start, 1A, 2B, etc..) to hold on that
780 frame. After reaching the end of pattern, the pattern restarts
789 6.8.1 cycle-jukebox-backward
791 Cycle save jukebox backwards.
793 6.8.2 cycle-jukebox-forward
795 Cycle save jukebox forwards
797 6.8.3 add-jukebox-save <filename>
799 Add <filename> to jukebox saves.
803 Do load from jukebox (current mode).
807 Do state save to jukebox.
811 Only available if lua support is compiled in.
813 6.9.1 evaluate-lua <luacode>
815 Run Lua code <luacode> using built-in Lua interpretter.
817 6.9.2 run-lua <script>
819 Run specified lua file using built-in Lua interpretter.
823 6.10.1 add-watch <name> <expression>
825 Adds new watch (or modifies old one).
827 6.10.2 remove-watch <name>
833 6.11.1 enable-sound <on/off>
835 Enable/Disable sound.
837 6.11.2 set-sound-device <device>
839 Set sound device to <device>
841 6.11.3 show-sound-status
843 Show status of sound system.
845 6.11.4 show-sound-devices
847 Show all available devices.
849 6.12 SDL Platform commands
851 The following are valid on SDL platform.
855 Asks to press a key and then identifies that (pseudo-)key.
857 6.12.2 toggle-console
859 Toggle between windowed/fullscreen console.
863 Scroll messages window as far back as it goes.
865 6.12.4 scroll-fulldown
867 Scroll messages window as far forward as it goes.
871 Scroll messages window back one screenful.
875 Scroll messages window forward one screenful.
883 Set where bsnes looks for firmware files. Default is “.”.
887 Set the target fps. Numeric, range is 0.001 to “infinite”.
888 Default is native framerate.
890 7.1.3 savecompression
892 Set save compression level (integer 0-9). Default is 7 (0 is no
895 7.1.4 advance-timeout
897 Set the frame advance timeout in milliseconds. Numeric integer,
898 range is 0-999999999. Default is 500.
900 7.2 AVI dumper settings
904 AVI dumper: Always dump at 512x448 or 512x478 regardless of what
907 7.2.2 avi-left-border
909 AVI dumper: Set the default left border thickness (unless lua
910 overrides) for dumps. Range 0-8191. Default is 0.
912 7.2.3 avi-right-border
914 AVI dumper: Set the default right border thickness (unless lua
915 overrides) for dumps. Range 0-8191. Default is 0.
919 AVI dumper: Set the default top border thickness (unless lua
920 overrides) for dumps. Range 0-8191. Default is 0.
922 7.2.5 avi-bottom-border
924 AVI dumper: Set the default bottom border thickness (unless lua
925 overrides) for dumps. Range 0-8191. Default is 0.
929 AVI dumper: Maximum number of frames per dump segment (0 =>
930 unlimited). Range 0-999999999. Default is 0.
932 7.2.7 avi-compresison
934 AVI dumper: Compression level (0-18).
936 • Compression levels 10 and above are not compatible with stock
939 • Recomended level is 7.
943 AVI dumper: Set method of determining the sound rate.
945 • 0: Pick nearest of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48,
946 64, 88.2, 96, 128, 176.4 and 192 kHz.
948 • 1: Round down to nearest integer.
950 • 2: Round up to nearest ingeter.
956 JMD dumper: Compression level (0-9).
958 7.4 SDL platform settings
960 7.4.1 autorepeat-first-delay
962 Sets the delay for first character in typematic autorepeat.
964 7.4.2 autorepeat-subsequent-delay
966 Sets the delay for subsequent characters in typematic autorepeat.
970 8.1 Core (in main table)
974 Print line to message console.
976 8.1.2 exec(string command)
978 Run command as it was entered on the command line
982 Bitwise logical functions and related.
984 8.2.1 bit.none(number...) / bit.bnot(number...)
986 48-bit bitwise NOT / NONE function (set bits that are set in none
989 8.2.2 bit.any(number...) / bit.bor(number...)
991 48-bit bitwise OR / ANY function (set bits that are set in any of
994 8.2.3 bit.all(number...) / bit.band(number...)
996 48-bit bitwise AND / ALL function (set bits that are set in all
999 8.2.4 bit.parity(number...) / bit.bxor(number...)
1001 48-bit bitwise XOR / PARITY function (set bits that are set in
1002 odd number of the arguments).
1004 8.2.5 bit.lrotate(number base[, number amount[, number bits]])
1006 Rotate bits-bit (max 48, default 48) number left by amount
1009 8.2.6 bit.rrotate(number base[, number amount[, number bits]])
1011 Rotate bits-bit (max 48, default 48) number right by amount
1014 8.2.7 bit.lshift(number base[, number amount[, number bits]])
1016 Shift bits-bit (max 48, default 48) number left by amount
1017 (default 1) places. The new bits are filled with zeroes.
1019 8.2.8 bit.lrshift(number base[, number amount[, number bits]])
1021 Shift bits-bit (max 48, default 48) number logically right by
1022 amount (default 1) places. The new bits are filled with zeroes.
1024 8.2.9 bit.arshift(number base[, number amount[, number bits]])
1026 Shift bits-bit (max 48, default 48) number arithmetically right
1027 by amount (default 1) places. The new bits are shifted in with
1028 copy of the high bit.
1032 Most of these functions can only be called in on_paint and
1033 on_video callbacks. Exceptions are noted.
1035 Colors are 32-bit. Bits 0-7 are the blue component, bits 8-15 are
1036 the green component, bits 16-23 are the red component, bits 24-31
1037 are alpha component (0 is fully opaque, 255 is almost
1038 transparent). -1 is the fully transparent color. Alpha values
1039 greater than 127 do work.
1041 Origin of coordinates is at top left corner of game display area.
1042 Left and top gaps correspond to negative coordinates.
1044 8.3.1 gui.resolution()
1046 Returns 2-tuple (hresolution, vresolution).
1048 8.3.2 gui.<class>_gap(number gap)
1050 Set the <class> (left, right, top, bottom) gap to specified value
1053 8.3.3 gui.text(number x, number y, string text[, number fgc[,
1056 Draw specified text on the GUI (each character cell is 8 or 16
1057 wide and 16 high). Parameters:
1059 • x: X-coordinate to start the drawing from (and x-coordinate at
1060 begining of the lines).
1062 • y: Y-coordinate to start the drawing from.
1064 • text: The text to draw.
1066 • fgc: Text color (default is 0xFFFFFF (white))
1068 • bgc: Background color (default is -1 (transparent))
1070 8.3.4 gui.textH(number x, number y, string text[, number fgc[,
1073 Like gui.text, but draw using double-width.
1075 8.3.5 gui.textV(number x, number y, string text[, number fgc[,
1078 Like gui.text, but draw using double-height.
1080 8.3.6 gui.textHV(number x, number y, string text[, number fgc[,
1083 Like gui.text, but draw using double-width/double-height.
1085 8.3.7 gui.rectangle(number x, number y, number width, number
1086 height[, number thickness[, number outline[, number fill]]])
1088 Draw rectangle on the GUI. Parameters:
1090 • x: X-coordinate of left edge.
1092 • y: Y-coordinate of upper edge.
1094 • width: Width of rectangle.
1096 • height: Height of rectangle.
1098 • thickness: Thickness of outline (default is 1).
1100 • outline: Color of outline (default is 0xFFFFFF (white))
1102 • fill: Color of fil (default is -1 (transparent))
1104 8.3.8 gui.pixel(number x, number y[, number color])
1106 Draw one pixel on the GUI. Parameters:
1108 • x: X-coordinate of the pixel
1110 • y: Y-coordinate of the pixel
1112 • color: Color of the pixel (default is 0xFFFFFF (white))
1114 8.3.9 gui.crosshair(number x, number y[, number length[, number
1117 Draw a crosshair. Parameters:
1119 • x: X-coordinate of the crosshair
1121 • y: Y-coordinate of the crosshair
1123 • length: Length of the crosshair lines (default 10).
1125 • color: Color of the crosshair (default is 0xFFFFFF (white))
1127 8.3.10 gui.line(number x1, number y1, number x2, number y2[,
1130 Draw a thin line. Parameters:
1132 • x1: X-coordinate of one end.
1134 • y1: Y-coordinate of one end.
1136 • x2: X-coordinate of the other end.
1138 • y2: Y-coordinate of the other end.
1140 • color: Color of the line (default is 0xFFFFFF (white)).
1142 8.3.11 gui.circle(number x, number y, number r[, number thick[,
1143 number border[, number fil]]])
1145 Draw a circle. Parameters.
1147 • x: X-coordinate of the center
1149 • y: Y-coordinate of the center
1151 • r: The radius of the circle
1153 • thick: Border thickness
1155 • border: Border color (default is 0xFFFFFF (white))
1157 • fill: Fill color (default is -1 (transparent)).
1159 8.3.12 gui.bitmap_draw(number x, number y, bitmap bitmap, palette
1162 Draw a bitmap on screen with specified palette. Parameters:
1164 • x: X-coordinate of left edge.
1166 • y: Y-coordinate of top edge.
1168 • bitmap: The bitmap to draw
1170 • palette: The palette to draw the bitmap using.
1172 8.3.13 gui.bitmap_draw(number x, number y, dbitmap bitmap)
1174 Draw a bitmap on screen. Parameters:
1176 • x: X-coordinate of left edge.
1178 • y: Y-coordinate of top edge.
1180 • bitmap: The bitmap to draw
1182 8.3.14 gui.palette_new()
1184 Returns a new palette (initially all transparent). Can be used
1187 8.3.15 gui.bitmap_new(number w, number h, boolean direct)
1189 Returns a new bitmap/dbitmap. Can be used anywhere. Parameters:
1191 • w: The width of new bitmap
1193 • h: The height of new bitmap
1195 • direct: If true, the returned bitmap is dbitmap, otherwise
1198 8.3.16 gui.bitmap_load(string file)
1200 Returns loaded bitmap/dbitmap (if bitmap, the second return value
1201 is palette for bitmap). Can be used anywhere. Parameters:
1203 • file: The name of file to load.
1205 8.3.17 gui.palette_set(palette palette, number index, number
1208 Sets color in palette. Can be used anywhere. Parameters:
1210 • palette: The palette to manipulate
1212 • index: Index of color (0-65535).
1214 • color: The color value.
1216 8.3.18 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y,
1219 Sets specified pixel in bitmap. Can be used anywhere. Parameters:
1221 • bitmap: The bitmap to manipulate
1223 • x: The x-coordinate of the pixel.
1225 • y: The y-coordinate of the pixel.
1227 • color: If bitmap is a bitmap, color index (0-65535). Otherwise
1230 8.3.19 gui.bitmap_size(bitmap/dbitmap bitmap)
1232 Get size of bitmap. Can be used anywhere. Parameters:
1234 • bitmap: The bitmap to query.
1236 The first return is the width, the second is the height.
1238 8.3.20 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy,
1239 bitmap/dbitmap src, number sx, number sy, number w, number h[,
1242 Blit a part of bitmap to another. Can be used anywhere.
1245 • dest: Destination to blit to.
1247 • dx: left edge of target
1249 • dy: Top edge of target
1251 • src: The source to blit from. Must be of the same type as
1254 • sx: left edge of source
1256 • sy: Top edge of source
1258 • w: Width of region
1260 • h: Height of region.
1262 • ck: Color key. Pixels of this color are not blitted.
1264 – If bitmaps are bitmaps, this is color index of colorkey.
1265 Values outside range 0-65535 cause no key to be used as
1268 – If bitmaps are dbitmaps, this color value of colorkey.
1270 – May be absent or nil for no colorkey blit.
1272 8.3.21 gui.repaint()
1274 Request on_repaint() to happen as soon as possible. Can be used
1277 8.3.22 gui.subframe_update(boolean on)
1279 Request subframe updates (calling on_paint() on subframes) to
1280 happen (on=true) or not happen (on=false). Can be used anywhere.
1282 8.3.23 gui.screenshot(string filename)
1284 Write PNG screenshot of the current frame (no drawings) to
1285 specified file. Can be used anywhere.
1287 8.3.24 gui.color(number r, number g, number b[, number a])
1289 Returns color (in notation Lua scripts use) corresponding to
1290 color (r,g,b), each component in scale 0-255. If a is specified,
1291 that is alpha (0 is fully transparent, 256(sic) is fully opaque).
1292 The default alpha is 256.
1294 8.3.25 gui.status(string name, string value)
1296 Set status field “L[<name>]” to <value> in status area. Can be
1301 Input handling. Only available in on_input callback.
1303 8.4.1 input.get(number controller, number index)
1305 Read the specified index (0-11) from specified controller (0-7).
1308 • Uses physical controller numbering. Gamepad in port 2 is
1309 controller 4, not 1!
1311 8.4.2 input.set(number controller, number index, number value)
1313 Write the specified index (0-11) from specified controller (0-7),
1314 storing value. Notes:
1316 • Uses physical controller numbering. Gamepad in port 2 is
1317 controller 4, not 1!
1319 8.4.3 input.reset([number cycles])
1321 Execute reset. If cycles is greater than zero, do delayed reset.
1322 0 (or no value) causes immediate reset.
1324 • Only available with subframe flag false.
1328 Returns table of tables of all available keys and axes. The first
1329 table is indexed by key name (platform-dependent!), and the inner
1330 table has the following fields:
1332 • last_rawval: Last reported raw value for control.
1334 • ktype: Type of key (disabled, key, mouse, axis, axis-inverse,
1335 hat, pressure-m0, pressure-mp, pressure-0m, pressure-0p,
1336 pressure-pm, pressure-p0).
1338 • cal_left: Minimum calibration value. Only meaningful with axis
1341 • cal_center: Center calibration value. Only meaningful with axis
1344 • cal_right: Maximum calibration value. Only meaningful with axis
1347 • cal_tolerance: Dead zone tolerance. Only meaningful with axis
1350 8.4.5 input.keyhook(key, state)
1352 Requests that keyhook events to be sent for key (state=true) or
1353 not sent (state=false).
1355 8.5 Table hostmemory
1357 Host memory handling (extra memory saved to savestates). Host
1358 memory starts empty.
1360 8.5.1 hostmemory.read(number address)
1362 Reads hostmemory slot address. Slot numbers out of range return
1363 false instead of numeric.
1365 8.5.2 hostmemory.write(number address, number value)
1367 Writes hostmemory slot with 0-255. Slot numbers out of range
1368 cause extension of host memory slot space.
1370 8.5.3 hostmemory.readbyte(number address)
1372 Read unsigned byte (1 element) from given address. Slots out of
1375 8.5.4 hostmemory.writebyte(number address, number value)
1377 Write unsigned byte (1 element) to given slot. Slot numbers out
1378 of range cause extension.
1380 8.5.5 hostmemory.readsbyte(number address)
1382 Read signed byte (1 element) from given address. Slots out of
1385 8.5.6 hostmemory.writesbyte(number address, number value)
1387 Write signed byte (1 element) to given slot. Slot numbers out of
1388 range cause extension.
1390 8.5.7 hostmemory.readword(number address)
1392 Read unsigned word (2 elements) from given address. Slots out of
1395 8.5.8 hostmemory.writeword(number address, number value)
1397 Write unsigned word (2 elements) to given slot. Slot numbers out
1398 of range cause extension.
1400 8.5.9 hostmemory.readsword(number address)
1402 Read signed word (2 elements) from given address. Slots out of
1405 8.5.10 hostmemory.writesword(number address, number value)
1407 Write signed word (2 elements) to given slot. Slot numbers out of
1408 range cause extension.
1410 8.5.11 hostmemory.readdword(number address)
1412 Read unsigned doubleword (4 elements) from given address. Slots
1413 out of range return false.
1415 8.5.12 hostmemory.writedword(number address, number value)
1417 Write unsigned doubleword (4 elements) to given slot. Slot
1418 numbers out of range cause extension.
1420 8.5.13 hostmemory.readsdword(number address)
1422 Read signed doubleword (4 elements) from given address. Slots out
1423 of range return false.
1425 8.5.14 hostmemory.writesdword(number address, number value)
1427 Write signed doubleword (4 elements) to given slot. Slot numbers
1428 out of range cause extension.
1430 8.5.15 hostmemory.readqword(number address)
1432 Read unsigned quadword (8 elements) from given address. Slots out
1433 of range return false.
1435 8.5.16 hostmemory.writeqword(number address, number value)
1437 Write unsigned quadword (4 elements) to given slot. Slot numbers
1438 out of range cause extension.
1440 8.5.17 hostmemory.readsqword(number address)
1442 Read signed quadword (8 elements) from given address. Slots out
1443 of range return false.
1445 8.5.18 hostmemory.writesqword(number address, number value)
1447 Write signed quadword (8 elements) to given slot. Slot numbers
1448 out of range cause extension.
1454 8.6.1 movie.currentframe()
1456 Return number of current frame.
1458 8.6.2 movie.framecount()
1460 Return number of frames in movie.
1462 8.6.3 movie.readonly()
1464 Return true if in readonly mode, false if in readwrite.
1466 8.6.4 movie.set_readwrite()
1468 Set readwrite mode (does not cause on_readwrite callback).
1470 8.6.5 movie.frame_subframes(number frame)
1472 Count number of subframes in specified frame (frame numbers are
1473 1-based) and return that.
1475 8.6.6 movie.read_subframe(number frame, number subframe)
1477 Read specifed subframe in specified frame and return data as
1478 array (100 elements, numbered 0-99 currently).
1482 Routines for settings manipulation
1484 8.7.1 settings.get(string name)
1486 Get value of setting. If setting is blank, returns false. If
1487 setting value can't be obtained, returns (nil, error message).
1489 8.7.2 settings.set(string name, string value)
1491 Set value of setting. If setting can't be set, returns (nil,
1494 8.7.3 settings.is_set(string name)
1496 Returns if setting is set. If setting does not exist, returns
1497 (nil, error message).
1499 8.7.4 settings.blank(string name)
1501 Blanks a setting and returns true. If setting can't be blanked,
1502 returns (nil, error message).
1506 Contains various functions for managing memory
1508 8.8.1 memory.vma_count()
1510 Returns the number of VMAs
1512 8.8.2 memory.read_vma(number index)
1514 Reads the specified VMA (indices start from zero). Trying to read
1515 invalid VMA gives nil. The read VMA is table with the following
1518 • region_name (string): The readable name of the VMA
1520 • baseaddr (number): Base address of the VMA
1522 • lastaddr (number): Last address in the VMA.
1524 • size (number): The size of VMA in bytes.
1526 • readonly (boolean): True of the VMA corresponds to ROM.
1528 • native_endian (boolean): True if the VMA has native endian as
1529 opposed to little endian.
1531 8.8.3 memory.find_vma(number address)
1533 Finds the VMA containing specified address. Returns table in the
1534 same format as read_vma or nil if not found.
1536 8.8.4 memory.readbyte(number address)
1538 Reads the specified address as unsigned byte and returns the
1541 8.8.5 memory.readsbyte(number address)
1543 Reads the specified address as signed byte and returns the
1546 8.8.6 memory.writebyte(number address, number value)
1548 Writes the specified value (negative values undergo 2's
1549 complement) to specified address (as a byte).
1551 8.8.7 memory.readword(number address)
1553 Reads the specified address as unsigned word and returns the
1556 8.8.8 memory.readsword(number address)
1558 Reads the specified address as signed word and returns the
1561 8.8.9 memory.writeword(number address, number value)
1563 Writes the specified value (negative values undergo 2's
1564 complement) to specified address (as a word).
1566 8.8.10 memory.readdword(number address)
1568 Reads the specified address as unsigned doubleword and returns
1571 8.8.11 memory.readsdword(number address)
1573 Reads the specified address as signed doubleword and returns the
1576 8.8.12 memory.writedword(number address, number value)
1578 Writes the specified value (negative values undergo 2's
1579 complement) to specified address (as a doubleword).
1581 8.8.13 memory.readqword(number address)
1583 Reads the specified address as unsigned quadword and returns the
1586 8.8.14 memory.readsqword(number address)
1588 Reads the specified address as signed quadword and returns the
1591 8.8.15 memory.writeqword(number address, number value)
1593 Writes the specified value (negative values undergo 2's
1594 complement) to specified address (as a quadword).
1598 Contains copy of global variables from time of Lua
1599 initialization. Non-writeable.
1603 Various callbacks to Lua that can occur.
1605 8.10.1 Callback: on_paint()
1607 Called when screen is being painted. Any gui.* calls requiring
1608 graphic context draw on the screen.
1610 8.10.2 Callback: on_video()
1612 Called when video dump frame is being painted. Any gui.* calls
1613 requiring graphic context draw on the video.
1615 8.10.3 Callback: on_frame()
1617 Called on each starting whole frame.
1619 8.10.4 Callback: on_startup()
1621 Called when the emulator is starting (lsnes.rc and --run files
1624 8.10.5 Callback: on_pre_load(string name)
1626 Called just before savestate/movie load occurs (note: loads are
1627 always delayed, so this occurs even when load was initiated by
1630 8.10.6 Callback: on_err_load(string name)
1632 Called if loadstate goes wrong.
1634 8.10.7 Callback: on_post_load(string name, boolean was_savestate)
1636 Called on successful loadstate. was_savestate gives if this was a
1637 savestate or a movie.
1639 8.10.8 Callback: on_pre_save(string name, boolean is_savestate)
1641 Called just before savestate save occurs (note: movie saves are
1642 synchronous and won't trigger these callbacks if called from
1645 8.10.9 Callback: on_err_save(string name)
1647 Called if savestate goes wrong.
1649 8.10.10 Callback: on_post_save(string name, boolean is_savestate)
1651 Called on successful savaestate. is_savestate gives if this was a
1652 savestate or a movie.
1654 8.10.11 Callback: on_quit()
1656 Called when emulator is shutting down.
1658 8.10.12 Callback: on_input(boolean subframe)
1660 Called when emulator is just sending input to bsnes core.
1661 Warning: This is called even in readonly mode, but the results
1664 8.10.13 Callback: on_reset()
1666 Called when SNES is reset.
1668 8.10.14 Callback: on_readwrite()
1670 Called when moving into readwrite mode as result of “set-rwmode”
1671 command (note: moving to rwmode by Lua won't trigger this, as per
1672 recursive entry protection).
1674 8.10.15 Callback: on_snoop(number port, number controller, number
1675 index, number value)
1677 Called each time bsnes asks for input. The value is the final
1678 value to be sent to bsnes core (readonly mode, autohold and
1679 autofire have been taken into account). Might be useful when
1680 translating movies to format suitable for console verification.
1681 Note: There is no way to modify the value to be sent.
1683 8.10.16 Callback: on_keyhook(string keyname, table state)
1685 Sent when key that has keyhook events requested changes state.
1686 Keyname is name of the key (group) and state is the state (same
1687 kind as table values in input.raw).
1689 9 Memory watch expression syntax
1691 Memory watch expressions are in RPN (Reverse Polish Notation). At
1692 the end of expression, the top entry on stack is taken as the
1697 • Evaluation order is strictly left to right.
1699 • a is the entry on top of stack
1701 • b is the entry immediately below top of stack
1703 • ; separates values to be pushed (no intermediate pop).
1705 • After end of element, all used stack slots are popped and all
1708 • When pushing multiple values, the pushes occur in order shown.
1710 The following operators are available:
1724 • b : read_signed_byte(a)
1728 • d : read_signed_dword(a)
1730 • i : quotent(a / b)
1735 • q : read_signed_qword(a)
1745 • w : read_signed_word(a)
1749 • B : read_unsigned_byte(a)
1751 • C<number>z : Push number <number> to stack.
1753 • D : read_unsigned_dword(a)
1755 • C0x<number>z : Push number <number> (hexadecimal) to stack.
1757 • Q : read_unsigned_qword(a)
1759 • R<digit> : round a to <digit> digits.
1761 • W : read_unsigned_word(a)
1765 C0x007e0878zWC0x007e002czW-
1767 1. Push value 0x7e0878 on top of stack (C0x007e0878z).
1769 2. Pop the value on top of stack (0x7e0878), read word value at
1770 that address and push the result,call it x1 (W).
1772 3. Push value 0x7e002c on top of stack (C0x007e002cz).
1774 4. Pop the value on top of stack (0x7e002c), read word value at
1775 that address and push the result,call it x2 (W).
1777 5. Pop the two top numbers on stack, x1 and x2, substract x1 from
1778 x2 and push x2 - x1 (-).
1780 6. Since the expression ends, the final memory watch result is
1781 the top one on stack, which is x2 - x1.
1783 10 Modifier and key names:
1787 10.1.1 Modifier names
1789 Following modifier names are known:
1791 • ctrl, lctrl, rctrl: Control keys
1793 • alt, lalt, ralt: ALT keys.
1795 • shift, lshift, rshift: Shift keys.
1797 • meta, lmeta, rmeta: Meta keys.
1799 • num, caps: Numlock/Capslock (these are sticky!)
1801 • mode: Mode select.
1805 Following key names are known:
1807 • backspace, tab, clear, return, pause, escape, space, exclaim,
1808 quotedbl, hash, dollar, ampersand, quote, leftparen,
1809 rightparen, asterisk, plus, comma, minus, period, slash, 0, 1,
1810 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
1811 greater, question, at, leftbracket, backslash, rightbracket,
1812 caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k,
1813 l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0,
1814 world_1, world_2, world_3, world_4, world_5, world_6, world_7,
1815 world_8, world_9, world_10, world_11, world_12, world_13,
1816 world_14, world_15, world_16, world_17, world_18, world_19,
1817 world_20, world_21, world_22, world_23, world_24, world_25,
1818 world_26, world_27, world_28, world_29, world_30, world_31,
1819 world_32, world_33, world_34, world_35, world_36, world_37,
1820 world_38, world_39, world_40, world_41, world_42, world_43,
1821 world_44, world_45, world_46, world_47, world_48, world_49,
1822 world_50, world_51, world_52, world_53, world_54, world_55,
1823 world_56, world_57, world_58, world_59, world_60, world_61,
1824 world_62, world_63, world_64, world_65, world_66, world_67,
1825 world_68, world_69, world_70, world_71, world_72, world_73,
1826 world_74, world_75, world_76, world_77, world_78, world_79,
1827 world_80, world_81, world_82, world_83, world_84, world_85,
1828 world_86, world_87, world_88, world_89, world_90, world_91,
1829 world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3,
1830 kp4, kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide,
1831 kp_multiply, kp_minus, kp_plus, kp_enter, kp_equals, up, down,
1832 right, left, insert, home, end, pageup, pagedown, f1, f2, f3,
1833 f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, numlock,
1834 capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt, lalt,
1835 rmeta, lmeta, lsuper, rsuper, mode, compose, help, print,
1836 sysreq, break, menu, power, euro, undo
1838 • Names of form 'key<n>' where <n> is 0-255 are interpretted as
1839 key having hardware-dependent scan code of <n> (useful to bind
1840 those keys that don't have symbolic names).
1842 10.1.3 Joystick pseudo-keys:
1844 • joystick<num>button<button>: Joystick <num> (0-based) button
1847 • joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat>
1850 • joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat>
1853 • joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat>
1856 • joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat>
1859 • joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis>
1860 negative position (axis modes axis and axis_inverse).
1862 • joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis>
1863 positive position (axis modes axis and axis_inverse).
1865 • joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis>
1866 pressure (axis modes pressure_*).
1868 10.1.4 Special buttons:
1870 • Escape: Enter/Exit Command mode, cancel modal dialogs.
1872 • Return (also KPEnter): Execute command, ok modal dialog.
1874 • Pgup/Up (also KP8/9 if no num lock; command mode): Previous
1875 command in command history
1877 • Pgdn/Down(also KP2/3 if no num lock; command mode): Next
1878 command in command history
1880 • Home (also KP7 if no num lock; command mode): Beginning of
1883 • End (also KP1 if no num lock; command mode): End of command.
1885 • Left (also KP4 if no num lock; command mode): Move cursor left.
1887 • Right (also KP6 if no num lock; command mode): Move cursor
1890 • Delete (also KP. if no num lock; command mode): Delete
1891 character to right of cursor.
1893 • Insert (also KP0 if no num lock; command mode): Toggle between
1894 insert / overwrite modes.
1896 • Backspace (command mode): Delete character to left of cursor.
1898 • LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump
1901 10.2 wxWidgets platform
1903 10.2.1 Modifier names:
1905 Following modifier names are known:
1915 • cmd (Mac OS X only)
1919 Following key names are known:
1921 • back, tab, return, escape, space, exclaim, quotedbl, hash,
1922 dollar, percent, ampersand, quote, leftparen, rightparen,
1923 asterisk, plus, comma, minus, period, slash, 0, 1, 2, 3, 4, 5,
1924 6, 7, 8, 9, colon, semicolon, less, equals, greater, question,
1925 at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t,
1926 u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
1927 underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m,
1928 n, o, p, q, r, s, t, u, v, w, x, y, z, leftcurly, pipe,
1929 rightcurly, tilde, delete, start, lbutton, rbutton, cancel,
1930 mbutton, clear, shift, alt, control, menu, pause, capital, end,
1931 home, lefT, up, right, down, select, print, execute, snapshot,
1932 insert, help, numpad0, numpad1, numpad2, numpad3, numpad4,
1933 numpad5, numpad6, numpad7, numpad8, numpad9, multiply, add,
1934 separator, subtract, decimal, divide, f1, f2, f3, f4, f5, f6,
1935 f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19,
1936 f20, f21, f22, f23, f24, numlock, scroll, pageup, pagedown,
1937 numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
1938 numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up,
1939 numpad_right, numpad_down, numpad_pageup, numpad_pagedown,
1940 numpad_end, numpad_begin, numpad_insert, numpad_delete,
1941 numpad_equal, numpad_multiply, numpad_add, numpad_separator,
1942 numpad_subtract, numpad_decimal, numpad_divide, windows_left,
1943 windows_right, windows_menu, command, special1, special2,
1944 special3, special4, special5, special6, special7, special8,
1945 special9, special10, special11, special12, special13,
1946 special14, special15, special16, special17, special18,
1947 special19, special20
1949 11 Movie file format
1951 Movie file is .zip archive in itself, normal ZIP archive tools
1952 work on it (note: If you recompress it, do not use compression
1953 methods other than store and deflate and especially do not use
1954 encryption of any kind).
1956 11.1 Detecting clean start/SRAM/Savestate
1958 • If file has member “savestate” it is savestate, otherwise:
1960 • If file has members with names starting “moviesram.” it is
1961 movie starting from SRAM, otherwise:
1963 • It is movie starting from clear state.
1965 11.2 Member: gametype
1967 Type of game ROM and region (as one line). Valid values are:
1970 +--------------+---------------------+--------+
1971 | Value | System | Region |
1972 +--------------+---------------------+--------+
1973 +--------------+---------------------+--------+
1974 | snes_pal | Super NES | PAL |
1975 +--------------+---------------------+--------+
1976 | sgb_pal | Super Game Boy | PAL |
1977 +--------------+---------------------+--------+
1978 | snes_ntsc | Super NES | NTSC |
1979 +--------------+---------------------+--------+
1980 | sgb_ntsc | Super Game Boy | NTSC |
1981 +--------------+---------------------+--------+
1982 | bsx | BS-X (non-slotted) | NTSC |
1983 +--------------+---------------------+--------+
1984 | bsxslotted | BS-X (slotted) | NTSC |
1985 +--------------+---------------------+--------+
1986 | sufamiturbo | Sufami Turbo | NTSC |
1987 +--------------+---------------------+--------+
1993 +---------+-----------------+
1994 | Region | Framerate (fps) |
1995 +---------+-----------------+
1996 +---------+-----------------+
1997 | PAL | 322445/6448 |
1998 +---------+-----------------+
1999 | NTSC | 10738636/178683 |
2000 +---------+-----------------+
2005 Contains type of port #1 (as one line). Valid values are 'none',
2006 'gamepad', 'multitap' and 'mouse'. If not present, defaults to
2011 Contains type of port #2 (as one line). Valid values are 'none',
2012 'gamepad', 'multitap', 'mouse', 'superscope', 'justifier' and
2013 'justifiers'. If not present, defaults to 'none'.
2015 11.5 Member: gamename
2017 Contains name of the game (as one line).
2019 11.6 Member: authors
2021 Contains authors, one per line. Part before '|' is the full name,
2022 part after is the nickname.
2024 11.7 Member: systemid
2026 Always “lsnes-rr1” (one line). Used to reject other saves.
2028 11.8 Member: controlsversion
2030 Always “0” (one line). Used to identify what controls are there.
2032 11.9 Member: “coreversion”
2034 Contains bsnes core version number (as one line).
2036 11.10 Member: projectid
2038 Contains project ID (as one line). Used to identify if two movies
2039 are part of the same project.
2041 11.11 Member: {rom,slota,slotb}{,xml}.sha256
2043 Contains SHA-256 of said ROM or ROM mapping file (as one line).
2044 Absent if corresponding file is absent.
2046 11.12 Member: moviesram.<name>
2048 Raw binary startup SRAM of kind <name>. Only present in
2049 savestates and movies starting from SRAM.
2051 11.13 Member: saveframe
2053 Contains frame number (as one line) of frame movie was saved on.
2054 Only present in savestates.
2056 11.14 Member: lagcounter
2058 Current value of lag counter (as one line). Only present in
2061 11.15 Member: pollcounters
2063 Contains poll counters (currently 100 of them), one per line.
2064 Each line is raw poll count if DRDY is set for it. Otherwise it
2065 is negative poll count minus one. Only present in savestates.
2067 11.16 Member: hostmemory
2069 Raw binary dump of host memory. Only present in savestates.
2071 11.17 Member: savestate
2073 The raw binary savestate itself. Savestate detection uses this
2074 file, only present in savestates.
2076 11.18 Member: screenshot
2078 Screenshot of current frame. Only present in savestates. First 2
2079 bytes are big-endian width of image, rest are 24-bit RGB image
2080 data. Height of image is inferred from the width and size of
2083 11.19 Member: sram.<name>
2085 Raw binary SRAM of kind <name> at time of savestate. Only present
2090 The actual input track, one line per subframe (blank lines are
2093 • If the first byte of each line is '.', ' ', <tab> or '|', then
2094 the line is part of same frame as previous, otherwise it starts
2097 • First subframe must start a new frame.
2099 Length of movie in frames is number of lines in input file that
2102 11.21 Member: rerecords
2104 Contains textual base-10 rerecord count (as one line; emulator
2105 just writes this, it doesn't read it) + 1.
2107 11.22 Member: rrdata
2109 This member stores set of load IDs. There is one load ID per
2110 rerecord (plus one corresponding to start of project).
2112 • This member constists of concatenation of records
2114 • Each record is 2-36 bytes long and can represent 1-16,843,009
2117 • IDs are interpretted as 256-bit big-endian integers with
2120 • Initial predicted ID is all zeroes.
2122 Format of each record is:
2124 • 1 byte: Opcode byte. Bits 0-4 are prefix length (prefixlen),
2125 bits 5-6 are count length (countlen). Bit 7 is unused.
2127 • 32-prefixlen bytes of ID.
2129 • countlen bytes of big-endian count (count).
2131 Records are processed as follows:
2133 • To form the first ID encoded by record, take the first
2134 prefixlen bytes predicted ID and append the read ID value to
2135 it. The result is the first ID encoded.
2137 • If countlen is 0, record encodes 1 ID.
2139 • If countlen is 1, record encodes 2+count IDs.
2141 • If countlen is 2, record encodes 258+count IDs.
2143 • If countlen is 3, record encodes 65794+count IDs.
2145 • The new predicted ID is the next ID after last one encoded by
2148 The number of rerecords + 1 is equal to the sum of number of IDs
2149 encoded by all records.
2151 11.23 Member: starttime.second
2153 Movie starting time, second part. Epoch is Unix epoch. Default is
2156 11.24 Member: starttime.subsecond
2158 Movie starting time, subsecond part. Unit is CPU clocks. Default
2161 11.25 Member: savetime.second
2163 Movie saving time, second part. Default is starttime.second. Only
2164 present in savestates.
2166 11.26 Member: savetime.subsecond
2168 Movie saving time, subsecond part. Default is
2169 starttime.subsecond. Only present in savestates.
2171 12 Quick'n'dirty encode guide
2173 1. Start the emulator and load the movie file.
2175 2. Set large AVI option 'set-setting avi-large on'
2177 3. Enable dumping 'dump-avi tmpdump'
2179 4. Unpause and let it run until you want to end dumping.
2181 5. Close the emulator (closing the window is the easiest way). Or
2184 6. For each tmpdump*.avi file created, on command prompt, do
2185 'x264 --crf 10 -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
2187 7. Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
2189 8. Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv +
2190 tmpdump_0000001.mkv + tmpdump_0000002.mkv' (list every
2191 tmpdump_<numbers>.mkv, with + in between).
2193 9. Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'. Now
2194 final.mkv contains quick'n'dirty encode.
2196 13 Axis configurations for some gamepad types:
2198 13.1 XBox360 controller:
2200 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be
2203 set-axis joystick0axis2 pressure-+
2205 set-axis joystick0axis5 pressure-+
2207 • This is needed for SDL only. EVDEV sets those types correctly.
2209 13.2 PS3 “sixaxis” controller:
2211 Axes 8-19 should be disabled.
2213 set-axis joystick0axis8 disabled
2215 set-axis joystick0axis9 disabled
2217 set-axis joystick0axis10 disabled
2219 set-axis joystick0axis11 disabled
2221 set-axis joystick0axis12 disabled
2223 set-axis joystick0axis13 disabled
2225 set-axis joystick0axis14 disabled
2227 set-axis joystick0axis15 disabled
2229 set-axis joystick0axis16 disabled
2231 set-axis joystick0axis17 disabled
2233 set-axis joystick0axis18 disabled
2235 set-axis joystick0axis19 disabled
2239 14.1 Problems from BSNES core:
2241 • The whole pending save stuff.
2243 • Lack of layer hiding.
2245 • It is slow (especially accuracy).
2247 • Firmwares can't be loaded from ZIP archives.
2249 14.2 Other problems:
2251 • Modifiers don't work with pseudo-keys (SDL, EVDEV).
2253 • Audio for last dumped frame is not itself dumped.
2255 • Audio in UI is pretty bad in quality if game doesn't run at
2258 • AVI compression levels 10-18 are not compatible with AVISynth
2261 • No menus, command based interface (SDL).
2263 • Long commands don't scroll.
2265 • Wxwidgets UI is still buggy.
2271 • Fix -Wall warnings
2273 • Fix dumper video corruption with levels 10-18.
2279 • Lots of code cleanups
2281 • Lua interface to settings
2283 • Allow specifying AVI borders without Lua
2285 • Fix scaling if vscale > 1 and originx > 0 (left border exists)
2287 • on_snoop lua callback
2289 • Faster movie loading and saving.
2299 • Save jukebox functionality.
2303 • Try to fix some nasty failing movie load edge cases
2305 • Allow specifying scripts to run on command line.
2309 • Major source code reorganization.
2311 • Backup savestates before overwriting.
2313 • Don't crash if loading initial state fails.
2317 • Fix firmware lookup
2319 • Fix author name parsing
2321 • Fix rerecord counting
2323 • (SDL) Print messages to console if SDL is uninitialized
2325 • Add movieinfo program
2327 • Fix loading movies starting from SRAM.
2331 • Add support for unattended dumping
2333 • Fix compiling for Win32
2335 • Don't lock up if sound can't be initialized
2337 • Strip trailing CR from commands
2339 • Don't try to do dubious things in global ctors (fix crash on
2344 • Small documentation tweaking
2348 • Fix major bug in modifier matching
2352 • Lots of documentation fixes
2354 • Use dedicated callbacks for event backcomm., not commands.
2356 • Ensure that the watchdog is not hit when executing delayed
2359 • Remove errant tab from joystick message.
2363 • Make autofire operate in absolute time, not linear time
2365 • Reinitialize controls when resuming from loadstate
2367 • Some more code cleanups
2369 • If Lua allocator fails, call OOM_panic()
2371 • Byte/word/dword/qword sized host memory write/read functions.
2373 • Dump at correct framerate if dumping interlaced NTSC
2378 • Actually include the complete source code
2384 • Document {save,start}time.{,sub}second.
2386 • Intercept time() from bsnes core.
2390 • Allow disabling time() interception (allow build on Mac OS X)
2392 • Use SDLMain on Mac OS X (make SDL not crash)
2394 • Disable delayed resets (just plain too buggy for now).
2398 • Use 16-bit for graphics/video instead of 32-bit.
2400 • gui.rectangle/gui.pixel
2404 • New CSCD writer implementation.
2408 • Fix interaction of * and +.
2410 • Manual improvements
2412 • Use gettimeofday()/usleep(), these seem portable enough.
2414 • Move joystick axis manipulation to keymapper code.
2416 • Changes to how read-only works.
2418 • Refactor controller input code.
2422 • Fix mouseclick scale compensation.
2424 • Draw area boundaries correctly in SDL code.
2428 • Fix CSCD output (buffer overrun and race condition).
2432 • JMD dumping support.
2434 • Allow unattended dumping to JMD.
2436 • Move to BSNES v083.
2438 • Switch back to 32-bit colors.
2440 • Add Lua function gui.color.
2442 • Use some new C++11 features in GCC 4.6.
2444 • Be prepared for core frequency changes.
2446 • Pass colors in one chunk from Lua.
2450 • New lua functions gui.line(), gui.status() and gui.circle(),
2451 memory.vma_count(), memory.read_vma() and memory.find_vma().
2453 • Numerious documentation fixups
2455 • RTC time format changed
2457 • Reformat flags display
2459 • Allow lua package name to be overridden
2461 • SDUMP (high-quality dumping).
2463 • Split platform support to plugins.
2465 • Make all sound plugins support basic sound commands
2467 • Support portaudio for sound.
2469 • Allow disable Lua/SDL searching.
2471 • Upconvert colors when copying lcscreen to screen.
2473 • Reorganize source tree.
2475 • Evdev joystick support.
2477 • Refactor more code into generic window code.
2481 • Refactor message handling.
2485 • Documentation fixes
2487 • Finish pending saves before load/quit.
2489 • Wxwidgets graphics plugin.
2493 • Get rid of win32-crap.[ch]pp.
2495 • Move files around a lot.
2497 • Get rid of need for host C++ compiler.
2501 • Refactor inter-component communication.
2505 • Fix crash on multiline aliases.
2507 • Load/Save settings in wxwidgets gui.
2511 • Patch problems in bsnes core
2513 • SNES is little-endian, not big-endian!
2515 • Fix memory corruption in lcscreen::load()
2519 • Fix interpretting repeat counts in rrdata loading.
2521 • New lua callback: on_frame()
2523 • Remove calls to runtosave() that aren't supposed to be there
2525 • Lua function: movie.read_rtc()
2527 • Ignore src/fonts/font.cpp
2529 • Fix more bsnes core problems
2531 • Control bsnes random seeding
2535 • Some bsnes core debugging features (state dump and state hash)
2537 • Fix titlebar version number (no, the last version wasn't
2538 'lsnes-0-beta21', it was 'lsnes rr0-beta21').
2542 • Fix memory corruption due to macro/field mixup
2544 • search-memory update
2546 • Allow direct-mapped framebuffer
2548 • SDL: Use SDL_ANYFORMAT if possible
2550 • SDMP2SOX: 2s delay modes.
2552 • Wxwidgets: Cleanups
2554 • Use sed -E, not sed -r. Fixes building on Mac OS X.
2556 • Wxwidgets: Save jukebox on exit
2558 • Fix RTC if using load-movie on savestate.
2560 • Fix crash related to full console mode.
2564 • Wxwidgets: Allow bringing application to foreground on Mac OS
2567 • Wxwidgets: Allow compiling on Mac OS X.
2569 • Use movie compare instead of movie hashing (faster save/load).
2571 • Lua: _SYSTEM table.
2575 • sdmp2sox: Pad soundtrack if using -l or -L.
2577 • sdmp2sox: Fix NTSC overscan.
2579 • sdmp2sox: Add AR correction mode.
2581 • call lua_close() when exiting.
2583 • Fix zip_writer bug causing warnings from info-zip and error
2588 • Fix IPS patching code (use bsnes core IPS patcher).
2590 • Implement BPS patching (using bsnes core IPS patcher).
2592 • Add feature to load headered ROMs.
2596 • Show command names when showing keybindings
2600 • Fix pause-on-end to be actually controllable
2602 • SDL: Poll all events in queue, not just first one (fixes
2603 slowness in command typing)
2605 • Wxwidgets: Fix ROM loading.
2609 • Lua: Add gui.textH, gui.textV, gui.textHV
2611 • Fix text colors on SDL on Mac OS X
2613 • Mode 'F' for finished in readonly mode.
2615 • Fix some WS errors.
2617 • Reliably pause after skip poll
2619 • Split UI and core into their own threads
2623 • Remove leftover dummy SRAM slot
2625 • Fix controller numbers.
2629 • Fix lsnes-dumpavi after interface change.
2631 • Also give BSNES patches for v085.
2633 • Pack movie data in memory.
2637 • Fix framecount/length given when loading movies.
2639 • Controller command memory leak fixes.
2641 • Don't leak palette if freeing screen object.
2647 • Wxwidgets: Allow controlling dumper from the menu.
2651 • Rewrite parts of manual
2653 • Lua: Make it work with Lua 5.2.
2657 • Win32: Fix compile errors.
2661 • Refactor controller input code.
2663 • Fix crash when using command line on SDL / Mac OS X.
2667 • Delete core/coroutine (obsolete)
2669 • Lag input display by one frame.
2671 • Rewind movie to beginning function.
2673 • Fix wrong frame number reported to Lua when repainting after
2676 • Support UI editing of jukebox
2678 • Wxwidgets: Save settings on exit.
2680 • Support ${project} for filenames
2682 • SDL: Fix command history
2686 • Fix some order-of-global-ctor bugs.
2690 • Fix crashes when quitting on Win32.
2694 • EVDEV: Queue keypresses from joystick, don't send directly
2696 • Wxwidgets: Load-Preserve that actually works.
2700 • Wxwidgets: GUI for memory search.
2702 • Warn about using synchronous queue in UI callback.
2706 • Remember last saved file for each ROM
2708 • Support MT dumping via boost.
2712 • Lua: input.keyhook
2714 • Make mouse be ordinary input instead of special-casing
2716 • SDL: Don't screw up commands with NUL codepoints.
2720 • Merge status panel and main window
2722 • True movie slot support (the rest of it)
2724 • SDL: Fix compilation error
2726 • Elminate cross calls in dump menu code.
2730 • Cancel pending saves command
2732 • Wxwidgets: Code refactoring
2734 • Wxwidgets: Fix system -> reset
2736 • Wxwidgets: Read watch expressions in the right thread
2740 • Wxwidgets: Don't prompt for member when running Lua script (Lua
2741 doesn't support that).
2743 • Wxwidgets: 128 -> 1024 Autohold slots (in case more are
2746 • Don't append trailing '-' to prefix when saving movie.
2748 • Fix ROM/savestate handling (don't let user mismatch ROM and
2753 • Document memory watch syntax.
2757 • Fix unattended dumping (lsnes-dumpavi)
2759 • Support RAW dumping
2761 • Use adv_dumper instead of the old interface in lsnes-dumpavi
2764 • Add option to control sample rate preturbation in AVI dumper
2768 • Wxwidgets: Fix dumper submodes
2770 • Set core controller types before loadstate
2772 15.49 rr1-delta2epsilon1
2774 • Fix compiling with bsnes v086.
2778 • Don't prompt before quitting
2780 • Start unpaused, preserve pause/unpause over load.
2782 • Try to autodetect if ROM is headered.
2784 • Wxwidgets: Only bring up ROM patching screen if specifically
2787 • Allow configuring some hotkeys.