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 Returns two values. First is time since some epoch in seconds,
983 the second is microseconds mod 10^6 since that epoch.
985 8.1.4 emulator_ready()
987 Returns true if emulator has finished booting, false if not
988 (on_startup() will be issued later).
990 8.1.5 set_idle_timeout(number timeout)
992 Set number of microseconds to block idle for. After this timeout
993 has expired, on_idle() will be called once.
995 8.1.6 set_timer_timeout(number timeout)
997 Set number of microseconds to block timer for. After this timeout
998 has expired, on_timer() will be called once.
1002 Bitwise logical functions and related.
1004 8.2.1 bit.none(number...) / bit.bnot(number...)
1006 48-bit bitwise NOT / NONE function (set bits that are set in none
1009 8.2.2 bit.any(number...) / bit.bor(number...)
1011 48-bit bitwise OR / ANY function (set bits that are set in any of
1014 8.2.3 bit.all(number...) / bit.band(number...)
1016 48-bit bitwise AND / ALL function (set bits that are set in all
1019 8.2.4 bit.parity(number...) / bit.bxor(number...)
1021 48-bit bitwise XOR / PARITY function (set bits that are set in
1022 odd number of the arguments).
1024 8.2.5 bit.lrotate(number base[, number amount[, number bits]])
1026 Rotate bits-bit (max 48, default 48) number left by amount
1029 8.2.6 bit.rrotate(number base[, number amount[, number bits]])
1031 Rotate bits-bit (max 48, default 48) number right by amount
1034 8.2.7 bit.lshift(number base[, number amount[, number bits]])
1036 Shift bits-bit (max 48, default 48) number left by amount
1037 (default 1) places. The new bits are filled with zeroes.
1039 8.2.8 bit.lrshift(number base[, number amount[, number bits]])
1041 Shift bits-bit (max 48, default 48) number logically right by
1042 amount (default 1) places. The new bits are filled with zeroes.
1044 8.2.9 bit.arshift(number base[, number amount[, number bits]])
1046 Shift bits-bit (max 48, default 48) number arithmetically right
1047 by amount (default 1) places. The new bits are shifted in with
1048 copy of the high bit.
1050 8.2.10 bit.extract(number base[, number bit0[, number bit1,...]])
1052 Returns number that has bit0-th bit as bit 0, bit1-th bit as 1
1057 • Bit numbers up to 51 should work reliably (then things start
1058 falling apart due to double precision issues).
1060 • There are two special bit positions, true and false, standing
1061 for always set bit and always clear bit.
1065 Most of these functions can only be called in on_paint and
1066 on_video callbacks. Exceptions are noted.
1068 Colors are 32-bit. Bits 0-7 are the blue component, bits 8-15 are
1069 the green component, bits 16-23 are the red component, bits 24-31
1070 are alpha component (0 is fully opaque, 255 is almost
1071 transparent). -1 is the fully transparent color. Alpha values
1072 greater than 127 do work.
1074 Origin of coordinates is at top left corner of game display area.
1075 Left and top gaps correspond to negative coordinates.
1077 8.3.1 gui.resolution()
1079 Returns 2-tuple (hresolution, vresolution).
1081 8.3.2 gui.<class>_gap(number gap)
1083 Set the <class> (left, right, top, bottom) gap to specified value
1086 8.3.3 gui.text(number x, number y, string text[, number fgc[,
1089 Draw specified text on the GUI (each character cell is 8 or 16
1090 wide and 16 high). Parameters:
1092 • x: X-coordinate to start the drawing from (and x-coordinate at
1093 begining of the lines).
1095 • y: Y-coordinate to start the drawing from.
1097 • text: The text to draw.
1099 • fgc: Text color (default is 0xFFFFFF (white))
1101 • bgc: Background color (default is -1 (transparent))
1103 8.3.4 gui.textH(number x, number y, string text[, number fgc[,
1106 Like gui.text, but draw using double-width.
1108 8.3.5 gui.textV(number x, number y, string text[, number fgc[,
1111 Like gui.text, but draw using double-height.
1113 8.3.6 gui.textHV(number x, number y, string text[, number fgc[,
1116 Like gui.text, but draw using double-width/double-height.
1118 8.3.7 gui.rectangle(number x, number y, number width, number
1119 height[, number thickness[, number outline[, number fill]]])
1121 Draw rectangle on the GUI. Parameters:
1123 • x: X-coordinate of left edge.
1125 • y: Y-coordinate of upper edge.
1127 • width: Width of rectangle.
1129 • height: Height of rectangle.
1131 • thickness: Thickness of outline (default is 1).
1133 • outline: Color of outline (default is 0xFFFFFF (white))
1135 • fill: Color of fil (default is -1 (transparent))
1137 8.3.8 gui.pixel(number x, number y[, number color])
1139 Draw one pixel on the GUI. Parameters:
1141 • x: X-coordinate of the pixel
1143 • y: Y-coordinate of the pixel
1145 • color: Color of the pixel (default is 0xFFFFFF (white))
1147 8.3.9 gui.crosshair(number x, number y[, number length[, number
1150 Draw a crosshair. Parameters:
1152 • x: X-coordinate of the crosshair
1154 • y: Y-coordinate of the crosshair
1156 • length: Length of the crosshair lines (default 10).
1158 • color: Color of the crosshair (default is 0xFFFFFF (white))
1160 8.3.10 gui.line(number x1, number y1, number x2, number y2[,
1163 Draw a thin line. Parameters:
1165 • x1: X-coordinate of one end.
1167 • y1: Y-coordinate of one end.
1169 • x2: X-coordinate of the other end.
1171 • y2: Y-coordinate of the other end.
1173 • color: Color of the line (default is 0xFFFFFF (white)).
1175 8.3.11 gui.circle(number x, number y, number r[, number thick[,
1176 number border[, number fil]]])
1178 Draw a circle. Parameters.
1180 • x: X-coordinate of the center
1182 • y: Y-coordinate of the center
1184 • r: The radius of the circle
1186 • thick: Border thickness
1188 • border: Border color (default is 0xFFFFFF (white))
1190 • fill: Fill color (default is -1 (transparent)).
1192 8.3.12 gui.bitmap_draw(number x, number y, bitmap bitmap, palette
1195 Draw a bitmap on screen with specified palette. Parameters:
1197 • x: X-coordinate of left edge.
1199 • y: Y-coordinate of top edge.
1201 • bitmap: The bitmap to draw
1203 • palette: The palette to draw the bitmap using.
1205 8.3.13 gui.bitmap_draw(number x, number y, dbitmap bitmap)
1207 Draw a bitmap on screen. Parameters:
1209 • x: X-coordinate of left edge.
1211 • y: Y-coordinate of top edge.
1213 • bitmap: The bitmap to draw
1215 8.3.14 gui.palette_new()
1217 Returns a new palette (initially all transparent). Can be used
1220 8.3.15 gui.bitmap_new(number w, number h, boolean direct)
1222 Returns a new bitmap/dbitmap. Can be used anywhere. Parameters:
1224 • w: The width of new bitmap
1226 • h: The height of new bitmap
1228 • direct: If true, the returned bitmap is dbitmap, otherwise
1231 8.3.16 gui.bitmap_load(string file)
1233 Returns loaded bitmap/dbitmap (if bitmap, the second return value
1234 is palette for bitmap). Can be used anywhere. Parameters:
1236 • file: The name of file to load.
1238 8.3.17 gui.palette_set(palette palette, number index, number
1241 Sets color in palette. Can be used anywhere. Parameters:
1243 • palette: The palette to manipulate
1245 • index: Index of color (0-65535).
1247 • color: The color value.
1249 8.3.18 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y,
1252 Sets specified pixel in bitmap. Can be used anywhere. Parameters:
1254 • bitmap: The bitmap to manipulate
1256 • x: The x-coordinate of the pixel.
1258 • y: The y-coordinate of the pixel.
1260 • color: If bitmap is a bitmap, color index (0-65535). Otherwise
1263 8.3.19 gui.bitmap_size(bitmap/dbitmap bitmap)
1265 Get size of bitmap. Can be used anywhere. Parameters:
1267 • bitmap: The bitmap to query.
1269 The first return is the width, the second is the height.
1271 8.3.20 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy,
1272 bitmap/dbitmap src, number sx, number sy, number w, number h[,
1275 Blit a part of bitmap to another. Can be used anywhere.
1278 • dest: Destination to blit to.
1280 • dx: left edge of target
1282 • dy: Top edge of target
1284 • src: The source to blit from. Must be of the same type as
1287 • sx: left edge of source
1289 • sy: Top edge of source
1291 • w: Width of region
1293 • h: Height of region.
1295 • ck: Color key. Pixels of this color are not blitted.
1297 – If bitmaps are bitmaps, this is color index of colorkey.
1298 Values outside range 0-65535 cause no key to be used as
1301 – If bitmaps are dbitmaps, this color value of colorkey.
1303 – May be absent or nil for no colorkey blit.
1305 8.3.21 gui.repaint()
1307 Request on_repaint() to happen as soon as possible. Can be used
1310 8.3.22 gui.subframe_update(boolean on)
1312 Request subframe updates (calling on_paint() on subframes) to
1313 happen (on=true) or not happen (on=false). Can be used anywhere.
1315 8.3.23 gui.screenshot(string filename)
1317 Write PNG screenshot of the current frame (no drawings) to
1318 specified file. Can be used anywhere.
1320 8.3.24 gui.color(number r, number g, number b[, number a])
1322 Returns color (in notation Lua scripts use) corresponding to
1323 color (r,g,b), each component in scale 0-255. If a is specified,
1324 that is alpha (0 is fully transparent, 256(sic) is fully opaque).
1325 The default alpha is 256.
1327 8.3.25 gui.status(string name, string value)
1329 Set status field “L[<name>]” to <value> in status area. Can be
1334 Input handling. Only available in on_input callback.
1336 8.4.1 input.get(number controller, number index)
1338 Read the specified index (0-11) from specified controller (0-7).
1341 • Uses physical controller numbering. Gamepad in port 2 is
1342 controller 4, not 1!
1344 8.4.2 input.set(number controller, number index, number value)
1346 Write the specified index (0-11) from specified controller (0-7),
1347 storing value. Notes:
1349 • Uses physical controller numbering. Gamepad in port 2 is
1350 controller 4, not 1!
1352 8.4.3 input.geta(number controller)
1354 Get input state for entiere controller. Returns 13 return values.
1356 • 1st return value: Bitmask: bit i is set if i:th index is
1359 • 2nd-13th return value: value of i:th index.
1361 8.4.4 input.seta(number controller, number bitmask, number
1364 Set state for entiere controller. args is up to 12 values for
1365 indices (overriding values in bitmask if specified).
1367 8.4.5 input.reset([number cycles])
1369 Execute reset. If cycles is greater than zero, do delayed reset.
1370 0 (or no value) causes immediate reset.
1372 • Only available with subframe flag false.
1376 Returns table of tables of all available keys and axes. The first
1377 table is indexed by key name (platform-dependent!), and the inner
1378 table has the following fields:
1380 • last_rawval: Last reported raw value for control.
1382 • ktype: Type of key (disabled, key, mouse, axis, axis-inverse,
1383 hat, pressure-m0, pressure-mp, pressure-0m, pressure-0p,
1384 pressure-pm, pressure-p0).
1386 • cal_left: Minimum calibration value. Only meaningful with axis
1389 • cal_center: Center calibration value. Only meaningful with axis
1392 • cal_right: Maximum calibration value. Only meaningful with axis
1395 • cal_tolerance: Dead zone tolerance. Only meaningful with axis
1398 8.4.7 input.keyhook(key, state)
1400 Requests that keyhook events to be sent for key (state=true) or
1401 not sent (state=false).
1403 8.5 Table hostmemory
1405 Host memory handling (extra memory saved to savestates). Host
1406 memory starts empty.
1408 8.5.1 hostmemory.read(number address)
1410 Reads hostmemory slot address. Slot numbers out of range return
1411 false instead of numeric.
1413 8.5.2 hostmemory.write(number address, number value)
1415 Writes hostmemory slot with 0-255. Slot numbers out of range
1416 cause extension of host memory slot space.
1418 8.5.3 hostmemory.readbyte(number address)
1420 Read unsigned byte (1 element) from given address. Slots out of
1423 8.5.4 hostmemory.writebyte(number address, number value)
1425 Write unsigned byte (1 element) to given slot. Slot numbers out
1426 of range cause extension.
1428 8.5.5 hostmemory.readsbyte(number address)
1430 Read signed byte (1 element) from given address. Slots out of
1433 8.5.6 hostmemory.writesbyte(number address, number value)
1435 Write signed byte (1 element) to given slot. Slot numbers out of
1436 range cause extension.
1438 8.5.7 hostmemory.readword(number address)
1440 Read unsigned word (2 elements) from given address. Slots out of
1443 8.5.8 hostmemory.writeword(number address, number value)
1445 Write unsigned word (2 elements) to given slot. Slot numbers out
1446 of range cause extension.
1448 8.5.9 hostmemory.readsword(number address)
1450 Read signed word (2 elements) from given address. Slots out of
1453 8.5.10 hostmemory.writesword(number address, number value)
1455 Write signed word (2 elements) to given slot. Slot numbers out of
1456 range cause extension.
1458 8.5.11 hostmemory.readdword(number address)
1460 Read unsigned doubleword (4 elements) from given address. Slots
1461 out of range return false.
1463 8.5.12 hostmemory.writedword(number address, number value)
1465 Write unsigned doubleword (4 elements) to given slot. Slot
1466 numbers out of range cause extension.
1468 8.5.13 hostmemory.readsdword(number address)
1470 Read signed doubleword (4 elements) from given address. Slots out
1471 of range return false.
1473 8.5.14 hostmemory.writesdword(number address, number value)
1475 Write signed doubleword (4 elements) to given slot. Slot numbers
1476 out of range cause extension.
1478 8.5.15 hostmemory.readqword(number address)
1480 Read unsigned quadword (8 elements) from given address. Slots out
1481 of range return false.
1483 8.5.16 hostmemory.writeqword(number address, number value)
1485 Write unsigned quadword (4 elements) to given slot. Slot numbers
1486 out of range cause extension.
1488 8.5.17 hostmemory.readsqword(number address)
1490 Read signed quadword (8 elements) from given address. Slots out
1491 of range return false.
1493 8.5.18 hostmemory.writesqword(number address, number value)
1495 Write signed quadword (8 elements) to given slot. Slot numbers
1496 out of range cause extension.
1502 8.6.1 movie.currentframe()
1504 Return number of current frame.
1506 8.6.2 movie.framecount()
1508 Return number of frames in movie.
1510 8.6.3 movie.readonly()
1512 Return true if in readonly mode, false if in readwrite.
1514 8.6.4 movie.set_readwrite()
1516 Set readwrite mode (does not cause on_readwrite callback).
1518 8.6.5 movie.frame_subframes(number frame)
1520 Count number of subframes in specified frame (frame numbers are
1521 1-based) and return that.
1523 8.6.6 movie.read_subframe(number frame, number subframe)
1525 Read specifed subframe in specified frame and return data as
1526 array (100 elements, numbered 0-99 currently).
1530 Routines for settings manipulation
1532 8.7.1 settings.get(string name)
1534 Get value of setting. If setting is blank, returns false. If
1535 setting value can't be obtained, returns (nil, error message).
1537 8.7.2 settings.set(string name, string value)
1539 Set value of setting. If setting can't be set, returns (nil,
1542 8.7.3 settings.is_set(string name)
1544 Returns if setting is set. If setting does not exist, returns
1545 (nil, error message).
1547 8.7.4 settings.blank(string name)
1549 Blanks a setting and returns true. If setting can't be blanked,
1550 returns (nil, error message).
1554 Contains various functions for managing memory
1556 8.8.1 memory.vma_count()
1558 Returns the number of VMAs
1560 8.8.2 memory.read_vma(number index)
1562 Reads the specified VMA (indices start from zero). Trying to read
1563 invalid VMA gives nil. The read VMA is table with the following
1566 • region_name (string): The readable name of the VMA
1568 • baseaddr (number): Base address of the VMA
1570 • lastaddr (number): Last address in the VMA.
1572 • size (number): The size of VMA in bytes.
1574 • readonly (boolean): True of the VMA corresponds to ROM.
1576 • native_endian (boolean): True if the VMA has native endian as
1577 opposed to little endian.
1579 8.8.3 memory.find_vma(number address)
1581 Finds the VMA containing specified address. Returns table in the
1582 same format as read_vma or nil if not found.
1584 8.8.4 memory.readbyte(number address)
1586 Reads the specified address as unsigned byte and returns the
1589 8.8.5 memory.readsbyte(number address)
1591 Reads the specified address as signed byte and returns the
1594 8.8.6 memory.writebyte(number address, number value)
1596 Writes the specified value (negative values undergo 2's
1597 complement) to specified address (as a byte).
1599 8.8.7 memory.readword(number address)
1601 Reads the specified address as unsigned word and returns the
1604 8.8.8 memory.readsword(number address)
1606 Reads the specified address as signed word and returns the
1609 8.8.9 memory.writeword(number address, number value)
1611 Writes the specified value (negative values undergo 2's
1612 complement) to specified address (as a word).
1614 8.8.10 memory.readdword(number address)
1616 Reads the specified address as unsigned doubleword and returns
1619 8.8.11 memory.readsdword(number address)
1621 Reads the specified address as signed doubleword and returns the
1624 8.8.12 memory.writedword(number address, number value)
1626 Writes the specified value (negative values undergo 2's
1627 complement) to specified address (as a doubleword).
1629 8.8.13 memory.readqword(number address)
1631 Reads the specified address as unsigned quadword and returns the
1634 8.8.14 memory.readsqword(number address)
1636 Reads the specified address as signed quadword and returns the
1639 8.8.15 memory.writeqword(number address, number value)
1641 Writes the specified value (negative values undergo 2's
1642 complement) to specified address (as a quadword).
1646 Contains copy of global variables from time of Lua
1647 initialization. Non-writeable.
1651 Various callbacks to Lua that can occur.
1653 8.10.1 Callback: on_paint(bool not_synth)
1655 Called when screen is being painted. Any gui.* calls requiring
1656 graphic context draw on the screen.
1658 not_synth is true if this hook is being called in response to
1659 received frame, false otherwise.
1661 8.10.2 Callback: on_video()
1663 Called when video dump frame is being painted. Any gui.* calls
1664 requiring graphic context draw on the video.
1666 8.10.3 Callback: on_frame_emulated()
1668 Called when emulating frame has completed and
1669 on_paint()/on_video() calls are about to be issued.
1671 8.10.4 Callback: on_frame()
1673 Called on each starting whole frame.
1675 8.10.5 Callback: on_startup()
1677 Called when the emulator is starting (lsnes.rc and --run files
1680 8.10.6 Callback: on_rewind()
1682 Called when rewind movie to beginning has completed.
1684 8.10.7 Callback: on_pre_load(string name)
1686 Called just before savestate/movie load occurs (note: loads are
1687 always delayed, so this occurs even when load was initiated by
1690 8.10.8 Callback: on_err_load(string name)
1692 Called if loadstate goes wrong.
1694 8.10.9 Callback: on_post_load(string name, boolean was_savestate)
1696 Called on successful loadstate. was_savestate gives if this was a
1697 savestate or a movie.
1699 8.10.10 Callback: on_pre_save(string name, boolean is_savestate)
1701 Called just before savestate save occurs (note: movie saves are
1702 synchronous and won't trigger these callbacks if called from
1705 8.10.11 Callback: on_err_save(string name)
1707 Called if savestate goes wrong.
1709 8.10.12 Callback: on_post_save(string name, boolean is_savestate)
1711 Called on successful savaestate. is_savestate gives if this was a
1712 savestate or a movie.
1714 8.10.13 Callback: on_quit()
1716 Called when emulator is shutting down.
1718 8.10.14 Callback: on_input(boolean subframe)
1720 Called when emulator is just sending input to bsnes core.
1721 Warning: This is called even in readonly mode, but the results
1724 8.10.15 Callback: on_reset()
1726 Called when SNES is reset.
1728 8.10.16 Callback: on_readwrite()
1730 Called when moving into readwrite mode as result of “set-rwmode”
1731 command (note: moving to rwmode by Lua won't trigger this, as per
1732 recursive entry protection).
1734 8.10.17 Callback: on_snoop(number port, number controller, number
1735 index, number value)
1737 Called each time bsnes asks for input. The value is the final
1738 value to be sent to bsnes core (readonly mode, autohold and
1739 autofire have been taken into account). Might be useful when
1740 translating movies to format suitable for console verification.
1741 Note: There is no way to modify the value to be sent.
1743 8.10.18 Callback: on_keyhook(string keyname, table state)
1745 Sent when key that has keyhook events requested changes state.
1746 Keyname is name of the key (group) and state is the state (same
1747 kind as table values in input.raw).
1749 8.10.19 Callback: on_idle()
1751 Called when requested by set_idle_timeout(), the timeout has
1752 expired and emulator is waiting.
1754 8.10.20 Callback: on_timer()
1756 Called when requested by set_idle_timeout() and the timeout has
1757 expired (regardless if emulator is waiting).
1759 9 Memory watch expression syntax
1761 Memory watch expressions are in RPN (Reverse Polish Notation). At
1762 the end of expression, the top entry on stack is taken as the
1767 • Evaluation order is strictly left to right.
1769 • a is the entry on top of stack
1771 • b is the entry immediately below top of stack
1773 • ; separates values to be pushed (no intermediate pop).
1775 • After end of element, all used stack slots are popped and all
1778 • When pushing multiple values, the pushes occur in order shown.
1780 The following operators are available:
1794 • b : read_signed_byte(a)
1798 • d : read_signed_dword(a)
1800 • i : quotent(a / b)
1805 • q : read_signed_qword(a)
1815 • w : read_signed_word(a)
1819 • B : read_unsigned_byte(a)
1821 • C<number>z : Push number <number> to stack.
1823 • D : read_unsigned_dword(a)
1825 • C0x<number>z : Push number <number> (hexadecimal) to stack.
1827 • Q : read_unsigned_qword(a)
1829 • R<digit> : round a to <digit> digits.
1831 • W : read_unsigned_word(a)
1835 C0x007e0878zWC0x007e002czW-
1837 1. Push value 0x7e0878 on top of stack (C0x007e0878z).
1839 2. Pop the value on top of stack (0x7e0878), read word value at
1840 that address and push the result,call it x1 (W).
1842 3. Push value 0x7e002c on top of stack (C0x007e002cz).
1844 4. Pop the value on top of stack (0x7e002c), read word value at
1845 that address and push the result,call it x2 (W).
1847 5. Pop the two top numbers on stack, x1 and x2, substract x1 from
1848 x2 and push x2 - x1 (-).
1850 6. Since the expression ends, the final memory watch result is
1851 the top one on stack, which is x2 - x1.
1853 10 Modifier and key names:
1857 10.1.1 Modifier names
1859 Following modifier names are known:
1861 • ctrl, lctrl, rctrl: Control keys
1863 • alt, lalt, ralt: ALT keys.
1865 • shift, lshift, rshift: Shift keys.
1867 • meta, lmeta, rmeta: Meta keys.
1869 • num, caps: Numlock/Capslock (these are sticky!)
1871 • mode: Mode select.
1875 Following key names are known:
1877 • backspace, tab, clear, return, pause, escape, space, exclaim,
1878 quotedbl, hash, dollar, ampersand, quote, leftparen,
1879 rightparen, asterisk, plus, comma, minus, period, slash, 0, 1,
1880 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
1881 greater, question, at, leftbracket, backslash, rightbracket,
1882 caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k,
1883 l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0,
1884 world_1, world_2, world_3, world_4, world_5, world_6, world_7,
1885 world_8, world_9, world_10, world_11, world_12, world_13,
1886 world_14, world_15, world_16, world_17, world_18, world_19,
1887 world_20, world_21, world_22, world_23, world_24, world_25,
1888 world_26, world_27, world_28, world_29, world_30, world_31,
1889 world_32, world_33, world_34, world_35, world_36, world_37,
1890 world_38, world_39, world_40, world_41, world_42, world_43,
1891 world_44, world_45, world_46, world_47, world_48, world_49,
1892 world_50, world_51, world_52, world_53, world_54, world_55,
1893 world_56, world_57, world_58, world_59, world_60, world_61,
1894 world_62, world_63, world_64, world_65, world_66, world_67,
1895 world_68, world_69, world_70, world_71, world_72, world_73,
1896 world_74, world_75, world_76, world_77, world_78, world_79,
1897 world_80, world_81, world_82, world_83, world_84, world_85,
1898 world_86, world_87, world_88, world_89, world_90, world_91,
1899 world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3,
1900 kp4, kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide,
1901 kp_multiply, kp_minus, kp_plus, kp_enter, kp_equals, up, down,
1902 right, left, insert, home, end, pageup, pagedown, f1, f2, f3,
1903 f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, numlock,
1904 capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt, lalt,
1905 rmeta, lmeta, lsuper, rsuper, mode, compose, help, print,
1906 sysreq, break, menu, power, euro, undo
1908 • Names of form 'key<n>' where <n> is 0-255 are interpretted as
1909 key having hardware-dependent scan code of <n> (useful to bind
1910 those keys that don't have symbolic names).
1912 10.1.3 Joystick pseudo-keys:
1914 • joystick<num>button<button>: Joystick <num> (0-based) button
1917 • joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat>
1920 • joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat>
1923 • joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat>
1926 • joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat>
1929 • joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis>
1930 negative position (axis modes axis and axis_inverse).
1932 • joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis>
1933 positive position (axis modes axis and axis_inverse).
1935 • joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis>
1936 pressure (axis modes pressure_*).
1938 10.1.4 Special buttons:
1940 • Escape: Enter/Exit Command mode, cancel modal dialogs.
1942 • Return (also KPEnter): Execute command, ok modal dialog.
1944 • Pgup/Up (also KP8/9 if no num lock; command mode): Previous
1945 command in command history
1947 • Pgdn/Down(also KP2/3 if no num lock; command mode): Next
1948 command in command history
1950 • Home (also KP7 if no num lock; command mode): Beginning of
1953 • End (also KP1 if no num lock; command mode): End of command.
1955 • Left (also KP4 if no num lock; command mode): Move cursor left.
1957 • Right (also KP6 if no num lock; command mode): Move cursor
1960 • Delete (also KP. if no num lock; command mode): Delete
1961 character to right of cursor.
1963 • Insert (also KP0 if no num lock; command mode): Toggle between
1964 insert / overwrite modes.
1966 • Backspace (command mode): Delete character to left of cursor.
1968 • LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump
1971 10.2 wxWidgets platform
1973 10.2.1 Modifier names:
1975 Following modifier names are known:
1985 • cmd (Mac OS X only)
1989 Following key names are known:
1991 • back, tab, return, escape, space, exclaim, quotedbl, hash,
1992 dollar, percent, ampersand, quote, leftparen, rightparen,
1993 asterisk, plus, comma, minus, period, slash, 0, 1, 2, 3, 4, 5,
1994 6, 7, 8, 9, colon, semicolon, less, equals, greater, question,
1995 at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t,
1996 u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
1997 underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m,
1998 n, o, p, q, r, s, t, u, v, w, x, y, z, leftcurly, pipe,
1999 rightcurly, tilde, delete, start, lbutton, rbutton, cancel,
2000 mbutton, clear, shift, alt, control, menu, pause, capital, end,
2001 home, lefT, up, right, down, select, print, execute, snapshot,
2002 insert, help, numpad0, numpad1, numpad2, numpad3, numpad4,
2003 numpad5, numpad6, numpad7, numpad8, numpad9, multiply, add,
2004 separator, subtract, decimal, divide, f1, f2, f3, f4, f5, f6,
2005 f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19,
2006 f20, f21, f22, f23, f24, numlock, scroll, pageup, pagedown,
2007 numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
2008 numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up,
2009 numpad_right, numpad_down, numpad_pageup, numpad_pagedown,
2010 numpad_end, numpad_begin, numpad_insert, numpad_delete,
2011 numpad_equal, numpad_multiply, numpad_add, numpad_separator,
2012 numpad_subtract, numpad_decimal, numpad_divide, windows_left,
2013 windows_right, windows_menu, command, special1, special2,
2014 special3, special4, special5, special6, special7, special8,
2015 special9, special10, special11, special12, special13,
2016 special14, special15, special16, special17, special18,
2017 special19, special20
2019 11 Movie file format
2021 Movie file is .zip archive in itself, normal ZIP archive tools
2022 work on it (note: If you recompress it, do not use compression
2023 methods other than store and deflate and especially do not use
2024 encryption of any kind).
2026 11.1 Detecting clean start/SRAM/Savestate
2028 • If file has member “savestate” it is savestate, otherwise:
2030 • If file has members with names starting “moviesram.” it is
2031 movie starting from SRAM, otherwise:
2033 • It is movie starting from clear state.
2035 11.2 Member: gametype
2037 Type of game ROM and region (as one line). Valid values are:
2040 +--------------+---------------------+--------+
2041 | Value | System | Region |
2042 +--------------+---------------------+--------+
2043 +--------------+---------------------+--------+
2044 | snes_pal | Super NES | PAL |
2045 +--------------+---------------------+--------+
2046 | sgb_pal | Super Game Boy | PAL |
2047 +--------------+---------------------+--------+
2048 | snes_ntsc | Super NES | NTSC |
2049 +--------------+---------------------+--------+
2050 | sgb_ntsc | Super Game Boy | NTSC |
2051 +--------------+---------------------+--------+
2052 | bsx | BS-X (non-slotted) | NTSC |
2053 +--------------+---------------------+--------+
2054 | bsxslotted | BS-X (slotted) | NTSC |
2055 +--------------+---------------------+--------+
2056 | sufamiturbo | Sufami Turbo | NTSC |
2057 +--------------+---------------------+--------+
2063 +---------+-----------------+
2064 | Region | Framerate (fps) |
2065 +---------+-----------------+
2066 +---------+-----------------+
2067 | PAL | 322445/6448 |
2068 +---------+-----------------+
2069 | NTSC | 10738636/178683 |
2070 +---------+-----------------+
2075 Contains type of port #1 (as one line). Valid values are 'none',
2076 'gamepad', 'multitap' and 'mouse'. If not present, defaults to
2081 Contains type of port #2 (as one line). Valid values are 'none',
2082 'gamepad', 'multitap', 'mouse', 'superscope', 'justifier' and
2083 'justifiers'. If not present, defaults to 'none'.
2085 11.5 Member: gamename
2087 Contains name of the game (as one line).
2089 11.6 Member: authors
2091 Contains authors, one per line. Part before '|' is the full name,
2092 part after is the nickname.
2094 11.7 Member: systemid
2096 Always “lsnes-rr1” (one line). Used to reject other saves.
2098 11.8 Member: controlsversion
2100 Always “0” (one line). Used to identify what controls are there.
2102 11.9 Member: “coreversion”
2104 Contains bsnes core version number (as one line).
2106 11.10 Member: projectid
2108 Contains project ID (as one line). Used to identify if two movies
2109 are part of the same project.
2111 11.11 Member: {rom,slota,slotb}{,xml}.sha256
2113 Contains SHA-256 of said ROM or ROM mapping file (as one line).
2114 Absent if corresponding file is absent.
2116 11.12 Member: moviesram.<name>
2118 Raw binary startup SRAM of kind <name>. Only present in
2119 savestates and movies starting from SRAM.
2121 11.13 Member: saveframe
2123 Contains frame number (as one line) of frame movie was saved on.
2124 Only present in savestates.
2126 11.14 Member: lagcounter
2128 Current value of lag counter (as one line). Only present in
2131 11.15 Member: pollcounters
2133 Contains poll counters (currently 100 of them), one per line.
2134 Each line is raw poll count if DRDY is set for it. Otherwise it
2135 is negative poll count minus one. Only present in savestates.
2137 11.16 Member: hostmemory
2139 Raw binary dump of host memory. Only present in savestates.
2141 11.17 Member: savestate
2143 The raw binary savestate itself. Savestate detection uses this
2144 file, only present in savestates.
2146 11.18 Member: screenshot
2148 Screenshot of current frame. Only present in savestates. First 2
2149 bytes are big-endian width of image, rest are 24-bit RGB image
2150 data. Height of image is inferred from the width and size of
2153 11.19 Member: sram.<name>
2155 Raw binary SRAM of kind <name> at time of savestate. Only present
2160 The actual input track, one line per subframe (blank lines are
2163 • If the first byte of each line is '.', ' ', <tab> or '|', then
2164 the line is part of same frame as previous, otherwise it starts
2167 • First subframe must start a new frame.
2169 Length of movie in frames is number of lines in input file that
2172 11.21 Member: rerecords
2174 Contains textual base-10 rerecord count (as one line; emulator
2175 just writes this, it doesn't read it) + 1.
2177 11.22 Member: rrdata
2179 This member stores set of load IDs. There is one load ID per
2180 rerecord (plus one corresponding to start of project).
2182 • This member constists of concatenation of records
2184 • Each record is 2-36 bytes long and can represent 1-16,843,009
2187 • IDs are interpretted as 256-bit big-endian integers with
2190 • Initial predicted ID is all zeroes.
2192 Format of each record is:
2194 • 1 byte: Opcode byte. Bits 0-4 are prefix length (prefixlen),
2195 bits 5-6 are count length (countlen). Bit 7 is unused.
2197 • 32-prefixlen bytes of ID.
2199 • countlen bytes of big-endian count (count).
2201 Records are processed as follows:
2203 • To form the first ID encoded by record, take the first
2204 prefixlen bytes predicted ID and append the read ID value to
2205 it. The result is the first ID encoded.
2207 • If countlen is 0, record encodes 1 ID.
2209 • If countlen is 1, record encodes 2+count IDs.
2211 • If countlen is 2, record encodes 258+count IDs.
2213 • If countlen is 3, record encodes 65794+count IDs.
2215 • The new predicted ID is the next ID after last one encoded by
2218 The number of rerecords + 1 is equal to the sum of number of IDs
2219 encoded by all records.
2221 11.23 Member: starttime.second
2223 Movie starting time, second part. Epoch is Unix epoch. Default is
2226 11.24 Member: starttime.subsecond
2228 Movie starting time, subsecond part. Unit is CPU clocks. Default
2231 11.25 Member: savetime.second
2233 Movie saving time, second part. Default is starttime.second. Only
2234 present in savestates.
2236 11.26 Member: savetime.subsecond
2238 Movie saving time, subsecond part. Default is
2239 starttime.subsecond. Only present in savestates.
2241 12 Quick'n'dirty encode guide
2243 1. Start the emulator and load the movie file.
2245 2. Set large AVI option 'set-setting avi-large on'
2247 3. Enable dumping 'dump-avi tmpdump'
2249 4. Unpause and let it run until you want to end dumping.
2251 5. Close the emulator (closing the window is the easiest way). Or
2254 6. For each tmpdump*.avi file created, on command prompt, do
2255 'x264 --crf 10 -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
2257 7. Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
2259 8. Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv +
2260 tmpdump_0000001.mkv + tmpdump_0000002.mkv' (list every
2261 tmpdump_<numbers>.mkv, with + in between).
2263 9. Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'. Now
2264 final.mkv contains quick'n'dirty encode.
2266 13 Axis configurations for some gamepad types:
2268 13.1 XBox360 controller:
2270 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be
2273 set-axis joystick0axis2 pressure-+
2275 set-axis joystick0axis5 pressure-+
2277 • This is needed for SDL only. EVDEV sets those types correctly.
2279 13.2 PS3 “sixaxis” controller:
2281 Axes 8-19 should be disabled.
2283 set-axis joystick0axis8 disabled
2285 set-axis joystick0axis9 disabled
2287 set-axis joystick0axis10 disabled
2289 set-axis joystick0axis11 disabled
2291 set-axis joystick0axis12 disabled
2293 set-axis joystick0axis13 disabled
2295 set-axis joystick0axis14 disabled
2297 set-axis joystick0axis15 disabled
2299 set-axis joystick0axis16 disabled
2301 set-axis joystick0axis17 disabled
2303 set-axis joystick0axis18 disabled
2305 set-axis joystick0axis19 disabled
2309 14.1 Problems from BSNES core:
2311 • The whole pending save stuff.
2313 • Lack of layer hiding.
2315 • It is slow (especially accuracy).
2317 • Firmwares can't be loaded from ZIP archives.
2319 14.2 Other problems:
2321 • Modifiers don't work with pseudo-keys (SDL, EVDEV).
2323 • Audio for last dumped frame is not itself dumped.
2325 • Audio in UI is pretty bad in quality if game doesn't run at
2328 • AVI compression levels 10-18 are not compatible with AVISynth
2331 • No menus, command based interface (SDL).
2333 • Long commands don't scroll.
2335 • Wxwidgets UI is still buggy.
2341 • Fix -Wall warnings
2343 • Fix dumper video corruption with levels 10-18.
2349 • Lots of code cleanups
2351 • Lua interface to settings
2353 • Allow specifying AVI borders without Lua
2355 • Fix scaling if vscale > 1 and originx > 0 (left border exists)
2357 • on_snoop lua callback
2359 • Faster movie loading and saving.
2369 • Save jukebox functionality.
2373 • Try to fix some nasty failing movie load edge cases
2375 • Allow specifying scripts to run on command line.
2379 • Major source code reorganization.
2381 • Backup savestates before overwriting.
2383 • Don't crash if loading initial state fails.
2387 • Fix firmware lookup
2389 • Fix author name parsing
2391 • Fix rerecord counting
2393 • (SDL) Print messages to console if SDL is uninitialized
2395 • Add movieinfo program
2397 • Fix loading movies starting from SRAM.
2401 • Add support for unattended dumping
2403 • Fix compiling for Win32
2405 • Don't lock up if sound can't be initialized
2407 • Strip trailing CR from commands
2409 • Don't try to do dubious things in global ctors (fix crash on
2414 • Small documentation tweaking
2418 • Fix major bug in modifier matching
2422 • Lots of documentation fixes
2424 • Use dedicated callbacks for event backcomm., not commands.
2426 • Ensure that the watchdog is not hit when executing delayed
2429 • Remove errant tab from joystick message.
2433 • Make autofire operate in absolute time, not linear time
2435 • Reinitialize controls when resuming from loadstate
2437 • Some more code cleanups
2439 • If Lua allocator fails, call OOM_panic()
2441 • Byte/word/dword/qword sized host memory write/read functions.
2443 • Dump at correct framerate if dumping interlaced NTSC
2448 • Actually include the complete source code
2454 • Document {save,start}time.{,sub}second.
2456 • Intercept time() from bsnes core.
2460 • Allow disabling time() interception (allow build on Mac OS X)
2462 • Use SDLMain on Mac OS X (make SDL not crash)
2464 • Disable delayed resets (just plain too buggy for now).
2468 • Use 16-bit for graphics/video instead of 32-bit.
2470 • gui.rectangle/gui.pixel
2474 • New CSCD writer implementation.
2478 • Fix interaction of * and +.
2480 • Manual improvements
2482 • Use gettimeofday()/usleep(), these seem portable enough.
2484 • Move joystick axis manipulation to keymapper code.
2486 • Changes to how read-only works.
2488 • Refactor controller input code.
2492 • Fix mouseclick scale compensation.
2494 • Draw area boundaries correctly in SDL code.
2498 • Fix CSCD output (buffer overrun and race condition).
2502 • JMD dumping support.
2504 • Allow unattended dumping to JMD.
2506 • Move to BSNES v083.
2508 • Switch back to 32-bit colors.
2510 • Add Lua function gui.color.
2512 • Use some new C++11 features in GCC 4.6.
2514 • Be prepared for core frequency changes.
2516 • Pass colors in one chunk from Lua.
2520 • New lua functions gui.line(), gui.status() and gui.circle(),
2521 memory.vma_count(), memory.read_vma() and memory.find_vma().
2523 • Numerious documentation fixups
2525 • RTC time format changed
2527 • Reformat flags display
2529 • Allow lua package name to be overridden
2531 • SDUMP (high-quality dumping).
2533 • Split platform support to plugins.
2535 • Make all sound plugins support basic sound commands
2537 • Support portaudio for sound.
2539 • Allow disable Lua/SDL searching.
2541 • Upconvert colors when copying lcscreen to screen.
2543 • Reorganize source tree.
2545 • Evdev joystick support.
2547 • Refactor more code into generic window code.
2551 • Refactor message handling.
2555 • Documentation fixes
2557 • Finish pending saves before load/quit.
2559 • Wxwidgets graphics plugin.
2563 • Get rid of win32-crap.[ch]pp.
2565 • Move files around a lot.
2567 • Get rid of need for host C++ compiler.
2571 • Refactor inter-component communication.
2575 • Fix crash on multiline aliases.
2577 • Load/Save settings in wxwidgets gui.
2581 • Patch problems in bsnes core
2583 • SNES is little-endian, not big-endian!
2585 • Fix memory corruption in lcscreen::load()
2589 • Fix interpretting repeat counts in rrdata loading.
2591 • New lua callback: on_frame()
2593 • Remove calls to runtosave() that aren't supposed to be there
2595 • Lua function: movie.read_rtc()
2597 • Ignore src/fonts/font.cpp
2599 • Fix more bsnes core problems
2601 • Control bsnes random seeding
2605 • Some bsnes core debugging features (state dump and state hash)
2607 • Fix titlebar version number (no, the last version wasn't
2608 'lsnes-0-beta21', it was 'lsnes rr0-beta21').
2612 • Fix memory corruption due to macro/field mixup
2614 • search-memory update
2616 • Allow direct-mapped framebuffer
2618 • SDL: Use SDL_ANYFORMAT if possible
2620 • SDMP2SOX: 2s delay modes.
2622 • Wxwidgets: Cleanups
2624 • Use sed -E, not sed -r. Fixes building on Mac OS X.
2626 • Wxwidgets: Save jukebox on exit
2628 • Fix RTC if using load-movie on savestate.
2630 • Fix crash related to full console mode.
2634 • Wxwidgets: Allow bringing application to foreground on Mac OS
2637 • Wxwidgets: Allow compiling on Mac OS X.
2639 • Use movie compare instead of movie hashing (faster save/load).
2641 • Lua: _SYSTEM table.
2645 • sdmp2sox: Pad soundtrack if using -l or -L.
2647 • sdmp2sox: Fix NTSC overscan.
2649 • sdmp2sox: Add AR correction mode.
2651 • call lua_close() when exiting.
2653 • Fix zip_writer bug causing warnings from info-zip and error
2658 • Fix IPS patching code (use bsnes core IPS patcher).
2660 • Implement BPS patching (using bsnes core IPS patcher).
2662 • Add feature to load headered ROMs.
2666 • Show command names when showing keybindings
2670 • Fix pause-on-end to be actually controllable
2672 • SDL: Poll all events in queue, not just first one (fixes
2673 slowness in command typing)
2675 • Wxwidgets: Fix ROM loading.
2679 • Lua: Add gui.textH, gui.textV, gui.textHV
2681 • Fix text colors on SDL on Mac OS X
2683 • Mode 'F' for finished in readonly mode.
2685 • Fix some WS errors.
2687 • Reliably pause after skip poll
2689 • Split UI and core into their own threads
2693 • Remove leftover dummy SRAM slot
2695 • Fix controller numbers.
2699 • Fix lsnes-dumpavi after interface change.
2701 • Also give BSNES patches for v085.
2703 • Pack movie data in memory.
2707 • Fix framecount/length given when loading movies.
2709 • Controller command memory leak fixes.
2711 • Don't leak palette if freeing screen object.
2717 • Wxwidgets: Allow controlling dumper from the menu.
2721 • Rewrite parts of manual
2723 • Lua: Make it work with Lua 5.2.
2727 • Win32: Fix compile errors.
2731 • Refactor controller input code.
2733 • Fix crash when using command line on SDL / Mac OS X.
2737 • Delete core/coroutine (obsolete)
2739 • Lag input display by one frame.
2741 • Rewind movie to beginning function.
2743 • Fix wrong frame number reported to Lua when repainting after
2746 • Support UI editing of jukebox
2748 • Wxwidgets: Save settings on exit.
2750 • Support ${project} for filenames
2752 • SDL: Fix command history
2756 • Fix some order-of-global-ctor bugs.
2760 • Fix crashes when quitting on Win32.
2764 • EVDEV: Queue keypresses from joystick, don't send directly
2766 • Wxwidgets: Load-Preserve that actually works.
2770 • Wxwidgets: GUI for memory search.
2772 • Warn about using synchronous queue in UI callback.
2776 • Remember last saved file for each ROM
2778 • Support MT dumping via boost.
2782 • Lua: input.keyhook
2784 • Make mouse be ordinary input instead of special-casing
2786 • SDL: Don't screw up commands with NUL codepoints.
2790 • Merge status panel and main window
2792 • True movie slot support (the rest of it)
2794 • SDL: Fix compilation error
2796 • Elminate cross calls in dump menu code.
2800 • Cancel pending saves command
2802 • Wxwidgets: Code refactoring
2804 • Wxwidgets: Fix system -> reset
2806 • Wxwidgets: Read watch expressions in the right thread
2810 • Wxwidgets: Don't prompt for member when running Lua script (Lua
2811 doesn't support that).
2813 • Wxwidgets: 128 -> 1024 Autohold slots (in case more are
2816 • Don't append trailing '-' to prefix when saving movie.
2818 • Fix ROM/savestate handling (don't let user mismatch ROM and
2823 • Document memory watch syntax.
2827 • Fix unattended dumping (lsnes-dumpavi)
2829 • Support RAW dumping
2831 • Use adv_dumper instead of the old interface in lsnes-dumpavi
2834 • Add option to control sample rate preturbation in AVI dumper
2838 • Wxwidgets: Fix dumper submodes
2840 • Set core controller types before loadstate
2842 15.49 rr1-delta2epsilon1
2844 • Fix compiling with bsnes v086.
2848 • Don't prompt before quitting
2850 • Start unpaused, preserve pause/unpause over load.
2852 • Try to autodetect if ROM is headered.
2854 • Wxwidgets: Only bring up ROM patching screen if specifically
2857 • Allow configuring some hotkeys.
2861 • Lots of code cleanups
2863 • Fix JMD compression (JMD dumping was broken)
2865 • Don't crash if Lua C function throws an exception.
2867 • Support bitmap drawing in Lua.
2869 • Fix bsnes v085/v086 patches.
2871 • Improve stability on win32.
2873 15.52 rr1-delta4epsilon1
2875 • Don't corrupt movie if movie length is integer multiple of