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 Bitwise logical functions and related.
978 8.2.1 bit.none(number...) / bit.bnot(number...)
980 48-bit bitwise NOT / NONE function (set bits that are set in none
983 8.2.2 bit.any(number...) / bit.bor(number...)
985 48-bit bitwise OR / ANY function (set bits that are set in any of
988 8.2.3 bit.all(number...) / bit.band(number...)
990 48-bit bitwise AND / ALL function (set bits that are set in all
993 8.2.4 bit.parity(number...) / bit.bxor(number...)
995 48-bit bitwise XOR / PARITY function (set bits that are set in
996 odd number of the arguments).
998 8.2.5 bit.lrotate(number base[, number amount[, number bits]])
1000 Rotate bits-bit (max 48, default 48) number left by amount
1003 8.2.6 bit.rrotate(number base[, number amount[, number bits]])
1005 Rotate bits-bit (max 48, default 48) number right by amount
1008 8.2.7 bit.lshift(number base[, number amount[, number bits]])
1010 Shift bits-bit (max 48, default 48) number left by amount
1011 (default 1) places. The new bits are filled with zeroes.
1013 8.2.8 bit.lrshift(number base[, number amount[, number bits]])
1015 Shift bits-bit (max 48, default 48) number logically right by
1016 amount (default 1) places. The new bits are filled with zeroes.
1018 8.2.9 bit.arshift(number base[, number amount[, number bits]])
1020 Shift bits-bit (max 48, default 48) number arithmetically right
1021 by amount (default 1) places. The new bits are shifted in with
1022 copy of the high bit.
1026 Most of these functions can only be called in on_paint and
1027 on_video callbacks. Exceptions are noted.
1029 Colors are 32-bit. Bits 0-7 are the blue component, bits 8-15 are
1030 the green component, bits 16-23 are the red component, bits 24-31
1031 are alpha component (0 is fully opaque, 255 is almost
1032 transparent). -1 is the fully transparent color. Alpha values
1033 greater than 127 do work.
1035 Origin of coordinates is at top left corner of game display area.
1036 Left and top gaps correspond to negative coordinates.
1038 8.3.1 gui.resolution()
1040 Returns 2-tuple (hresolution, vresolution).
1042 8.3.2 gui.<class>_gap(number gap)
1044 Set the <class> (left, right, top, bottom) gap to specified value
1047 8.3.3 gui.text(number x, number y, string text[, number fgc[,
1050 Draw specified text on the GUI (each character cell is 8 or 16
1051 wide and 16 high). Parameters:
1053 • x: X-coordinate to start the drawing from (and x-coordinate at
1054 begining of the lines).
1056 • y: Y-coordinate to start the drawing from.
1058 • text: The text to draw.
1060 • fgc: Text color (default is 0xFFFFFF (white))
1062 • bgc: Background color (default is -1 (transparent))
1064 8.3.4 gui.textH(number x, number y, string text[, number fgc[,
1067 Like gui.text, but draw using double-width.
1069 8.3.5 gui.textV(number x, number y, string text[, number fgc[,
1072 Like gui.text, but draw using double-height.
1074 8.3.6 gui.textHV(number x, number y, string text[, number fgc[,
1077 Like gui.text, but draw using double-width/double-height.
1079 8.3.7 gui.rectangle(number x, number y, number width, number
1080 height[, number thickness[, number outline[, number fill]]])
1082 Draw rectangle on the GUI. Parameters:
1084 • x: X-coordinate of left edge.
1086 • y: Y-coordinate of upper edge.
1088 • width: Width of rectangle.
1090 • height: Height of rectangle.
1092 • thickness: Thickness of outline (default is 1).
1094 • outline: Color of outline (default is 0xFFFFFF (white))
1096 • fill: Color of fil (default is -1 (transparent))
1098 8.3.8 gui.pixel(number x, number y[, number color])
1100 Draw one pixel on the GUI. Parameters:
1102 • x: X-coordinate of the pixel
1104 • y: Y-coordinate of the pixel
1106 • color: Color of the pixel (default is 0xFFFFFF (white))
1108 8.3.9 gui.crosshair(number x, number y[, number length[, number
1111 Draw a crosshair. Parameters:
1113 • x: X-coordinate of the crosshair
1115 • y: Y-coordinate of the crosshair
1117 • length: Length of the crosshair lines (default 10).
1119 • color: Color of the crosshair (default is 0xFFFFFF (white))
1121 8.3.10 gui.line(number x1, number y1, number x2, number y2[,
1124 Draw a thin line. Parameters:
1126 • x1: X-coordinate of one end.
1128 • y1: Y-coordinate of one end.
1130 • x2: X-coordinate of the other end.
1132 • y2: Y-coordinate of the other end.
1134 • color: Color of the line (default is 0xFFFFFF (white)).
1136 8.3.11 gui.circle(number x, number y, number r[, number thick[,
1137 number border[, number fil]]])
1139 Draw a circle. Parameters.
1141 • x: X-coordinate of the center
1143 • y: Y-coordinate of the center
1145 • r: The radius of the circle
1147 • thick: Border thickness
1149 • border: Border color (default is 0xFFFFFF (white))
1151 • fill: Fill color (default is -1 (transparent)).
1153 8.3.12 gui.bitmap_draw(number x, number y, bitmap bitmap, palette
1156 Draw a bitmap on screen with specified palette. Parameters:
1158 • x: X-coordinate of left edge.
1160 • y: Y-coordinate of top edge.
1162 • bitmap: The bitmap to draw
1164 • palette: The palette to draw the bitmap using.
1166 8.3.13 gui.bitmap_draw(number x, number y, dbitmap bitmap)
1168 Draw a bitmap on screen. Parameters:
1170 • x: X-coordinate of left edge.
1172 • y: Y-coordinate of top edge.
1174 • bitmap: The bitmap to draw
1176 8.3.14 gui.palette_new()
1178 Returns a new palette (initially all transparent). Can be used
1181 8.3.15 gui.bitmap_new(number w, number h, boolean direct)
1183 Returns a new bitmap/dbitmap. Can be used anywhere. Parameters:
1185 • w: The width of new bitmap
1187 • h: The height of new bitmap
1189 • direct: If true, the returned bitmap is dbitmap, otherwise
1192 8.3.16 gui.bitmap_load(string file)
1194 Returns loaded bitmap/dbitmap (if bitmap, the second return value
1195 is palette for bitmap). Can be used anywhere. Parameters:
1197 • file: The name of file to load.
1199 8.3.17 gui.palette_set(palette palette, number index, number
1202 Sets color in palette. Can be used anywhere. Parameters:
1204 • palette: The palette to manipulate
1206 • index: Index of color (0-65535).
1208 • color: The color value.
1210 8.3.18 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y,
1213 Sets specified pixel in bitmap. Can be used anywhere. Parameters:
1215 • bitmap: The bitmap to manipulate
1217 • x: The x-coordinate of the pixel.
1219 • y: The y-coordinate of the pixel.
1221 • color: If bitmap is a bitmap, color index (0-65535). Otherwise
1224 8.3.19 gui.bitmap_size(bitmap/dbitmap bitmap)
1226 Get size of bitmap. Can be used anywhere. Parameters:
1228 • bitmap: The bitmap to query.
1230 The first return is the width, the second is the height.
1232 8.3.20 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy,
1233 bitmap/dbitmap src, number sx, number sy, number w, number h[,
1236 Blit a part of bitmap to another. Can be used anywhere.
1239 • dest: Destination to blit to.
1241 • dx: left edge of target
1243 • dy: Top edge of target
1245 • src: The source to blit from. Must be of the same type as
1248 • sx: left edge of source
1250 • sy: Top edge of source
1252 • w: Width of region
1254 • h: Height of region.
1256 • ck: Color key. Pixels of this color are not blitted.
1258 – If bitmaps are bitmaps, this is color index of colorkey.
1259 Values outside range 0-65535 cause no key to be used as
1262 – If bitmaps are dbitmaps, this color value of colorkey.
1264 – May be absent or nil for no colorkey blit.
1266 8.3.21 gui.repaint()
1268 Request on_repaint() to happen as soon as possible. Can be used
1271 8.3.22 gui.subframe_update(boolean on)
1273 Request subframe updates (calling on_paint() on subframes) to
1274 happen (on=true) or not happen (on=false). Can be used anywhere.
1276 8.3.23 gui.screenshot(string filename)
1278 Write PNG screenshot of the current frame (no drawings) to
1279 specified file. Can be used anywhere.
1281 8.3.24 gui.color(number r, number g, number b[, number a])
1283 Returns color (in notation Lua scripts use) corresponding to
1284 color (r,g,b), each component in scale 0-255. If a is specified,
1285 that is alpha (0 is fully transparent, 256(sic) is fully opaque).
1286 The default alpha is 256.
1288 8.3.25 gui.status(string name, string value)
1290 Set status field “L[<name>]” to <value> in status area. Can be
1295 Input handling. Only available in on_input callback.
1297 8.4.1 input.get(number controller, number index)
1299 Read the specified index (0-11) from specified controller (0-7).
1302 • Uses physical controller numbering. Gamepad in port 2 is
1303 controller 4, not 1!
1305 8.4.2 input.set(number controller, number index, number value)
1307 Write the specified index (0-11) from specified controller (0-7),
1308 storing value. Notes:
1310 • Uses physical controller numbering. Gamepad in port 2 is
1311 controller 4, not 1!
1313 8.4.3 input.reset([number cycles])
1315 Execute reset. If cycles is greater than zero, do delayed reset.
1316 0 (or no value) causes immediate reset.
1318 • Only available with subframe flag false.
1322 Returns table of tables of all available keys and axes. The first
1323 table is indexed by key name (platform-dependent!), and the inner
1324 table has the following fields:
1326 • last_rawval: Last reported raw value for control.
1328 • ktype: Type of key (disabled, key, mouse, axis, axis-inverse,
1329 hat, pressure-m0, pressure-mp, pressure-0m, pressure-0p,
1330 pressure-pm, pressure-p0).
1332 • cal_left: Minimum calibration value. Only meaningful with axis
1335 • cal_center: Center calibration value. Only meaningful with axis
1338 • cal_right: Maximum calibration value. Only meaningful with axis
1341 • cal_tolerance: Dead zone tolerance. Only meaningful with axis
1344 8.4.5 input.keyhook(key, state)
1346 Requests that keyhook events to be sent for key (state=true) or
1347 not sent (state=false).
1349 8.5 Table hostmemory
1351 Host memory handling (extra memory saved to savestates). Host
1352 memory starts empty.
1354 8.5.1 hostmemory.read(number address)
1356 Reads hostmemory slot address. Slot numbers out of range return
1357 false instead of numeric.
1359 8.5.2 hostmemory.write(number address, number value)
1361 Writes hostmemory slot with 0-255. Slot numbers out of range
1362 cause extension of host memory slot space.
1364 8.5.3 hostmemory.readbyte(number address)
1366 Read unsigned byte (1 element) from given address. Slots out of
1369 8.5.4 hostmemory.writebyte(number address, number value)
1371 Write unsigned byte (1 element) to given slot. Slot numbers out
1372 of range cause extension.
1374 8.5.5 hostmemory.readsbyte(number address)
1376 Read signed byte (1 element) from given address. Slots out of
1379 8.5.6 hostmemory.writesbyte(number address, number value)
1381 Write signed byte (1 element) to given slot. Slot numbers out of
1382 range cause extension.
1384 8.5.7 hostmemory.readword(number address)
1386 Read unsigned word (2 elements) from given address. Slots out of
1389 8.5.8 hostmemory.writeword(number address, number value)
1391 Write unsigned word (2 elements) to given slot. Slot numbers out
1392 of range cause extension.
1394 8.5.9 hostmemory.readsword(number address)
1396 Read signed word (2 elements) from given address. Slots out of
1399 8.5.10 hostmemory.writesword(number address, number value)
1401 Write signed word (2 elements) to given slot. Slot numbers out of
1402 range cause extension.
1404 8.5.11 hostmemory.readdword(number address)
1406 Read unsigned doubleword (4 elements) from given address. Slots
1407 out of range return false.
1409 8.5.12 hostmemory.writedword(number address, number value)
1411 Write unsigned doubleword (4 elements) to given slot. Slot
1412 numbers out of range cause extension.
1414 8.5.13 hostmemory.readsdword(number address)
1416 Read signed doubleword (4 elements) from given address. Slots out
1417 of range return false.
1419 8.5.14 hostmemory.writesdword(number address, number value)
1421 Write signed doubleword (4 elements) to given slot. Slot numbers
1422 out of range cause extension.
1424 8.5.15 hostmemory.readqword(number address)
1426 Read unsigned quadword (8 elements) from given address. Slots out
1427 of range return false.
1429 8.5.16 hostmemory.writeqword(number address, number value)
1431 Write unsigned quadword (4 elements) to given slot. Slot numbers
1432 out of range cause extension.
1434 8.5.17 hostmemory.readsqword(number address)
1436 Read signed quadword (8 elements) from given address. Slots out
1437 of range return false.
1439 8.5.18 hostmemory.writesqword(number address, number value)
1441 Write signed quadword (8 elements) to given slot. Slot numbers
1442 out of range cause extension.
1448 8.6.1 movie.currentframe()
1450 Return number of current frame.
1452 8.6.2 movie.framecount()
1454 Return number of frames in movie.
1456 8.6.3 movie.readonly()
1458 Return true if in readonly mode, false if in readwrite.
1460 8.6.4 movie.set_readwrite()
1462 Set readwrite mode (does not cause on_readwrite callback).
1464 8.6.5 movie.frame_subframes(number frame)
1466 Count number of subframes in specified frame (frame numbers are
1467 1-based) and return that.
1469 8.6.6 movie.read_subframe(number frame, number subframe)
1471 Read specifed subframe in specified frame and return data as
1472 array (100 elements, numbered 0-99 currently).
1476 Routines for settings manipulation
1478 8.7.1 settings.get(string name)
1480 Get value of setting. If setting is blank, returns false. If
1481 setting value can't be obtained, returns (nil, error message).
1483 8.7.2 settings.set(string name, string value)
1485 Set value of setting. If setting can't be set, returns (nil,
1488 8.7.3 settings.is_set(string name)
1490 Returns if setting is set. If setting does not exist, returns
1491 (nil, error message).
1493 8.7.4 settings.blank(string name)
1495 Blanks a setting and returns true. If setting can't be blanked,
1496 returns (nil, error message).
1500 Contains various functions for managing memory
1502 8.8.1 memory.vma_count()
1504 Returns the number of VMAs
1506 8.8.2 memory.read_vma(number index)
1508 Reads the specified VMA (indices start from zero). Trying to read
1509 invalid VMA gives nil. The read VMA is table with the following
1512 • region_name (string): The readable name of the VMA
1514 • baseaddr (number): Base address of the VMA
1516 • lastaddr (number): Last address in the VMA.
1518 • size (number): The size of VMA in bytes.
1520 • readonly (boolean): True of the VMA corresponds to ROM.
1522 • native_endian (boolean): True if the VMA has native endian as
1523 opposed to little endian.
1525 8.8.3 memory.find_vma(number address)
1527 Finds the VMA containing specified address. Returns table in the
1528 same format as read_vma or nil if not found.
1530 8.8.4 memory.readbyte(number address)
1532 Reads the specified address as unsigned byte and returns the
1535 8.8.5 memory.readsbyte(number address)
1537 Reads the specified address as signed byte and returns the
1540 8.8.6 memory.writebyte(number address, number value)
1542 Writes the specified value (negative values undergo 2's
1543 complement) to specified address (as a byte).
1545 8.8.7 memory.readword(number address)
1547 Reads the specified address as unsigned word and returns the
1550 8.8.8 memory.readsword(number address)
1552 Reads the specified address as signed word and returns the
1555 8.8.9 memory.writeword(number address, number value)
1557 Writes the specified value (negative values undergo 2's
1558 complement) to specified address (as a word).
1560 8.8.10 memory.readdword(number address)
1562 Reads the specified address as unsigned doubleword and returns
1565 8.8.11 memory.readsdword(number address)
1567 Reads the specified address as signed doubleword and returns the
1570 8.8.12 memory.writedword(number address, number value)
1572 Writes the specified value (negative values undergo 2's
1573 complement) to specified address (as a doubleword).
1575 8.8.13 memory.readqword(number address)
1577 Reads the specified address as unsigned quadword and returns the
1580 8.8.14 memory.readsqword(number address)
1582 Reads the specified address as signed quadword and returns the
1585 8.8.15 memory.writeqword(number address, number value)
1587 Writes the specified value (negative values undergo 2's
1588 complement) to specified address (as a quadword).
1592 Contains copy of global variables from time of Lua
1593 initialization. Non-writeable.
1597 Various callbacks to Lua that can occur.
1599 8.10.1 Callback: on_paint()
1601 Called when screen is being painted. Any gui.* calls requiring
1602 graphic context draw on the screen.
1604 8.10.2 Callback: on_video()
1606 Called when video dump frame is being painted. Any gui.* calls
1607 requiring graphic context draw on the video.
1609 8.10.3 Callback: on_frame()
1611 Called on each starting whole frame.
1613 8.10.4 Callback: on_startup()
1615 Called when the emulator is starting (lsnes.rc and --run files
1618 8.10.5 Callback: on_pre_load(string name)
1620 Called just before savestate/movie load occurs (note: loads are
1621 always delayed, so this occurs even when load was initiated by
1624 8.10.6 Callback: on_err_load(string name)
1626 Called if loadstate goes wrong.
1628 8.10.7 Callback: on_post_load(string name, boolean was_savestate)
1630 Called on successful loadstate. was_savestate gives if this was a
1631 savestate or a movie.
1633 8.10.8 Callback: on_pre_save(string name, boolean is_savestate)
1635 Called just before savestate save occurs (note: movie saves are
1636 synchronous and won't trigger these callbacks if called from
1639 8.10.9 Callback: on_err_save(string name)
1641 Called if savestate goes wrong.
1643 8.10.10 Callback: on_post_save(string name, boolean is_savestate)
1645 Called on successful savaestate. is_savestate gives if this was a
1646 savestate or a movie.
1648 8.10.11 Callback: on_quit()
1650 Called when emulator is shutting down.
1652 8.10.12 Callback: on_input(boolean subframe)
1654 Called when emulator is just sending input to bsnes core.
1655 Warning: This is called even in readonly mode, but the results
1658 8.10.13 Callback: on_reset()
1660 Called when SNES is reset.
1662 8.10.14 Callback: on_readwrite()
1664 Called when moving into readwrite mode as result of “set-rwmode”
1665 command (note: moving to rwmode by Lua won't trigger this, as per
1666 recursive entry protection).
1668 8.10.15 Callback: on_snoop(number port, number controller, number
1669 index, number value)
1671 Called each time bsnes asks for input. The value is the final
1672 value to be sent to bsnes core (readonly mode, autohold and
1673 autofire have been taken into account). Might be useful when
1674 translating movies to format suitable for console verification.
1675 Note: There is no way to modify the value to be sent.
1677 8.10.16 Callback: on_keyhook(string keyname, table state)
1679 Sent when key that has keyhook events requested changes state.
1680 Keyname is name of the key (group) and state is the state (same
1681 kind as table values in input.raw).
1683 9 Memory watch expression syntax
1685 Memory watch expressions are in RPN (Reverse Polish Notation). At
1686 the end of expression, the top entry on stack is taken as the
1691 • Evaluation order is strictly left to right.
1693 • a is the entry on top of stack
1695 • b is the entry immediately below top of stack
1697 • ; separates values to be pushed (no intermediate pop).
1699 • After end of element, all used stack slots are popped and all
1702 • When pushing multiple values, the pushes occur in order shown.
1704 The following operators are available:
1718 • b : read_signed_byte(a)
1722 • d : read_signed_dword(a)
1724 • i : quotent(a / b)
1729 • q : read_signed_qword(a)
1739 • w : read_signed_word(a)
1743 • B : read_unsigned_byte(a)
1745 • C<number>z : Push number <number> to stack.
1747 • D : read_unsigned_dword(a)
1749 • C0x<number>z : Push number <number> (hexadecimal) to stack.
1751 • Q : read_unsigned_qword(a)
1753 • R<digit> : round a to <digit> digits.
1755 • W : read_unsigned_word(a)
1759 C0x007e0878zWC0x007e002czW-
1761 1. Push value 0x7e0878 on top of stack (C0x007e0878z).
1763 2. Pop the value on top of stack (0x7e0878), read word value at
1764 that address and push the result,call it x1 (W).
1766 3. Push value 0x7e002c on top of stack (C0x007e002cz).
1768 4. Pop the value on top of stack (0x7e002c), read word value at
1769 that address and push the result,call it x2 (W).
1771 5. Pop the two top numbers on stack, x1 and x2, substract x1 from
1772 x2 and push x2 - x1 (-).
1774 6. Since the expression ends, the final memory watch result is
1775 the top one on stack, which is x2 - x1.
1777 10 Modifier and key names:
1781 10.1.1 Modifier names
1783 Following modifier names are known:
1785 • ctrl, lctrl, rctrl: Control keys
1787 • alt, lalt, ralt: ALT keys.
1789 • shift, lshift, rshift: Shift keys.
1791 • meta, lmeta, rmeta: Meta keys.
1793 • num, caps: Numlock/Capslock (these are sticky!)
1795 • mode: Mode select.
1799 Following key names are known:
1801 • backspace, tab, clear, return, pause, escape, space, exclaim,
1802 quotedbl, hash, dollar, ampersand, quote, leftparen,
1803 rightparen, asterisk, plus, comma, minus, period, slash, 0, 1,
1804 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
1805 greater, question, at, leftbracket, backslash, rightbracket,
1806 caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k,
1807 l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0,
1808 world_1, world_2, world_3, world_4, world_5, world_6, world_7,
1809 world_8, world_9, world_10, world_11, world_12, world_13,
1810 world_14, world_15, world_16, world_17, world_18, world_19,
1811 world_20, world_21, world_22, world_23, world_24, world_25,
1812 world_26, world_27, world_28, world_29, world_30, world_31,
1813 world_32, world_33, world_34, world_35, world_36, world_37,
1814 world_38, world_39, world_40, world_41, world_42, world_43,
1815 world_44, world_45, world_46, world_47, world_48, world_49,
1816 world_50, world_51, world_52, world_53, world_54, world_55,
1817 world_56, world_57, world_58, world_59, world_60, world_61,
1818 world_62, world_63, world_64, world_65, world_66, world_67,
1819 world_68, world_69, world_70, world_71, world_72, world_73,
1820 world_74, world_75, world_76, world_77, world_78, world_79,
1821 world_80, world_81, world_82, world_83, world_84, world_85,
1822 world_86, world_87, world_88, world_89, world_90, world_91,
1823 world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3,
1824 kp4, kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide,
1825 kp_multiply, kp_minus, kp_plus, kp_enter, kp_equals, up, down,
1826 right, left, insert, home, end, pageup, pagedown, f1, f2, f3,
1827 f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, numlock,
1828 capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt, lalt,
1829 rmeta, lmeta, lsuper, rsuper, mode, compose, help, print,
1830 sysreq, break, menu, power, euro, undo
1832 • Names of form 'key<n>' where <n> is 0-255 are interpretted as
1833 key having hardware-dependent scan code of <n> (useful to bind
1834 those keys that don't have symbolic names).
1836 10.1.3 Joystick pseudo-keys:
1838 • joystick<num>button<button>: Joystick <num> (0-based) button
1841 • joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat>
1844 • joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat>
1847 • joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat>
1850 • joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat>
1853 • joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis>
1854 negative position (axis modes axis and axis_inverse).
1856 • joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis>
1857 positive position (axis modes axis and axis_inverse).
1859 • joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis>
1860 pressure (axis modes pressure_*).
1862 10.1.4 Special buttons:
1864 • Escape: Enter/Exit Command mode, cancel modal dialogs.
1866 • Return (also KPEnter): Execute command, ok modal dialog.
1868 • Pgup/Up (also KP8/9 if no num lock; command mode): Previous
1869 command in command history
1871 • Pgdn/Down(also KP2/3 if no num lock; command mode): Next
1872 command in command history
1874 • Home (also KP7 if no num lock; command mode): Beginning of
1877 • End (also KP1 if no num lock; command mode): End of command.
1879 • Left (also KP4 if no num lock; command mode): Move cursor left.
1881 • Right (also KP6 if no num lock; command mode): Move cursor
1884 • Delete (also KP. if no num lock; command mode): Delete
1885 character to right of cursor.
1887 • Insert (also KP0 if no num lock; command mode): Toggle between
1888 insert / overwrite modes.
1890 • Backspace (command mode): Delete character to left of cursor.
1892 • LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump
1895 10.2 wxWidgets platform
1897 10.2.1 Modifier names:
1899 Following modifier names are known:
1909 • cmd (Mac OS X only)
1913 Following key names are known:
1915 • back, tab, return, escape, space, exclaim, quotedbl, hash,
1916 dollar, percent, ampersand, quote, leftparen, rightparen,
1917 asterisk, plus, comma, minus, period, slash, 0, 1, 2, 3, 4, 5,
1918 6, 7, 8, 9, colon, semicolon, less, equals, greater, question,
1919 at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t,
1920 u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
1921 underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m,
1922 n, o, p, q, r, s, t, u, v, w, x, y, z, leftcurly, pipe,
1923 rightcurly, tilde, delete, start, lbutton, rbutton, cancel,
1924 mbutton, clear, shift, alt, control, menu, pause, capital, end,
1925 home, lefT, up, right, down, select, print, execute, snapshot,
1926 insert, help, numpad0, numpad1, numpad2, numpad3, numpad4,
1927 numpad5, numpad6, numpad7, numpad8, numpad9, multiply, add,
1928 separator, subtract, decimal, divide, f1, f2, f3, f4, f5, f6,
1929 f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19,
1930 f20, f21, f22, f23, f24, numlock, scroll, pageup, pagedown,
1931 numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
1932 numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up,
1933 numpad_right, numpad_down, numpad_pageup, numpad_pagedown,
1934 numpad_end, numpad_begin, numpad_insert, numpad_delete,
1935 numpad_equal, numpad_multiply, numpad_add, numpad_separator,
1936 numpad_subtract, numpad_decimal, numpad_divide, windows_left,
1937 windows_right, windows_menu, command, special1, special2,
1938 special3, special4, special5, special6, special7, special8,
1939 special9, special10, special11, special12, special13,
1940 special14, special15, special16, special17, special18,
1941 special19, special20
1943 11 Movie file format
1945 Movie file is .zip archive in itself, normal ZIP archive tools
1946 work on it (note: If you recompress it, do not use compression
1947 methods other than store and deflate and especially do not use
1948 encryption of any kind).
1950 11.1 Detecting clean start/SRAM/Savestate
1952 • If file has member “savestate” it is savestate, otherwise:
1954 • If file has members with names starting “moviesram.” it is
1955 movie starting from SRAM, otherwise:
1957 • It is movie starting from clear state.
1959 11.2 Member: gametype
1961 Type of game ROM and region (as one line). Valid values are:
1964 +--------------+---------------------+--------+
1965 | Value | System | Region |
1966 +--------------+---------------------+--------+
1967 +--------------+---------------------+--------+
1968 | snes_pal | Super NES | PAL |
1969 +--------------+---------------------+--------+
1970 | sgb_pal | Super Game Boy | PAL |
1971 +--------------+---------------------+--------+
1972 | snes_ntsc | Super NES | NTSC |
1973 +--------------+---------------------+--------+
1974 | sgb_ntsc | Super Game Boy | NTSC |
1975 +--------------+---------------------+--------+
1976 | bsx | BS-X (non-slotted) | NTSC |
1977 +--------------+---------------------+--------+
1978 | bsxslotted | BS-X (slotted) | NTSC |
1979 +--------------+---------------------+--------+
1980 | sufamiturbo | Sufami Turbo | NTSC |
1981 +--------------+---------------------+--------+
1987 +---------+-----------------+
1988 | Region | Framerate (fps) |
1989 +---------+-----------------+
1990 +---------+-----------------+
1991 | PAL | 322445/6448 |
1992 +---------+-----------------+
1993 | NTSC | 10738636/178683 |
1994 +---------+-----------------+
1999 Contains type of port #1 (as one line). Valid values are 'none',
2000 'gamepad', 'multitap' and 'mouse'. If not present, defaults to
2005 Contains type of port #2 (as one line). Valid values are 'none',
2006 'gamepad', 'multitap', 'mouse', 'superscope', 'justifier' and
2007 'justifiers'. If not present, defaults to 'none'.
2009 11.5 Member: gamename
2011 Contains name of the game (as one line).
2013 11.6 Member: authors
2015 Contains authors, one per line. Part before '|' is the full name,
2016 part after is the nickname.
2018 11.7 Member: systemid
2020 Always “lsnes-rr1” (one line). Used to reject other saves.
2022 11.8 Member: controlsversion
2024 Always “0” (one line). Used to identify what controls are there.
2026 11.9 Member: “coreversion”
2028 Contains bsnes core version number (as one line).
2030 11.10 Member: projectid
2032 Contains project ID (as one line). Used to identify if two movies
2033 are part of the same project.
2035 11.11 Member: {rom,slota,slotb}{,xml}.sha256
2037 Contains SHA-256 of said ROM or ROM mapping file (as one line).
2038 Absent if corresponding file is absent.
2040 11.12 Member: moviesram.<name>
2042 Raw binary startup SRAM of kind <name>. Only present in
2043 savestates and movies starting from SRAM.
2045 11.13 Member: saveframe
2047 Contains frame number (as one line) of frame movie was saved on.
2048 Only present in savestates.
2050 11.14 Member: lagcounter
2052 Current value of lag counter (as one line). Only present in
2055 11.15 Member: pollcounters
2057 Contains poll counters (currently 100 of them), one per line.
2058 Each line is raw poll count if DRDY is set for it. Otherwise it
2059 is negative poll count minus one. Only present in savestates.
2061 11.16 Member: hostmemory
2063 Raw binary dump of host memory. Only present in savestates.
2065 11.17 Member: savestate
2067 The raw binary savestate itself. Savestate detection uses this
2068 file, only present in savestates.
2070 11.18 Member: screenshot
2072 Screenshot of current frame. Only present in savestates. First 2
2073 bytes are big-endian width of image, rest are 24-bit RGB image
2074 data. Height of image is inferred from the width and size of
2077 11.19 Member: sram.<name>
2079 Raw binary SRAM of kind <name> at time of savestate. Only present
2084 The actual input track, one line per subframe (blank lines are
2087 • If the first byte of each line is '.', ' ', <tab> or '|', then
2088 the line is part of same frame as previous, otherwise it starts
2091 • First subframe must start a new frame.
2093 Length of movie in frames is number of lines in input file that
2096 11.21 Member: rerecords
2098 Contains textual base-10 rerecord count (as one line; emulator
2099 just writes this, it doesn't read it) + 1.
2101 11.22 Member: rrdata
2103 This member stores set of load IDs. There is one load ID per
2104 rerecord (plus one corresponding to start of project).
2106 • This member constists of concatenation of records
2108 • Each record is 2-36 bytes long and can represent 1-16,843,009
2111 • IDs are interpretted as 256-bit big-endian integers with
2114 • Initial predicted ID is all zeroes.
2116 Format of each record is:
2118 • 1 byte: Opcode byte. Bits 0-4 are prefix length (prefixlen),
2119 bits 5-6 are count length (countlen). Bit 7 is unused.
2121 • 32-prefixlen bytes of ID.
2123 • countlen bytes of big-endian count (count).
2125 Records are processed as follows:
2127 • To form the first ID encoded by record, take the first
2128 prefixlen bytes predicted ID and append the read ID value to
2129 it. The result is the first ID encoded.
2131 • If countlen is 0, record encodes 1 ID.
2133 • If countlen is 1, record encodes 2+count IDs.
2135 • If countlen is 2, record encodes 258+count IDs.
2137 • If countlen is 3, record encodes 65794+count IDs.
2139 • The new predicted ID is the next ID after last one encoded by
2142 The number of rerecords + 1 is equal to the sum of number of IDs
2143 encoded by all records.
2145 11.23 Member: starttime.second
2147 Movie starting time, second part. Epoch is Unix epoch. Default is
2150 11.24 Member: starttime.subsecond
2152 Movie starting time, subsecond part. Unit is CPU clocks. Default
2155 11.25 Member: savetime.second
2157 Movie saving time, second part. Default is starttime.second. Only
2158 present in savestates.
2160 11.26 Member: savetime.subsecond
2162 Movie saving time, subsecond part. Default is
2163 starttime.subsecond. Only present in savestates.
2165 12 Quick'n'dirty encode guide
2167 1. Start the emulator and load the movie file.
2169 2. Set large AVI option 'set-setting avi-large on'
2171 3. Enable dumping 'dump-avi tmpdump'
2173 4. Unpause and let it run until you want to end dumping.
2175 5. Close the emulator (closing the window is the easiest way). Or
2178 6. For each tmpdump*.avi file created, on command prompt, do
2179 'x264 --crf 10 -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
2181 7. Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
2183 8. Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv +
2184 tmpdump_0000001.mkv + tmpdump_0000002.mkv' (list every
2185 tmpdump_<numbers>.mkv, with + in between).
2187 9. Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'. Now
2188 final.mkv contains quick'n'dirty encode.
2190 13 Axis configurations for some gamepad types:
2192 13.1 XBox360 controller:
2194 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be
2197 set-axis joystick0axis2 pressure-+
2199 set-axis joystick0axis5 pressure-+
2201 • This is needed for SDL only. EVDEV sets those types correctly.
2203 13.2 PS3 “sixaxis” controller:
2205 Axes 8-19 should be disabled.
2207 set-axis joystick0axis8 disabled
2209 set-axis joystick0axis9 disabled
2211 set-axis joystick0axis10 disabled
2213 set-axis joystick0axis11 disabled
2215 set-axis joystick0axis12 disabled
2217 set-axis joystick0axis13 disabled
2219 set-axis joystick0axis14 disabled
2221 set-axis joystick0axis15 disabled
2223 set-axis joystick0axis16 disabled
2225 set-axis joystick0axis17 disabled
2227 set-axis joystick0axis18 disabled
2229 set-axis joystick0axis19 disabled
2233 14.1 Problems from BSNES core:
2235 • The whole pending save stuff.
2237 • Lack of layer hiding.
2239 • It is slow (especially accuracy).
2241 • Firmwares can't be loaded from ZIP archives.
2243 14.2 Other problems:
2245 • Modifiers don't work with pseudo-keys (SDL, EVDEV).
2247 • Audio for last dumped frame is not itself dumped.
2249 • Audio in UI is pretty bad in quality if game doesn't run at
2252 • AVI compression levels 10-18 are not compatible with AVISynth
2255 • No menus, command based interface (SDL).
2257 • Long commands don't scroll.
2259 • Wxwidgets UI is still buggy.
2265 • Fix -Wall warnings
2267 • Fix dumper video corruption with levels 10-18.
2273 • Lots of code cleanups
2275 • Lua interface to settings
2277 • Allow specifying AVI borders without Lua
2279 • Fix scaling if vscale > 1 and originx > 0 (left border exists)
2281 • on_snoop lua callback
2283 • Faster movie loading and saving.
2293 • Save jukebox functionality.
2297 • Try to fix some nasty failing movie load edge cases
2299 • Allow specifying scripts to run on command line.
2303 • Major source code reorganization.
2305 • Backup savestates before overwriting.
2307 • Don't crash if loading initial state fails.
2311 • Fix firmware lookup
2313 • Fix author name parsing
2315 • Fix rerecord counting
2317 • (SDL) Print messages to console if SDL is uninitialized
2319 • Add movieinfo program
2321 • Fix loading movies starting from SRAM.
2325 • Add support for unattended dumping
2327 • Fix compiling for Win32
2329 • Don't lock up if sound can't be initialized
2331 • Strip trailing CR from commands
2333 • Don't try to do dubious things in global ctors (fix crash on
2338 • Small documentation tweaking
2342 • Fix major bug in modifier matching
2346 • Lots of documentation fixes
2348 • Use dedicated callbacks for event backcomm., not commands.
2350 • Ensure that the watchdog is not hit when executing delayed
2353 • Remove errant tab from joystick message.
2357 • Make autofire operate in absolute time, not linear time
2359 • Reinitialize controls when resuming from loadstate
2361 • Some more code cleanups
2363 • If Lua allocator fails, call OOM_panic()
2365 • Byte/word/dword/qword sized host memory write/read functions.
2367 • Dump at correct framerate if dumping interlaced NTSC
2372 • Actually include the complete source code
2378 • Document {save,start}time.{,sub}second.
2380 • Intercept time() from bsnes core.
2384 • Allow disabling time() interception (allow build on Mac OS X)
2386 • Use SDLMain on Mac OS X (make SDL not crash)
2388 • Disable delayed resets (just plain too buggy for now).
2392 • Use 16-bit for graphics/video instead of 32-bit.
2394 • gui.rectangle/gui.pixel
2398 • New CSCD writer implementation.
2402 • Fix interaction of * and +.
2404 • Manual improvements
2406 • Use gettimeofday()/usleep(), these seem portable enough.
2408 • Move joystick axis manipulation to keymapper code.
2410 • Changes to how read-only works.
2412 • Refactor controller input code.
2416 • Fix mouseclick scale compensation.
2418 • Draw area boundaries correctly in SDL code.
2422 • Fix CSCD output (buffer overrun and race condition).
2426 • JMD dumping support.
2428 • Allow unattended dumping to JMD.
2430 • Move to BSNES v083.
2432 • Switch back to 32-bit colors.
2434 • Add Lua function gui.color.
2436 • Use some new C++11 features in GCC 4.6.
2438 • Be prepared for core frequency changes.
2440 • Pass colors in one chunk from Lua.
2444 • New lua functions gui.line(), gui.status() and gui.circle(),
2445 memory.vma_count(), memory.read_vma() and memory.find_vma().
2447 • Numerious documentation fixups
2449 • RTC time format changed
2451 • Reformat flags display
2453 • Allow lua package name to be overridden
2455 • SDUMP (high-quality dumping).
2457 • Split platform support to plugins.
2459 • Make all sound plugins support basic sound commands
2461 • Support portaudio for sound.
2463 • Allow disable Lua/SDL searching.
2465 • Upconvert colors when copying lcscreen to screen.
2467 • Reorganize source tree.
2469 • Evdev joystick support.
2471 • Refactor more code into generic window code.
2475 • Refactor message handling.
2479 • Documentation fixes
2481 • Finish pending saves before load/quit.
2483 • Wxwidgets graphics plugin.
2487 • Get rid of win32-crap.[ch]pp.
2489 • Move files around a lot.
2491 • Get rid of need for host C++ compiler.
2495 • Refactor inter-component communication.
2499 • Fix crash on multiline aliases.
2501 • Load/Save settings in wxwidgets gui.
2505 • Patch problems in bsnes core
2507 • SNES is little-endian, not big-endian!
2509 • Fix memory corruption in lcscreen::load()
2513 • Fix interpretting repeat counts in rrdata loading.
2515 • New lua callback: on_frame()
2517 • Remove calls to runtosave() that aren't supposed to be there
2519 • Lua function: movie.read_rtc()
2521 • Ignore src/fonts/font.cpp
2523 • Fix more bsnes core problems
2525 • Control bsnes random seeding
2529 • Some bsnes core debugging features (state dump and state hash)
2531 • Fix titlebar version number (no, the last version wasn't
2532 'lsnes-0-beta21', it was 'lsnes rr0-beta21').
2536 • Fix memory corruption due to macro/field mixup
2538 • search-memory update
2540 • Allow direct-mapped framebuffer
2542 • SDL: Use SDL_ANYFORMAT if possible
2544 • SDMP2SOX: 2s delay modes.
2546 • Wxwidgets: Cleanups
2548 • Use sed -E, not sed -r. Fixes building on Mac OS X.
2550 • Wxwidgets: Save jukebox on exit
2552 • Fix RTC if using load-movie on savestate.
2554 • Fix crash related to full console mode.
2558 • Wxwidgets: Allow bringing application to foreground on Mac OS
2561 • Wxwidgets: Allow compiling on Mac OS X.
2563 • Use movie compare instead of movie hashing (faster save/load).
2565 • Lua: _SYSTEM table.
2569 • sdmp2sox: Pad soundtrack if using -l or -L.
2571 • sdmp2sox: Fix NTSC overscan.
2573 • sdmp2sox: Add AR correction mode.
2575 • call lua_close() when exiting.
2577 • Fix zip_writer bug causing warnings from info-zip and error
2582 • Fix IPS patching code (use bsnes core IPS patcher).
2584 • Implement BPS patching (using bsnes core IPS patcher).
2586 • Add feature to load headered ROMs.
2590 • Show command names when showing keybindings
2594 • Fix pause-on-end to be actually controllable
2596 • SDL: Poll all events in queue, not just first one (fixes
2597 slowness in command typing)
2599 • Wxwidgets: Fix ROM loading.
2603 • Lua: Add gui.textH, gui.textV, gui.textHV
2605 • Fix text colors on SDL on Mac OS X
2607 • Mode 'F' for finished in readonly mode.
2609 • Fix some WS errors.
2611 • Reliably pause after skip poll
2613 • Split UI and core into their own threads
2617 • Remove leftover dummy SRAM slot
2619 • Fix controller numbers.
2623 • Fix lsnes-dumpavi after interface change.
2625 • Also give BSNES patches for v085.
2627 • Pack movie data in memory.
2631 • Fix framecount/length given when loading movies.
2633 • Controller command memory leak fixes.
2635 • Don't leak palette if freeing screen object.
2641 • Wxwidgets: Allow controlling dumper from the menu.
2645 • Rewrite parts of manual
2647 • Lua: Make it work with Lua 5.2.
2651 • Win32: Fix compile errors.
2655 • Refactor controller input code.
2657 • Fix crash when using command line on SDL / Mac OS X.
2661 • Delete core/coroutine (obsolete)
2663 • Lag input display by one frame.
2665 • Rewind movie to beginning function.
2667 • Fix wrong frame number reported to Lua when repainting after
2670 • Support UI editing of jukebox
2672 • Wxwidgets: Save settings on exit.
2674 • Support ${project} for filenames
2676 • SDL: Fix command history
2680 • Fix some order-of-global-ctor bugs.
2684 • Fix crashes when quitting on Win32.
2688 • EVDEV: Queue keypresses from joystick, don't send directly
2690 • Wxwidgets: Load-Preserve that actually works.
2694 • Wxwidgets: GUI for memory search.
2696 • Warn about using synchronous queue in UI callback.
2700 • Remember last saved file for each ROM
2702 • Support MT dumping via boost.
2706 • Lua: input.keyhook
2708 • Make mouse be ordinary input instead of special-casing
2710 • SDL: Don't screw up commands with NUL codepoints.
2714 • Merge status panel and main window
2716 • True movie slot support (the rest of it)
2718 • SDL: Fix compilation error
2720 • Elminate cross calls in dump menu code.
2724 • Cancel pending saves command
2726 • Wxwidgets: Code refactoring
2728 • Wxwidgets: Fix system -> reset
2730 • Wxwidgets: Read watch expressions in the right thread
2734 • Wxwidgets: Don't prompt for member when running Lua script (Lua
2735 doesn't support that).
2737 • Wxwidgets: 128 -> 1024 Autohold slots (in case more are
2740 • Don't append trailing '-' to prefix when saving movie.
2742 • Fix ROM/savestate handling (don't let user mismatch ROM and
2747 • Document memory watch syntax.
2751 • Fix unattended dumping (lsnes-dumpavi)
2753 • Support RAW dumping
2755 • Use adv_dumper instead of the old interface in lsnes-dumpavi
2758 • Add option to control sample rate preturbation in AVI dumper
2762 • Wxwidgets: Fix dumper submodes
2764 • Set core controller types before loadstate
2766 15.49 rr1-delta2epsilon1
2768 • Fix compiling with bsnes v086.
2772 • Don't prompt before quitting
2774 • Start unpaused, preserve pause/unpause over load.
2776 • Try to autodetect if ROM is headered.
2778 • Wxwidgets: Only bring up ROM patching screen if specifically
2781 • Allow configuring some hotkeys.
2785 • Lots of code cleanups
2787 • Fix JMD compression (JMD dumping was broken)
2789 • Don't crash if Lua C function throws an exception.
2791 • Support bitmap drawing in Lua.
2793 • Fix bsnes v085/v086 patches.
2795 • Improve stability on win32.