3 lsnes is SNES rerecording emulator based on bsnes core.
7 1. bsnes libsnes (for bsnes SNES core)
9 (a) v084-v087 (v084 or v085 for delayreset support)
11 (b) accuracy or compatiblity core with debugger enabled.
13 (c) Patched version (using included 7 patches)
15 2. gambatte (for gambatte core)
19 (b) Patched with included patches
27 6. boost_thread (if native std::thread is not available)
31 8. sdlmain (SDL only, part of SDL)
33 9. boost_conversion (this is header-only library)
35 10. libswscale (wxwidgets graphics only)
37 11. Portaudio (portaudio sound only)
39 12. libao (libao sound only)
41 13. Lua (if Lua support is needed).
43 • Version 5.1.X or 5.2X.
45 14. G++ 4.6 (bsnes doesn't seem to like 4.7, status for gambatte
50 • Copy bsnes sources (the bsnes subdirectory) to subdirectory
51 'bsnes' (for bsnes core).
53 • Copy gambatte sources to subdirectory 'gambatte' (for gambatte
56 • Patch the bsnes sources with included patches (directory
57 'bsnes-patches/<version>', bsnes core)
59 • Patch the gambatte sources with included patches (directory
60 'gambatte-patches/<version>', gambatte core)
62 • Edit options.build (or copy of that file)
64 • Run make (passing 'OPTIONS=<filename>' if using something else
67 4 Command line options
71 4.1.1 --rom=<file> (lsnes/SDL, lsnes/wxwidgets, lsnes-avidump)
81 4.2.2 <filename> (lsnes/SDL, lsnes-avidump, movieinfo)
83 Load <filename> as movie or savestate file. All other session
86 4.2.3 --port1=<device> (lsnes/SDL, bsnes core only)
88 Set type of port1. Valid values are:
90 • none: No device connected
92 • gamepad: One gamepad (the default)
94 • multitap: Four gamepads (warning: makes most games refuse to
99 4.2.4 --port2=<type> (lsnes/SDL, bsnes core only)
101 Set type of port2. Valid values are:
103 • none: No device connected (the default)
105 • gamepad: One gamepad
107 • multitap: Four gamepads.
111 • superscope: Super Scope
113 • justifier: One justifier
115 • justifiers: Two justifiers
117 4.2.5 --gamename=<name> (lsnes/SDL)
119 Set the name of game to <name>. Default is blank.
121 4.2.6 --author=<name> (lsnes/SDL)
123 Add author with full name of <name> (no nickname).
125 4.2.7 --author=|<name> (lsnes/SDL)
127 Add author with nickname of <name> (no full name).
129 4.2.8 --author=<fullname>|<nickname> (lsnes/SDL)
131 Add author with full name of <fullname> and nickname of
134 4.2.9 --rtc-second=<value> (lsnes/SDL)
136 Set RTC second (0 is 1st January 1970 00:00:00Z). Default is
139 4.2.10 --rtc-subsecond=<value> (lsnes/SDL)
141 Set RTC subsecond. Range is 0-. Unit is CPU cycle. Default is 0.
143 4.2.11 --anchor-savestate=<file> (lsnes/SDL)
145 Set the anchor savestate file.
147 4.2.12 --load=<file> (lsnes/wxwidgets)
149 After loading the ROM, load <file> as savestate/movie.
153 4.3.1 --run=<file> (lsnes/SDL)
155 After running main RC file, run this file. If multiple are
156 specified, these execute in order specified.
158 4.4 dump options (lsnes-dumpavi only)
160 4.4.1 --dumper=<dumper>
162 Set the dumper to use (required). Use 'list' for listing of known
167 Set the mode to use (required for dumpers with multiple modes,
168 forbidden otherwise). Use 'list' for known modes.
170 4.4.3 --prefix=<prefix>
172 Set dump prefix. Default is “avidump”.
174 4.4.4 --option=<name>=<value>
176 Set option <name> to value <value>.
178 4.4.5 --length=<length>
180 Set number of frames to dump. Mandatory.
184 Run specified lua script (lsnes-dumpavi does not have
185 initialization files).
187 4.4.7 --load-library=<library>
189 Load the specified shared object / dynamic library / dynamic link
192 5 Startup file lsnes.rc
194 Upon startup, lsnes (lsnes/SDL only) executes file lsnes.rc as
195 commands. This file is located in:
197 • Windows: %APPDATA%\lsnes\lsnes.rc (if %APPDATA% exists)
199 • Unix: $XDG_CONFIG_HOME/lsnes/lsnes.rc (if $XDG_CONFIG_HOME
202 • Unix: $HOME/.config/lsnes/lsnes.rc (if $HOME exists)
204 • All: ./lsnes.rc (fallback default).
206 If leading directories do not exist, attempt to create them is
211 • Commands beginning with '*' invoke the corresponding command
212 without alias expansion.
214 • If command starts with '+' (after possible '*'), the command is
215 executed as-is when button is pressed, and when button is
216 released, it is executed with '+' replaced by '-'.
218 • Commands without '+' execute only on negative edge (release).
222 Settings control various aspects of emulator behaviour.
224 6.1.1 set-setting <setting> <value>
226 Sets setting <setting> to value <value> (may be empty).
228 6.1.2 unset-setting <setting>
230 Try to unset setting <setting> (not all settings can be unset).
232 6.1.3 get-setting <setting>
234 Read value of setting <setting>
238 Print names and values of all settings.
242 Keybindings bind commands or aliases to keys (or pseudo-keys).
246 • Do not bind edge active (+/-) commands to keys with modifiers,
247 that won't work right!
249 • Names of keys and modifiers are platform-dependent.
251 • Be careful before binding pseudo-keys (such as joystick axes,
252 buttons or hats) with modifiers. That may or may not work
255 6.2.1 bind-key [<mod>/<modmask>] <key> <command>
257 Bind <command> to key <key> (activating if modifiers in <modmask>
258 (comma-seperated list) are set as <mod> (comma-seperated list).
260 The names of keys and modifiers are platform-dependent.
262 6.2.2 unbind-key [<mod>/<modmask>] <key>
264 Unbind command from <key> (with specified <mod> and <modmask>).
266 6.2.3 set-axis <axis> [disabled | axis | axis-inverse |
267 pressure0- | pressure0+ | pressure-0 | pressure-+ | pressure+0
268 | pressure+-] [minus=<val>] [zero=<val>] [plus=<val>]
271 Set axis parameters for axis <axis>.
273 • disabled: Disable axis
277 • axis-inverse: Inverse axis
279 • pressure0-: Pressure sensitive. Released at 0, pressed at -.
281 • pressure0+: Pressure sensitive. Released at 0, pressed at +.
283 • pressure-0: Pressure sensitive. Released at -, pressed at 0.
285 • pressure-+: Pressure sensitive. Released at -, pressed at +.
287 • pressure+0: Pressure sensitive. Released at +, pressed at 0.
289 • pressure+-: Pressure sensitive. Released at +, pressed at -.
291 • minus=<val>: Calibration at extreme minus position
294 • zero=<val>: Calibration at neutral position (-32768-32767)
296 • plus=<val>: Calibration at extreme plus position (-32768-32767)
298 • tolerance=<value>: Center band tolerance (0<x<1). The smaller
299 the value, the more sensitive the control is.
303 Print all key bindings in effect.
307 Aliases bind command to sequence of commands. After alias has
308 been defined, it replaces the command it shadows.
312 • You can't alias command to itself.
314 • Aliases starting with +/- are edge active just like ordinary
315 commands starting with +/-.
317 • One command can be aliased to multiple commands.
319 6.3.1 alias-command <command> <expansion>
321 Append <expansion> to alias <command>. If alias does not already
322 exist, it is created.
324 6.3.2 unalias-command <command>
326 Clear alias expansion for <command>.
330 Print all aliases and their expansions in effect.
332 6.4 run-script <script>
334 Run <script> as if commands were entered on the command line.
338 Following commands control video dumping:
340 6.5.1 start-dump <dumper> [<mode>] <prefix/filename>
342 Start dumping using dumper <dumper>. If mode is present or not
343 and if prefix or filename is present depends on the dumper and
346 The following dumpers are available:
348 • INTERNAL-AVI-CSCD: Internal CSCD in .avi dumper.
350 – Mode: uncompressed/pcm: Uncompressed video, PCM audio. Takes
353 – Mode: cscd/pcm: CSCD video, PCM audio. Takes prefix.
355 • INTERNAL-JMD: Internal .jmd dumper.
357 – Does not take mode.
361 • INTERNAL-RAW: Internal RAW dumper.
363 – Does not take mode.
367 – Sound is big-endian signed 16-bit, usually at 32040.5Hz.
369 – Video is always upscaled to double resolution (512x448 / 512
372 – Video framerate is usually 322445/6448 fps for PAL and
373 10738636/178683 fps for NTSC.
375 • INTERNAL-SDMP: Internal SDMP dumper.
377 – Mode 'ms': Multi-segment. Takes prefix.
379 – Mode 'ss': Single-segment. Takes filename.
381 6.5.2 end-dump <dumper>
383 End dumping using <dumper>
385 6.5.3 show-dumpers [<dumper>]
387 Show the list of dumpers or list of modes for <dumper>
389 6.6 Memory manipulation
391 <address> may be decimal or hexadecimal (prefixed with '0x').
392 <value> can be hexadecimal (prefixed with '0x'), unsigned or
393 signed (prefixed with '-') decimal.
395 The available element <sizes> are:
405 When reading RAM and ROM, multi-byte reads/writes are big-endian.
406 When dealing with DSP memory, multi-byte reads/writes are
407 native-endian (do not use operand sizes exceeding DSP bitness,
408 except dword is OK for 24-bit memory).
410 6.6.1 read-<size> <address>
412 Read the value of byte in <address>.
414 6.6.2 read-s<size> <address>
416 Read the value of signed byte in <address>.
418 6.6.3 write-<size> <address> <value>
420 Write <value> to byte in address <address>.
422 6.6.4 search-memory reset
424 Reset the memory search
426 6.6.5 search-memory count
428 Print number of candidates remaining
430 6.6.6 search-memory print
432 Print all candidates remaining
434 6.6.7 search-memory <usflag><sizeflag><op>
436 Searches memory for addresses satisfying criteria.
456 • lt: < previous value.
458 • le: <= previous value.
460 • eq: = previous value.
462 • ne: != previous value.
464 • ge: >= previous value.
466 • gt: > previous value.
468 6.6.8 search-memory <sizeflag> <value>
470 Searches for addresses that currently have value <value>.
471 <sizeflag> is as in previous command.
475 These commands are not available in lsnesrc, but are available
476 after ROM has been loaded.
478 6.7.1 quit-emulator [/y]
480 Quits the emulator (asking for confirmation). If /y is given, no
481 confirmation is asked.
485 Toggle paused/unpaused
489 Advance frame. If the button is still held after configurable
490 timeout expires, game unpauses for the duration frame advance is
495 Advance subframe. If the button is still held after configurable
496 timeout expires, game unpauses for the duration frame advance is
499 6.7.5 advance-skiplag
501 Skip to first poll in frame after current.
505 Reset the SNES after this frame.
507 6.7.7 load <filename>
509 Load savestate <filename> in current mode.
511 6.7.8 load-state <filename>
513 Load savestate <filename> in readwrite mode.
515 6.7.9 load-readonly <filename>
517 Load savestate <filename> in readonly mode.
519 6.7.10 load-preserve <filename>
521 Load savestate <filename> in readonly mode, preserving current
524 6.7.11 load-movie <filename>
526 Load savestate <filename>, ignoring save part in readonly mode.
528 6.7.12 save-state <filename>
530 Save system state to <filename> as soon as possible.
532 6.7.13 save-movie <filename>
534 Save movie to <filename>.
546 Toggle between read-only and read-write modes.
548 6.7.17 set-gamename <name>
550 Set name of the game to <name>
554 Print the name of the game.
556 6.7.19 add-author <author>
558 Adds new author <author>. If <author> does not contain '|' it is
559 full name. If it contains '|', '|' splits the full name and
562 6.7.20 edit-author <num> <author>
564 Edit the author in slot <num> (0-based) to be <author> (see
565 add-author for format)
567 6.7.21 remove-author <num>
569 Remove author in slot <num>
575 6.7.23 test-1, test-2, test-3
577 Internal test commands. Don't use.
579 6.7.24 take-screenshot <filename>
581 Save screenshot to <filename>.
583 6.7.25 +controller<num><button>
585 Press button <button> on controller <num> (1-8). The following
586 button names are known:
620 6.7.26 controllerh<num><button>
622 Hold/unhold button <button> on controller <num> (1-8). See
623 +controller for button names.
625 6.7.27 controllerf<num><button>
627 Hold/unhold button <button> on controller <num> (1-8) for the
628 next frame. See +controller for button names.
630 Cauntion: Does not work properly if outside frame advance.
632 6.7.28 autofire (<pattern>|-)...
634 Set autofire pattern. Each parameter is comma-separated list of
635 button names (in form of 1start, 1A, 2B, etc..) to hold on that
636 frame. After reaching the end of pattern, the pattern restarts
645 6.8.1 cycle-jukebox-backward
647 Cycle save jukebox backwards.
649 6.8.2 cycle-jukebox-forward
651 Cycle save jukebox forwards
655 Do load from jukebox (current mode).
659 Do state save to jukebox.
663 Only available if lua support is compiled in.
665 6.9.1 evaluate-lua <luacode>
667 Run Lua code <luacode> using built-in Lua interpretter.
669 6.9.2 run-lua <script>
671 Run specified lua file using built-in Lua interpretter.
675 Clear the Lua VM state and restore to factory defaults.
679 6.10.1 add-watch <name> <expression>
681 Adds new watch (or modifies old one).
683 6.10.2 remove-watch <name>
689 6.11.1 enable-sound <on/off>
691 Enable/Disable sound.
693 6.11.2 set-sound-device <device>
695 Set sound device to <device>
697 6.11.3 show-sound-status
699 Show status of sound system.
701 6.11.4 show-sound-devices
703 Show all available devices.
705 6.11.5 set-volume <multiplier>
707 Set the volume multiplier to <multiplier>. 1 is normal volume,
708 and higher numbers are louder.
710 6.11.6 set-volume <multiplier>%
712 Set the volume multiplier to <multiplier> percent. 100 is normal
713 volume, and higher numbers are louder.
715 6.11.7 set-volume <multiplier>dB
717 Set the volume multiplier to <multiplier> dB. 0 is normal volume,
718 and higher numbers are louder. The value may be negative.
722 6.12.1 reload-rom [<file>]
724 Reloads the main ROM image from <file>.
726 6.12.2 edit-subtitle <firstframe> <length> [<text>]
728 Edit or delete a subtitle.
734 6.13 Commentary track
740 6.13.2 play-stream <id>
744 6.13.3 delete-stream <id>
748 6.13.4 change-timebase <id> <newbase>
750 Change time base of <id> to <newbase>. The time base can be given
751 as samples (integer) or second (postfix with s).
753 6.13.5 import-stream-opus <timebase> <file>
755 Import opus stream from <file>, placing it at <timebase>. This
756 operation is lossless.
758 6.13.6 import-stream-pcm <timebase> <file>
760 Import PCM (.sox, 1ch@48kHz) stream from <file>, placing it at
763 6.13.7 export-stream-opus <id> <file>
765 Export stream <id> as opus stream to <file>. This operation is
768 6.13.8 export-stream-pcm <id> <file>
770 Export stream <id> as PCM (.sox) stream to <file>.
772 6.13.9 export-superstream <file>
774 Export the entiere superstream as PCM (.sox) stream to <file>.
776 6.13.10 load-collection <file>
778 Load collection (if there is existing collection, unload it) from
781 6.13.11 unload-collection
787 Tangent for recording voice for commentary track. While pressed,
790 6.14 SDL Platform commands
792 The following are valid on SDL platform.
796 Asks to press a key and then identifies that (pseudo-)key.
798 6.14.2 toggle-console
800 Toggle between windowed/fullscreen console.
804 Scroll messages window as far back as it goes.
806 6.14.4 scroll-fulldown
808 Scroll messages window as far forward as it goes.
812 Scroll messages window back one screenful.
816 Scroll messages window forward one screenful.
818 6.14.7 prompt-command <command>
820 Enter command prompt, with prompt prepopulated with specified
829 Set where bsnes looks for firmware files. Default is “.”.
833 Set the target . Numeric, range is 0.001 to “infinite”. Default
836 7.1.3 savecompression
838 Set save compression level (integer 0-9). Default is 7 (0 is no
841 7.1.4 advance-timeout
843 Set the frame advance timeout in milliseconds. Numeric integer,
844 range is 0-999999999. Default is 500.
846 7.1.5 allow-inconsistent-saves (bsnes only)
848 If true, save without synchronization. Makes games seriously
851 7.1.6 save-every-frame (bsnes only)
853 If true, simulate saving on each frame. Trades off emulation
854 accuracy for sync stability. Also needed if the movie assumes
855 saving on each frame for rewind.
857 7.2 AVI dumper settings
861 AVI dumper: Always dump at 512x448 or 512x478 regardless of what
864 7.2.2 avi-left-border
866 AVI dumper: Set the default left border thickness (unless lua
867 overrides) for dumps. Range 0-8191. Default is 0.
869 7.2.3 avi-right-border
871 AVI dumper: Set the default right border thickness (unless lua
872 overrides) for dumps. Range 0-8191. Default is 0.
876 AVI dumper: Set the default top border thickness (unless lua
877 overrides) for dumps. Range 0-8191. Default is 0.
879 7.2.5 avi-bottom-border
881 AVI dumper: Set the default bottom border thickness (unless lua
882 overrides) for dumps. Range 0-8191. Default is 0.
886 AVI dumper: Maximum number of frames per dump segment (0 =>
887 unlimited). Range 0-999999999. Default is 0.
889 7.2.7 avi-compresison
891 AVI dumper: Compression level (0-18).
893 • Compression levels 10 and above are not compatible with stock
896 • Recomended level is 7.
900 AVI dumper: Set method of determining the sound rate.
902 • 0: Pick nearest of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48,
903 64, 88.2, 96, 128, 176.4 and 192 kHz.
905 • 1: Round down to nearest integer.
907 • 2: Round up to nearest ingeter.
913 JMD dumper: Compression level (0-9).
915 7.4 SDL platform settings
917 7.4.1 autorepeat-first-delay
919 Sets the delay for first character in typematic autorepeat.
921 7.4.2 autorepeat-subsequent-delay
923 Sets the delay for subsequent characters in typematic autorepeat.
927 8.1 Core (in main table)
931 Print line to message console.
933 8.1.2 exec(string command)
935 Run command as it was entered on the command line
939 Returns two values. First is time since some epoch in seconds,
940 the second is microseconds mod 10^6 since that epoch.
942 8.1.4 emulator_ready()
944 Returns true if emulator has finished booting, false if not
945 (on_startup() will be issued later).
947 8.1.5 set_idle_timeout(number timeout)
949 Set number of microseconds to block idle for. After this timeout
950 has expired, on_idle() will be called once.
952 8.1.6 set_timer_timeout(number timeout)
954 Set number of microseconds to block timer for. After this timeout
955 has expired, on_timer() will be called once.
957 8.1.7 bus_address(number snesaddr)
959 Returns virtual address corresponding to specified address on
962 8.1.8 loopwrapper(function fun, ...)
964 Calls function fun with function and specified arguments. The
965 function passed suspends execution until the function returned is
966 called. Handy for linear flow control among multiple invocations
967 of a hook. Example code:
969 on_paint = loopwrapper(function(wait)
973 gui.text(0, 0, “Test!”);
983 Bitwise logical functions and related.
985 8.2.1 bit.none(number...) / bit.bnot(number...)
987 48-bit bitwise NOT / NONE function (set bits that are set in none
990 8.2.2 bit.any(number...) / bit.bor(number...)
992 48-bit bitwise OR / ANY function (set bits that are set in any of
995 8.2.3 bit.all(number...) / bit.band(number...)
997 48-bit bitwise AND / ALL function (set bits that are set in all
1000 8.2.4 bit.parity(number...) / bit.bxor(number...)
1002 48-bit bitwise XOR / PARITY function (set bits that are set in
1003 odd number of the arguments).
1005 8.2.5 bit.lrotate(number base[, number amount[, number bits]])
1007 Rotate bits-bit (max 48, default 48) number left by amount
1010 8.2.6 bit.rrotate(number base[, number amount[, number bits]])
1012 Rotate bits-bit (max 48, default 48) number right by amount
1015 8.2.7 bit.lshift(number base[, number amount[, number bits]])
1017 Shift bits-bit (max 48, default 48) number left by amount
1018 (default 1) places. The new bits are filled with zeroes.
1020 8.2.8 bit.lrshift(number base[, number amount[, number bits]])
1022 Shift bits-bit (max 48, default 48) number logically right by
1023 amount (default 1) places. The new bits are filled with zeroes.
1025 8.2.9 bit.arshift(number base[, number amount[, number bits]])
1027 Shift bits-bit (max 48, default 48) number arithmetically right
1028 by amount (default 1) places. The new bits are shifted in with
1029 copy of the high bit.
1031 8.2.10 bit.extract(number base[, number bit0[, number bit1,...]])
1033 Returns number that has bit0-th bit as bit 0, bit1-th bit as 1
1038 • Bit numbers up to 51 should work reliably (then things start
1039 falling apart due to double precision issues).
1041 • There are two special bit positions, true and false, standing
1042 for always set bit and always clear bit.
1044 8.2.11 bit.value([number bit1[, number bit2,...]])
1046 Returns bitwise OR of 1 left shifted by bit1 places, 1 left
1047 shifted by bit2 places and so on. As special value, nil argument
1052 Most of these functions can only be called in on_paint and
1053 on_video callbacks. Exceptions are noted.
1055 Colors are 32-bit. Bits 0-7 are the blue component, bits 8-15 are
1056 the green component, bits 16-23 are the red component, bits 24-31
1057 are alpha component (0 is fully opaque, 255 is almost
1058 transparent). -1 is the fully transparent color. Alpha values
1059 greater than 127 do work.
1061 Origin of coordinates is at top left corner of game display area.
1062 Left and top gaps correspond to negative coordinates.
1064 8.3.1 gui.resolution()
1066 Returns 2-tuple (hresolution, vresolution).
1068 8.3.2 gui.<class>_gap(number gap)
1070 Set the <class> (left, right, top, bottom) gap to specified value
1073 8.3.3 gui.text(number x, number y, string text[, number fgc[,
1076 Draw specified text on the GUI (each character cell is 8 or 16
1077 wide and 16 high). Parameters:
1079 • x: X-coordinate to start the drawing from (and x-coordinate at
1080 begining of the lines).
1082 • y: Y-coordinate to start the drawing from.
1084 • text: The text to draw.
1086 • fgc: Text color (default is 0xFFFFFF (white))
1088 • bgc: Background color (default is -1 (transparent))
1090 8.3.4 gui.textH(number x, number y, string text[, number fgc[,
1093 Like gui.text, but draw using double-width.
1095 8.3.5 gui.textV(number x, number y, string text[, number fgc[,
1098 Like gui.text, but draw using double-height.
1100 8.3.6 gui.textHV(number x, number y, string text[, number fgc[,
1103 Like gui.text, but draw using double-width/double-height.
1105 8.3.7 gui.rectangle(number x, number y, number width, number
1106 height[, number thickness[, number outline[, number fill]]])
1108 Draw rectangle on the GUI. Parameters:
1110 • x: X-coordinate of left edge.
1112 • y: Y-coordinate of upper edge.
1114 • width: Width of rectangle.
1116 • height: Height of rectangle.
1118 • thickness: Thickness of outline (default is 1).
1120 • outline: Color of outline (default is 0xFFFFFF (white))
1122 • fill: Color of fill (default is -1 (transparent))
1124 8.3.8 gui.box(number x, number y, number width, number height[,
1125 number thickness[, number outline1[,number outline2[, number
1128 Draw rectangle with 3D effect on the GUI. Parameters:
1130 • x: X-coordinate of left edge.
1132 • y: Y-coordinate of upper edge.
1134 • width: Width of rectangle.
1136 • height: Height of rectangle.
1138 • thickness: Thickness of outline (default is 1).
1140 • outline1: First color of outline (default is 0xFFFFFF (white))
1142 • outline2: First color of outline (default is 0x808080 (dark
1145 • fill: Color of fill (default is 0xC0C0C0 (light grayy))
1147 8.3.9 gui.pixel(number x, number y[, number color])
1149 Draw one pixel on the GUI. Parameters:
1151 • x: X-coordinate of the pixel
1153 • y: Y-coordinate of the pixel
1155 • color: Color of the pixel (default is 0xFFFFFF (white))
1157 8.3.10 gui.crosshair(number x, number y[, number length[, number
1160 Draw a crosshair. Parameters:
1162 • x: X-coordinate of the crosshair
1164 • y: Y-coordinate of the crosshair
1166 • length: Length of the crosshair lines (default 10).
1168 • color: Color of the crosshair (default is 0xFFFFFF (white))
1170 8.3.11 gui.line(number x1, number y1, number x2, number y2[,
1173 Draw a thin line. Parameters:
1175 • x1: X-coordinate of one end.
1177 • y1: Y-coordinate of one end.
1179 • x2: X-coordinate of the other end.
1181 • y2: Y-coordinate of the other end.
1183 • color: Color of the line (default is 0xFFFFFF (white)).
1185 8.3.12 gui.circle(number x, number y, number r[, number thick[,
1186 number border[, number fil]]])
1188 Draw a circle. Parameters.
1190 • x: X-coordinate of the center
1192 • y: Y-coordinate of the center
1194 • r: The radius of the circle
1196 • thick: Border thickness
1198 • border: Border color (default is 0xFFFFFF (white))
1200 • fill: Fill color (default is -1 (transparent)).
1202 8.3.13 gui.bitmap_draw(number x, number y, bitmap bitmap, palette
1205 Draw a bitmap on screen with specified palette. Parameters:
1207 • x: X-coordinate of left edge.
1209 • y: Y-coordinate of top edge.
1211 • bitmap: The bitmap to draw
1213 • palette: The palette to draw the bitmap using.
1215 8.3.14 gui.bitmap_draw(number x, number y, dbitmap bitmap)
1217 Draw a bitmap on screen. Parameters:
1219 • x: X-coordinate of left edge.
1221 • y: Y-coordinate of top edge.
1223 • bitmap: The bitmap to draw
1225 8.3.15 gui.palette_new()
1227 Returns a new palette (initially all transparent). Can be used
1230 8.3.16 gui.bitmap_new(number w, number h, boolean direct[, bool
1233 Returns a new bitmap/dbitmap. Can be used anywhere. Parameters:
1235 • w: The width of new bitmap
1237 • h: The height of new bitmap
1239 • direct: If true, the returned bitmap is dbitmap, otherwise
1242 • icolor: Initital fill color (defaults to 0 on BITMAP, -1 on
1245 8.3.17 gui.bitmap_load(string file)
1247 Returns loaded bitmap/dbitmap (if bitmap, the second return value
1248 is palette for bitmap). Can be used anywhere. Parameters:
1250 • file: The name of file to load.
1252 8.3.18 gui.palette_set(palette palette, number index, number
1255 Sets color in palette. Can be used anywhere. Parameters:
1257 • palette: The palette to manipulate
1259 • index: Index of color (0-65535).
1261 • color: The color value.
1263 8.3.19 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y,
1266 Sets specified pixel in bitmap. Can be used anywhere. Parameters:
1268 • bitmap: The bitmap to manipulate
1270 • x: The x-coordinate of the pixel.
1272 • y: The y-coordinate of the pixel.
1274 • color: If bitmap is a bitmap, color index (0-65535). Otherwise
1277 8.3.20 gui.bitmap_size(bitmap/dbitmap bitmap)
1279 Get size of bitmap. Can be used anywhere. Parameters:
1281 • bitmap: The bitmap to query.
1283 The first return is the width, the second is the height.
1285 8.3.21 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy,
1286 bitmap/dbitmap src, number sx, number sy, number w, number h[,
1289 Blit a part of bitmap to another. Can be used anywhere.
1292 • dest: Destination to blit to.
1294 • dx: left edge of target
1296 • dy: Top edge of target
1298 • src: The source to blit from. Must be of the same type as
1301 • sx: left edge of source
1303 • sy: Top edge of source
1305 • w: Width of region
1307 • h: Height of region.
1309 • ck: Color key. Pixels of this color are not blitted.
1311 – If bitmaps are bitmaps, this is color index of colorkey.
1312 Values outside range 0-65535 cause no key to be used as
1315 – If bitmaps are dbitmaps, this color value of colorkey.
1317 – May be absent or nil for no colorkey blit.
1319 8.3.22 gui.repaint()
1321 Request on_repaint() to happen as soon as possible. Can be used
1324 8.3.23 gui.subframe_update(boolean on)
1326 Request subframe updates (calling on_paint() on subframes) to
1327 happen (on=true) or not happen (on=false). Can be used anywhere.
1329 8.3.24 gui.screenshot(string filename)
1331 Write PNG screenshot of the current frame (no drawings) to
1332 specified file. Can be used anywhere.
1334 8.3.25 gui.color(number r, number g, number b[, number a])
1336 Returns color (in notation Lua scripts use) corresponding to
1337 color (r,g,b), each component in scale 0-255. If a is specified,
1338 that is alpha (0 is fully transparent, 256(sic) is fully opaque).
1339 The default alpha is 256.
1341 8.3.26 gui.status(string name, string value)
1343 Set status field “L[<name>]” to <value> in status area. Can be
1346 8.3.27 gui.rainbow(number step, number steps[, number color])
1348 Perform hue rotation of color <color> (default bright red), by
1349 <step> steps. The number of steps per full rotation is given by
1350 absolute value of <steps>.
1352 If <steps> is negative, the rotation will be counterclockwise.
1356 Input handling. Only available in on_input callback.
1358 8.4.1 input.get(number controller, number index)
1360 Read the specified index (0-11) from specified controller (0-7).
1363 • Uses physical controller numbering. Gamepad in port 2 is
1364 controller 4, not 1!
1366 8.4.2 input.set(number controller, number index, number value)
1368 Write the specified index (0-11) from specified controller (0-7),
1369 storing value. Notes:
1371 • Uses physical controller numbering. Gamepad in port 2 is
1372 controller 4, not 1!
1374 8.4.3 input.geta(number controller)
1376 Get input state for entiere controller. Returns 13 return values.
1378 • 1st return value: Bitmask: bit i is set if i:th index is
1381 • 2nd-13th return value: value of i:th index.
1383 8.4.4 input.seta(number controller, number bitmask, number
1386 Set state for entiere controller. args is up to 12 values for
1387 indices (overriding values in bitmask if specified).
1389 8.4.5 input.controllertype(number controller)
1391 Get the type of controller as string. Valid values are:
1401 8.4.6 input.reset([number cycles])
1403 Execute reset. If cycles is greater than zero, do delayed reset.
1404 0 (or no value) causes immediate reset.
1406 • Only available with subframe flag false.
1410 Returns table of tables of all available keys and axes. The first
1411 table is indexed by key name (platform-dependent!), and the inner
1412 table has the following fields:
1414 • last_rawval: Last reported raw value for control.
1416 • ktype: Type of key (disabled, key, mouse, axis, axis-inverse,
1417 hat, pressure-m0, pressure-mp, pressure-0m, pressure-0p,
1418 pressure-pm, pressure-p0).
1420 • cal_left: Minimum calibration value. Only meaningful with axis
1423 • cal_center: Center calibration value. Only meaningful with axis
1426 • cal_right: Maximum calibration value. Only meaningful with axis
1429 • cal_tolerance: Dead zone tolerance. Only meaningful with axis
1432 8.4.8 input.keyhook(key, state)
1434 Requests that keyhook events to be sent for key (state=true) or
1435 not sent (state=false).
1441 8.5.1 subtitle.byindex(number i)
1443 Read the frame and length of ith subtitle. Returns nothing if not
1446 8.5.2 subtitle.set(number f, number l, string txt)
1448 Set the text of subtitle.
1450 8.5.3 subtitle.get(number f, number l)
1452 Get the text of subtitle.
1454 8.5.4 subtitle.delete(number f, number l)
1456 Delete specified subtitle.
1458 8.6 Table hostmemory
1460 Host memory handling (extra memory saved to savestates). Host
1461 memory starts empty.
1463 8.6.1 hostmemory.read(number address)
1465 Reads hostmemory slot address. Slot numbers out of range return
1466 false instead of numeric.
1468 8.6.2 hostmemory.write(number address, number value)
1470 Writes hostmemory slot with 0-255. Slot numbers out of range
1471 cause extension of host memory slot space.
1473 8.6.3 hostmemory.readbyte(number address)
1475 Read unsigned byte (1 element) from given address. Slots out of
1478 8.6.4 hostmemory.writebyte(number address, number value)
1480 Write unsigned byte (1 element) to given slot. Slot numbers out
1481 of range cause extension.
1483 8.6.5 hostmemory.readsbyte(number address)
1485 Read signed byte (1 element) from given address. Slots out of
1488 8.6.6 hostmemory.writesbyte(number address, number value)
1490 Write signed byte (1 element) to given slot. Slot numbers out of
1491 range cause extension.
1493 8.6.7 hostmemory.readword(number address)
1495 Read unsigned word (2 elements) from given address. Slots out of
1498 8.6.8 hostmemory.writeword(number address, number value)
1500 Write unsigned word (2 elements) to given slot. Slot numbers out
1501 of range cause extension.
1503 8.6.9 hostmemory.readsword(number address)
1505 Read signed word (2 elements) from given address. Slots out of
1508 8.6.10 hostmemory.writesword(number address, number value)
1510 Write signed word (2 elements) to given slot. Slot numbers out of
1511 range cause extension.
1513 8.6.11 hostmemory.readdword(number address)
1515 Read unsigned doubleword (4 elements) from given address. Slots
1516 out of range return false.
1518 8.6.12 hostmemory.writedword(number address, number value)
1520 Write unsigned doubleword (4 elements) to given slot. Slot
1521 numbers out of range cause extension.
1523 8.6.13 hostmemory.readsdword(number address)
1525 Read signed doubleword (4 elements) from given address. Slots out
1526 of range return false.
1528 8.6.14 hostmemory.writesdword(number address, number value)
1530 Write signed doubleword (4 elements) to given slot. Slot numbers
1531 out of range cause extension.
1533 8.6.15 hostmemory.readqword(number address)
1535 Read unsigned quadword (8 elements) from given address. Slots out
1536 of range return false.
1538 8.6.16 hostmemory.writeqword(number address, number value)
1540 Write unsigned quadword (4 elements) to given slot. Slot numbers
1541 out of range cause extension.
1543 8.6.17 hostmemory.readsqword(number address)
1545 Read signed quadword (8 elements) from given address. Slots out
1546 of range return false.
1548 8.6.18 hostmemory.writesqword(number address, number value)
1550 Write signed quadword (8 elements) to given slot. Slot numbers
1551 out of range cause extension.
1557 8.7.1 movie.currentframe()
1559 Return number of current frame.
1561 8.7.2 movie.framecount()
1563 Return number of frames in movie.
1565 8.7.3 movie.readonly()
1567 Return true if in readonly mode, false if in readwrite.
1569 8.7.4 movie.set_readwrite()
1571 Set readwrite mode (does not cause on_readwrite callback).
1573 8.7.5 movie.frame_subframes(number frame)
1575 Count number of subframes in specified frame (frame numbers are
1576 1-based) and return that.
1578 8.7.6 movie.read_subframe(number frame, number subframe)
1580 Read specifed subframe in specified frame and return data as
1581 array (100 elements, numbered 0-99 currently).
1583 8.7.7 movie.unsafe_rewind([UNSAFEREWIND state])
1585 Start setting point for unsafe rewind or jump to point of unsafe
1588 • If called without argument, causes emulator to start process of
1589 setting unsafe rewind point. When this has finished, callback
1590 on_set_rewind occurs, passing the rewind state to lua script.
1592 • If called with argument, causes emulator rewind to passed
1593 rewind point as soon as possible. Readwrite mode is implicitly
1596 The following warnings apply to unsafe rewinding:
1598 • There are no safety checks against misuse (that's what “unsafe”
1601 • Only call rewind from timeline rewind point was set from.
1603 • Only call rewind from after the rewind point was set.
1607 Routines for settings manipulation
1609 8.8.1 settings.get(string name)
1611 Get value of setting. If setting is blank, returns false. If
1612 setting value can't be obtained, returns (nil, error message).
1614 8.8.2 settings.set(string name, string value)
1616 Set value of setting. If setting can't be set, returns (nil,
1619 8.8.3 settings.is_set(string name)
1621 Returns if setting is set. If setting does not exist, returns
1622 (nil, error message).
1624 8.8.4 settings.blank(string name)
1626 Blanks a setting and returns true. If setting can't be blanked,
1627 returns (nil, error message).
1631 Contains various functions for managing memory
1633 8.9.1 memory.vma_count()
1635 Returns the number of VMAs
1637 8.9.2 memory.read_vma(number index)
1639 Reads the specified VMA (indices start from zero). Trying to read
1640 invalid VMA gives nil. The read VMA is table with the following
1643 • region_name (string): The readable name of the VMA
1645 • baseaddr (number): Base address of the VMA
1647 • lastaddr (number): Last address in the VMA.
1649 • size (number): The size of VMA in bytes.
1651 • readonly (boolean): True of the VMA corresponds to ROM.
1653 • iospace (boolean): True if the VMA is I/O space.
1655 • native_endian (boolean): True if the VMA has native endian as
1656 opposed to little endian.
1658 8.9.3 memory.find_vma(number address)
1660 Finds the VMA containing specified address. Returns table in the
1661 same format as read_vma or nil if not found.
1663 8.9.4 memory.readbyte(number address)
1665 Reads the specified address as unsigned byte and returns the
1668 8.9.5 memory.readsbyte(number address)
1670 Reads the specified address as signed byte and returns the
1673 8.9.6 memory.writebyte(number address, number value)
1675 Writes the specified value (negative values undergo 2's
1676 complement) to specified address (as a byte).
1678 8.9.7 memory.readword(number address)
1680 Reads the specified address as unsigned word and returns the
1683 8.9.8 memory.readsword(number address)
1685 Reads the specified address as signed word and returns the
1688 8.9.9 memory.writeword(number address, number value)
1690 Writes the specified value (negative values undergo 2's
1691 complement) to specified address (as a word).
1693 8.9.10 memory.readdword(number address)
1695 Reads the specified address as unsigned doubleword and returns
1698 8.9.11 memory.readsdword(number address)
1700 Reads the specified address as signed doubleword and returns the
1703 8.9.12 memory.writedword(number address, number value)
1705 Writes the specified value (negative values undergo 2's
1706 complement) to specified address (as a doubleword).
1708 8.9.13 memory.readqword(number address)
1710 Reads the specified address as unsigned quadword and returns the
1713 8.9.14 memory.readsqword(number address)
1715 Reads the specified address as signed quadword and returns the
1718 8.9.15 memory.writeqword(number address, number value)
1720 Writes the specified value (negative values undergo 2's
1721 complement) to specified address (as a quadword).
1723 8.9.16 memory.hash_region(number base, number size)
1725 Hash specified number of bytes starting from specified address
1726 and return the SHA-256.
1730 Contains copy of global variables from time of Lua
1731 initialization. Non-writeable.
1735 Various callbacks to Lua that can occur.
1737 8.11.1 Callback: on_paint(bool not_synth)
1739 Called when screen is being painted. Any gui.* calls requiring
1740 graphic context draw on the screen.
1742 not_synth is true if this hook is being called in response to
1743 received frame, false otherwise.
1745 8.11.2 Callback: on_video()
1747 Called when video dump frame is being painted. Any gui.* calls
1748 requiring graphic context draw on the video.
1750 8.11.3 Callback: on_frame_emulated()
1752 Called when emulating frame has completed and
1753 on_paint()/on_video() calls are about to be issued.
1755 8.11.4 Callback: on_frame()
1757 Called on each starting whole frame.
1759 8.11.5 Callback: on_startup()
1761 Called when the emulator is starting (lsnes.rc and --run files
1764 8.11.6 Callback: on_rewind()
1766 Called when rewind movie to beginning has completed.
1768 8.11.7 Callback: on_pre_load(string name)
1770 Called just before savestate/movie load occurs (note: loads are
1771 always delayed, so this occurs even when load was initiated by
1774 8.11.8 Callback: on_err_load(string name)
1776 Called if loadstate goes wrong.
1778 8.11.9 Callback: on_post_load(string name, boolean was_savestate)
1780 Called on successful loadstate. was_savestate gives if this was a
1781 savestate or a movie.
1783 8.11.10 Callback: on_pre_save(string name, boolean is_savestate)
1785 Called just before savestate save occurs (note: movie saves are
1786 synchronous and won't trigger these callbacks if called from
1789 8.11.11 Callback: on_err_save(string name)
1791 Called if savestate goes wrong.
1793 8.11.12 Callback: on_post_save(string name, boolean is_savestate)
1795 Called on successful savaestate. is_savestate gives if this was a
1796 savestate or a movie.
1798 8.11.13 Callback: on_quit()
1800 Called when emulator is shutting down.
1802 8.11.14 Callback: on_input(boolean subframe)
1804 Called when emulator is just sending input to bsnes core.
1805 Warning: This is called even in readonly mode, but the results
1808 8.11.15 Callback: on_reset()
1810 Called when SNES is reset.
1812 8.11.16 Callback: on_readwrite()
1814 Called when moving into readwrite mode as result of “set-rwmode”
1815 command (note: moving to rwmode by Lua won't trigger this, as per
1816 recursive entry protection).
1818 8.11.17 Callback: on_snoop(number port, number controller, number
1819 index, number value)
1821 Called each time bsnes asks for input. The value is the final
1822 value to be sent to bsnes core (readonly mode, autohold and
1823 autofire have been taken into account). Might be useful when
1824 translating movies to format suitable for console verification.
1825 Note: There is no way to modify the value to be sent.
1827 8.11.18 Callback: on_keyhook(string keyname, table state)
1829 Sent when key that has keyhook events requested changes state.
1830 Keyname is name of the key (group) and state is the state (same
1831 kind as table values in input.raw).
1833 8.11.19 Callback: on_idle()
1835 Called when requested by set_idle_timeout(), the timeout has
1836 expired and emulator is waiting.
1838 8.11.20 Callback: on_timer()
1840 Called when requested by set_idle_timeout() and the timeout has
1841 expired (regardless if emulator is waiting).
1843 8.11.21 Callback: on_set_rewind(UNSAFEREWIND r)
1845 Called when unsafe rewind object has been constructed.
1847 8.11.22 Callback: on_pre_rewind()
1849 Called just before unsafe rewind is about to occur.
1851 8.11.23 Callback: on_post_rewind()
1853 Called just after unsafe rewind has occured.
1855 9 Memory watch expression syntax
1857 Memory watch expressions are in RPN (Reverse Polish Notation). At
1858 the end of expression, the top entry on stack is taken as the
1863 • Evaluation order is strictly left to right.
1865 • a is the entry on top of stack
1867 • b is the entry immediately below top of stack
1869 • ; separates values to be pushed (no intermediate pop).
1871 • After end of element, all used stack slots are popped and all
1874 • When pushing multiple values, the pushes occur in order shown.
1876 The following operators are available:
1890 • b : read_signed_byte(a)
1894 • d : read_signed_dword(a)
1896 • i : quotent(a / b)
1901 • q : read_signed_qword(a)
1911 • w : read_signed_word(a)
1915 • B : read_unsigned_byte(a)
1917 • C<number>z : Push number <number> to stack.
1919 • D : read_unsigned_dword(a)
1921 • C0x<number>z : Push number <number> (hexadecimal) to stack.
1923 • Q : read_unsigned_qword(a)
1925 • R<digit> : round a to <digit> digits.
1927 • W : read_unsigned_word(a)
1931 C0x007e0878zWC0x007e002czW-
1933 1. Push value 0x7e0878 on top of stack (C0x007e0878z).
1935 2. Pop the value on top of stack (0x7e0878), read word value at
1936 that address and push the result,call it x1 (W).
1938 3. Push value 0x7e002c on top of stack (C0x007e002cz).
1940 4. Pop the value on top of stack (0x7e002c), read word value at
1941 that address and push the result,call it x2 (W).
1943 5. Pop the two top numbers on stack, x1 and x2, substract x1 from
1944 x2 and push x2 - x1 (-).
1946 6. Since the expression ends, the final memory watch result is
1947 the top one on stack, which is x2 - x1.
1949 10 Modifier and key names:
1953 10.1.1 Modifier names
1955 Following modifier names are known:
1957 • ctrl, lctrl, rctrl: Control keys
1959 • alt, lalt, ralt: ALT keys.
1961 • shift, lshift, rshift: Shift keys.
1963 • meta, lmeta, rmeta: Meta keys.
1965 • num, caps: Numlock/Capslock (these are sticky!)
1967 • mode: Mode select.
1971 Following key names are known:
1973 • backspace, tab, clear, return, pause, escape, space, exclaim,
1974 quotedbl, hash, dollar, ampersand, quote, leftparen,
1975 rightparen, asterisk, plus, comma, minus, period, slash, 0, 1,
1976 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
1977 greater, question, at, leftbracket, backslash, rightbracket,
1978 caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k,
1979 l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0,
1980 world_1, world_2, world_3, world_4, world_5, world_6, world_7,
1981 world_8, world_9, world_10, world_11, world_12, world_13,
1982 world_14, world_15, world_16, world_17, world_18, world_19,
1983 world_20, world_21, world_22, world_23, world_24, world_25,
1984 world_26, world_27, world_28, world_29, world_30, world_31,
1985 world_32, world_33, world_34, world_35, world_36, world_37,
1986 world_38, world_39, world_40, world_41, world_42, world_43,
1987 world_44, world_45, world_46, world_47, world_48, world_49,
1988 world_50, world_51, world_52, world_53, world_54, world_55,
1989 world_56, world_57, world_58, world_59, world_60, world_61,
1990 world_62, world_63, world_64, world_65, world_66, world_67,
1991 world_68, world_69, world_70, world_71, world_72, world_73,
1992 world_74, world_75, world_76, world_77, world_78, world_79,
1993 world_80, world_81, world_82, world_83, world_84, world_85,
1994 world_86, world_87, world_88, world_89, world_90, world_91,
1995 world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3,
1996 kp4, kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide,
1997 kp_multiply, kp_minus, kp_plus, kp_enter, kp_equals, up, down,
1998 right, left, insert, home, end, pageup, pagedown, f1, f2, f3,
1999 f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, numlock,
2000 capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt, lalt,
2001 rmeta, lmeta, lsuper, rsuper, mode, compose, help, print,
2002 sysreq, break, menu, power, euro, undo
2004 • Names of form 'key<n>' where <n> is 0-255 are interpretted as
2005 key having hardware-dependent scan code of <n> (useful to bind
2006 those keys that don't have symbolic names).
2008 10.1.3 Joystick pseudo-keys:
2010 • joystick<num>button<button>: Joystick <num> (0-based) button
2013 • joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat>
2016 • joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat>
2019 • joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat>
2022 • joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat>
2025 • joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis>
2026 negative position (axis modes axis and axis_inverse).
2028 • joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis>
2029 positive position (axis modes axis and axis_inverse).
2031 • joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis>
2032 pressure (axis modes pressure_*).
2034 10.1.4 Special buttons:
2036 • Escape: Enter/Exit Command mode, cancel modal dialogs.
2038 • Return (also KPEnter): Execute command, ok modal dialog.
2040 • Pgup/Up (also KP8/9 if no num lock, CTRL+P; command mode):
2041 Previous command in command history
2043 • Pgdn/Down(also KP2/3 if no num lock, CTRL+N; command mode):
2044 Next command in command history
2046 • Home (also KP7 if no num lock, CTRL+A; command mode): Beginning
2049 • End (also KP1 if no num lock, CTRL+E; command mode): End of
2052 • Left (also KP4 if no num lock, CTRL+B; command mode): Move
2055 • Right (also KP6 if no num lock, CTRL+F; command mode): Move
2058 • Delete (also KP. if no num lock; command mode): Delete
2059 character to right of cursor.
2061 • Insert (also KP0 if no num lock; command mode): Toggle between
2062 insert / overwrite modes.
2064 • Backspace (command mode): Delete character to left of cursor.
2066 • CTRL+LEFT (also ALT+B; command mode): Previous word.
2068 • CTRL+RIGHT (also ALT+F; command mode): Next word.
2070 • ALT+D (also CTRL+W; command mode): Delete word.
2072 • LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump
2075 10.2 wxWidgets platform
2077 10.2.1 Modifier names:
2079 Following modifier names are known:
2089 • cmd (Mac OS X only)
2093 Following key names are known:
2095 • back, tab, return, escape, space, exclaim, quotedbl, hash,
2096 dollar, percent, ampersand, quote, leftparen, rightparen,
2097 asterisk, plus, comma, minus, period, slash, 0, 1, 2, 3, 4, 5,
2098 6, 7, 8, 9, colon, semicolon, less, equals, greater, question,
2099 at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t,
2100 u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
2101 underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m,
2102 n, o, p, q, r, s, t, u, v, w, x, y, z, leftcurly, pipe,
2103 rightcurly, tilde, delete, start, lbutton, rbutton, cancel,
2104 mbutton, clear, shift, alt, control, menu, pause, capital, end,
2105 home, lefT, up, right, down, select, print, execute, snapshot,
2106 insert, help, numpad0, numpad1, numpad2, numpad3, numpad4,
2107 numpad5, numpad6, numpad7, numpad8, numpad9, multiply, add,
2108 separator, subtract, decimal, divide, f1, f2, f3, f4, f5, f6,
2109 f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19,
2110 f20, f21, f22, f23, f24, numlock, scroll, pageup, pagedown,
2111 numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
2112 numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up,
2113 numpad_right, numpad_down, numpad_pageup, numpad_pagedown,
2114 numpad_end, numpad_begin, numpad_insert, numpad_delete,
2115 numpad_equal, numpad_multiply, numpad_add, numpad_separator,
2116 numpad_subtract, numpad_decimal, numpad_divide, windows_left,
2117 windows_right, windows_menu, command, special1, special2,
2118 special3, special4, special5, special6, special7, special8,
2119 special9, special10, special11, special12, special13,
2120 special14, special15, special16, special17, special18,
2121 special19, special20
2123 11 Movie file format
2125 Movie file is .zip archive in itself, normal ZIP archive tools
2126 work on it (note: If you recompress it, do not use compression
2127 methods other than store and deflate and especially do not use
2128 encryption of any kind).
2130 11.1 Detecting clean start/SRAM/Savestate
2132 • If file has member “savestate” it is savestate, otherwise:
2134 • If file has members with names starting “moviesram.” it is
2135 movie starting from SRAM, otherwise:
2137 • It is movie starting from clear state.
2139 11.2 Member: gametype
2141 Type of game ROM and region (as one line). Valid values are:
2144 +--------------+---------------------+--------+
2145 | Value | System | Region |
2146 +--------------+---------------------+--------+
2147 +--------------+---------------------+--------+
2148 | snes_pal | Super NES | PAL |
2149 +--------------+---------------------+--------+
2150 | sgb_pal | Super Game Boy | PAL |
2151 +--------------+---------------------+--------+
2152 | snes_ntsc | Super NES | NTSC |
2153 +--------------+---------------------+--------+
2154 | sgb_ntsc | Super Game Boy | NTSC |
2155 +--------------+---------------------+--------+
2156 | bsx | BS-X (non-slotted) | NTSC |
2157 +--------------+---------------------+--------+
2158 | bsxslotted | BS-X (slotted) | NTSC |
2159 +--------------+---------------------+--------+
2160 | sufamiturbo | Sufami Turbo | NTSC |
2161 +--------------+---------------------+--------+
2167 +---------+-----------------+
2168 | Region | Framerate (fps) |
2169 +---------+-----------------+
2170 +---------+-----------------+
2171 | PAL | 322445/6448 |
2172 +---------+-----------------+
2173 | NTSC | 10738636/178683 |
2174 +---------+-----------------+
2179 Contains type of port #1 (as one line). Valid values are 'none',
2180 'gamepad', 'multitap' and 'mouse'. If not present, defaults to
2185 Contains type of port #2 (as one line). Valid values are 'none',
2186 'gamepad', 'multitap', 'mouse', 'superscope', 'justifier' and
2187 'justifiers'. If not present, defaults to 'none'.
2189 11.5 Member: gamename
2191 Contains name of the game (as one line).
2193 11.6 Member: authors
2195 Contains authors, one per line. Part before '|' is the full name,
2196 part after is the nickname.
2198 11.7 Member: systemid
2200 Always “lsnes-rr1” (one line). Used to reject other saves.
2202 11.8 Member: controlsversion
2204 Always “0” (one line). Used to identify what controls are there.
2206 11.9 Member: “coreversion”
2208 Contains bsnes core version number (as one line).
2210 11.10 Member: projectid
2212 Contains project ID (as one line). Used to identify if two movies
2213 are part of the same project.
2215 11.11 Member: {rom,slota,slotb}{,xml}.sha256
2217 Contains SHA-256 of said ROM or ROM mapping file (as one line).
2218 Absent if corresponding file is absent.
2220 11.12 Member: moviesram.<name>
2222 Raw binary startup SRAM of kind <name>. Only present in
2223 savestates and movies starting from SRAM.
2225 11.13 Member: saveframe
2227 Contains frame number (as one line) of frame movie was saved on.
2228 Only present in savestates.
2230 11.14 Member: lagcounter
2232 Current value of lag counter (as one line). Only present in
2235 11.15 Member: pollcounters
2237 Contains poll counters (currently 100 of them), one per line.
2238 Each line is raw poll count if DRDY is set for it. Otherwise it
2239 is negative poll count minus one. Only present in savestates.
2241 11.16 Member: hostmemory
2243 Raw binary dump of host memory. Only present in savestates.
2245 11.17 Member: savestate
2247 The raw binary savestate itself. Savestate detection uses this
2248 file, only present in savestates.
2250 11.18 Member: screenshot
2252 Screenshot of current frame. Only present in savestates. First 2
2253 bytes are big-endian width of image, rest are 24-bit RGB image
2254 data. Height of image is inferred from the width and size of
2257 11.19 Member: sram.<name>
2259 Raw binary SRAM of kind <name> at time of savestate. Only present
2264 The actual input track, one line per subframe (blank lines are
2267 • If the first byte of each line is '.', ' ', <tab> or '|', then
2268 the line is part of same frame as previous, otherwise it starts
2271 • First subframe must start a new frame.
2273 Length of movie in frames is number of lines in input file that
2276 11.21 Member: subtitles
2278 Subtitle track. Optional.
2280 • Each line is in form <firstframe> <numframes> <text>.
2282 • Linefeed is encoded as \n, backslash is encoded as \\.
2284 11.22 Member: rerecords
2286 Contains textual base-10 rerecord count (as one line; emulator
2287 just writes this, it doesn't read it) + 1.
2289 11.23 Member: rrdata
2291 This member stores set of load IDs. There is one load ID per
2292 rerecord (plus one corresponding to start of project).
2294 • This member constists of concatenation of records
2296 • Each record is 2-36 bytes long and can represent 1-16,843,009
2299 • IDs are interpretted as 256-bit big-endian integers with
2302 • Initial predicted ID is all zeroes.
2304 Format of each record is:
2306 • 1 byte: Opcode byte. Bits 0-4 are prefix length (prefixlen),
2307 bits 5-6 are count length (countlen). Bit 7 is unused.
2309 • 32-prefixlen bytes of ID.
2311 • countlen bytes of big-endian count (count).
2313 Records are processed as follows:
2315 • To form the first ID encoded by record, take the first
2316 prefixlen bytes predicted ID and append the read ID value to
2317 it. The result is the first ID encoded.
2319 • If countlen is 0, record encodes 1 ID.
2321 • If countlen is 1, record encodes 2+count IDs.
2323 • If countlen is 2, record encodes 258+count IDs.
2325 • If countlen is 3, record encodes 65794+count IDs.
2327 • The new predicted ID is the next ID after last one encoded by
2330 The number of rerecords + 1 is equal to the sum of number of IDs
2331 encoded by all records.
2333 11.24 Member: starttime.second
2335 Movie starting time, second part. Epoch is Unix epoch. Default is
2338 11.25 Member: starttime.subsecond
2340 Movie starting time, subsecond part. Unit is CPU clocks. Default
2343 11.26 Member: savetime.second
2345 Movie saving time, second part. Default is starttime.second. Only
2346 present in savestates.
2348 11.27 Member: savetime.subsecond
2350 Movie saving time, subsecond part. Default is
2351 starttime.subsecond. Only present in savestates.
2353 12 lsvs file format (commentary tracks)
2357 • Each cluster is 8kB (8192 bytes) in size.
2359 • Cluster n starts at offset 8192*n in file.
2361 • The following clusters are system special:
2363 – Cluster 0 and all clusters with number multiple of 2048
2366 – Cluster 1 (superblock)
2370 • The cluster table describing cluster n is stored in cluster n &
2371 ~0x7FF (zero last 11 bits of n).
2373 • This cluster table consists of 2048 4-byte big-endian integers.
2375 • Each entry describes a cluster in 16MB supercluster, in order.
2377 • The valid values for entries are:
2379 – 0x00000000: Free cluster
2381 – 0x00000001: Last cluster in chain.
2383 – 0xFFFFFFFF: System cluster (cluster tables and superblock)
2385 – (anything else): Number of next cluster in chain. Must not be
2388 • Due to limitations of the format, there can be at most 2097052
2389 superclusters, giving maximum file size of 16TB.
2393 • The stream table chain always starts in cluster 2.
2395 • Otherwise, it follows normal chaining.
2397 • The stream table consists of 16-byte entries:
2399 – The first 8 bytes of entry give big-endian beginning position
2400 of stream in units of 1/48000 s.
2402 – The next 4 bytes of entry give big-endian beginning cluster
2403 for control data. 0 here marks the entry as not present.
2405 – The last 4 bytes of entry give big-endian beginning cluster
2408 • Stream table clusters are normal clusters, following normal
2411 • The stream begnning position is not guarenteed unique. There
2412 can be multiple streams with the same starting position in the
2415 12.4 Stream control data
2417 • The stream control data consists of entries 4 bytes each:
2419 – The first 2 bytes of entry gives big-endian length of packet
2421 – The next byte of entry gives audio length of packet in units
2424 – The last byte is control byte.
2426 ∗ 0 means this entry is not present and the control data
2429 ∗ 1 is valid control entry.
2431 • The stream control data can also end by running into end of the
2434 – This happens if there happens to be exact multiple of 2048
2435 packets in stream and number of packets is nonzero.
2437 • These clusters follow normal chaining.
2439 12.5 Stream codec data
2441 • Stream codec data consists of raw Opus data packets packed back
2442 to back with nothing in between.
2444 • Warning: Due to internal limitations, this data must reside in
2445 the first 65536 superclusters (that is, the first 1TB of the
2450 • The superblock is stored in cluster 1.
2452 • The first 11 bytes are “sefs-magic”<NUL>.
2454 • The rest are unused.
2456 • This cluster 1 is marked as system special.
2458 13 Known ROM extensions
2460 • SNES cartridge ROMs: sfc, smc, swc, fig, ufo, sf2, gd3, gd7,
2463 • DMG cartridge ROMs: dmg, gb.
2465 • GBC cartridge ROMs: cgb, gbc.
2469 • The first line must be: “[GAMEPACK FILE]”.
2471 • There is one needed line: “type <systype>”. This sets system
2472 type to <systype>. The following system types are valid:
2476 – bsx (BS-X non-slotted)
2478 – bsxslotted (BS-X slotted)
2480 – sufamiturbo (Sufami Turbo)
2482 – sgb (Super Game Boy)
2486 – gbc (Game Boy Color)
2488 – gbc_gba (Game Boy Color with GBA initial register values)
2490 • Optionally a region can be specified: “region <region>”. The
2491 following values are valid:
2493 – autodetect (Autodetect region: snes and sgb only)
2495 – ntsc (NTSC: snes, bsx, bsxslotted, sufamiturbo, sgb)
2497 – pal (PAL: snes, sgb)
2499 – world (World: dmg, gbc, gbc_gba)
2501 • ROM images are loaded as: “rom <type> <file>”. The following
2504 – rom (Cartridge ROM in snes, dmg, gbc, gbc_gba. BIOS in bsx,
2505 bsxslotted, sufamiturbo)
2507 – bsx (Cartridge ROM in bsx, bsxslotted)
2509 – slot-a (Cartridge ROM in sufamiturbo)
2511 – slot-b (Cartridge ROM in sufamiturbo)
2513 • ROM markup can be loaded as: “xml <type> <file>”. The types
2514 valid are the same as for ROMs.
2516 • Patches can be loaded as “patch[<offset>] <type> <file>”. The
2517 types are the same as for ROMs.
2519 – Offset is given in form [+-]<number>. Usually offset is
2522 – Default offset is +0.
2530 rom rom speedygonzales.sfc
2532 patch-512 rom sonicthehedgehog.ips
2540 rom rom supergameboy.sfc
2542 rom dmg megamanV.dmg
2544 15 Quick'n'dirty encode guide
2546 1. Start the emulator and load the ROM and movie file.
2548 2. Set large AVI option 'set-setting avi-large on'
2550 3. Enable dumping 'dump-avi tmpdump'
2552 4. Unpause and let it run until you want to end dumping.
2554 5. Close the emulator (closing the window is the easiest way). Or
2557 6. For each tmpdump*.avi file created, on command prompt, do
2558 'x264 --crf 10 -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
2560 7. Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
2562 8. Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv +
2563 tmpdump_0000001.mkv + tmpdump_0000002.mkv' (list every
2564 tmpdump_<numbers>.mkv, with + in between).
2566 9. Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'. Now
2567 final.mkv contains quick'n'dirty encode.
2569 16 Axis configurations for some gamepad types:
2571 16.1 XBox360 controller:
2573 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be
2576 set-axis joystick0axis2 pressure-+
2578 set-axis joystick0axis5 pressure-+
2580 • This is needed for SDL only. EVDEV sets those types correctly.
2582 16.2 PS3 “sixaxis” controller:
2584 Axes 8-19 should be disabled.
2586 set-axis joystick0axis8 disabled
2588 set-axis joystick0axis9 disabled
2590 set-axis joystick0axis10 disabled
2592 set-axis joystick0axis11 disabled
2594 set-axis joystick0axis12 disabled
2596 set-axis joystick0axis13 disabled
2598 set-axis joystick0axis14 disabled
2600 set-axis joystick0axis15 disabled
2602 set-axis joystick0axis16 disabled
2604 set-axis joystick0axis17 disabled
2606 set-axis joystick0axis18 disabled
2608 set-axis joystick0axis19 disabled
2612 17.1 Problems from BSNES core:
2614 • The whole pending save stuff.
2616 • Lack of layer hiding.
2618 • It is slow (especially accuracy).
2620 • Firmwares can't be loaded from ZIP archives.
2622 17.2 Other problems:
2624 • Modifiers don't work with pseudo-keys (SDL, EVDEV).
2626 • Audio for last dumped frame is not itself dumped.
2628 • Audio in UI is pretty bad in quality if game doesn't run at
2631 • No menus, command based interface (SDL).
2633 • Long commands don't scroll.
2639 • Fix -Wall warnings
2641 • Fix dumper video corruption with levels 10-18.
2647 • Lots of code cleanups
2649 • Lua interface to settings
2651 • Allow specifying AVI borders without Lua
2653 • Fix scaling if vscale > 1 and originx > 0 (left border exists)
2655 • on_snoop lua callback
2657 • Faster movie loading and saving.
2667 • Save jukebox functionality.
2671 • Try to fix some nasty failing movie load edge cases
2673 • Allow specifying scripts to run on command line.
2677 • Major source code reorganization.
2679 • Backup savestates before overwriting.
2681 • Don't crash if loading initial state fails.
2685 • Fix firmware lookup
2687 • Fix author name parsing
2689 • Fix rerecord counting
2691 • (SDL) Print messages to console if SDL is uninitialized
2693 • Add movieinfo program
2695 • Fix loading movies starting from SRAM.
2699 • Add support for unattended dumping
2701 • Fix compiling for Win32
2703 • Don't lock up if sound can't be initialized
2705 • Strip trailing CR from commands
2707 • Don't try to do dubious things in global ctors (fix crash on
2712 • Small documentation tweaking
2716 • Fix major bug in modifier matching
2720 • Lots of documentation fixes
2722 • Use dedicated callbacks for event backcomm., not commands.
2724 • Ensure that the watchdog is not hit when executing delayed
2727 • Remove errant tab from joystick message.
2731 • Make autofire operate in absolute time, not linear time
2733 • Reinitialize controls when resuming from loadstate
2735 • Some more code cleanups
2737 • If Lua allocator fails, call OOM_panic()
2739 • Byte/word/dword/qword sized host memory write/read functions.
2741 • Dump at correct framerate if dumping interlaced NTSC
2746 • Actually include the complete source code
2752 • Document {save,start}time.{,sub}second.
2754 • Intercept time() from bsnes core.
2758 • Allow disabling time() interception (allow build on Mac OS X)
2760 • Use SDLMain on Mac OS X (make SDL not crash)
2762 • Disable delayed resets (just plain too buggy for now).
2766 • Use 16-bit for graphics/video instead of 32-bit.
2768 • gui.rectangle/gui.pixel
2772 • New CSCD writer implementation.
2776 • Fix interaction of * and +.
2778 • Manual improvements
2780 • Use gettimeofday()/usleep(), these seem portable enough.
2782 • Move joystick axis manipulation to keymapper code.
2784 • Changes to how read-only works.
2786 • Refactor controller input code.
2790 • Fix mouseclick scale compensation.
2792 • Draw area boundaries correctly in SDL code.
2796 • Fix CSCD output (buffer overrun and race condition).
2800 • JMD dumping support.
2802 • Allow unattended dumping to JMD.
2804 • Move to BSNES v083.
2806 • Switch back to 32-bit colors.
2808 • Add Lua function gui.color.
2810 • Use some new C++11 features in GCC 4.6.
2812 • Be prepared for core frequency changes.
2814 • Pass colors in one chunk from Lua.
2818 • New lua functions gui.line(), gui.status() and gui.circle(),
2819 memory.vma_count(), memory.read_vma() and memory.find_vma().
2821 • Numerious documentation fixups
2823 • RTC time format changed
2825 • Reformat flags display
2827 • Allow lua package name to be overridden
2829 • SDUMP (high-quality dumping).
2831 • Split platform support to plugins.
2833 • Make all sound plugins support basic sound commands
2835 • Support portaudio for sound.
2837 • Allow disable Lua/SDL searching.
2839 • Upconvert colors when copying lcscreen to screen.
2841 • Reorganize source tree.
2843 • Evdev joystick support.
2845 • Refactor more code into generic window code.
2849 • Refactor message handling.
2853 • Documentation fixes
2855 • Finish pending saves before load/quit.
2857 • Wxwidgets graphics plugin.
2861 • Get rid of win32-crap.[ch]pp.
2863 • Move files around a lot.
2865 • Get rid of need for host C++ compiler.
2869 • Refactor inter-component communication.
2873 • Fix crash on multiline aliases.
2875 • Load/Save settings in wxwidgets gui.
2879 • Patch problems in bsnes core
2881 • SNES is little-endian, not big-endian!
2883 • Fix memory corruption in lcscreen::load()
2887 • Fix interpretting repeat counts in rrdata loading.
2889 • New lua callback: on_frame()
2891 • Remove calls to runtosave() that aren't supposed to be there
2893 • Lua function: movie.read_rtc()
2895 • Ignore src/fonts/font.cpp
2897 • Fix more bsnes core problems
2899 • Control bsnes random seeding
2903 • Some bsnes core debugging features (state dump and state hash)
2905 • Fix titlebar version number (no, the last version wasn't
2906 'lsnes-0-beta21', it was 'lsnes rr0-beta21').
2910 • Fix memory corruption due to macro/field mixup
2912 • search-memory update
2914 • Allow direct-mapped framebuffer
2916 • SDL: Use SDL_ANYFORMAT if possible
2918 • SDMP2SOX: 2s delay modes.
2920 • Wxwidgets: Cleanups
2922 • Use sed -E, not sed -r. Fixes building on Mac OS X.
2924 • Wxwidgets: Save jukebox on exit
2926 • Fix RTC if using load-movie on savestate.
2928 • Fix crash related to full console mode.
2932 • Wxwidgets: Allow bringing application to foreground on Mac OS
2935 • Wxwidgets: Allow compiling on Mac OS X.
2937 • Use movie compare instead of movie hashing (faster save/load).
2939 • Lua: _SYSTEM table.
2943 • sdmp2sox: Pad soundtrack if using -l or -L.
2945 • sdmp2sox: Fix NTSC overscan.
2947 • sdmp2sox: Add AR correction mode.
2949 • call lua_close() when exiting.
2951 • Fix zip_writer bug causing warnings from info-zip and error
2956 • Fix IPS patching code (use bsnes core IPS patcher).
2958 • Implement BPS patching (using bsnes core IPS patcher).
2960 • Add feature to load headered ROMs.
2964 • Show command names when showing keybindings
2968 • Fix pause-on-end to be actually controllable
2970 • SDL: Poll all events in queue, not just first one (fixes
2971 slowness in command typing)
2973 • Wxwidgets: Fix ROM loading.
2977 • Lua: Add gui.textH, gui.textV, gui.textHV
2979 • Fix text colors on SDL on Mac OS X
2981 • Mode 'F' for finished in readonly mode.
2983 • Fix some WS errors.
2985 • Reliably pause after skip poll
2987 • Split UI and core into their own threads
2991 • Remove leftover dummy SRAM slot
2993 • Fix controller numbers.
2997 • Fix lsnes-dumpavi after interface change.
2999 • Also give BSNES patches for v085.
3001 • Pack movie data in memory.
3005 • Fix framecount/length given when loading movies.
3007 • Controller command memory leak fixes.
3009 • Don't leak palette if freeing screen object.
3015 • Wxwidgets: Allow controlling dumper from the menu.
3019 • Rewrite parts of manual
3021 • Lua: Make it work with Lua 5.2.
3025 • Win32: Fix compile errors.
3029 • Refactor controller input code.
3031 • Fix crash when using command line on SDL / Mac OS X.
3035 • Delete core/coroutine (obsolete)
3037 • Lag input display by one frame.
3039 • Rewind movie to beginning function.
3041 • Fix wrong frame number reported to Lua when repainting after
3044 • Support UI editing of jukebox
3046 • Wxwidgets: Save settings on exit.
3048 • Support ${project} for filenames
3050 • SDL: Fix command history
3054 • Fix some order-of-global-ctor bugs.
3058 • Fix crashes when quitting on Win32.
3062 • EVDEV: Queue keypresses from joystick, don't send directly
3064 • Wxwidgets: Load-Preserve that actually works.
3068 • Wxwidgets: GUI for memory search.
3070 • Warn about using synchronous queue in UI callback.
3074 • Remember last saved file for each ROM
3076 • Support MT dumping via boost.
3080 • Lua: input.keyhook
3082 • Make mouse be ordinary input instead of special-casing
3084 • SDL: Don't screw up commands with NUL codepoints.
3088 • Merge status panel and main window
3090 • True movie slot support (the rest of it)
3092 • SDL: Fix compilation error
3094 • Elminate cross calls in dump menu code.
3098 • Cancel pending saves command
3100 • Wxwidgets: Code refactoring
3102 • Wxwidgets: Fix system -> reset
3104 • Wxwidgets: Read watch expressions in the right thread
3108 • Wxwidgets: Don't prompt for member when running Lua script (Lua
3109 doesn't support that).
3111 • Wxwidgets: 128 -> 1024 Autohold slots (in case more are
3114 • Don't append trailing '-' to prefix when saving movie.
3116 • Fix ROM/savestate handling (don't let user mismatch ROM and
3121 • Document memory watch syntax.
3125 • Fix unattended dumping (lsnes-dumpavi)
3127 • Support RAW dumping
3129 • Use adv_dumper instead of the old interface in lsnes-dumpavi
3132 • Add option to control sample rate preturbation in AVI dumper
3136 • Wxwidgets: Fix dumper submodes
3138 • Set core controller types before loadstate
3140 18.49 rr1-delta2epsilon1
3142 • Fix compiling with bsnes v086.
3146 • Don't prompt before quitting
3148 • Start unpaused, preserve pause/unpause over load.
3150 • Try to autodetect if ROM is headered.
3152 • Wxwidgets: Only bring up ROM patching screen if specifically
3155 • Allow configuring some hotkeys.
3159 • Lots of code cleanups
3161 • Fix JMD compression (JMD dumping was broken)
3163 • Don't crash if Lua C function throws an exception.
3165 • Support bitmap drawing in Lua.
3167 • Fix bsnes v085/v086 patches.
3169 • Improve stability on win32.
3171 18.52 rr1-delta4epsilon1
3173 • Don't corrupt movie if movie length is integer multiple of
3178 • New Lua hooks: on_rewind, on_frame_emulated, on_idle, on_timer
3180 • New Lua functions: emulator_ready(), utime(),
3181 set_idle_timeout(), set_timer_timeout(), bit.extract(),
3182 bit.value(), input.geta(), input.seta() and
3183 input.controllertype()
3185 • Wxwidgets: Fix internal focus lost (hotkeys stop working)
3187 • Wxwidgets: Fix broken modifiers
3189 • on_paint has parameter now.
3191 • Optional initital fill for bitmaps
3193 • Fix palette changing.
3195 • Optimize rendering a bit.
3197 • Bsnes v087 support.
3199 18.54 rr1-delta5epsilon1
3201 • Movieinfo: Fix display of port #2 type.
3203 • Call on_input() after loadstate.
3205 18.55 rr1-delta5epsilon2
3207 • Fix writing port2 data to movie.
3209 • Fix SRAM handling with Bsnes v087.
3213 • Library loading support
3215 • Built-in TSCC encoder
3217 • Hi-color (256T colors) dumping.
3219 • Dump over TCP/IP(v6)
3221 • Hidable status panel
3225 • Adjustable sound volume
3229 • Allow DnD into filename boxes
3231 • Configurable paths
3233 • Portaudio: Fix speaker popping at start
3235 • Lots of UI changes
3237 • Speed adjustment menu
3239 • Win32 joystick support
3241 • Lua: gui.rainbow and gui.box
3243 • Split key lists into classes (the key list was large!)
3245 • More save slots support
3247 • Wxwidgets (wxJoystick) joystick support
3251 • Lots of internal joystick refactoring
3253 • Evdev: Add mapping for BTN_TOOL_QUINTTAP
3255 • Wxwidgets: Settings mode (open settings without ROM)
3257 • Wxwidgets: Prompt key to use option
3259 • Wxwidgets: Fix crash if key goes away underneath
3261 • Wxwidgets: Fix mouse position in presence of scaling
3263 • AVI dumper: Mode 4 (high-quality resampling to common rate
3266 • Wxwidgets: Redesign hotkeys dialog to avoid tree control (tree
3267 control doesn't seem to work well on WinXP)
3269 • Start paused option.
3271 18.58 rr1-delta7epsilon1
3275 • lsnes-dumpavi: Start Lua before starting dumper
3277 • AVI: Fix secondary audio in mode 4.
3279 18.59 rr1-delta7epsilon2
3281 • AVI: Refactor ZMBV a bit.
3283 • Fix error reading analog values from movie file
3287 • Delayed reset support
3289 • Lua: memory.hash_region
3291 18.61 rr1-delta8epsilon1
3293 • Rework the build system
3295 • Typing input support
3297 • Fix building with bsnes v086 and v087.
3299 • SDL: Save settings on exit
3301 • SDL: Command to enter command line mode with given command.
3303 • SDL: More advanced command editing.
3307 • wxMSW: Fix the “arrow keys and enter don't work” problem
3311 • Show mode changes due to rewinding.
3313 • Unsafe rewind support
3315 • Fix directory transversal.
3319 • AVI: Sound mode 5 (48kHz high-quality)
3323 • Map the SNES bus into address space
3325 • Fix loading memory watch files with CRLF line endings
3327 18.64 rr1-delta10epsilon1
3329 • Map bsnes internal state into memory space
3331 • Fix the “click on panel wedges the emulator” for real.
3333 • DnD movies/saves on the main window.
3337 • Split core bindings into own module.
3339 • Remember invalid settings
3341 • Support for modified Gambatte core for GB/GBC emulation.
3343 • Reload/swap ROM function
3345 18.66 rr1-delta11epsilon1
3347 • Fix step poll function
3351 • Non-insane savestate anchoring
3355 • More Memory search methods
3357 • Preserve movie if loading in RO mode.
3359 • Fix a obscure case in timeline check
3361 • Revamp the entiere ROM loading code
3363 • Support DnD on ROMs
3365 • Revamp menu layout
3367 • Standalone hotkey config dialog
3369 • Show bindings in more user-friendly format
3371 18.69 rr1-delta13epsilon1
3375 • Fix uninitialized variables in bsnes v085
3379 • Merge gambatte core into mainline (from its own branch)
3381 • Wxwidgets: Show expected dump file formats
3383 • Memory watch: Data typing
3385 • lsnes internal MMIO area.
3387 • Wxwidgets: New memory watch editor
3389 • Hexadecimal memory watches
3391 • Wxwidgets: Monospaced panel
3393 • Wxwidgets: Split memory watches in panel
3395 • Wxwidgets: Disable VMAs in memory search
3397 • lsnes-dumpavi: Fix speed bug
3399 • Movie subtitle support
3401 • Fix rerecord count reporting
3403 • Don't trash movie when loading in readonly mode.
3405 18.71 rr1-delta14epsilon1
3407 • Wxwidgets: Fix crashes on closing settings dialogs on Mac OS X.
3409 • Fix build on Mac OS X.
3413 • Wxwidgets: Hidable messages window
3417 • Bsnes: Support inconsistent saves
3419 • Bsnes: Allow simulating saving every frame
3421 • Fix desync if savestate is loaded in readonly mode in certain
3424 • Wxwidgets: Fix save dialogs on Mac OS X.
3426 • Wxwidgets: Fix insane status width on Win32.
3428 • Wxwidgets: Fix autohold processing to be faster.
3430 • Wxwidgets: Allow loading ROMs and movies from commandline.
3434 • Be a bit smarter with --load
3436 • Rewrote higher-level parts of audio system
3438 • Tool to build commentary tracks
3442 • Gambatte: Add support for SVN358
3444 • Use builtin font when rendering status panel.
3446 • Option to detach memory watch to its own window.
3448 • Recent ROMs/Movies menu
3452 • Useful lag counter for SNES games that autopoll
3454 • Fix buffer overflow in gambatte sound output