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
1050 8.2.12 bit.test_any(number a, number b)
1052 Is there a common set bit in a and b?
1054 8.2.13 bit.test_all(number a, number b)
1056 Are all set bits in b also set in a?
1058 8.2.14 bit.popcount(number a)
1060 Population count of a.
1062 8.2.15 bit.clshift(number a, number b, [number amount,[number
1065 Does chained left shift on a, b by amount positions, assuming
1066 numbers to be of specified number of bits.
1068 8.2.16 bit.crshift(number a, number b, [number amount,[number
1071 Does chained right shift on a, b by amount positions, assuming
1072 numbers to be of specified number of bits.
1074 8.2.17 bit.flagdecode(number a, number bits, [string on, [string
1077 Return string of length bits where ith character is ith character
1078 of on if bit i is on, otherwise ith character of off. Out of
1079 range reads give last character, or '*'/'-' if empty.
1081 8.2.18 bit.rflagdecode(number a, number bits, [string on, [string
1084 Like bit.flagdecode, but outputs the string in the opposite order
1085 (most significant bit first).
1089 Most of these functions can only be called in on_paint and
1090 on_video callbacks. Exceptions are noted.
1092 Colors are 32-bit. Bits 0-7 are the blue component, bits 8-15 are
1093 the green component, bits 16-23 are the red component, bits 24-31
1094 are alpha component (0 is fully opaque, 255 is almost
1095 transparent). -1 is the fully transparent color. Alpha values
1096 greater than 127 do work.
1098 Origin of coordinates is at top left corner of game display area.
1099 Left and top gaps correspond to negative coordinates.
1101 8.3.1 gui.resolution()
1103 Returns 2-tuple (hresolution, vresolution).
1105 8.3.2 gui.<class>_gap(number gap)
1107 Set the <class> (left, right, top, bottom) gap to specified value
1110 8.3.3 gui.text(number x, number y, string text[, number fgc[,
1113 Draw specified text on the GUI (each character cell is 8 or 16
1114 wide and 16 high). Parameters:
1116 • x: X-coordinate to start the drawing from (and x-coordinate at
1117 begining of the lines).
1119 • y: Y-coordinate to start the drawing from.
1121 • text: The text to draw.
1123 • fgc: Text color (default is 0xFFFFFF (white))
1125 • bgc: Background color (default is -1 (transparent))
1127 8.3.4 gui.textH(number x, number y, string text[, number fgc[,
1130 Like gui.text, but draw using double-width.
1132 8.3.5 gui.textV(number x, number y, string text[, number fgc[,
1135 Like gui.text, but draw using double-height.
1137 8.3.6 gui.textHV(number x, number y, string text[, number fgc[,
1140 Like gui.text, but draw using double-width/double-height.
1142 8.3.7 gui.rectangle(number x, number y, number width, number
1143 height[, number thickness[, number outline[, number fill]]])
1145 Draw rectangle on the GUI. Parameters:
1147 • x: X-coordinate of left edge.
1149 • y: Y-coordinate of upper edge.
1151 • width: Width of rectangle.
1153 • height: Height of rectangle.
1155 • thickness: Thickness of outline (default is 1).
1157 • outline: Color of outline (default is 0xFFFFFF (white))
1159 • fill: Color of fill (default is -1 (transparent))
1161 8.3.8 gui.box(number x, number y, number width, number height[,
1162 number thickness[, number outline1[,number outline2[, number
1165 Draw rectangle with 3D effect on the GUI. Parameters:
1167 • x: X-coordinate of left edge.
1169 • y: Y-coordinate of upper edge.
1171 • width: Width of rectangle.
1173 • height: Height of rectangle.
1175 • thickness: Thickness of outline (default is 1).
1177 • outline1: First color of outline (default is 0xFFFFFF (white))
1179 • outline2: First color of outline (default is 0x808080 (dark
1182 • fill: Color of fill (default is 0xC0C0C0 (light grayy))
1184 8.3.9 gui.pixel(number x, number y[, number color])
1186 Draw one pixel on the GUI. Parameters:
1188 • x: X-coordinate of the pixel
1190 • y: Y-coordinate of the pixel
1192 • color: Color of the pixel (default is 0xFFFFFF (white))
1194 8.3.10 gui.crosshair(number x, number y[, number length[, number
1197 Draw a crosshair. Parameters:
1199 • x: X-coordinate of the crosshair
1201 • y: Y-coordinate of the crosshair
1203 • length: Length of the crosshair lines (default 10).
1205 • color: Color of the crosshair (default is 0xFFFFFF (white))
1207 8.3.11 gui.line(number x1, number y1, number x2, number y2[,
1210 Draw a thin line. Parameters:
1212 • x1: X-coordinate of one end.
1214 • y1: Y-coordinate of one end.
1216 • x2: X-coordinate of the other end.
1218 • y2: Y-coordinate of the other end.
1220 • color: Color of the line (default is 0xFFFFFF (white)).
1222 8.3.12 gui.circle(number x, number y, number r[, number thick[,
1223 number border[, number fil]]])
1225 Draw a circle. Parameters.
1227 • x: X-coordinate of the center
1229 • y: Y-coordinate of the center
1231 • r: The radius of the circle
1233 • thick: Border thickness
1235 • border: Border color (default is 0xFFFFFF (white))
1237 • fill: Fill color (default is -1 (transparent)).
1239 8.3.13 gui.bitmap_draw(number x, number y, bitmap bitmap, palette
1242 Draw a bitmap on screen with specified palette. Parameters:
1244 • x: X-coordinate of left edge.
1246 • y: Y-coordinate of top edge.
1248 • bitmap: The bitmap to draw
1250 • palette: The palette to draw the bitmap using.
1252 8.3.14 gui.bitmap_draw(number x, number y, dbitmap bitmap)
1254 Draw a bitmap on screen. Parameters:
1256 • x: X-coordinate of left edge.
1258 • y: Y-coordinate of top edge.
1260 • bitmap: The bitmap to draw
1262 8.3.15 gui.palette_new()
1264 Returns a new palette (initially all transparent). Can be used
1267 8.3.16 gui.bitmap_new(number w, number h, boolean direct[, bool
1270 Returns a new bitmap/dbitmap. Can be used anywhere. Parameters:
1272 • w: The width of new bitmap
1274 • h: The height of new bitmap
1276 • direct: If true, the returned bitmap is dbitmap, otherwise
1279 • icolor: Initital fill color (defaults to 0 on BITMAP, -1 on
1282 8.3.17 gui.bitmap_load(string file)
1284 Returns loaded bitmap/dbitmap (if bitmap, the second return value
1285 is palette for bitmap). Can be used anywhere. Parameters:
1287 • file: The name of file to load.
1289 8.3.18 gui.palette_set(palette palette, number index, number
1292 Sets color in palette. Can be used anywhere. Parameters:
1294 • palette: The palette to manipulate
1296 • index: Index of color (0-65535).
1298 • color: The color value.
1300 8.3.19 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y,
1303 Sets specified pixel in bitmap. Can be used anywhere. Parameters:
1305 • bitmap: The bitmap to manipulate
1307 • x: The x-coordinate of the pixel.
1309 • y: The y-coordinate of the pixel.
1311 • color: If bitmap is a bitmap, color index (0-65535). Otherwise
1314 8.3.20 gui.bitmap_size(bitmap/dbitmap bitmap)
1316 Get size of bitmap. Can be used anywhere. Parameters:
1318 • bitmap: The bitmap to query.
1320 The first return is the width, the second is the height.
1322 8.3.21 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy,
1323 bitmap/dbitmap src, number sx, number sy, number w, number h[,
1326 Blit a part of bitmap to another. Can be used anywhere.
1329 • dest: Destination to blit to.
1331 • dx: left edge of target
1333 • dy: Top edge of target
1335 • src: The source to blit from. Must be of the same type as
1338 • sx: left edge of source
1340 • sy: Top edge of source
1342 • w: Width of region
1344 • h: Height of region.
1346 • ck: Color key. Pixels of this color are not blitted.
1348 – If bitmaps are bitmaps, this is color index of colorkey.
1349 Values outside range 0-65535 cause no key to be used as
1352 – If bitmaps are dbitmaps, this color value of colorkey.
1354 – May be absent or nil for no colorkey blit.
1356 8.3.22 gui.repaint()
1358 Request on_repaint() to happen as soon as possible. Can be used
1361 8.3.23 gui.subframe_update(boolean on)
1363 Request subframe updates (calling on_paint() on subframes) to
1364 happen (on=true) or not happen (on=false). Can be used anywhere.
1366 8.3.24 gui.screenshot(string filename)
1368 Write PNG screenshot of the current frame (no drawings) to
1369 specified file. Can be used anywhere.
1371 8.3.25 gui.color(number r, number g, number b[, number a])
1373 Returns color (in notation Lua scripts use) corresponding to
1374 color (r,g,b), each component in scale 0-255. If a is specified,
1375 that is alpha (0 is fully transparent, 256(sic) is fully opaque).
1376 The default alpha is 256.
1378 8.3.26 gui.status(string name, string value)
1380 Set status field “L[<name>]” to <value> in status area. Can be
1383 8.3.27 gui.rainbow(number step, number steps[, number color])
1385 Perform hue rotation of color <color> (default bright red), by
1386 <step> steps. The number of steps per full rotation is given by
1387 absolute value of <steps>.
1389 If <steps> is negative, the rotation will be counterclockwise.
1391 8.3.28 gui.screenshot(string filename)
1393 Saves a screenshot into specified file.
1397 Input handling. Only available in on_input callback.
1399 8.4.1 input.get(number controller, number index)
1401 Read the specified index (0-11) from specified controller (0-7).
1404 • Uses physical controller numbering. Gamepad in port 2 is
1405 controller 4, not 1!
1407 8.4.2 input.set(number controller, number index, number value)
1409 Write the specified index (0-11) from specified controller (0-7),
1410 storing value. Notes:
1412 • Uses physical controller numbering. Gamepad in port 2 is
1413 controller 4, not 1!
1415 8.4.3 input.geta(number controller)
1417 Get input state for entiere controller. Returns 13 return values.
1419 • 1st return value: Bitmask: bit i is set if i:th index is
1422 • 2nd-13th return value: value of i:th index.
1424 8.4.4 input.seta(number controller, number bitmask, number
1427 Set state for entiere controller. args is up to 12 values for
1428 indices (overriding values in bitmask if specified).
1430 8.4.5 input.controllertype(number controller)
1432 Get the type of controller as string. Valid values are:
1442 8.4.6 input.reset([number cycles])
1444 Execute reset. If cycles is greater than zero, do delayed reset.
1445 0 (or no value) causes immediate reset.
1447 • Only available with subframe flag false.
1451 Returns table of tables of all available keys and axes. The first
1452 table is indexed by key name (platform-dependent!), and the inner
1453 table has the following fields:
1455 • last_rawval: Last reported raw value for control.
1457 • ktype: Type of key (disabled, key, mouse, axis, axis-inverse,
1458 hat, pressure-m0, pressure-mp, pressure-0m, pressure-0p,
1459 pressure-pm, pressure-p0).
1461 • cal_left: Minimum calibration value. Only meaningful with axis
1464 • cal_center: Center calibration value. Only meaningful with axis
1467 • cal_right: Maximum calibration value. Only meaningful with axis
1470 • cal_tolerance: Dead zone tolerance. Only meaningful with axis
1473 8.4.8 input.keyhook(string key, boolean state)
1475 Requests that keyhook events to be sent for key (state=true) or
1476 not sent (state=false).
1478 8.4.9 input.joyget(number controller)
1480 Returns table for current controls for specified controller. The
1481 names of fields vary by controller type.
1483 • The buttons have the same name as those are referred to in
1484 other contexts in the emulator
1486 • The analog axes are “xaxis” and “yaxis”.
1488 8.4.10 input.joyset(number controller, table controls)
1490 Set the the state of specified controller to values specified in
1493 8.4.11 input.lcid_to_pcid(number controller)
1495 Return the physical index, physical port and controller number in
1496 port for specified (1-based) logical controller.
1502 8.5.1 subtitle.byindex(number i)
1504 Read the frame and length of ith subtitle. Returns nothing if not
1507 8.5.2 subtitle.set(number f, number l, string txt)
1509 Set the text of subtitle.
1511 8.5.3 subtitle.get(number f, number l)
1513 Get the text of subtitle.
1515 8.5.4 subtitle.delete(number f, number l)
1517 Delete specified subtitle.
1519 8.6 Table hostmemory
1521 Host memory handling (extra memory saved to savestates). Host
1522 memory starts empty.
1524 8.6.1 hostmemory.read(number address)
1526 Reads hostmemory slot address. Slot numbers out of range return
1527 false instead of numeric.
1529 8.6.2 hostmemory.write(number address, number value)
1531 Writes hostmemory slot with 0-255. Slot numbers out of range
1532 cause extension of host memory slot space.
1534 8.6.3 hostmemory.readbyte(number address)
1536 Read unsigned byte (1 element) from given address. Slots out of
1539 8.6.4 hostmemory.writebyte(number address, number value)
1541 Write unsigned byte (1 element) to given slot. Slot numbers out
1542 of range cause extension.
1544 8.6.5 hostmemory.readsbyte(number address)
1546 Read signed byte (1 element) from given address. Slots out of
1549 8.6.6 hostmemory.writesbyte(number address, number value)
1551 Write signed byte (1 element) to given slot. Slot numbers out of
1552 range cause extension.
1554 8.6.7 hostmemory.readword(number address)
1556 Read unsigned word (2 elements) from given address. Slots out of
1559 8.6.8 hostmemory.writeword(number address, number value)
1561 Write unsigned word (2 elements) to given slot. Slot numbers out
1562 of range cause extension.
1564 8.6.9 hostmemory.readsword(number address)
1566 Read signed word (2 elements) from given address. Slots out of
1569 8.6.10 hostmemory.writesword(number address, number value)
1571 Write signed word (2 elements) to given slot. Slot numbers out of
1572 range cause extension.
1574 8.6.11 hostmemory.readdword(number address)
1576 Read unsigned doubleword (4 elements) from given address. Slots
1577 out of range return false.
1579 8.6.12 hostmemory.writedword(number address, number value)
1581 Write unsigned doubleword (4 elements) to given slot. Slot
1582 numbers out of range cause extension.
1584 8.6.13 hostmemory.readsdword(number address)
1586 Read signed doubleword (4 elements) from given address. Slots out
1587 of range return false.
1589 8.6.14 hostmemory.writesdword(number address, number value)
1591 Write signed doubleword (4 elements) to given slot. Slot numbers
1592 out of range cause extension.
1594 8.6.15 hostmemory.readqword(number address)
1596 Read unsigned quadword (8 elements) from given address. Slots out
1597 of range return false.
1599 8.6.16 hostmemory.writeqword(number address, number value)
1601 Write unsigned quadword (4 elements) to given slot. Slot numbers
1602 out of range cause extension.
1604 8.6.17 hostmemory.readsqword(number address)
1606 Read signed quadword (8 elements) from given address. Slots out
1607 of range return false.
1609 8.6.18 hostmemory.writesqword(number address, number value)
1611 Write signed quadword (8 elements) to given slot. Slot numbers
1612 out of range cause extension.
1618 8.7.1 movie.currentframe()
1620 Return number of current frame.
1622 8.7.2 movie.framecount()
1624 Return number of frames in movie.
1626 8.7.3 movie.readonly()
1628 Return true if in readonly mode, false if in readwrite.
1630 8.7.4 movie.rerecords()
1632 Returns the current value of rerecord count.
1634 8.7.5 movie.set_readwrite()
1636 Set readwrite mode (does not cause on_readwrite callback).
1638 8.7.6 movie.frame_subframes(number frame)
1640 Count number of subframes in specified frame (frame numbers are
1641 1-based) and return that.
1643 8.7.7 movie.read_subframe(number frame, number subframe)
1645 Read specifed subframe in specified frame and return data as
1646 array (100 elements, numbered 0-99 currently).
1648 8.7.8 movie.read_rtc()
1650 Returns the current value of the RTC as a pair (second,
1653 8.7.9 movie.unsafe_rewind([UNSAFEREWIND state])
1655 Start setting point for unsafe rewind or jump to point of unsafe
1658 • If called without argument, causes emulator to start process of
1659 setting unsafe rewind point. When this has finished, callback
1660 on_set_rewind occurs, passing the rewind state to lua script.
1662 • If called with argument, causes emulator rewind to passed
1663 rewind point as soon as possible. Readwrite mode is implicitly
1666 The following warnings apply to unsafe rewinding:
1668 • There are no safety checks against misuse (that's what “unsafe”
1671 • Only call rewind from timeline rewind point was set from.
1673 • Only call rewind from after the rewind point was set.
1677 Routines for settings manipulation
1679 8.8.1 settings.get(string name)
1681 Get value of setting. If setting is blank, returns false. If
1682 setting value can't be obtained, returns (nil, error message).
1684 8.8.2 settings.set(string name, string value)
1686 Set value of setting. If setting can't be set, returns (nil,
1689 8.8.3 settings.is_set(string name)
1691 Returns if setting is set. If setting does not exist, returns
1692 (nil, error message).
1694 8.8.4 settings.blank(string name)
1696 Blanks a setting and returns true. If setting can't be blanked,
1697 returns (nil, error message).
1701 Contains various functions for managing memory
1703 8.9.1 memory.vma_count()
1705 Returns the number of VMAs
1707 8.9.2 memory.read_vma(number index)
1709 Reads the specified VMA (indices start from zero). Trying to read
1710 invalid VMA gives nil. The read VMA is table with the following
1713 • region_name (string): The readable name of the VMA
1715 • baseaddr (number): Base address of the VMA
1717 • lastaddr (number): Last address in the VMA.
1719 • size (number): The size of VMA in bytes.
1721 • readonly (boolean): True of the VMA corresponds to ROM.
1723 • iospace (boolean): True if the VMA is I/O space.
1725 • native_endian (boolean): True if the VMA has native endian as
1726 opposed to little endian.
1728 8.9.3 memory.find_vma(number address)
1730 Finds the VMA containing specified address. Returns table in the
1731 same format as read_vma or nil if not found.
1733 8.9.4 memory.readbyte(number address)
1735 Reads the specified address as unsigned byte and returns the
1738 8.9.5 memory.readsbyte(number address)
1740 Reads the specified address as signed byte and returns the
1743 8.9.6 memory.writebyte(number address, number value)
1745 Writes the specified value (negative values undergo 2's
1746 complement) to specified address (as a byte).
1748 8.9.7 memory.readword(number address)
1750 Reads the specified address as unsigned word and returns the
1753 8.9.8 memory.readsword(number address)
1755 Reads the specified address as signed word and returns the
1758 8.9.9 memory.writeword(number address, number value)
1760 Writes the specified value (negative values undergo 2's
1761 complement) to specified address (as a word).
1763 8.9.10 memory.readdword(number address)
1765 Reads the specified address as unsigned doubleword and returns
1768 8.9.11 memory.readsdword(number address)
1770 Reads the specified address as signed doubleword and returns the
1773 8.9.12 memory.writedword(number address, number value)
1775 Writes the specified value (negative values undergo 2's
1776 complement) to specified address (as a doubleword).
1778 8.9.13 memory.readqword(number address)
1780 Reads the specified address as unsigned quadword and returns the
1783 8.9.14 memory.readsqword(number address)
1785 Reads the specified address as signed quadword and returns the
1788 8.9.15 memory.writeqword(number address, number value)
1790 Writes the specified value (negative values undergo 2's
1791 complement) to specified address (as a quadword).
1793 8.9.16 memory.hash_region(number base, number size)
1795 Hash specified number of bytes starting from specified address
1796 and return the SHA-256.
1798 8.9.17 memory.hash_state()
1800 Hash the current system state. Mainly useful for debugging
1803 8.9.18 memory.readregion(number base, number size)
1805 Read a region of memory.
1807 • Warning: If the region crosses VMA boundary, the results are
1810 8.9.19 memory.map<type>([number base, number size])
1812 Returns a table mapping specified memory aperture for read/write.
1813 If parameters are omitted, entiere map space is the aperture.
1815 • Type may be one of: byte, sbyte, word, sword, dword, sdword,
1818 8.9.20 memory.writeregion(number base, number size, table data)
1820 Write a region of memory.
1822 • Warning: If the region crosses VMA boundary, the results are
1825 8.9.21 memory.map_struct()
1827 Returns a new mapping structure (MMAP_STRUCT)
1829 8.9.22 MMAP_STRUCT(string key, number address, string type)
1831 Bind key in mmap structure to specified address with specified
1834 • Type may be one of: byte, sbyte, word, sword, dword, sdword,
1837 8.9.23 memory.read_expr(string expr)
1839 Evaluate specified watch expression and return result
1843 Contains functions for manipulating subtitles.
1845 8.10.1 subtitle.byindex(number index)
1847 Get (basetime, length) pair of specified subtitle index or
1848 nothing if index isn't valid.
1850 8.10.2 subtitle.get(number basetime, number length)
1852 Read the specified subtitle. Returns “” if the subtitle does not
1855 8.10.3 subtitle.set(number basetime, number length, string
1858 Set the specified subtitle.
1860 8.10.4 subtitle.deltete(number basetime, number length)
1862 Delete the specified subtitle.
1866 Contains copy of global variables from time of Lua
1867 initialization. Non-writeable.
1871 Various callbacks to Lua that can occur.
1873 8.12.1 Callback: on_paint(bool not_synth)
1875 Called when screen is being painted. Any gui.* calls requiring
1876 graphic context draw on the screen.
1878 not_synth is true if this hook is being called in response to
1879 received frame, false otherwise.
1881 8.12.2 Callback: on_video()
1883 Called when video dump frame is being painted. Any gui.* calls
1884 requiring graphic context draw on the video.
1886 8.12.3 Callback: on_frame_emulated()
1888 Called when emulating frame has completed and
1889 on_paint()/on_video() calls are about to be issued.
1891 8.12.4 Callback: on_frame()
1893 Called on each starting whole frame.
1895 8.12.5 Callback: on_startup()
1897 Called when the emulator is starting (lsnes.rc and --run files
1900 8.12.6 Callback: on_rewind()
1902 Called when rewind movie to beginning has completed.
1904 8.12.7 Callback: on_pre_load(string name)
1906 Called just before savestate/movie load occurs (note: loads are
1907 always delayed, so this occurs even when load was initiated by
1910 8.12.8 Callback: on_err_load(string name)
1912 Called if loadstate goes wrong.
1914 8.12.9 Callback: on_post_load(string name, boolean was_savestate)
1916 Called on successful loadstate. was_savestate gives if this was a
1917 savestate or a movie.
1919 8.12.10 Callback: on_pre_save(string name, boolean is_savestate)
1921 Called just before savestate save occurs (note: movie saves are
1922 synchronous and won't trigger these callbacks if called from
1925 8.12.11 Callback: on_err_save(string name)
1927 Called if savestate goes wrong.
1929 8.12.12 Callback: on_post_save(string name, boolean is_savestate)
1931 Called on successful savaestate. is_savestate gives if this was a
1932 savestate or a movie.
1934 8.12.13 Callback: on_quit()
1936 Called when emulator is shutting down.
1938 8.12.14 Callback: on_input(boolean subframe)
1940 Called when emulator is just sending input to bsnes core.
1941 Warning: This is called even in readonly mode, but the results
1944 8.12.15 Callback: on_reset()
1946 Called when SNES is reset.
1948 8.12.16 Callback: on_readwrite()
1950 Called when moving into readwrite mode as result of “set-rwmode”
1951 command (note: moving to rwmode by Lua won't trigger this, as per
1952 recursive entry protection).
1954 8.12.17 Callback: on_snoop(number port, number controller, number
1955 index, number value)
1957 Called each time bsnes asks for input. The value is the final
1958 value to be sent to bsnes core (readonly mode, autohold and
1959 autofire have been taken into account). Might be useful when
1960 translating movies to format suitable for console verification.
1961 Note: There is no way to modify the value to be sent.
1963 8.12.18 Callback: on_keyhook(string keyname, table state)
1965 Sent when key that has keyhook events requested changes state.
1966 Keyname is name of the key (group) and state is the state (same
1967 kind as table values in input.raw).
1969 8.12.19 Callback: on_idle()
1971 Called when requested by set_idle_timeout(), the timeout has
1972 expired and emulator is waiting.
1974 8.12.20 Callback: on_timer()
1976 Called when requested by set_idle_timeout() and the timeout has
1977 expired (regardless if emulator is waiting).
1979 8.12.21 Callback: on_set_rewind(UNSAFEREWIND r)
1981 Called when unsafe rewind object has been constructed.
1983 8.12.22 Callback: on_pre_rewind()
1985 Called just before unsafe rewind is about to occur.
1987 8.12.23 Callback: on_post_rewind()
1989 Called just after unsafe rewind has occured.
1991 9 Memory watch expression syntax
1993 Memory watch expressions are in RPN (Reverse Polish Notation). At
1994 the end of expression, the top entry on stack is taken as the
1999 • Evaluation order is strictly left to right.
2001 • a is the entry on top of stack
2003 • b is the entry immediately below top of stack
2005 • ; separates values to be pushed (no intermediate pop).
2007 • After end of element, all used stack slots are popped and all
2010 • When pushing multiple values, the pushes occur in order shown.
2012 The following operators are available:
2026 • b : read_signed_byte(a)
2030 • d : read_signed_dword(a)
2032 • i : quotent(a / b)
2037 • q : read_signed_qword(a)
2047 • w : read_signed_word(a)
2051 • B : read_unsigned_byte(a)
2053 • C<number>z : Push number <number> to stack.
2055 • D : read_unsigned_dword(a)
2057 • C0x<number>z : Push number <number> (hexadecimal) to stack.
2059 • Q : read_unsigned_qword(a)
2061 • R<digit> : round a to <digit> digits.
2063 • W : read_unsigned_word(a)
2067 C0x007e0878zWC0x007e002czW-
2069 1. Push value 0x7e0878 on top of stack (C0x007e0878z).
2071 2. Pop the value on top of stack (0x7e0878), read word value at
2072 that address and push the result,call it x1 (W).
2074 3. Push value 0x7e002c on top of stack (C0x007e002cz).
2076 4. Pop the value on top of stack (0x7e002c), read word value at
2077 that address and push the result,call it x2 (W).
2079 5. Pop the two top numbers on stack, x1 and x2, substract x1 from
2080 x2 and push x2 - x1 (-).
2082 6. Since the expression ends, the final memory watch result is
2083 the top one on stack, which is x2 - x1.
2085 10 Modifier and key names:
2089 10.1.1 Modifier names
2091 Following modifier names are known:
2093 • ctrl, lctrl, rctrl: Control keys
2095 • alt, lalt, ralt: ALT keys.
2097 • shift, lshift, rshift: Shift keys.
2099 • meta, lmeta, rmeta: Meta keys.
2101 • num, caps: Numlock/Capslock (these are sticky!)
2103 • mode: Mode select.
2107 Following key names are known:
2109 • backspace, tab, clear, return, pause, escape, space, exclaim,
2110 quotedbl, hash, dollar, ampersand, quote, leftparen,
2111 rightparen, asterisk, plus, comma, minus, period, slash, 0, 1,
2112 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
2113 greater, question, at, leftbracket, backslash, rightbracket,
2114 caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k,
2115 l, m, n, o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0,
2116 world_1, world_2, world_3, world_4, world_5, world_6, world_7,
2117 world_8, world_9, world_10, world_11, world_12, world_13,
2118 world_14, world_15, world_16, world_17, world_18, world_19,
2119 world_20, world_21, world_22, world_23, world_24, world_25,
2120 world_26, world_27, world_28, world_29, world_30, world_31,
2121 world_32, world_33, world_34, world_35, world_36, world_37,
2122 world_38, world_39, world_40, world_41, world_42, world_43,
2123 world_44, world_45, world_46, world_47, world_48, world_49,
2124 world_50, world_51, world_52, world_53, world_54, world_55,
2125 world_56, world_57, world_58, world_59, world_60, world_61,
2126 world_62, world_63, world_64, world_65, world_66, world_67,
2127 world_68, world_69, world_70, world_71, world_72, world_73,
2128 world_74, world_75, world_76, world_77, world_78, world_79,
2129 world_80, world_81, world_82, world_83, world_84, world_85,
2130 world_86, world_87, world_88, world_89, world_90, world_91,
2131 world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3,
2132 kp4, kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide,
2133 kp_multiply, kp_minus, kp_plus, kp_enter, kp_equals, up, down,
2134 right, left, insert, home, end, pageup, pagedown, f1, f2, f3,
2135 f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, numlock,
2136 capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt, lalt,
2137 rmeta, lmeta, lsuper, rsuper, mode, compose, help, print,
2138 sysreq, break, menu, power, euro, undo
2140 • Names of form 'key<n>' where <n> is 0-255 are interpretted as
2141 key having hardware-dependent scan code of <n> (useful to bind
2142 those keys that don't have symbolic names).
2144 10.1.3 Joystick pseudo-keys:
2146 • joystick<num>button<button>: Joystick <num> (0-based) button
2149 • joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat>
2152 • joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat>
2155 • joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat>
2158 • joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat>
2161 • joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis>
2162 negative position (axis modes axis and axis_inverse).
2164 • joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis>
2165 positive position (axis modes axis and axis_inverse).
2167 • joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis>
2168 pressure (axis modes pressure_*).
2170 10.1.4 Special buttons:
2172 • Escape: Enter/Exit Command mode, cancel modal dialogs.
2174 • Return (also KPEnter): Execute command, ok modal dialog.
2176 • Pgup/Up (also KP8/9 if no num lock, CTRL+P; command mode):
2177 Previous command in command history
2179 • Pgdn/Down(also KP2/3 if no num lock, CTRL+N; command mode):
2180 Next command in command history
2182 • Home (also KP7 if no num lock, CTRL+A; command mode): Beginning
2185 • End (also KP1 if no num lock, CTRL+E; command mode): End of
2188 • Left (also KP4 if no num lock, CTRL+B; command mode): Move
2191 • Right (also KP6 if no num lock, CTRL+F; command mode): Move
2194 • Delete (also KP. if no num lock; command mode): Delete
2195 character to right of cursor.
2197 • Insert (also KP0 if no num lock; command mode): Toggle between
2198 insert / overwrite modes.
2200 • Backspace (command mode): Delete character to left of cursor.
2202 • CTRL+LEFT (also ALT+B; command mode): Previous word.
2204 • CTRL+RIGHT (also ALT+F; command mode): Next word.
2206 • ALT+D (also CTRL+W; command mode): Delete word.
2208 • LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump
2211 10.2 wxWidgets platform
2213 10.2.1 Modifier names:
2215 Following modifier names are known:
2225 • cmd (Mac OS X only)
2229 Following key names are known:
2231 • back, tab, return, escape, space, exclaim, quotedbl, hash,
2232 dollar, percent, ampersand, quote, leftparen, rightparen,
2233 asterisk, plus, comma, minus, period, slash, 0, 1, 2, 3, 4, 5,
2234 6, 7, 8, 9, colon, semicolon, less, equals, greater, question,
2235 at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t,
2236 u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
2237 underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m,
2238 n, o, p, q, r, s, t, u, v, w, x, y, z, leftcurly, pipe,
2239 rightcurly, tilde, delete, start, lbutton, rbutton, cancel,
2240 mbutton, clear, shift, alt, control, menu, pause, capital, end,
2241 home, lefT, up, right, down, select, print, execute, snapshot,
2242 insert, help, numpad0, numpad1, numpad2, numpad3, numpad4,
2243 numpad5, numpad6, numpad7, numpad8, numpad9, multiply, add,
2244 separator, subtract, decimal, divide, f1, f2, f3, f4, f5, f6,
2245 f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19,
2246 f20, f21, f22, f23, f24, numlock, scroll, pageup, pagedown,
2247 numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
2248 numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up,
2249 numpad_right, numpad_down, numpad_pageup, numpad_pagedown,
2250 numpad_end, numpad_begin, numpad_insert, numpad_delete,
2251 numpad_equal, numpad_multiply, numpad_add, numpad_separator,
2252 numpad_subtract, numpad_decimal, numpad_divide, windows_left,
2253 windows_right, windows_menu, command, special1, special2,
2254 special3, special4, special5, special6, special7, special8,
2255 special9, special10, special11, special12, special13,
2256 special14, special15, special16, special17, special18,
2257 special19, special20
2259 11 Movie file format
2261 Movie file is .zip archive in itself, normal ZIP archive tools
2262 work on it (note: If you recompress it, do not use compression
2263 methods other than store and deflate and especially do not use
2264 encryption of any kind).
2266 11.1 Detecting clean start/SRAM/Savestate
2268 • If file has member “savestate” it is savestate, otherwise:
2270 • If file has members with names starting “moviesram.” it is
2271 movie starting from SRAM, otherwise:
2273 • It is movie starting from clear state.
2275 11.2 Member: gametype
2277 Type of game ROM and region (as one line). Valid values are:
2280 +--------------+---------------------+--------+
2281 | Value | System | Region |
2282 +--------------+---------------------+--------+
2283 +--------------+---------------------+--------+
2284 | snes_pal | Super NES | PAL |
2285 +--------------+---------------------+--------+
2286 | sgb_pal | Super Game Boy | PAL |
2287 +--------------+---------------------+--------+
2288 | snes_ntsc | Super NES | NTSC |
2289 +--------------+---------------------+--------+
2290 | sgb_ntsc | Super Game Boy | NTSC |
2291 +--------------+---------------------+--------+
2292 | bsx | BS-X (non-slotted) | NTSC |
2293 +--------------+---------------------+--------+
2294 | bsxslotted | BS-X (slotted) | NTSC |
2295 +--------------+---------------------+--------+
2296 | sufamiturbo | Sufami Turbo | NTSC |
2297 +--------------+---------------------+--------+
2303 +---------+-----------------+
2304 | Region | Framerate (fps) |
2305 +---------+-----------------+
2306 +---------+-----------------+
2307 | PAL | 322445/6448 |
2308 +---------+-----------------+
2309 | NTSC | 10738636/178683 |
2310 +---------+-----------------+
2315 Contains type of port #1 (as one line). Valid values are 'none',
2316 'gamepad', 'multitap' and 'mouse'. If not present, defaults to
2321 Contains type of port #2 (as one line). Valid values are 'none',
2322 'gamepad', 'multitap', 'mouse', 'superscope', 'justifier' and
2323 'justifiers'. If not present, defaults to 'none'.
2325 11.5 Member: gamename
2327 Contains name of the game (as one line).
2329 11.6 Member: authors
2331 Contains authors, one per line. Part before '|' is the full name,
2332 part after is the nickname.
2334 11.7 Member: systemid
2336 Always “lsnes-rr1” (one line). Used to reject other saves.
2338 11.8 Member: controlsversion
2340 Always “0” (one line). Used to identify what controls are there.
2342 11.9 Member: “coreversion”
2344 Contains bsnes core version number (as one line).
2346 11.10 Member: projectid
2348 Contains project ID (as one line). Used to identify if two movies
2349 are part of the same project.
2351 11.11 Member: {rom,slota,slotb}{,xml}.sha256
2353 Contains SHA-256 of said ROM or ROM mapping file (as one line).
2354 Absent if corresponding file is absent.
2356 11.12 Member: moviesram.<name>
2358 Raw binary startup SRAM of kind <name>. Only present in
2359 savestates and movies starting from SRAM.
2361 11.13 Member: saveframe
2363 Contains frame number (as one line) of frame movie was saved on.
2364 Only present in savestates.
2366 11.14 Member: lagcounter
2368 Current value of lag counter (as one line). Only present in
2371 11.15 Member: pollcounters
2373 Contains poll counters (currently 100 of them), one per line.
2374 Each line is raw poll count if DRDY is set for it. Otherwise it
2375 is negative poll count minus one. Only present in savestates.
2377 11.16 Member: hostmemory
2379 Raw binary dump of host memory. Only present in savestates.
2381 11.17 Member: savestate
2383 The raw binary savestate itself. Savestate detection uses this
2384 file, only present in savestates.
2386 11.18 Member: screenshot
2388 Screenshot of current frame. Only present in savestates. First 2
2389 bytes are big-endian width of image, rest are 24-bit RGB image
2390 data. Height of image is inferred from the width and size of
2393 11.19 Member: sram.<name>
2395 Raw binary SRAM of kind <name> at time of savestate. Only present
2400 The actual input track, one line per subframe (blank lines are
2403 • If the first byte of each line is '.', ' ', <tab> or '|', then
2404 the line is part of same frame as previous, otherwise it starts
2407 • First subframe must start a new frame.
2409 Length of movie in frames is number of lines in input file that
2412 11.21 Member: subtitles
2414 Subtitle track. Optional.
2416 • Each line is in form <firstframe> <numframes> <text>.
2418 • Linefeed is encoded as \n, backslash is encoded as \\.
2420 11.22 Member: rerecords
2422 Contains textual base-10 rerecord count (as one line; emulator
2423 just writes this, it doesn't read it) + 1.
2425 11.23 Member: rrdata
2427 This member stores set of load IDs. There is one load ID per
2428 rerecord (plus one corresponding to start of project).
2430 • This member constists of concatenation of records
2432 • Each record is 2-36 bytes long and can represent 1-16,843,009
2435 • IDs are interpretted as 256-bit big-endian integers with
2438 • Initial predicted ID is all zeroes.
2440 Format of each record is:
2442 • 1 byte: Opcode byte. Bits 0-4 are prefix length (prefixlen),
2443 bits 5-6 are count length (countlen). Bit 7 is unused.
2445 • 32-prefixlen bytes of ID.
2447 • countlen bytes of big-endian count (count).
2449 Records are processed as follows:
2451 • To form the first ID encoded by record, take the first
2452 prefixlen bytes predicted ID and append the read ID value to
2453 it. The result is the first ID encoded.
2455 • If countlen is 0, record encodes 1 ID.
2457 • If countlen is 1, record encodes 2+count IDs.
2459 • If countlen is 2, record encodes 258+count IDs.
2461 • If countlen is 3, record encodes 65794+count IDs.
2463 • The new predicted ID is the next ID after last one encoded by
2466 The number of rerecords + 1 is equal to the sum of number of IDs
2467 encoded by all records.
2469 11.24 Member: starttime.second
2471 Movie starting time, second part. Epoch is Unix epoch. Default is
2474 11.25 Member: starttime.subsecond
2476 Movie starting time, subsecond part. Unit is CPU clocks. Default
2479 11.26 Member: savetime.second
2481 Movie saving time, second part. Default is starttime.second. Only
2482 present in savestates.
2484 11.27 Member: savetime.subsecond
2486 Movie saving time, subsecond part. Default is
2487 starttime.subsecond. Only present in savestates.
2489 12 lsvs file format (commentary tracks)
2493 • Each cluster is 8kB (8192 bytes) in size.
2495 • Cluster n starts at offset 8192*n in file.
2497 • The following clusters are system special:
2499 – Cluster 0 and all clusters with number multiple of 2048
2502 – Cluster 1 (superblock)
2506 • The cluster table describing cluster n is stored in cluster n &
2507 ~0x7FF (zero last 11 bits of n).
2509 • This cluster table consists of 2048 4-byte big-endian integers.
2511 • Each entry describes a cluster in 16MB supercluster, in order.
2513 • The valid values for entries are:
2515 – 0x00000000: Free cluster
2517 – 0x00000001: Last cluster in chain.
2519 – 0xFFFFFFFF: System cluster (cluster tables and superblock)
2521 – (anything else): Number of next cluster in chain. Must not be
2524 • Due to limitations of the format, there can be at most 2097052
2525 superclusters, giving maximum file size of 16TB.
2529 • The stream table chain always starts in cluster 2.
2531 • Otherwise, it follows normal chaining.
2533 • The stream table consists of 16-byte entries:
2535 – The first 8 bytes of entry give big-endian beginning position
2536 of stream in units of 1/48000 s.
2538 – The next 4 bytes of entry give big-endian beginning cluster
2539 for control data. 0 here marks the entry as not present.
2541 – The last 4 bytes of entry give big-endian beginning cluster
2544 • Stream table clusters are normal clusters, following normal
2547 • The stream begnning position is not guarenteed unique. There
2548 can be multiple streams with the same starting position in the
2551 12.4 Stream control data
2553 • The stream control data consists of entries 4 bytes each:
2555 – The first 2 bytes of entry gives big-endian length of packet
2557 – The next byte of entry gives audio length of packet in units
2560 – The last byte is control byte.
2562 ∗ 0 means this entry is not present and the control data
2565 ∗ 1 is valid control entry.
2567 • The stream control data can also end by running into end of the
2570 – This happens if there happens to be exact multiple of 2048
2571 packets in stream and number of packets is nonzero.
2573 • These clusters follow normal chaining.
2575 12.5 Stream codec data
2577 • Stream codec data consists of raw Opus data packets packed back
2578 to back with nothing in between.
2580 • Warning: Due to internal limitations, this data must reside in
2581 the first 65536 superclusters (that is, the first 1TB of the
2586 • The superblock is stored in cluster 1.
2588 • The first 11 bytes are “sefs-magic”<NUL>.
2590 • The rest are unused.
2592 • This cluster 1 is marked as system special.
2594 13 Known ROM extensions
2596 • SNES cartridge ROMs: sfc, smc, swc, fig, ufo, sf2, gd3, gd7,
2599 • DMG cartridge ROMs: dmg, gb.
2601 • GBC cartridge ROMs: cgb, gbc.
2605 • The first line must be: “[GAMEPACK FILE]”.
2607 • There is one needed line: “type <systype>”. This sets system
2608 type to <systype>. The following system types are valid:
2612 – bsx (BS-X non-slotted)
2614 – bsxslotted (BS-X slotted)
2616 – sufamiturbo (Sufami Turbo)
2618 – sgb (Super Game Boy)
2622 – gbc (Game Boy Color)
2624 – gbc_gba (Game Boy Color with GBA initial register values)
2626 • Optionally a region can be specified: “region <region>”. The
2627 following values are valid:
2629 – autodetect (Autodetect region: snes and sgb only)
2631 – ntsc (NTSC: snes, bsx, bsxslotted, sufamiturbo, sgb)
2633 – pal (PAL: snes, sgb)
2635 – world (World: dmg, gbc, gbc_gba)
2637 • ROM images are loaded as: “rom <type> <file>”. The following
2640 – rom (Cartridge ROM in snes, dmg, gbc, gbc_gba. BIOS in bsx,
2641 bsxslotted, sufamiturbo)
2643 – bsx (Cartridge ROM in bsx, bsxslotted)
2645 – slot-a (Cartridge ROM in sufamiturbo)
2647 – slot-b (Cartridge ROM in sufamiturbo)
2649 • ROM markup can be loaded as: “xml <type> <file>”. The types
2650 valid are the same as for ROMs.
2652 • Patches can be loaded as “patch[<offset>] <type> <file>”. The
2653 types are the same as for ROMs.
2655 – Offset is given in form [+-]<number>. Usually offset is
2658 – Default offset is +0.
2666 rom rom speedygonzales.sfc
2668 patch-512 rom sonicthehedgehog.ips
2676 rom rom supergameboy.sfc
2678 rom dmg megamanV.dmg
2680 15 Quick'n'dirty encode guide
2682 1. Start the emulator and load the ROM and movie file.
2684 2. Set large AVI option 'set-setting avi-large on'
2686 3. Enable dumping 'dump-avi tmpdump'
2688 4. Unpause and let it run until you want to end dumping.
2690 5. Close the emulator (closing the window is the easiest way). Or
2693 6. For each tmpdump*.avi file created, on command prompt, do
2694 'x264 --crf 10 -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
2696 7. Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
2698 8. Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv +
2699 tmpdump_0000001.mkv + tmpdump_0000002.mkv' (list every
2700 tmpdump_<numbers>.mkv, with + in between).
2702 9. Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'. Now
2703 final.mkv contains quick'n'dirty encode.
2705 16 Axis configurations for some gamepad types:
2707 16.1 XBox360 controller:
2709 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be
2712 set-axis joystick0axis2 pressure-+
2714 set-axis joystick0axis5 pressure-+
2716 • This is needed for SDL only. EVDEV sets those types correctly.
2718 16.2 PS3 “sixaxis” controller:
2720 Axes 8-19 should be disabled.
2722 set-axis joystick0axis8 disabled
2724 set-axis joystick0axis9 disabled
2726 set-axis joystick0axis10 disabled
2728 set-axis joystick0axis11 disabled
2730 set-axis joystick0axis12 disabled
2732 set-axis joystick0axis13 disabled
2734 set-axis joystick0axis14 disabled
2736 set-axis joystick0axis15 disabled
2738 set-axis joystick0axis16 disabled
2740 set-axis joystick0axis17 disabled
2742 set-axis joystick0axis18 disabled
2744 set-axis joystick0axis19 disabled
2748 17.1 Problems from BSNES core:
2750 • The whole pending save stuff.
2752 • Lack of layer hiding.
2754 • It is slow (especially accuracy).
2756 • Firmwares can't be loaded from ZIP archives.
2758 17.2 Other problems:
2760 • Modifiers don't work with pseudo-keys (SDL, EVDEV).
2762 • Audio for last dumped frame is not itself dumped.
2764 • Audio in UI is pretty bad in quality if game doesn't run at
2767 • No menus, command based interface (SDL).
2769 • Long commands don't scroll.
2775 • Fix -Wall warnings
2777 • Fix dumper video corruption with levels 10-18.
2783 • Lots of code cleanups
2785 • Lua interface to settings
2787 • Allow specifying AVI borders without Lua
2789 • Fix scaling if vscale > 1 and originx > 0 (left border exists)
2791 • on_snoop lua callback
2793 • Faster movie loading and saving.
2803 • Save jukebox functionality.
2807 • Try to fix some nasty failing movie load edge cases
2809 • Allow specifying scripts to run on command line.
2813 • Major source code reorganization.
2815 • Backup savestates before overwriting.
2817 • Don't crash if loading initial state fails.
2821 • Fix firmware lookup
2823 • Fix author name parsing
2825 • Fix rerecord counting
2827 • (SDL) Print messages to console if SDL is uninitialized
2829 • Add movieinfo program
2831 • Fix loading movies starting from SRAM.
2835 • Add support for unattended dumping
2837 • Fix compiling for Win32
2839 • Don't lock up if sound can't be initialized
2841 • Strip trailing CR from commands
2843 • Don't try to do dubious things in global ctors (fix crash on
2848 • Small documentation tweaking
2852 • Fix major bug in modifier matching
2856 • Lots of documentation fixes
2858 • Use dedicated callbacks for event backcomm., not commands.
2860 • Ensure that the watchdog is not hit when executing delayed
2863 • Remove errant tab from joystick message.
2867 • Make autofire operate in absolute time, not linear time
2869 • Reinitialize controls when resuming from loadstate
2871 • Some more code cleanups
2873 • If Lua allocator fails, call OOM_panic()
2875 • Byte/word/dword/qword sized host memory write/read functions.
2877 • Dump at correct framerate if dumping interlaced NTSC
2882 • Actually include the complete source code
2888 • Document {save,start}time.{,sub}second.
2890 • Intercept time() from bsnes core.
2894 • Allow disabling time() interception (allow build on Mac OS X)
2896 • Use SDLMain on Mac OS X (make SDL not crash)
2898 • Disable delayed resets (just plain too buggy for now).
2902 • Use 16-bit for graphics/video instead of 32-bit.
2904 • gui.rectangle/gui.pixel
2908 • New CSCD writer implementation.
2912 • Fix interaction of * and +.
2914 • Manual improvements
2916 • Use gettimeofday()/usleep(), these seem portable enough.
2918 • Move joystick axis manipulation to keymapper code.
2920 • Changes to how read-only works.
2922 • Refactor controller input code.
2926 • Fix mouseclick scale compensation.
2928 • Draw area boundaries correctly in SDL code.
2932 • Fix CSCD output (buffer overrun and race condition).
2936 • JMD dumping support.
2938 • Allow unattended dumping to JMD.
2940 • Move to BSNES v083.
2942 • Switch back to 32-bit colors.
2944 • Add Lua function gui.color.
2946 • Use some new C++11 features in GCC 4.6.
2948 • Be prepared for core frequency changes.
2950 • Pass colors in one chunk from Lua.
2954 • New lua functions gui.line(), gui.status() and gui.circle(),
2955 memory.vma_count(), memory.read_vma() and memory.find_vma().
2957 • Numerious documentation fixups
2959 • RTC time format changed
2961 • Reformat flags display
2963 • Allow lua package name to be overridden
2965 • SDUMP (high-quality dumping).
2967 • Split platform support to plugins.
2969 • Make all sound plugins support basic sound commands
2971 • Support portaudio for sound.
2973 • Allow disable Lua/SDL searching.
2975 • Upconvert colors when copying lcscreen to screen.
2977 • Reorganize source tree.
2979 • Evdev joystick support.
2981 • Refactor more code into generic window code.
2985 • Refactor message handling.
2989 • Documentation fixes
2991 • Finish pending saves before load/quit.
2993 • Wxwidgets graphics plugin.
2997 • Get rid of win32-crap.[ch]pp.
2999 • Move files around a lot.
3001 • Get rid of need for host C++ compiler.
3005 • Refactor inter-component communication.
3009 • Fix crash on multiline aliases.
3011 • Load/Save settings in wxwidgets gui.
3015 • Patch problems in bsnes core
3017 • SNES is little-endian, not big-endian!
3019 • Fix memory corruption in lcscreen::load()
3023 • Fix interpretting repeat counts in rrdata loading.
3025 • New lua callback: on_frame()
3027 • Remove calls to runtosave() that aren't supposed to be there
3029 • Lua function: movie.read_rtc()
3031 • Ignore src/fonts/font.cpp
3033 • Fix more bsnes core problems
3035 • Control bsnes random seeding
3039 • Some bsnes core debugging features (state dump and state hash)
3041 • Fix titlebar version number (no, the last version wasn't
3042 'lsnes-0-beta21', it was 'lsnes rr0-beta21').
3046 • Fix memory corruption due to macro/field mixup
3048 • search-memory update
3050 • Allow direct-mapped framebuffer
3052 • SDL: Use SDL_ANYFORMAT if possible
3054 • SDMP2SOX: 2s delay modes.
3056 • Wxwidgets: Cleanups
3058 • Use sed -E, not sed -r. Fixes building on Mac OS X.
3060 • Wxwidgets: Save jukebox on exit
3062 • Fix RTC if using load-movie on savestate.
3064 • Fix crash related to full console mode.
3068 • Wxwidgets: Allow bringing application to foreground on Mac OS
3071 • Wxwidgets: Allow compiling on Mac OS X.
3073 • Use movie compare instead of movie hashing (faster save/load).
3075 • Lua: _SYSTEM table.
3079 • sdmp2sox: Pad soundtrack if using -l or -L.
3081 • sdmp2sox: Fix NTSC overscan.
3083 • sdmp2sox: Add AR correction mode.
3085 • call lua_close() when exiting.
3087 • Fix zip_writer bug causing warnings from info-zip and error
3092 • Fix IPS patching code (use bsnes core IPS patcher).
3094 • Implement BPS patching (using bsnes core IPS patcher).
3096 • Add feature to load headered ROMs.
3100 • Show command names when showing keybindings
3104 • Fix pause-on-end to be actually controllable
3106 • SDL: Poll all events in queue, not just first one (fixes
3107 slowness in command typing)
3109 • Wxwidgets: Fix ROM loading.
3113 • Lua: Add gui.textH, gui.textV, gui.textHV
3115 • Fix text colors on SDL on Mac OS X
3117 • Mode 'F' for finished in readonly mode.
3119 • Fix some WS errors.
3121 • Reliably pause after skip poll
3123 • Split UI and core into their own threads
3127 • Remove leftover dummy SRAM slot
3129 • Fix controller numbers.
3133 • Fix lsnes-dumpavi after interface change.
3135 • Also give BSNES patches for v085.
3137 • Pack movie data in memory.
3141 • Fix framecount/length given when loading movies.
3143 • Controller command memory leak fixes.
3145 • Don't leak palette if freeing screen object.
3151 • Wxwidgets: Allow controlling dumper from the menu.
3155 • Rewrite parts of manual
3157 • Lua: Make it work with Lua 5.2.
3161 • Win32: Fix compile errors.
3165 • Refactor controller input code.
3167 • Fix crash when using command line on SDL / Mac OS X.
3171 • Delete core/coroutine (obsolete)
3173 • Lag input display by one frame.
3175 • Rewind movie to beginning function.
3177 • Fix wrong frame number reported to Lua when repainting after
3180 • Support UI editing of jukebox
3182 • Wxwidgets: Save settings on exit.
3184 • Support ${project} for filenames
3186 • SDL: Fix command history
3190 • Fix some order-of-global-ctor bugs.
3194 • Fix crashes when quitting on Win32.
3198 • EVDEV: Queue keypresses from joystick, don't send directly
3200 • Wxwidgets: Load-Preserve that actually works.
3204 • Wxwidgets: GUI for memory search.
3206 • Warn about using synchronous queue in UI callback.
3210 • Remember last saved file for each ROM
3212 • Support MT dumping via boost.
3216 • Lua: input.keyhook
3218 • Make mouse be ordinary input instead of special-casing
3220 • SDL: Don't screw up commands with NUL codepoints.
3224 • Merge status panel and main window
3226 • True movie slot support (the rest of it)
3228 • SDL: Fix compilation error
3230 • Elminate cross calls in dump menu code.
3234 • Cancel pending saves command
3236 • Wxwidgets: Code refactoring
3238 • Wxwidgets: Fix system -> reset
3240 • Wxwidgets: Read watch expressions in the right thread
3244 • Wxwidgets: Don't prompt for member when running Lua script (Lua
3245 doesn't support that).
3247 • Wxwidgets: 128 -> 1024 Autohold slots (in case more are
3250 • Don't append trailing '-' to prefix when saving movie.
3252 • Fix ROM/savestate handling (don't let user mismatch ROM and
3257 • Document memory watch syntax.
3261 • Fix unattended dumping (lsnes-dumpavi)
3263 • Support RAW dumping
3265 • Use adv_dumper instead of the old interface in lsnes-dumpavi
3268 • Add option to control sample rate preturbation in AVI dumper
3272 • Wxwidgets: Fix dumper submodes
3274 • Set core controller types before loadstate
3276 18.49 rr1-delta2epsilon1
3278 • Fix compiling with bsnes v086.
3282 • Don't prompt before quitting
3284 • Start unpaused, preserve pause/unpause over load.
3286 • Try to autodetect if ROM is headered.
3288 • Wxwidgets: Only bring up ROM patching screen if specifically
3291 • Allow configuring some hotkeys.
3295 • Lots of code cleanups
3297 • Fix JMD compression (JMD dumping was broken)
3299 • Don't crash if Lua C function throws an exception.
3301 • Support bitmap drawing in Lua.
3303 • Fix bsnes v085/v086 patches.
3305 • Improve stability on win32.
3307 18.52 rr1-delta4epsilon1
3309 • Don't corrupt movie if movie length is integer multiple of
3314 • New Lua hooks: on_rewind, on_frame_emulated, on_idle, on_timer
3316 • New Lua functions: emulator_ready(), utime(),
3317 set_idle_timeout(), set_timer_timeout(), bit.extract(),
3318 bit.value(), input.geta(), input.seta() and
3319 input.controllertype()
3321 • Wxwidgets: Fix internal focus lost (hotkeys stop working)
3323 • Wxwidgets: Fix broken modifiers
3325 • on_paint has parameter now.
3327 • Optional initital fill for bitmaps
3329 • Fix palette changing.
3331 • Optimize rendering a bit.
3333 • Bsnes v087 support.
3335 18.54 rr1-delta5epsilon1
3337 • Movieinfo: Fix display of port #2 type.
3339 • Call on_input() after loadstate.
3341 18.55 rr1-delta5epsilon2
3343 • Fix writing port2 data to movie.
3345 • Fix SRAM handling with Bsnes v087.
3349 • Library loading support
3351 • Built-in TSCC encoder
3353 • Hi-color (256T colors) dumping.
3355 • Dump over TCP/IP(v6)
3357 • Hidable status panel
3361 • Adjustable sound volume
3365 • Allow DnD into filename boxes
3367 • Configurable paths
3369 • Portaudio: Fix speaker popping at start
3371 • Lots of UI changes
3373 • Speed adjustment menu
3375 • Win32 joystick support
3377 • Lua: gui.rainbow and gui.box
3379 • Split key lists into classes (the key list was large!)
3381 • More save slots support
3383 • Wxwidgets (wxJoystick) joystick support
3387 • Lots of internal joystick refactoring
3389 • Evdev: Add mapping for BTN_TOOL_QUINTTAP
3391 • Wxwidgets: Settings mode (open settings without ROM)
3393 • Wxwidgets: Prompt key to use option
3395 • Wxwidgets: Fix crash if key goes away underneath
3397 • Wxwidgets: Fix mouse position in presence of scaling
3399 • AVI dumper: Mode 4 (high-quality resampling to common rate
3402 • Wxwidgets: Redesign hotkeys dialog to avoid tree control (tree
3403 control doesn't seem to work well on WinXP)
3405 • Start paused option.
3407 18.58 rr1-delta7epsilon1
3411 • lsnes-dumpavi: Start Lua before starting dumper
3413 • AVI: Fix secondary audio in mode 4.
3415 18.59 rr1-delta7epsilon2
3417 • AVI: Refactor ZMBV a bit.
3419 • Fix error reading analog values from movie file
3423 • Delayed reset support
3425 • Lua: memory.hash_region
3427 18.61 rr1-delta8epsilon1
3429 • Rework the build system
3431 • Typing input support
3433 • Fix building with bsnes v086 and v087.
3435 • SDL: Save settings on exit
3437 • SDL: Command to enter command line mode with given command.
3439 • SDL: More advanced command editing.
3443 • wxMSW: Fix the “arrow keys and enter don't work” problem
3447 • Show mode changes due to rewinding.
3449 • Unsafe rewind support
3451 • Fix directory transversal.
3455 • AVI: Sound mode 5 (48kHz high-quality)
3459 • Map the SNES bus into address space
3461 • Fix loading memory watch files with CRLF line endings
3463 18.64 rr1-delta10epsilon1
3465 • Map bsnes internal state into memory space
3467 • Fix the “click on panel wedges the emulator” for real.
3469 • DnD movies/saves on the main window.
3473 • Split core bindings into own module.
3475 • Remember invalid settings
3477 • Support for modified Gambatte core for GB/GBC emulation.
3479 • Reload/swap ROM function
3481 18.66 rr1-delta11epsilon1
3483 • Fix step poll function
3487 • Non-insane savestate anchoring
3491 • More Memory search methods
3493 • Preserve movie if loading in RO mode.
3495 • Fix a obscure case in timeline check
3497 • Revamp the entiere ROM loading code
3499 • Support DnD on ROMs
3501 • Revamp menu layout
3503 • Standalone hotkey config dialog
3505 • Show bindings in more user-friendly format
3507 18.69 rr1-delta13epsilon1
3511 • Fix uninitialized variables in bsnes v085
3515 • Merge gambatte core into mainline (from its own branch)
3517 • Wxwidgets: Show expected dump file formats
3519 • Memory watch: Data typing
3521 • lsnes internal MMIO area.
3523 • Wxwidgets: New memory watch editor
3525 • Hexadecimal memory watches
3527 • Wxwidgets: Monospaced panel
3529 • Wxwidgets: Split memory watches in panel
3531 • Wxwidgets: Disable VMAs in memory search
3533 • lsnes-dumpavi: Fix speed bug
3535 • Movie subtitle support
3537 • Fix rerecord count reporting
3539 • Don't trash movie when loading in readonly mode.
3541 18.71 rr1-delta14epsilon1
3543 • Wxwidgets: Fix crashes on closing settings dialogs on Mac OS X.
3545 • Fix build on Mac OS X.
3549 • Wxwidgets: Hidable messages window
3553 • Bsnes: Support inconsistent saves
3555 • Bsnes: Allow simulating saving every frame
3557 • Fix desync if savestate is loaded in readonly mode in certain
3560 • Wxwidgets: Fix save dialogs on Mac OS X.
3562 • Wxwidgets: Fix insane status width on Win32.
3564 • Wxwidgets: Fix autohold processing to be faster.
3566 • Wxwidgets: Allow loading ROMs and movies from commandline.
3570 • Be a bit smarter with --load
3572 • Rewrote higher-level parts of audio system
3574 • Tool to build commentary tracks
3578 • Gambatte: Add support for SVN358
3580 • Use builtin font when rendering status panel.
3582 • Option to detach memory watch to its own window.
3584 • Recent ROMs/Movies menu
3588 • Useful lag counter for SNES games that autopoll
3590 • Fix buffer overflow in gambatte sound output
3592 18.73 rr1-delta15epsilon1
3594 • Don't blow up on wxGTK if the window is hidden somehow
3596 • Support simultaneous drop of ROM and movie.
3598 • Gambatte: Don't save spurious SRAMs.
3600 • Make SGB ROMs actually usable.
3602 • Fix so that saved movies appear in recent movies.
3604 • Don't open multiple commentary editors at once.
3606 18.74 rr1-delta15epsilon2
3608 • Lua: memory.readregion/memory.writeregion
3610 • Lua: memory.map{,s}{byte,word,dword,qword}
3612 • Lua: memory.map_structure
3614 • Lua: Fix bus_address for gambatte
3616 • Fix features dependent of bsnes debugger
3618 • Cleanup bsnes debugger logic
3620 • Fix resets in presence of save every frame
3622 18.75 rr1-delta15epsilon3
3624 • Lua: input.lcid_to_pcid
3626 • Fix off-by-one bug with slot hashes
3628 • Fix crashes on certain memory watch expressions
3630 • Lua: memory.read_expr
3632 • Lua: Fix memory.read_expr on nil argument
3634 • Fix the code to compile on G++ 4.7
3636 • Change button_id to be a function pointer field, not a virtual
3639 • Add bsnes patches to fix libsnes to compile on GCC 4.7
3641 • Gambatte: Always use legacy lag counting
3643 • Memory commands: Memory addresses are up to 16 hex digits, not
3646 • Fix analog controllers
3648 • Fix autohold menus
3650 • Fix button symbols in input display
3652 • Compensate for nuts bsnes superscope/justifier handling
3654 • Lua: Fix bit.extract boolean handling