1 #LyX 2.0 created this file. For more info see http://www.lyx.org/
6 \use_default_options true
7 \maintain_unincluded_children false
9 \language_package default
14 \font_typewriter default
15 \font_default_family default
16 \use_non_tex_fonts false
23 \default_output_format default
25 \bibtex_command default
26 \index_command default
27 \paperfontsize default
38 \paperorientation portrait
47 \paragraph_separation indent
48 \paragraph_indentation default
49 \quotes_language english
52 \paperpagestyle default
53 \tracking_changes false
66 \begin_layout Standard
67 lsnes is SNES rerecording emulator based on bsnes core.
74 \begin_layout Enumerate
79 \begin_layout Enumerate
83 \begin_layout Enumerate
84 accuracy or compatiblity core.
87 \begin_layout Enumerate
88 Patched version (using included 6 patches)
92 \begin_layout Enumerate
96 \begin_layout Enumerate
100 \begin_layout Enumerate
104 \begin_layout Enumerate
108 \begin_layout Enumerate
112 \begin_layout Enumerate
113 sdlmain (SDL only, part of SDL)
116 \begin_layout Enumerate
117 boost_conversion (this is header-only library)
120 \begin_layout Enumerate
121 libswscale (wxwidgets graphics only)
124 \begin_layout Enumerate
125 Portaudio (portaudio sound only)
128 \begin_layout Enumerate
129 std::thread and co (for threaded dumper only, not needed if std::thread
133 \begin_layout Enumerate
134 Lua (if Lua support is needed).
137 \begin_layout Itemize
138 Version 5.1.X or 5.2X.
141 \begin_layout Section
145 \begin_layout Standard
146 Building is via makefile, the following options are available:
149 \begin_layout Itemize
150 CROSS_PREFIX=<prefix>
154 \begin_layout Itemize
155 Prefix to apply to commands when building executables / object files for
156 the target architecture.
160 \begin_layout Itemize
165 \begin_layout Itemize
170 \begin_layout Itemize
171 Name of C++ compiler.
174 \begin_layout Itemize
175 CROSS_PREFIX is prepended if compiling for target architecture.
178 \begin_layout Itemize
179 This needs to be at least GCC 4.6.
182 \begin_layout Itemize
183 Set to 'g++-mp-4.6' if compiling on Mac OS X using GCC 4.6 from Macports.
186 \begin_layout Itemize
191 \begin_layout Itemize
196 \begin_layout Itemize
197 Name of host C++ compiler.
200 \begin_layout Itemize
201 Default is value of 'CC' option.
205 \begin_layout Itemize
206 USER_HOSTCCFLAGS=<flags>:
210 \begin_layout Itemize
211 Compiler flags to pass when compiling/linking for host architecture.
214 \begin_layout Itemize
219 \begin_layout Itemize
224 \begin_layout Itemize
225 Extra flags to pass when compiling for target architecture
228 \begin_layout Itemize
233 \begin_layout Itemize
234 USER_LDFLAGS=<flags>:
238 \begin_layout Itemize
239 Extra flags to pass when linking for target architecture.
242 \begin_layout Itemize
247 \begin_layout Itemize
248 USER_PLATFORM_CFLAGS=<flags>
252 \begin_layout Itemize
253 Extra flags to pass when compiling files using platform-dependent code for
257 \begin_layout Itemize
262 \begin_layout Itemize
263 USER_PLATFORM_LDFLAGS=<flags>
267 \begin_layout Itemize
268 Extra flags to pass when linking files using platform-dependent code for
272 \begin_layout Itemize
277 \begin_layout Itemize
282 \begin_layout Itemize
283 Set the font file to use.
286 \begin_layout Itemize
287 Currently the valid values are:
291 \begin_layout Itemize
292 cp437.hex: Standard VGA font (256 characters).
295 \begin_layout Itemize
296 unifontfull-5.1.20080820.hex: GNU unifont (covers most of Unicode BMP)
300 \begin_layout Itemize
301 Default is 'unifontfull-5.1.20080820.hex'
305 \begin_layout Itemize
310 \begin_layout Itemize
311 Package to use for Lua support.
314 \begin_layout Itemize
315 Usually valid value is 'lua' or 'lua5.1'.
318 \begin_layout Itemize
319 Default is not to build Lua support.
323 \begin_layout Itemize
328 \begin_layout Itemize
329 Override platform default for dumper threading support.
332 \begin_layout Itemize
333 Threading is default on Linux.
336 \begin_layout Itemize
337 'YES' tries to use threading (std::thread).
340 \begin_layout Itemize
341 'BOOST' tries to use threading (boost::thread).
344 \begin_layout Itemize
345 'NO' disables threading.
348 \begin_layout Itemize
349 Note: This has absolutely nothing to do with platform threading.
353 \begin_layout Itemize
354 BSNES_IS_COMPAT=<anything>
358 \begin_layout Itemize
359 Signals that BSNES core used is compatiblity core, not accuracy core.
362 \begin_layout Itemize
363 Default is to assume accuracy core.
367 \begin_layout Itemize
368 JOYSTICK=<implementation>
372 \begin_layout Itemize
373 Set joystick implementation.
378 \begin_layout Itemize
379 SDL: Use SDL for joystick (requires SDL graphics)
382 \begin_layout Itemize
383 EVDEV: Use EVDEV for joystick (Linux only).
386 \begin_layout Itemize
387 DUMMY: Disable joystick support.
391 \begin_layout Itemize
396 \begin_layout Itemize
397 SOUND=<implementation>
401 \begin_layout Itemize
402 Set sound implementation.
407 \begin_layout Itemize
408 SDL: Use SDL for sound (requires SDL graphics)
411 \begin_layout Itemize
412 PORTAUDIO: Use Portaudio for sound.
415 \begin_layout Itemize
416 DUMMY: Disable sound support
420 \begin_layout Itemize
425 \begin_layout Itemize
426 GRAPHICS=<implementation>
430 \begin_layout Itemize
431 Set windowing library to use.
436 \begin_layout Itemize
437 SDL: Use SDL for graphics
440 \begin_layout Itemize
441 WXWIDGETS: Use wxWidgets for graphics.
445 \begin_layout Itemize
450 \begin_layout Section
454 \begin_layout Subsection
458 \begin_layout Standard
459 <kind> in the following can be one of:
462 \begin_layout Itemize
463 rom: Cartridge ROM (BIOS for special carts).
467 \begin_layout Itemize
468 bsx: BS-X (non-slotted) Game flash ROM.
471 \begin_layout Itemize
472 bsxslotted: BS-X (slotted) Game flash ROM.
475 \begin_layout Itemize
479 \begin_layout Itemize
480 slot-a: Sufami Turbo Slot A ROM
483 \begin_layout Itemize
484 slot-b: Sufami Turbo Slot B ROM
487 \begin_layout Subsubsection
488 --<kind>=<file> (lsnes/SDL, lsnes-avidump)
491 \begin_layout Standard
492 Load <file> as specified ROM (SFC/BS/DMG/ST file format).
495 \begin_layout Subsubsection
496 --<kind>-xml=<file> (lsnes/SDL, lsnes-avidump)
499 \begin_layout Standard
500 Override hardware detection for ROM, reading the values from <file> (BSNES
504 \begin_layout Subsubsection
505 --ips-<kind>=<file> (lsnes/SDL, lsnes-avidump)
508 \begin_layout Standard
509 Apply BPS/IPS patch <file> to ROM <kind>.
510 If specified multiple times, the patches are applied in order.
513 \begin_layout Subsubsection
514 --ips-<kind>-xml=<file> (lsnes/SDL, lsnes-avidump)
517 \begin_layout Standard
518 Apply BPS/IPS patch <file> to XML of ROM <kind>.
519 If specified multiple times, the patches are applied in order.
522 \begin_layout Subsubsection
523 --ips-offset=<offset> (lsnes/SDL, lsnes-avidump)
526 \begin_layout Standard
527 Set offset to apply to IPS patches.
529 Handy for applying headered IPS patches (use offset of -512 for this).
530 The offset must be 0 for BPS patches.
533 \begin_layout Subsubsection
537 \begin_layout Standard
538 Force ROM to be considered PAL-only.
541 \begin_layout Itemize
542 Only works on SNES and SGB ROMs (not BS-X or Sufami Turbo).
545 \begin_layout Itemize
546 Attempting to load NTSC movie file will error out.
549 \begin_layout Subsubsection
553 \begin_layout Standard
554 Force ROM to be considered NTSC-only.
557 \begin_layout Itemize
558 Attempting to load PAL movie file will error out.
561 \begin_layout Subsection
565 \begin_layout Subsubsection
566 <filename> (lsnes/SDL, lsnes-avidump, movieinfo)
569 \begin_layout Standard
570 Load <filename> as movie or savestate file.
571 All other session options are ignored.
574 \begin_layout Subsubsection
575 --port1=<device> (lsnes/SDL)
578 \begin_layout Standard
583 \begin_layout Itemize
584 none: No device connected
587 \begin_layout Itemize
588 gamepad: One gamepad (the default)
591 \begin_layout Itemize
592 multitap: Four gamepads (warning: makes most games refuse to start)
595 \begin_layout Itemize
599 \begin_layout Subsubsection
600 --port2=<type> (lsnes/SDL)
603 \begin_layout Standard
608 \begin_layout Itemize
609 none: No device connected (the default)
612 \begin_layout Itemize
616 \begin_layout Itemize
617 multitap: Four gamepads.
620 \begin_layout Itemize
624 \begin_layout Itemize
625 superscope: Super Scope
628 \begin_layout Itemize
629 justifier: One justifier
632 \begin_layout Itemize
633 justifiers: Two justifiers
636 \begin_layout Subsubsection
637 --gamename=<name> (lsnes/SDL)
640 \begin_layout Standard
641 Set the name of game to <name>.
645 \begin_layout Subsubsection
646 --author=<name> (lsnes/SDL)
649 \begin_layout Standard
650 Add author with full name of <name> (no nickname).
653 \begin_layout Subsubsection
654 --author=|<name> (lsnes/SDL)
657 \begin_layout Standard
658 Add author with nickname of <name> (no full name).
661 \begin_layout Subsubsection
662 --author=<fullname>|<nickname> (lsnes/SDL)
665 \begin_layout Standard
666 Add author with full name of <fullname> and nickname of <nickname>.
669 \begin_layout Subsubsection
670 --rtc-second=<value> (lsnes/SDL)
673 \begin_layout Standard
674 Set RTC second (0 is 1st January 1970 00:00:00Z).
675 Default is 1,000,000,000.
678 \begin_layout Subsubsection
679 --rtc-subsecond=<value> (lsnes/SDL)
682 \begin_layout Standard
689 \begin_layout Subsection
694 \begin_layout Subsubsection
695 --run=<file> (lsnes/SDL)
698 \begin_layout Standard
699 After running main RC file, run this file.
700 If multiple are specified, these execute in order specified.
703 \begin_layout Subsection
704 dump options (lsnes-dumpavi only)
707 \begin_layout Subsubsection
711 \begin_layout Standard
712 Set the dumper to use (required).
713 Use 'list' for listing of known dumpers.
716 \begin_layout Subsubsection
720 \begin_layout Standard
721 Set the mode to use (required for dumpers with multiple modes, forbidden
723 Use 'list' for known modes.
726 \begin_layout Subsubsection
730 \begin_layout Standard
733 \begin_inset Quotes eld
737 \begin_inset Quotes erd
743 \begin_layout Subsubsection
744 --option=<name>=<value>
747 \begin_layout Standard
748 Set option <name> to value <value>.
751 \begin_layout Subsubsection
755 \begin_layout Standard
756 Set number of frames to dump.
760 \begin_layout Subsubsection
764 \begin_layout Standard
765 Run specified lua script (lsnes-dumpavi does not have initialization files).
768 \begin_layout Section
769 Startup file lsnes.rc
772 \begin_layout Standard
773 Upon startup, lsnes (lsnes/SDL only) executes file lsnes.rc as commands.
774 This file is located in:
777 \begin_layout Itemize
782 lsnes.rc (if %APPDATA% exists)
785 \begin_layout Itemize
786 Unix: $XDG_CONFIG_HOME/lsnes/lsnes.rc (if $XDG_CONFIG_HOME exists)
789 \begin_layout Itemize
790 Unix: $HOME/.config/lsnes/lsnes.rc (if $HOME exists)
793 \begin_layout Itemize
794 All: ./lsnes.rc (fallback default).
797 \begin_layout Standard
798 If leading directories do not exist, attempt to create them is made.
801 \begin_layout Section
805 \begin_layout Itemize
806 Commands beginning with '*' invoke the corresponding command without alias
810 \begin_layout Itemize
811 If command starts with '+' (after possible '*'), the command is executed
812 as-is when button is pressed, and when button is released, it is executed
813 with '+' replaced by '-'.
816 \begin_layout Itemize
817 Commands without '+' execute only on negative edge (release).
820 \begin_layout Subsection
824 \begin_layout Standard
825 Settings control various aspects of emulator behaviour.
828 \begin_layout Subsubsection
829 set-setting <setting> <value>
832 \begin_layout Standard
833 Sets setting <setting> to value <value> (may be empty).
836 \begin_layout Subsubsection
837 unset-setting <setting>
840 \begin_layout Standard
841 Try to unset setting <setting> (not all settings can be unset).
844 \begin_layout Subsubsection
845 get-setting <setting>
848 \begin_layout Standard
849 Read value of setting <setting>
852 \begin_layout Subsubsection
856 \begin_layout Standard
857 Print names and values of all settings.
860 \begin_layout Subsection
864 \begin_layout Standard
865 Keybindings bind commands or aliases to keys (or pseudo-keys).
869 \begin_layout Standard
873 \begin_layout Itemize
874 Do not bind edge active (+/-) commands to keys with modifiers, that won't
878 \begin_layout Itemize
879 Names of keys and modifiers are platform-dependent.
882 \begin_layout Itemize
883 Be careful before binding pseudo-keys (such as joystick axes, buttons or
884 hats) with modifiers.
885 That may or may not work right.
888 \begin_layout Subsubsection
889 bind-key [<mod>/<modmask>] <key> <command>
892 \begin_layout Standard
893 Bind <command> to key <key> (activating if modifiers in <modmask> (comma-seperat
894 ed list) are set as <mod> (comma-seperated list).
897 \begin_layout Standard
898 The names of keys and modifiers are platform-dependent.
901 \begin_layout Subsubsection
902 unbind-key [<mod>/<modmask>] <key>
905 \begin_layout Standard
906 Unbind command from <key> (with specified <mod> and <modmask>).
909 \begin_layout Subsubsection
910 set-axis <axis> [disabled | axis | axis-inverse | pressure0- | pressure0+
911 | pressure-0 | pressure-+ | pressure+0 | pressure+-] [minus=<val>] [zero=<val>]
912 [plus=<val>] [tolerance=<val>]
915 \begin_layout Standard
916 Set axis parameters for axis <axis>.
919 \begin_layout Itemize
920 disabled: Disable axis
923 \begin_layout Itemize
927 \begin_layout Itemize
928 axis-inverse: Inverse axis
931 \begin_layout Itemize
932 pressure0-: Pressure sensitive.
933 Released at 0, pressed at -.
936 \begin_layout Itemize
937 pressure0+: Pressure sensitive.
938 Released at 0, pressed at +.
941 \begin_layout Itemize
942 pressure-0: Pressure sensitive.
943 Released at -, pressed at 0.
946 \begin_layout Itemize
947 pressure-+: Pressure sensitive.
948 Released at -, pressed at +.
951 \begin_layout Itemize
952 pressure+0: Pressure sensitive.
953 Released at +, pressed at 0.
956 \begin_layout Itemize
957 pressure+-: Pressure sensitive.
958 Released at +, pressed at -.
961 \begin_layout Itemize
962 minus=<val>: Calibration at extreme minus position (-32768-32767)
965 \begin_layout Itemize
966 zero=<val>: Calibration at neutral position (-32768-32767)
969 \begin_layout Itemize
970 plus=<val>: Calibration at extreme plus position (-32768-32767)
973 \begin_layout Itemize
974 tolerance=<value>: Center band tolerance (0<x<1).
975 The smaller the value, the more sensitive the control is.
978 \begin_layout Subsubsection
982 \begin_layout Standard
983 Print all key bindings in effect.
986 \begin_layout Subsection
990 \begin_layout Standard
991 Aliases bind command to sequence of commands.
992 After alias has been defined, it replaces the command it shadows.
995 \begin_layout Standard
999 \begin_layout Itemize
1000 You can't alias command to itself.
1003 \begin_layout Itemize
1004 Aliases starting with +/- are edge active just like ordinary commands starting
1008 \begin_layout Itemize
1009 One command can be aliased to multiple commands.
1012 \begin_layout Subsubsection
1013 alias-command <command> <expansion>
1016 \begin_layout Standard
1017 Append <expansion> to alias <command>.
1018 If alias does not already exist, it is created.
1021 \begin_layout Subsubsection
1022 unalias-command <command>
1025 \begin_layout Standard
1026 Clear alias expansion for <command>.
1029 \begin_layout Subsubsection
1033 \begin_layout Standard
1034 Print all aliases and their expansions in effect.
1037 \begin_layout Subsection
1041 \begin_layout Standard
1042 Run <script> as if commands were entered on the command line.
1045 \begin_layout Subsection
1049 \begin_layout Standard
1050 Following commands control video dumping:
1053 \begin_layout Subsubsection
1057 \begin_layout Standard
1058 Dump AVI video to prefix <prefix> Notes:
1061 \begin_layout Itemize
1062 The codec is Camstudio Codec in gzip mode.
1065 \begin_layout Itemize
1066 Encoder and muxer are internal, available on all platforms.
1069 \begin_layout Itemize
1070 Audio enable/disable and framerate has no effect.
1073 \begin_layout Itemize
1074 The audio dumped to .avi is low-quality version.
1075 The high-quality version is dumped to .sox file.
1078 \begin_layout Subsubsection
1082 \begin_layout Standard
1083 End current AVI video dump (closing the emulator also closes the dump).
1086 \begin_layout Subsubsection
1090 \begin_layout Standard
1091 Dump JMD video to file <file>.
1094 \begin_layout Subsubsection
1098 \begin_layout Standard
1099 End the current JMD dump in progress.
1102 \begin_layout Subsubsection
1106 \begin_layout Standard
1107 Dump SDMP to <prefix>, splitting at 2GB.
1110 \begin_layout Subsubsection
1114 \begin_layout Standard
1115 Dump SDMP to <file>, no splitting
1118 \begin_layout Subsubsection
1122 \begin_layout Standard
1123 End the current SDMP dump in progress.
1126 \begin_layout Subsubsection
1130 \begin_layout Standard
1131 Dump raw audio (to <prefix>.audio, at 32040.5Hz) and video (to <prefix>.video>,
1132 at nominal framerate and 512x448 / 512x478 size).
1135 \begin_layout Subsubsection
1139 \begin_layout Standard
1140 End the current RAW dump in progress.
1143 \begin_layout Subsection
1147 \begin_layout Standard
1148 <address> may be decimal or hexadecimal (prefixed with '0x').
1149 <value> can be hexadecimal (prefixed with '0x'), unsigned or signed (prefixed
1153 \begin_layout Standard
1154 The available element <sizes> are:
1157 \begin_layout Itemize
1161 \begin_layout Itemize
1165 \begin_layout Itemize
1169 \begin_layout Itemize
1173 \begin_layout Standard
1174 When reading RAM and ROM, multi-byte reads/writes are big-endian.
1175 When dealing with DSP memory, multi-byte reads/writes are native-endian
1176 (do not use operand sizes exceeding DSP bitness, except dword is OK for
1180 \begin_layout Subsubsection
1181 read-<size> <address>
1184 \begin_layout Standard
1185 Read the value of byte in <address>.
1188 \begin_layout Subsubsection
1189 read-s<size> <address>
1192 \begin_layout Standard
1193 Read the value of signed byte in <address>.
1196 \begin_layout Subsubsection
1197 write-<size> <address> <value>
1200 \begin_layout Standard
1201 Write <value> to byte in address <address>.
1204 \begin_layout Subsubsection
1208 \begin_layout Standard
1209 Reset the memory search
1212 \begin_layout Subsubsection
1216 \begin_layout Standard
1217 Print number of candidates remaining
1220 \begin_layout Subsubsection
1224 \begin_layout Standard
1225 Print all candidates remaining
1228 \begin_layout Subsubsection
1229 search-memory <usflag><sizeflag><op>
1232 \begin_layout Standard
1233 Searches memory for addresses satisfying criteria.
1236 \begin_layout Standard
1240 \begin_layout Itemize
1244 \begin_layout Itemize
1248 \begin_layout Standard
1252 \begin_layout Itemize
1256 \begin_layout Itemize
1260 \begin_layout Itemize
1264 \begin_layout Itemize
1268 \begin_layout Standard
1272 \begin_layout Itemize
1273 lt: < previous value.
1276 \begin_layout Itemize
1277 le: <= previous value.
1280 \begin_layout Itemize
1281 eq: = previous value.
1284 \begin_layout Itemize
1285 ne: != previous value.
1288 \begin_layout Itemize
1289 ge: >= previous value.
1292 \begin_layout Itemize
1293 gt: > previous value.
1296 \begin_layout Subsubsection
1297 search-memory <sizeflag> <value>
1300 \begin_layout Standard
1301 Searches for addresses that currently have value <value>.
1302 <sizeflag> is as in previous command.
1305 \begin_layout Subsection
1309 \begin_layout Standard
1310 These commands are not available in lsnesrc, but are available after ROM
1314 \begin_layout Subsubsection
1318 \begin_layout Standard
1319 Quits the emulator (asking for confirmation).
1320 If /y is given, no confirmation is asked.
1323 \begin_layout Subsubsection
1327 \begin_layout Standard
1328 Toggle paused/unpaused
1331 \begin_layout Subsubsection
1335 \begin_layout Standard
1337 If the button is still held after configurable timeout expires, game unpauses
1338 for the duration frame advance is held.
1341 \begin_layout Subsubsection
1345 \begin_layout Standard
1347 If the button is still held after configurable timeout expires, game unpauses
1348 for the duration frame advance is held.
1351 \begin_layout Subsubsection
1355 \begin_layout Standard
1356 Skip to first poll in frame after current.
1359 \begin_layout Subsubsection
1363 \begin_layout Standard
1364 Reset the SNES after this frame.
1367 \begin_layout Subsubsection
1371 \begin_layout Standard
1372 Load savestate <filename> in current mode.
1375 \begin_layout Subsubsection
1376 load-state <filename>
1379 \begin_layout Standard
1380 Load savestate <filename> in readwrite mode.
1383 \begin_layout Subsubsection
1384 load-readonly <filename>
1387 \begin_layout Standard
1388 Load savestate <filename> in readonly mode.
1391 \begin_layout Subsubsection
1392 load-preserve <filename>
1395 \begin_layout Standard
1396 Load savestate <filename> in readonly mode, preserving current events.
1399 \begin_layout Subsubsection
1400 load-movie <filename>
1403 \begin_layout Standard
1404 Load savestate <filename>, ignoring save part in readonly mode.
1407 \begin_layout Subsubsection
1408 save-state <filename>
1411 \begin_layout Standard
1412 Save system state to <filename> as soon as possible.
1415 \begin_layout Subsubsection
1416 save-movie <filename>
1419 \begin_layout Standard
1420 Save movie to <filename>.
1423 \begin_layout Subsubsection
1427 \begin_layout Standard
1428 Set read-write mode.
1431 \begin_layout Subsubsection
1435 \begin_layout Standard
1439 \begin_layout Subsubsection
1443 \begin_layout Standard
1444 Toggle between read-only and read-write modes.
1447 \begin_layout Subsubsection
1451 \begin_layout Standard
1452 Set name of the game to <name>
1455 \begin_layout Subsubsection
1459 \begin_layout Standard
1460 Print the name of the game.
1463 \begin_layout Subsubsection
1467 \begin_layout Standard
1468 Adds new author <author>.
1469 If <author> does not contain '|' it is full name.
1470 If it contains '|', '|' splits the full name and nickname.
1473 \begin_layout Subsubsection
1474 edit-author <num> <author>
1477 \begin_layout Standard
1478 Edit the author in slot <num> (0-based) to be <author> (see add-author for
1482 \begin_layout Subsubsection
1486 \begin_layout Standard
1487 Remove author in slot <num>
1490 \begin_layout Subsubsection
1494 \begin_layout Standard
1498 \begin_layout Subsubsection
1499 test-1, test-2, test-3
1502 \begin_layout Standard
1503 Internal test commands.
1507 \begin_layout Subsubsection
1508 take-screenshot <filename>
1511 \begin_layout Standard
1512 Save screenshot to <filename>.
1515 \begin_layout Subsubsection
1516 +controller<num><button>
1519 \begin_layout Standard
1520 Press button <button> on controller <num> (1-8).
1521 The following button names are known:
1524 \begin_layout Itemize
1528 \begin_layout Itemize
1532 \begin_layout Itemize
1536 \begin_layout Itemize
1540 \begin_layout Itemize
1544 \begin_layout Itemize
1548 \begin_layout Itemize
1552 \begin_layout Itemize
1556 \begin_layout Itemize
1560 \begin_layout Itemize
1564 \begin_layout Itemize
1568 \begin_layout Itemize
1572 \begin_layout Itemize
1576 \begin_layout Itemize
1580 \begin_layout Itemize
1584 \begin_layout Itemize
1588 \begin_layout Subsubsection
1589 controllerh<num><button>
1592 \begin_layout Standard
1593 Hold/unhold button <button> on controller <num> (1-8).
1594 See +controller for button names.
1597 \begin_layout Subsubsection
1598 autofire (<pattern>|-)...
1601 \begin_layout Standard
1602 Set autofire pattern.
1603 Each parameter is comma-separated list of button names (in form of 1start,
1604 1A, 2B, etc..) to hold on that frame.
1605 After reaching the end of pattern, the pattern restarts from the beginning.
1608 \begin_layout Subsubsection
1612 \begin_layout Standard
1616 \begin_layout Subsection
1620 \begin_layout Subsubsection
1621 cycle-jukebox-backward
1624 \begin_layout Standard
1625 Cycle save jukebox backwards.
1628 \begin_layout Subsubsection
1629 cycle-jukebox-forward
1632 \begin_layout Standard
1633 Cycle save jukebox forwards
1636 \begin_layout Subsubsection
1637 add-jukebox-save <filename>
1640 \begin_layout Standard
1641 Add <filename> to jukebox saves.
1644 \begin_layout Subsubsection
1648 \begin_layout Standard
1649 Do load from jukebox (current mode).
1652 \begin_layout Subsubsection
1656 \begin_layout Standard
1657 Do state save to jukebox.
1660 \begin_layout Subsection
1664 \begin_layout Standard
1665 Only available if lua support is compiled in.
1668 \begin_layout Subsubsection
1669 evaluate-lua <luacode>
1672 \begin_layout Standard
1673 Run Lua code <luacode> using built-in Lua interpretter.
1676 \begin_layout Subsubsection
1680 \begin_layout Standard
1681 Run specified lua file using built-in Lua interpretter.
1684 \begin_layout Subsection
1688 \begin_layout Subsubsection
1689 add-watch <name> <expression>
1692 \begin_layout Standard
1693 Adds new watch (or modifies old one).
1696 \begin_layout Subsubsection
1700 \begin_layout Standard
1704 \begin_layout Subsection
1708 \begin_layout Subsubsection
1709 enable-sound <on/off>
1712 \begin_layout Standard
1713 Enable/Disable sound.
1716 \begin_layout Subsubsection
1717 set-sound-device <device>
1720 \begin_layout Standard
1721 Set sound device to <device>
1724 \begin_layout Subsubsection
1728 \begin_layout Standard
1729 Show status of sound system.
1732 \begin_layout Subsubsection
1736 \begin_layout Standard
1737 Show all available devices.
1740 \begin_layout Subsection
1741 SDL Platform commands
1744 \begin_layout Standard
1745 The following are valid on SDL platform.
1748 \begin_layout Subsubsection
1752 \begin_layout Standard
1753 Asks to press a key and then identifies that (pseudo-)key.
1756 \begin_layout Subsubsection
1760 \begin_layout Standard
1761 Toggle between windowed/fullscreen console.
1764 \begin_layout Subsubsection
1768 \begin_layout Standard
1769 Scroll messages window as far back as it goes.
1772 \begin_layout Subsubsection
1776 \begin_layout Standard
1777 Scroll messages window as far forward as it goes.
1780 \begin_layout Subsubsection
1784 \begin_layout Standard
1785 Scroll messages window back one screenful.
1788 \begin_layout Subsubsection
1792 \begin_layout Standard
1793 Scroll messages window forward one screenful.
1796 \begin_layout Section
1800 \begin_layout Subsection
1804 \begin_layout Subsubsection
1808 \begin_layout Standard
1809 Set where bsnes looks for firmware files.
1811 \begin_inset Quotes eld
1815 \begin_inset Quotes erd
1821 \begin_layout Subsubsection
1825 \begin_layout Standard
1827 Numeric, range is 0.001 to
1828 \begin_inset Quotes eld
1832 \begin_inset Quotes erd
1836 Default is native framerate.
1839 \begin_layout Subsubsection
1843 \begin_layout Standard
1844 Set save compression level (integer 0-9).
1845 Default is 7 (0 is no compression).
1848 \begin_layout Subsubsection
1852 \begin_layout Standard
1853 Set the frame advance timeout in milliseconds.
1854 Numeric integer, range is 0-999999999.
1858 \begin_layout Subsection
1862 \begin_layout Subsubsection
1866 \begin_layout Standard
1867 AVI dumper: Always dump at 512x448 or 512x478 regardless of what the console
1871 \begin_layout Subsubsection
1875 \begin_layout Standard
1876 AVI dumper: Set the default left border thickness (unless lua overrides)
1882 \begin_layout Subsubsection
1886 \begin_layout Standard
1887 AVI dumper: Set the default right border thickness (unless lua overrides)
1893 \begin_layout Subsubsection
1897 \begin_layout Standard
1898 AVI dumper: Set the default top border thickness (unless lua overrides)
1904 \begin_layout Subsubsection
1908 \begin_layout Standard
1909 AVI dumper: Set the default bottom border thickness (unless lua overrides)
1915 \begin_layout Subsubsection
1919 \begin_layout Standard
1920 AVI dumper: Maximum number of frames per dump segment (0 => unlimited).
1925 \begin_layout Subsubsection
1929 \begin_layout Standard
1930 AVI dumper: Compression level (0-18).
1933 \begin_layout Itemize
1934 Compression levels 10 and above are not compatible with stock CSCD codec.
1937 \begin_layout Itemize
1938 Recomended level is 7.
1941 \begin_layout Subsubsection
1945 \begin_layout Standard
1946 AVI dumper: Set method of determining the sound rate.
1949 \begin_layout Itemize
1950 0: Pick nearest of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48, 64, 88.2, 96,
1951 128, 176.4 and 192 kHz.
1954 \begin_layout Itemize
1955 1: Round down to nearest integer.
1958 \begin_layout Itemize
1959 2: Round up to nearest ingeter.
1962 \begin_layout Subsection
1966 \begin_layout Subsubsection
1970 \begin_layout Standard
1971 JMD dumper: Compression level (0-9).
1974 \begin_layout Subsection
1975 SDL platform settings
1978 \begin_layout Subsubsection
1979 autorepeat-first-delay
1982 \begin_layout Standard
1983 Sets the delay for first character in typematic autorepeat.
1986 \begin_layout Subsubsection
1987 autorepeat-subsequent-delay
1990 \begin_layout Standard
1991 Sets the delay for subsequent characters in typematic autorepeat.
1994 \begin_layout Section
1998 \begin_layout Subsection
1999 Core (in main table)
2002 \begin_layout Subsubsection
2006 \begin_layout Standard
2007 Print line to message console.
2010 \begin_layout Subsubsection
2011 exec(string command)
2014 \begin_layout Standard
2015 Run command as it was entered on the command line
2018 \begin_layout Subsubsection
2022 \begin_layout Standard
2024 First is time since some epoch in seconds, the second is microseconds mod
2025 10^6 since that epoch.
2028 \begin_layout Subsubsection
2032 \begin_layout Standard
2033 Returns true if emulator has finished booting, false if not (on_startup()
2034 will be issued later).
2037 \begin_layout Subsubsection
2038 set_idle_timeout(number timeout)
2041 \begin_layout Standard
2042 Set number of microseconds to block idle for.
2043 After this timeout has expired, on_idle() will be called once.
2046 \begin_layout Subsubsection
2047 set_timer_timeout(number timeout)
2050 \begin_layout Standard
2051 Set number of microseconds to block timer for.
2052 After this timeout has expired, on_timer() will be called once.
2055 \begin_layout Subsection
2059 \begin_layout Standard
2060 Bitwise logical functions and related.
2063 \begin_layout Subsubsection
2064 bit.none(number...) / bit.bnot(number...)
2067 \begin_layout Standard
2068 48-bit bitwise NOT / NONE function (set bits that are set in none of the
2072 \begin_layout Subsubsection
2073 bit.any(number...) / bit.bor(number...)
2076 \begin_layout Standard
2077 48-bit bitwise OR / ANY function (set bits that are set in any of the arguments).
2080 \begin_layout Subsubsection
2081 bit.all(number...) / bit.band(number...)
2084 \begin_layout Standard
2085 48-bit bitwise AND / ALL function (set bits that are set in all of the arguments
2089 \begin_layout Subsubsection
2090 bit.parity(number...) / bit.bxor(number...)
2093 \begin_layout Standard
2094 48-bit bitwise XOR / PARITY function (set bits that are set in odd number
2098 \begin_layout Subsubsection
2099 bit.lrotate(number base[, number amount[, number bits]])
2102 \begin_layout Standard
2103 Rotate bits-bit (max 48, default 48) number left by amount (default 1) places.
2106 \begin_layout Subsubsection
2107 bit.rrotate(number base[, number amount[, number bits]])
2110 \begin_layout Standard
2111 Rotate bits-bit (max 48, default 48) number right by amount (default 1)
2115 \begin_layout Subsubsection
2116 bit.lshift(number base[, number amount[, number bits]])
2119 \begin_layout Standard
2120 Shift bits-bit (max 48, default 48) number left by amount (default 1) places.
2121 The new bits are filled with zeroes.
2124 \begin_layout Subsubsection
2125 bit.lrshift(number base[, number amount[, number bits]])
2128 \begin_layout Standard
2129 Shift bits-bit (max 48, default 48) number logically right by amount (default
2131 The new bits are filled with zeroes.
2134 \begin_layout Subsubsection
2135 bit.arshift(number base[, number amount[, number bits]])
2138 \begin_layout Standard
2139 Shift bits-bit (max 48, default 48) number arithmetically right by amount
2141 The new bits are shifted in with copy of the high bit.
2144 \begin_layout Subsubsection
2145 bit.extract(number base[, number bit0[, number bit1,...]])
2148 \begin_layout Standard
2149 Returns number that has bit0-th bit as bit 0, bit1-th bit as 1 and so on.
2152 \begin_layout Standard
2156 \begin_layout Itemize
2157 Bit numbers up to 51 should work reliably (then things start falling apart
2158 due to double precision issues).
2161 \begin_layout Itemize
2162 There are two special bit positions, true and false, standing for always
2163 set bit and always clear bit.
2166 \begin_layout Subsubsection
2167 bit.value([number bit1[, number bit2,...]])
2170 \begin_layout Standard
2171 Returns bitwise OR of 1 left shifted by bit1 places, 1 left shifted by bit2
2173 As special value, nil argument is no-op.
2176 \begin_layout Subsection
2180 \begin_layout Standard
2181 Most of these functions can only be called in on_paint and on_video callbacks.
2182 Exceptions are noted.
2185 \begin_layout Standard
2187 Bits 0-7 are the blue component, bits 8-15 are the green component, bits
2188 16-23 are the red component, bits 24-31 are alpha component (0 is fully
2189 opaque, 255 is almost transparent).
2190 -1 is the fully transparent color.
2191 Alpha values greater than 127 do work.
2194 \begin_layout Standard
2195 Origin of coordinates is at top left corner of game display area.
2196 Left and top gaps correspond to negative coordinates.
2199 \begin_layout Subsubsection
2203 \begin_layout Standard
2204 Returns 2-tuple (hresolution, vresolution).
2207 \begin_layout Subsubsection
2208 gui.<class>_gap(number gap)
2211 \begin_layout Standard
2212 Set the <class> (left, right, top, bottom) gap to specified value (max gap
2216 \begin_layout Subsubsection
2217 gui.text(number x, number y, string text[, number fgc[, number bgc]])
2220 \begin_layout Standard
2221 Draw specified text on the GUI (each character cell is 8 or 16 wide and
2226 \begin_layout Itemize
2227 x: X-coordinate to start the drawing from (and x-coordinate at begining
2231 \begin_layout Itemize
2232 y: Y-coordinate to start the drawing from.
2235 \begin_layout Itemize
2236 text: The text to draw.
2239 \begin_layout Itemize
2240 fgc: Text color (default is 0xFFFFFF (white))
2243 \begin_layout Itemize
2244 bgc: Background color (default is -1 (transparent))
2247 \begin_layout Subsubsection
2248 gui.textH(number x, number y, string text[, number fgc[, number bgc]])
2251 \begin_layout Standard
2252 Like gui.text, but draw using double-width.
2255 \begin_layout Subsubsection
2256 gui.textV(number x, number y, string text[, number fgc[, number bgc]])
2259 \begin_layout Standard
2260 Like gui.text, but draw using double-height.
2263 \begin_layout Subsubsection
2264 gui.textHV(number x, number y, string text[, number fgc[, number bgc]])
2267 \begin_layout Standard
2268 Like gui.text, but draw using double-width/double-height.
2271 \begin_layout Subsubsection
2272 gui.rectangle(number x, number y, number width, number height[, number thickness[
2273 , number outline[, number fill]]])
2276 \begin_layout Standard
2277 Draw rectangle on the GUI.
2281 \begin_layout Itemize
2282 x: X-coordinate of left edge.
2285 \begin_layout Itemize
2286 y: Y-coordinate of upper edge.
2289 \begin_layout Itemize
2290 width: Width of rectangle.
2293 \begin_layout Itemize
2294 height: Height of rectangle.
2297 \begin_layout Itemize
2298 thickness: Thickness of outline (default is 1).
2301 \begin_layout Itemize
2302 outline: Color of outline (default is 0xFFFFFF (white))
2305 \begin_layout Itemize
2306 fill: Color of fil (default is -1 (transparent))
2309 \begin_layout Subsubsection
2310 gui.pixel(number x, number y[, number color])
2313 \begin_layout Standard
2314 Draw one pixel on the GUI.
2318 \begin_layout Itemize
2319 x: X-coordinate of the pixel
2322 \begin_layout Itemize
2323 y: Y-coordinate of the pixel
2326 \begin_layout Itemize
2327 color: Color of the pixel (default is 0xFFFFFF (white))
2330 \begin_layout Subsubsection
2331 gui.crosshair(number x, number y[, number length[, number color]])
2334 \begin_layout Standard
2339 \begin_layout Itemize
2340 x: X-coordinate of the crosshair
2343 \begin_layout Itemize
2344 y: Y-coordinate of the crosshair
2347 \begin_layout Itemize
2348 length: Length of the crosshair lines (default 10).
2351 \begin_layout Itemize
2352 color: Color of the crosshair (default is 0xFFFFFF (white))
2355 \begin_layout Subsubsection
2356 gui.line(number x1, number y1, number x2, number y2[, number color])
2359 \begin_layout Standard
2364 \begin_layout Itemize
2365 x1: X-coordinate of one end.
2368 \begin_layout Itemize
2369 y1: Y-coordinate of one end.
2372 \begin_layout Itemize
2373 x2: X-coordinate of the other end.
2376 \begin_layout Itemize
2377 y2: Y-coordinate of the other end.
2380 \begin_layout Itemize
2381 color: Color of the line (default is 0xFFFFFF (white)).
2384 \begin_layout Subsubsection
2385 gui.circle(number x, number y, number r[, number thick[, number border[,
2389 \begin_layout Standard
2394 \begin_layout Itemize
2395 x: X-coordinate of the center
2398 \begin_layout Itemize
2399 y: Y-coordinate of the center
2402 \begin_layout Itemize
2403 r: The radius of the circle
2406 \begin_layout Itemize
2407 thick: Border thickness
2410 \begin_layout Itemize
2411 border: Border color (default is 0xFFFFFF (white))
2414 \begin_layout Itemize
2415 fill: Fill color (default is -1 (transparent)).
2418 \begin_layout Subsubsection
2419 gui.bitmap_draw(number x, number y, bitmap bitmap, palette palette)
2422 \begin_layout Standard
2423 Draw a bitmap on screen with specified palette.
2427 \begin_layout Itemize
2428 x: X-coordinate of left edge.
2431 \begin_layout Itemize
2432 y: Y-coordinate of top edge.
2435 \begin_layout Itemize
2436 bitmap: The bitmap to draw
2439 \begin_layout Itemize
2440 palette: The palette to draw the bitmap using.
2443 \begin_layout Subsubsection
2444 gui.bitmap_draw(number x, number y, dbitmap bitmap)
2447 \begin_layout Standard
2448 Draw a bitmap on screen.
2452 \begin_layout Itemize
2453 x: X-coordinate of left edge.
2456 \begin_layout Itemize
2457 y: Y-coordinate of top edge.
2460 \begin_layout Itemize
2461 bitmap: The bitmap to draw
2464 \begin_layout Subsubsection
2468 \begin_layout Standard
2469 Returns a new palette (initially all transparent).
2470 Can be used anywhere.
2473 \begin_layout Subsubsection
2474 gui.bitmap_new(number w, number h, boolean direct[, bool icolor])
2477 \begin_layout Standard
2478 Returns a new bitmap/dbitmap.
2479 Can be used anywhere.
2483 \begin_layout Itemize
2484 w: The width of new bitmap
2487 \begin_layout Itemize
2488 h: The height of new bitmap
2491 \begin_layout Itemize
2492 direct: If true, the returned bitmap is dbitmap, otherwise bitmap.
2495 \begin_layout Itemize
2496 icolor: Initital fill color (defaults to 0 on BITMAP, -1 on DBITMAP)
2499 \begin_layout Subsubsection
2500 gui.bitmap_load(string file)
2503 \begin_layout Standard
2504 Returns loaded bitmap/dbitmap (if bitmap, the second return value is palette
2506 Can be used anywhere.
2510 \begin_layout Itemize
2511 file: The name of file to load.
2514 \begin_layout Subsubsection
2515 gui.palette_set(palette palette, number index, number color)
2518 \begin_layout Standard
2519 Sets color in palette.
2520 Can be used anywhere.
2524 \begin_layout Itemize
2525 palette: The palette to manipulate
2528 \begin_layout Itemize
2529 index: Index of color (0-65535).
2532 \begin_layout Itemize
2533 color: The color value.
2536 \begin_layout Subsubsection
2537 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y, number color)
2540 \begin_layout Standard
2541 Sets specified pixel in bitmap.
2542 Can be used anywhere.
2546 \begin_layout Itemize
2547 bitmap: The bitmap to manipulate
2550 \begin_layout Itemize
2551 x: The x-coordinate of the pixel.
2554 \begin_layout Itemize
2555 y: The y-coordinate of the pixel.
2558 \begin_layout Itemize
2559 color: If bitmap is a bitmap, color index (0-65535).
2560 Otherwise color value.
2563 \begin_layout Subsubsection
2564 gui.bitmap_size(bitmap/dbitmap bitmap)
2567 \begin_layout Standard
2569 Can be used anywhere.
2573 \begin_layout Itemize
2574 bitmap: The bitmap to query.
2577 \begin_layout Standard
2578 The first return is the width, the second is the height.
2581 \begin_layout Subsubsection
2582 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy, bitmap/dbitmap
2583 src, number sx, number sy, number w, number h[, number ck])
2586 \begin_layout Standard
2587 Blit a part of bitmap to another.
2588 Can be used anywhere.
2592 \begin_layout Itemize
2593 dest: Destination to blit to.
2596 \begin_layout Itemize
2597 dx: left edge of target
2600 \begin_layout Itemize
2601 dy: Top edge of target
2604 \begin_layout Itemize
2605 src: The source to blit from.
2606 Must be of the same type as destination.
2609 \begin_layout Itemize
2610 sx: left edge of source
2613 \begin_layout Itemize
2614 sy: Top edge of source
2617 \begin_layout Itemize
2621 \begin_layout Itemize
2622 h: Height of region.
2625 \begin_layout Itemize
2627 Pixels of this color are not blitted.
2631 \begin_layout Itemize
2632 If bitmaps are bitmaps, this is color index of colorkey.
2633 Values outside range 0-65535 cause no key to be used as colorkey.
2636 \begin_layout Itemize
2637 If bitmaps are dbitmaps, this color value of colorkey.
2640 \begin_layout Itemize
2641 May be absent or nil for no colorkey blit.
2645 \begin_layout Subsubsection
2649 \begin_layout Standard
2650 Request on_repaint() to happen as soon as possible.
2651 Can be used anywhere.
2654 \begin_layout Subsubsection
2655 gui.subframe_update(boolean on)
2658 \begin_layout Standard
2659 Request subframe updates (calling on_paint() on subframes) to happen (on=true)
2660 or not happen (on=false).
2661 Can be used anywhere.
2664 \begin_layout Subsubsection
2665 gui.screenshot(string filename)
2668 \begin_layout Standard
2669 Write PNG screenshot of the current frame (no drawings) to specified file.
2670 Can be used anywhere.
2673 \begin_layout Subsubsection
2674 gui.color(number r, number g, number b[, number a])
2677 \begin_layout Standard
2678 Returns color (in notation Lua scripts use) corresponding to color (r,g,b),
2679 each component in scale 0-255.
2680 If a is specified, that is alpha (0 is fully transparent, 256(sic) is fully
2682 The default alpha is 256.
2685 \begin_layout Subsubsection
2686 gui.status(string name, string value)
2689 \begin_layout Standard
2691 \begin_inset Quotes eld
2695 \begin_inset Quotes erd
2698 to <value> in status area.
2699 Can be used anywhere.
2702 \begin_layout Subsection
2706 \begin_layout Standard
2708 Only available in on_input callback.
2711 \begin_layout Subsubsection
2712 input.get(number controller, number index)
2715 \begin_layout Standard
2716 Read the specified index (0-11) from specified controller (0-7).
2720 \begin_layout Itemize
2721 Uses physical controller numbering.
2722 Gamepad in port 2 is controller 4, not 1!
2725 \begin_layout Subsubsection
2726 input.set(number controller, number index, number value)
2729 \begin_layout Standard
2730 Write the specified index (0-11) from specified controller (0-7), storing
2735 \begin_layout Itemize
2736 Uses physical controller numbering.
2737 Gamepad in port 2 is controller 4, not 1!
2740 \begin_layout Subsubsection
2741 input.geta(number controller)
2744 \begin_layout Standard
2745 Get input state for entiere controller.
2746 Returns 13 return values.
2749 \begin_layout Itemize
2750 1st return value: Bitmask: bit i is set if i:th index is nonzero
2753 \begin_layout Itemize
2754 2nd-13th return value: value of i:th index.
2757 \begin_layout Subsubsection
2758 input.seta(number controller, number bitmask, number args...)
2761 \begin_layout Standard
2762 Set state for entiere controller.
2763 args is up to 12 values for indices (overriding values in bitmask if specified).
2766 \begin_layout Subsubsection
2767 input.controllertype(number controller)
2770 \begin_layout Standard
2771 Get the type of controller as string.
2775 \begin_layout Itemize
2779 \begin_layout Itemize
2783 \begin_layout Itemize
2787 \begin_layout Itemize
2791 \begin_layout Subsubsection
2792 input.reset([number cycles])
2795 \begin_layout Standard
2797 If cycles is greater than zero, do delayed reset.
2798 0 (or no value) causes immediate reset.
2801 \begin_layout Itemize
2802 Only available with subframe flag false.
2805 \begin_layout Subsubsection
2809 \begin_layout Standard
2810 Returns table of tables of all available keys and axes.
2811 The first table is indexed by key name (platform-dependent!), and the inner
2812 table has the following fields:
2815 \begin_layout Itemize
2816 last_rawval: Last reported raw value for control.
2819 \begin_layout Itemize
2820 ktype: Type of key (disabled, key, mouse, axis, axis-inverse, hat, pressure-m0,
2821 pressure-mp, pressure-0m, pressure-0p, pressure-pm, pressure-p0).
2824 \begin_layout Itemize
2825 cal_left: Minimum calibration value.
2826 Only meaningful with axis and pressure types.
2829 \begin_layout Itemize
2830 cal_center: Center calibration value.
2831 Only meaningful with axis and pressure types.
2834 \begin_layout Itemize
2835 cal_right: Maximum calibration value.
2836 Only meaningful with axis and pressure types.
2839 \begin_layout Itemize
2840 cal_tolerance: Dead zone tolerance.
2841 Only meaningful with axis and pressure types.
2844 \begin_layout Subsubsection
2845 input.keyhook(key, state)
2848 \begin_layout Standard
2849 Requests that keyhook events to be sent for key (state=true) or not sent
2853 \begin_layout Subsection
2857 \begin_layout Standard
2858 Host memory handling (extra memory saved to savestates).
2859 Host memory starts empty.
2862 \begin_layout Subsubsection
2863 hostmemory.read(number address)
2866 \begin_layout Standard
2867 Reads hostmemory slot address.
2868 Slot numbers out of range return false instead of numeric.
2871 \begin_layout Subsubsection
2872 hostmemory.write(number address, number value)
2875 \begin_layout Standard
2876 Writes hostmemory slot with 0-255.
2877 Slot numbers out of range cause extension of host memory slot space.
2880 \begin_layout Subsubsection
2881 hostmemory.readbyte(number address)
2884 \begin_layout Standard
2885 Read unsigned byte (1 element) from given address.
2886 Slots out of range return false.
2889 \begin_layout Subsubsection
2890 hostmemory.writebyte(number address, number value)
2893 \begin_layout Standard
2894 Write unsigned byte (1 element) to given slot.
2895 Slot numbers out of range cause extension.
2898 \begin_layout Subsubsection
2899 hostmemory.readsbyte(number address)
2902 \begin_layout Standard
2903 Read signed byte (1 element) from given address.
2904 Slots out of range return false.
2907 \begin_layout Subsubsection
2908 hostmemory.writesbyte(number address, number value)
2911 \begin_layout Standard
2912 Write signed byte (1 element) to given slot.
2913 Slot numbers out of range cause extension.
2916 \begin_layout Subsubsection
2917 hostmemory.readword(number address)
2920 \begin_layout Standard
2921 Read unsigned word (2 elements) from given address.
2922 Slots out of range return false.
2925 \begin_layout Subsubsection
2926 hostmemory.writeword(number address, number value)
2929 \begin_layout Standard
2930 Write unsigned word (2 elements) to given slot.
2931 Slot numbers out of range cause extension.
2934 \begin_layout Subsubsection
2935 hostmemory.readsword(number address)
2938 \begin_layout Standard
2939 Read signed word (2 elements) from given address.
2940 Slots out of range return false.
2943 \begin_layout Subsubsection
2944 hostmemory.writesword(number address, number value)
2947 \begin_layout Standard
2948 Write signed word (2 elements) to given slot.
2949 Slot numbers out of range cause extension.
2952 \begin_layout Subsubsection
2953 hostmemory.readdword(number address)
2956 \begin_layout Standard
2957 Read unsigned doubleword (4 elements) from given address.
2958 Slots out of range return false.
2961 \begin_layout Subsubsection
2962 hostmemory.writedword(number address, number value)
2965 \begin_layout Standard
2966 Write unsigned doubleword (4 elements) to given slot.
2967 Slot numbers out of range cause extension.
2970 \begin_layout Subsubsection
2971 hostmemory.readsdword(number address)
2974 \begin_layout Standard
2975 Read signed doubleword (4 elements) from given address.
2976 Slots out of range return false.
2979 \begin_layout Subsubsection
2980 hostmemory.writesdword(number address, number value)
2983 \begin_layout Standard
2984 Write signed doubleword (4 elements) to given slot.
2985 Slot numbers out of range cause extension.
2988 \begin_layout Subsubsection
2989 hostmemory.readqword(number address)
2992 \begin_layout Standard
2993 Read unsigned quadword (8 elements) from given address.
2994 Slots out of range return false.
2997 \begin_layout Subsubsection
2998 hostmemory.writeqword(number address, number value)
3001 \begin_layout Standard
3002 Write unsigned quadword (4 elements) to given slot.
3003 Slot numbers out of range cause extension.
3006 \begin_layout Subsubsection
3007 hostmemory.readsqword(number address)
3010 \begin_layout Standard
3011 Read signed quadword (8 elements) from given address.
3012 Slots out of range return false.
3015 \begin_layout Subsubsection
3016 hostmemory.writesqword(number address, number value)
3019 \begin_layout Standard
3020 Write signed quadword (8 elements) to given slot.
3021 Slot numbers out of range cause extension.
3024 \begin_layout Subsection
3028 \begin_layout Standard
3032 \begin_layout Subsubsection
3033 movie.currentframe()
3036 \begin_layout Standard
3037 Return number of current frame.
3040 \begin_layout Subsubsection
3044 \begin_layout Standard
3045 Return number of frames in movie.
3048 \begin_layout Subsubsection
3052 \begin_layout Standard
3053 Return true if in readonly mode, false if in readwrite.
3056 \begin_layout Subsubsection
3057 movie.set_readwrite()
3060 \begin_layout Standard
3061 Set readwrite mode (does not cause on_readwrite callback).
3064 \begin_layout Subsubsection
3065 movie.frame_subframes(number frame)
3068 \begin_layout Standard
3069 Count number of subframes in specified frame (frame numbers are 1-based)
3073 \begin_layout Subsubsection
3074 movie.read_subframe(number frame, number subframe)
3077 \begin_layout Standard
3078 Read specifed subframe in specified frame and return data as array (100
3079 elements, numbered 0-99 currently).
3082 \begin_layout Subsection
3086 \begin_layout Standard
3087 Routines for settings manipulation
3090 \begin_layout Subsubsection
3091 settings.get(string name)
3094 \begin_layout Standard
3095 Get value of setting.
3096 If setting is blank, returns false.
3097 If setting value can't be obtained, returns (nil, error message).
3100 \begin_layout Subsubsection
3101 settings.set(string name, string value)
3104 \begin_layout Standard
3105 Set value of setting.
3106 If setting can't be set, returns (nil, error message).
3109 \begin_layout Subsubsection
3110 settings.is_set(string name)
3113 \begin_layout Standard
3114 Returns if setting is set.
3115 If setting does not exist, returns (nil, error message).
3118 \begin_layout Subsubsection
3119 settings.blank(string name)
3122 \begin_layout Standard
3123 Blanks a setting and returns true.
3124 If setting can't be blanked, returns (nil, error message).
3127 \begin_layout Subsection
3131 \begin_layout Standard
3132 Contains various functions for managing memory
3135 \begin_layout Subsubsection
3139 \begin_layout Standard
3140 Returns the number of VMAs
3143 \begin_layout Subsubsection
3144 memory.read_vma(number index)
3147 \begin_layout Standard
3148 Reads the specified VMA (indices start from zero).
3149 Trying to read invalid VMA gives nil.
3150 The read VMA is table with the following fields:
3153 \begin_layout Itemize
3154 region_name (string): The readable name of the VMA
3157 \begin_layout Itemize
3158 baseaddr (number): Base address of the VMA
3161 \begin_layout Itemize
3162 lastaddr (number): Last address in the VMA.
3165 \begin_layout Itemize
3166 size (number): The size of VMA in bytes.
3169 \begin_layout Itemize
3170 readonly (boolean): True of the VMA corresponds to ROM.
3173 \begin_layout Itemize
3174 native_endian (boolean): True if the VMA has native endian as opposed to
3178 \begin_layout Subsubsection
3179 memory.find_vma(number address)
3182 \begin_layout Standard
3183 Finds the VMA containing specified address.
3184 Returns table in the same format as read_vma or nil if not found.
3187 \begin_layout Subsubsection
3188 memory.readbyte(number address)
3191 \begin_layout Standard
3192 Reads the specified address as unsigned byte and returns the result.
3195 \begin_layout Subsubsection
3196 memory.readsbyte(number address)
3199 \begin_layout Standard
3200 Reads the specified address as signed byte and returns the result.
3203 \begin_layout Subsubsection
3204 memory.writebyte(number address, number value)
3207 \begin_layout Standard
3208 Writes the specified value (negative values undergo 2's complement) to specified
3209 address (as a byte).
3212 \begin_layout Subsubsection
3213 memory.readword(number address)
3216 \begin_layout Standard
3217 Reads the specified address as unsigned word and returns the result.
3220 \begin_layout Subsubsection
3221 memory.readsword(number address)
3224 \begin_layout Standard
3225 Reads the specified address as signed word and returns the result.
3228 \begin_layout Subsubsection
3229 memory.writeword(number address, number value)
3232 \begin_layout Standard
3233 Writes the specified value (negative values undergo 2's complement) to specified
3234 address (as a word).
3237 \begin_layout Subsubsection
3238 memory.readdword(number address)
3241 \begin_layout Standard
3242 Reads the specified address as unsigned doubleword and returns the result.
3245 \begin_layout Subsubsection
3246 memory.readsdword(number address)
3249 \begin_layout Standard
3250 Reads the specified address as signed doubleword and returns the result.
3253 \begin_layout Subsubsection
3254 memory.writedword(number address, number value)
3257 \begin_layout Standard
3258 Writes the specified value (negative values undergo 2's complement) to specified
3259 address (as a doubleword).
3262 \begin_layout Subsubsection
3263 memory.readqword(number address)
3266 \begin_layout Standard
3267 Reads the specified address as unsigned quadword and returns the result.
3270 \begin_layout Subsubsection
3271 memory.readsqword(number address)
3274 \begin_layout Standard
3275 Reads the specified address as signed quadword and returns the result.
3278 \begin_layout Subsubsection
3279 memory.writeqword(number address, number value)
3282 \begin_layout Standard
3283 Writes the specified value (negative values undergo 2's complement) to specified
3284 address (as a quadword).
3287 \begin_layout Subsection
3291 \begin_layout Standard
3292 Contains copy of global variables from time of Lua initialization.
3296 \begin_layout Subsection
3300 \begin_layout Standard
3301 Various callbacks to Lua that can occur.
3304 \begin_layout Subsubsection
3305 Callback: on_paint(bool not_synth)
3308 \begin_layout Standard
3309 Called when screen is being painted.
3310 Any gui.* calls requiring graphic context draw on the screen.
3313 \begin_layout Standard
3314 not_synth is true if this hook is being called in response to received frame,
3318 \begin_layout Subsubsection
3319 Callback: on_video()
3322 \begin_layout Standard
3323 Called when video dump frame is being painted.
3324 Any gui.* calls requiring graphic context draw on the video.
3327 \begin_layout Subsubsection
3328 Callback: on_frame_emulated()
3331 \begin_layout Standard
3332 Called when emulating frame has completed and on_paint()/on_video() calls
3333 are about to be issued.
3336 \begin_layout Subsubsection
3337 Callback: on_frame()
3340 \begin_layout Standard
3341 Called on each starting whole frame.
3344 \begin_layout Subsubsection
3345 Callback: on_startup()
3348 \begin_layout Standard
3349 Called when the emulator is starting (lsnes.rc and --run files has been run).
3352 \begin_layout Subsubsection
3353 Callback: on_rewind()
3356 \begin_layout Standard
3357 Called when rewind movie to beginning has completed.
3360 \begin_layout Subsubsection
3361 Callback: on_pre_load(string name)
3364 \begin_layout Standard
3365 Called just before savestate/movie load occurs (note: loads are always delayed,
3366 so this occurs even when load was initiated by lua).
3369 \begin_layout Subsubsection
3370 Callback: on_err_load(string name)
3373 \begin_layout Standard
3374 Called if loadstate goes wrong.
3377 \begin_layout Subsubsection
3378 Callback: on_post_load(string name, boolean was_savestate)
3381 \begin_layout Standard
3382 Called on successful loadstate.
3383 was_savestate gives if this was a savestate or a movie.
3386 \begin_layout Subsubsection
3387 Callback: on_pre_save(string name, boolean is_savestate)
3390 \begin_layout Standard
3391 Called just before savestate save occurs (note: movie saves are synchronous
3392 and won't trigger these callbacks if called from Lua).
3395 \begin_layout Subsubsection
3396 Callback: on_err_save(string name)
3399 \begin_layout Standard
3400 Called if savestate goes wrong.
3403 \begin_layout Subsubsection
3404 Callback: on_post_save(string name, boolean is_savestate)
3407 \begin_layout Standard
3408 Called on successful savaestate.
3409 is_savestate gives if this was a savestate or a movie.
3412 \begin_layout Subsubsection
3416 \begin_layout Standard
3417 Called when emulator is shutting down.
3420 \begin_layout Subsubsection
3421 Callback: on_input(boolean subframe)
3424 \begin_layout Standard
3425 Called when emulator is just sending input to bsnes core.
3426 Warning: This is called even in readonly mode, but the results are ignored.
3429 \begin_layout Subsubsection
3430 Callback: on_reset()
3433 \begin_layout Standard
3434 Called when SNES is reset.
3437 \begin_layout Subsubsection
3438 Callback: on_readwrite()
3441 \begin_layout Standard
3442 Called when moving into readwrite mode as result of
3443 \begin_inset Quotes eld
3447 \begin_inset Quotes erd
3450 command (note: moving to rwmode by Lua won't trigger this, as per recursive
3454 \begin_layout Subsubsection
3455 Callback: on_snoop(number port, number controller, number index, number
3459 \begin_layout Standard
3460 Called each time bsnes asks for input.
3461 The value is the final value to be sent to bsnes core (readonly mode, autohold
3462 and autofire have been taken into account).
3463 Might be useful when translating movies to format suitable for console
3465 Note: There is no way to modify the value to be sent.
3468 \begin_layout Subsubsection
3469 Callback: on_keyhook(string keyname, table state)
3472 \begin_layout Standard
3473 Sent when key that has keyhook events requested changes state.
3474 Keyname is name of the key (group) and state is the state (same kind as
3475 table values in input.raw).
3478 \begin_layout Subsubsection
3482 \begin_layout Standard
3483 Called when requested by set_idle_timeout(), the timeout has expired and
3484 emulator is waiting.
3487 \begin_layout Subsubsection
3488 Callback: on_timer()
3491 \begin_layout Standard
3492 Called when requested by set_idle_timeout() and the timeout has expired
3493 (regardless if emulator is waiting).
3496 \begin_layout Section
3497 Memory watch expression syntax
3500 \begin_layout Standard
3501 Memory watch expressions are in RPN (Reverse Polish Notation).
3502 At the end of expression, the top entry on stack is taken as the final
3506 \begin_layout Standard
3510 \begin_layout Itemize
3511 Evaluation order is strictly left to right.
3514 \begin_layout Itemize
3515 a is the entry on top of stack
3518 \begin_layout Itemize
3519 b is the entry immediately below top of stack
3522 \begin_layout Itemize
3523 ; separates values to be pushed (no intermediate pop).
3526 \begin_layout Itemize
3527 After end of element, all used stack slots are popped and all results are
3531 \begin_layout Itemize
3532 When pushing multiple values, the pushes occur in order shown.
3535 \begin_layout Standard
3536 The following operators are available:
3539 \begin_layout Itemize
3543 \begin_layout Itemize
3547 \begin_layout Itemize
3551 \begin_layout Itemize
3555 \begin_layout Itemize
3559 \begin_layout Itemize
3563 \begin_layout Itemize
3564 b : read_signed_byte(a)
3567 \begin_layout Itemize
3571 \begin_layout Itemize
3572 d : read_signed_dword(a)
3575 \begin_layout Itemize
3579 \begin_layout Itemize
3581 \begin_inset Formula $\pi$
3587 \begin_layout Itemize
3588 q : read_signed_qword(a)
3591 \begin_layout Itemize
3595 \begin_layout Itemize
3599 \begin_layout Itemize
3603 \begin_layout Itemize
3607 \begin_layout Itemize
3608 w : read_signed_word(a)
3611 \begin_layout Itemize
3615 \begin_layout Itemize
3616 B : read_unsigned_byte(a)
3619 \begin_layout Itemize
3620 C<number>z : Push number <number> to stack.
3623 \begin_layout Itemize
3624 D : read_unsigned_dword(a)
3627 \begin_layout Itemize
3628 C0x<number>z : Push number <number> (hexadecimal) to stack.
3631 \begin_layout Itemize
3632 Q : read_unsigned_qword(a)
3635 \begin_layout Itemize
3636 R<digit> : round a to <digit> digits.
3639 \begin_layout Itemize
3640 W : read_unsigned_word(a)
3643 \begin_layout Subsection
3647 \begin_layout Standard
3648 C0x007e0878zWC0x007e002czW-
3651 \begin_layout Enumerate
3652 Push value 0x7e0878 on top of stack (C0x007e0878z).
3655 \begin_layout Enumerate
3656 Pop the value on top of stack (0x7e0878), read word value at that address
3657 and push the result,call it x1 (W).
3660 \begin_layout Enumerate
3661 Push value 0x7e002c on top of stack (C0x007e002cz).
3664 \begin_layout Enumerate
3665 Pop the value on top of stack (0x7e002c), read word value at that address
3666 and push the result,call it x2 (W).
3669 \begin_layout Enumerate
3670 Pop the two top numbers on stack, x1 and x2, substract x1 from x2 and push
3674 \begin_layout Enumerate
3675 Since the expression ends, the final memory watch result is the top one
3676 on stack, which is x2 - x1.
3679 \begin_layout Section
3680 Modifier and key names:
3683 \begin_layout Subsection
3687 \begin_layout Subsubsection
3691 \begin_layout Standard
3692 Following modifier names are known:
3695 \begin_layout Itemize
3696 ctrl, lctrl, rctrl: Control keys
3699 \begin_layout Itemize
3700 alt, lalt, ralt: ALT keys.
3703 \begin_layout Itemize
3704 shift, lshift, rshift: Shift keys.
3707 \begin_layout Itemize
3708 meta, lmeta, rmeta: Meta keys.
3711 \begin_layout Itemize
3712 num, caps: Numlock/Capslock (these are sticky!)
3715 \begin_layout Itemize
3719 \begin_layout Subsubsection
3723 \begin_layout Standard
3724 Following key names are known:
3727 \begin_layout Itemize
3728 backspace, tab, clear, return, pause, escape, space, exclaim, quotedbl,
3729 hash, dollar, ampersand, quote, leftparen, rightparen, asterisk, plus,
3730 comma, minus, period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon,
3731 less, equals, greater, question, at, leftbracket, backslash, rightbracket,
3732 caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n,
3733 o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0, world_1, world_2,
3734 world_3, world_4, world_5, world_6, world_7, world_8, world_9, world_10,
3735 world_11, world_12, world_13, world_14, world_15, world_16, world_17, world_18,
3736 world_19, world_20, world_21, world_22, world_23, world_24, world_25, world_26,
3737 world_27, world_28, world_29, world_30, world_31, world_32, world_33, world_34,
3738 world_35, world_36, world_37, world_38, world_39, world_40, world_41, world_42,
3739 world_43, world_44, world_45, world_46, world_47, world_48, world_49, world_50,
3740 world_51, world_52, world_53, world_54, world_55, world_56, world_57, world_58,
3741 world_59, world_60, world_61, world_62, world_63, world_64, world_65, world_66,
3742 world_67, world_68, world_69, world_70, world_71, world_72, world_73, world_74,
3743 world_75, world_76, world_77, world_78, world_79, world_80, world_81, world_82,
3744 world_83, world_84, world_85, world_86, world_87, world_88, world_89, world_90,
3745 world_91, world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3, kp4,
3746 kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide, kp_multiply, kp_minus, kp_plus,
3747 kp_enter, kp_equals, up, down, right, left, insert, home, end, pageup,
3748 pagedown, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14,
3749 f15, numlock, capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt,
3750 lalt, rmeta, lmeta, lsuper, rsuper, mode, compose, help, print, sysreq,
3751 break, menu, power, euro, undo
3754 \begin_layout Itemize
3755 Names of form 'key<n>' where <n> is 0-255 are interpretted as key having
3756 hardware-dependent scan code of <n> (useful to bind those keys that don't
3757 have symbolic names).
3760 \begin_layout Subsubsection
3761 Joystick pseudo-keys:
3764 \begin_layout Itemize
3765 joystick<num>button<button>: Joystick <num> (0-based) button <button> (0-based).
3768 \begin_layout Itemize
3769 joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat> (0-based) up.
3772 \begin_layout Itemize
3773 joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat> (0-based) left.
3776 \begin_layout Itemize
3777 joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat> (0-based) down.
3780 \begin_layout Itemize
3781 joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat> (0-based) right.
3784 \begin_layout Itemize
3785 joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis> negative
3786 position (axis modes axis and axis_inverse).
3789 \begin_layout Itemize
3790 joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis> positive
3791 position (axis modes axis and axis_inverse).
3794 \begin_layout Itemize
3795 joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis> pressure (axis
3799 \begin_layout Subsubsection
3803 \begin_layout Itemize
3804 Escape: Enter/Exit Command mode, cancel modal dialogs.
3807 \begin_layout Itemize
3808 Return (also KPEnter): Execute command, ok modal dialog.
3811 \begin_layout Itemize
3812 Pgup/Up (also KP8/9 if no num lock; command mode): Previous command in command
3816 \begin_layout Itemize
3817 Pgdn/Down(also KP2/3 if no num lock; command mode): Next command in command
3821 \begin_layout Itemize
3822 Home (also KP7 if no num lock; command mode): Beginning of command.
3825 \begin_layout Itemize
3826 End (also KP1 if no num lock; command mode): End of command.
3829 \begin_layout Itemize
3830 Left (also KP4 if no num lock; command mode): Move cursor left.
3833 \begin_layout Itemize
3834 Right (also KP6 if no num lock; command mode): Move cursor right.
3837 \begin_layout Itemize
3839 if no num lock; command mode): Delete character to right of cursor.
3842 \begin_layout Itemize
3843 Insert (also KP0 if no num lock; command mode): Toggle between insert /
3847 \begin_layout Itemize
3848 Backspace (command mode): Delete character to left of cursor.
3851 \begin_layout Itemize
3852 LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump corrupted!).
3855 \begin_layout Subsection
3859 \begin_layout Subsubsection
3863 \begin_layout Standard
3864 Following modifier names are known:
3867 \begin_layout Itemize
3871 \begin_layout Itemize
3875 \begin_layout Itemize
3879 \begin_layout Itemize
3883 \begin_layout Itemize
3887 \begin_layout Subsubsection
3891 \begin_layout Standard
3892 Following key names are known:
3895 \begin_layout Itemize
3896 back, tab, return, escape, space, exclaim, quotedbl, hash, dollar, percent,
3897 ampersand, quote, leftparen, rightparen, asterisk, plus, comma, minus,
3898 period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
3899 greater, question, at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3900 q, r, s, t, u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
3901 underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3902 q, r, s, t, u, v, w, x, y, z, leftcurly, pipe, rightcurly, tilde, delete,
3903 start, lbutton, rbutton, cancel, mbutton, clear, shift, alt, control, menu,
3904 pause, capital, end, home, lefT, up, right, down, select, print, execute,
3905 snapshot, insert, help, numpad0, numpad1, numpad2, numpad3, numpad4, numpad5,
3906 numpad6, numpad7, numpad8, numpad9, multiply, add, separator, subtract,
3907 decimal, divide, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13,
3908 f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, numlock, scroll,
3909 pageup, pagedown, numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
3910 numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up, numpad_right,
3911 numpad_down, numpad_pageup, numpad_pagedown, numpad_end, numpad_begin,
3912 numpad_insert, numpad_delete, numpad_equal, numpad_multiply, numpad_add,
3913 numpad_separator, numpad_subtract, numpad_decimal, numpad_divide, windows_left,
3914 windows_right, windows_menu, command, special1, special2, special3, special4,
3915 special5, special6, special7, special8, special9, special10, special11,
3916 special12, special13, special14, special15, special16, special17, special18,
3917 special19, special20
3920 \begin_layout Section
3924 \begin_layout Standard
3925 Movie file is .zip archive in itself, normal ZIP archive tools work on it
3926 (note: If you recompress it, do not use compression methods other than
3927 store and deflate and especially do not use encryption of any kind).
3930 \begin_layout Subsection
3931 Detecting clean start/SRAM/Savestate
3934 \begin_layout Itemize
3936 \begin_inset Quotes eld
3940 \begin_inset Quotes erd
3943 it is savestate, otherwise:
3946 \begin_layout Itemize
3947 If file has members with names starting
3948 \begin_inset Quotes eld
3952 \begin_inset Quotes erd
3955 it is movie starting from SRAM, otherwise:
3958 \begin_layout Itemize
3959 It is movie starting from clear state.
3962 \begin_layout Subsection
3966 \begin_layout Standard
3967 Type of game ROM and region (as one line).
3971 \begin_layout Standard
3972 \begin_inset Tabular
3973 <lyxtabular version="3" rows="8" columns="3">
3974 <features tabularvalignment="middle">
3975 <column alignment="center" valignment="top" width="0">
3976 <column alignment="center" valignment="top" width="0">
3977 <column alignment="center" valignment="top" width="0">
3979 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3982 \begin_layout Plain Layout
3988 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3991 \begin_layout Plain Layout
3997 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4000 \begin_layout Plain Layout
4008 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4011 \begin_layout Plain Layout
4017 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4020 \begin_layout Plain Layout
4026 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4029 \begin_layout Plain Layout
4037 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4040 \begin_layout Plain Layout
4046 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4049 \begin_layout Plain Layout
4055 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4058 \begin_layout Plain Layout
4066 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4069 \begin_layout Plain Layout
4075 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4078 \begin_layout Plain Layout
4084 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4087 \begin_layout Plain Layout
4095 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4098 \begin_layout Plain Layout
4104 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4107 \begin_layout Plain Layout
4113 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4116 \begin_layout Plain Layout
4124 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4127 \begin_layout Plain Layout
4133 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4136 \begin_layout Plain Layout
4142 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4145 \begin_layout Plain Layout
4153 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4156 \begin_layout Plain Layout
4162 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4165 \begin_layout Plain Layout
4171 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4174 \begin_layout Plain Layout
4182 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4185 \begin_layout Plain Layout
4191 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4194 \begin_layout Plain Layout
4200 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4203 \begin_layout Plain Layout
4217 \begin_layout Standard
4221 \begin_layout Standard
4222 \begin_inset Tabular
4223 <lyxtabular version="3" rows="3" columns="2">
4224 <features tabularvalignment="middle">
4225 <column alignment="center" valignment="top" width="0">
4226 <column alignment="center" valignment="top" width="0">
4228 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4231 \begin_layout Plain Layout
4237 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4240 \begin_layout Plain Layout
4248 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4251 \begin_layout Plain Layout
4257 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4260 \begin_layout Plain Layout
4268 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4271 \begin_layout Plain Layout
4277 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4280 \begin_layout Plain Layout
4294 \begin_layout Subsection
4298 \begin_layout Standard
4299 Contains type of port #1 (as one line).
4300 Valid values are 'none', 'gamepad', 'multitap' and 'mouse'.
4301 If not present, defaults to 'gamepad'.
4304 \begin_layout Subsection
4308 \begin_layout Standard
4309 Contains type of port #2 (as one line).
4310 Valid values are 'none', 'gamepad', 'multitap', 'mouse', 'superscope',
4311 'justifier' and 'justifiers'.
4312 If not present, defaults to 'none'.
4315 \begin_layout Subsection
4319 \begin_layout Standard
4320 Contains name of the game (as one line).
4323 \begin_layout Subsection
4327 \begin_layout Standard
4328 Contains authors, one per line.
4329 Part before '|' is the full name, part after is the nickname.
4332 \begin_layout Subsection
4336 \begin_layout Standard
4338 \begin_inset Quotes eld
4342 \begin_inset Quotes erd
4346 Used to reject other saves.
4349 \begin_layout Subsection
4350 Member: controlsversion
4353 \begin_layout Standard
4355 \begin_inset Quotes eld
4359 \begin_inset Quotes erd
4363 Used to identify what controls are there.
4366 \begin_layout Subsection
4368 \begin_inset Quotes eld
4372 \begin_inset Quotes erd
4378 \begin_layout Standard
4379 Contains bsnes core version number (as one line).
4382 \begin_layout Subsection
4386 \begin_layout Standard
4387 Contains project ID (as one line).
4388 Used to identify if two movies are part of the same project.
4391 \begin_layout Subsection
4392 Member: {rom,slota,slotb}{,xml}.sha256
4395 \begin_layout Standard
4396 Contains SHA-256 of said ROM or ROM mapping file (as one line).
4397 Absent if corresponding file is absent.
4400 \begin_layout Subsection
4401 Member: moviesram.<name>
4404 \begin_layout Standard
4405 Raw binary startup SRAM of kind <name>.
4406 Only present in savestates and movies starting from SRAM.
4409 \begin_layout Subsection
4413 \begin_layout Standard
4414 Contains frame number (as one line) of frame movie was saved on.
4415 Only present in savestates.
4418 \begin_layout Subsection
4422 \begin_layout Standard
4423 Current value of lag counter (as one line).
4424 Only present in savestates.
4427 \begin_layout Subsection
4428 Member: pollcounters
4431 \begin_layout Standard
4432 Contains poll counters (currently 100 of them), one per line.
4433 Each line is raw poll count if DRDY is set for it.
4434 Otherwise it is negative poll count minus one.
4435 Only present in savestates.
4438 \begin_layout Subsection
4442 \begin_layout Standard
4443 Raw binary dump of host memory.
4444 Only present in savestates.
4447 \begin_layout Subsection
4451 \begin_layout Standard
4452 The raw binary savestate itself.
4453 Savestate detection uses this file, only present in savestates.
4456 \begin_layout Subsection
4460 \begin_layout Standard
4461 Screenshot of current frame.
4462 Only present in savestates.
4463 First 2 bytes are big-endian width of image, rest are 24-bit RGB image
4465 Height of image is inferred from the width and size of data.
4468 \begin_layout Subsection
4472 \begin_layout Standard
4473 Raw binary SRAM of kind <name> at time of savestate.
4474 Only present in savestates.
4477 \begin_layout Subsection
4481 \begin_layout Standard
4482 The actual input track, one line per subframe (blank lines are skipped).
4485 \begin_layout Itemize
4486 If the first byte of each line is '.', ' ', <tab> or '|', then the line is
4487 part of same frame as previous, otherwise it starts a new frame.
4490 \begin_layout Itemize
4491 First subframe must start a new frame.
4494 \begin_layout Standard
4495 Length of movie in frames is number of lines in input file that start a
4499 \begin_layout Subsection
4503 \begin_layout Standard
4504 Contains textual base-10 rerecord count (as one line; emulator just writes
4505 this, it doesn't read it) + 1.
4508 \begin_layout Subsection
4512 \begin_layout Standard
4513 This member stores set of load IDs.
4514 There is one load ID per rerecord (plus one corresponding to start of project).
4517 \begin_layout Itemize
4518 This member constists of concatenation of records
4521 \begin_layout Itemize
4522 Each record is 2-36 bytes long and can represent 1-16,843,009 consequtive
4526 \begin_layout Itemize
4527 IDs are interpretted as 256-bit big-endian integers with warparound.
4530 \begin_layout Itemize
4531 Initial predicted ID is all zeroes.
4534 \begin_layout Standard
4535 Format of each record is:
4538 \begin_layout Itemize
4539 1 byte: Opcode byte.
4540 Bits 0-4 are prefix length (prefixlen), bits 5-6 are count length (countlen).
4544 \begin_layout Itemize
4545 32-prefixlen bytes of ID.
4548 \begin_layout Itemize
4549 countlen bytes of big-endian count (count).
4552 \begin_layout Standard
4553 Records are processed as follows:
4556 \begin_layout Itemize
4557 To form the first ID encoded by record, take the first prefixlen bytes predicted
4558 ID and append the read ID value to it.
4559 The result is the first ID encoded.
4562 \begin_layout Itemize
4563 If countlen is 0, record encodes 1 ID.
4566 \begin_layout Itemize
4567 If countlen is 1, record encodes 2+count IDs.
4570 \begin_layout Itemize
4571 If countlen is 2, record encodes 258+count IDs.
4574 \begin_layout Itemize
4575 If countlen is 3, record encodes 65794+count IDs.
4578 \begin_layout Itemize
4579 The new predicted ID is the next ID after last one encoded by the record.
4582 \begin_layout Standard
4583 The number of rerecords + 1 is equal to the sum of number of IDs encoded
4587 \begin_layout Subsection
4588 Member: starttime.second
4591 \begin_layout Standard
4592 Movie starting time, second part.
4593 Epoch is Unix epoch.
4594 Default is 1,000,000,000.
4597 \begin_layout Subsection
4598 Member: starttime.subsecond
4601 \begin_layout Standard
4602 Movie starting time, subsecond part.
4607 \begin_layout Subsection
4608 Member: savetime.second
4611 \begin_layout Standard
4612 Movie saving time, second part.
4613 Default is starttime.second.
4614 Only present in savestates.
4617 \begin_layout Subsection
4618 Member: savetime.subsecond
4621 \begin_layout Standard
4622 Movie saving time, subsecond part.
4623 Default is starttime.subsecond.
4624 Only present in savestates.
4627 \begin_layout Section
4628 Quick'n'dirty encode guide
4631 \begin_layout Enumerate
4632 Start the emulator and load the movie file.
4635 \begin_layout Enumerate
4636 Set large AVI option 'set-setting avi-large on'
4639 \begin_layout Enumerate
4640 Enable dumping 'dump-avi tmpdump'
4643 \begin_layout Enumerate
4644 Unpause and let it run until you want to end dumping.
4647 \begin_layout Enumerate
4648 Close the emulator (closing the window is the easiest way).
4652 \begin_layout Enumerate
4653 For each tmpdump*.avi file created, on command prompt, do 'x264 --crf 10
4654 -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
4657 \begin_layout Enumerate
4658 Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
4661 \begin_layout Enumerate
4662 Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv + tmpdump_0000001.mkv
4663 + tmpdump_0000002.mkv' (list every tmpdump_<numbers>.mkv, with + in between).
4666 \begin_layout Enumerate
4667 Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'.
4668 Now final.mkv contains quick'n'dirty encode.
4671 \begin_layout Section
4672 Axis configurations for some gamepad types:
4675 \begin_layout Subsection
4679 \begin_layout Standard
4680 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be set to pressure-+.
4683 \begin_layout LyX-Code
4684 set-axis joystick0axis2 pressure-+
4687 \begin_layout LyX-Code
4688 set-axis joystick0axis5 pressure-+
4691 \begin_layout Itemize
4692 This is needed for SDL only.
4693 EVDEV sets those types correctly.
4696 \begin_layout Subsection
4698 \begin_inset Quotes eld
4702 \begin_inset Quotes erd
4708 \begin_layout Standard
4709 Axes 8-19 should be disabled.
4712 \begin_layout LyX-Code
4713 set-axis joystick0axis8 disabled
4716 \begin_layout LyX-Code
4717 set-axis joystick0axis9 disabled
4720 \begin_layout LyX-Code
4721 set-axis joystick0axis10 disabled
4724 \begin_layout LyX-Code
4725 set-axis joystick0axis11 disabled
4728 \begin_layout LyX-Code
4729 set-axis joystick0axis12 disabled
4732 \begin_layout LyX-Code
4733 set-axis joystick0axis13 disabled
4736 \begin_layout LyX-Code
4737 set-axis joystick0axis14 disabled
4740 \begin_layout LyX-Code
4741 set-axis joystick0axis15 disabled
4744 \begin_layout LyX-Code
4745 set-axis joystick0axis16 disabled
4748 \begin_layout LyX-Code
4749 set-axis joystick0axis17 disabled
4752 \begin_layout LyX-Code
4753 set-axis joystick0axis18 disabled
4756 \begin_layout LyX-Code
4757 set-axis joystick0axis19 disabled
4760 \begin_layout Section
4764 \begin_layout Subsection
4765 Problems from BSNES core:
4768 \begin_layout Itemize
4769 The whole pending save stuff.
4772 \begin_layout Itemize
4773 Lack of layer hiding.
4776 \begin_layout Itemize
4777 It is slow (especially accuracy).
4780 \begin_layout Itemize
4781 Firmwares can't be loaded from ZIP archives.
4784 \begin_layout Subsection
4788 \begin_layout Itemize
4789 Modifiers don't work with pseudo-keys (SDL, EVDEV).
4792 \begin_layout Itemize
4793 Audio for last dumped frame is not itself dumped.
4796 \begin_layout Itemize
4797 Audio in UI is pretty bad in quality if game doesn't run at full speed.
4800 \begin_layout Itemize
4801 AVI compression levels 10-18 are not compatible with AVISynth AVISource.
4804 \begin_layout Itemize
4805 No menus, command based interface (SDL).
4808 \begin_layout Itemize
4809 Long commands don't scroll.
4812 \begin_layout Itemize
4813 Wxwidgets UI is still buggy.
4816 \begin_layout Section
4820 \begin_layout Subsection
4824 \begin_layout Itemize
4828 \begin_layout Itemize
4829 Fix dumper video corruption with levels 10-18.
4832 \begin_layout Subsection
4836 \begin_layout Itemize
4840 \begin_layout Itemize
4841 Lots of code cleanups
4844 \begin_layout Itemize
4845 Lua interface to settings
4848 \begin_layout Itemize
4849 Allow specifying AVI borders without Lua
4852 \begin_layout Itemize
4853 Fix scaling if vscale > 1 and originx > 0 (left border exists)
4856 \begin_layout Itemize
4857 on_snoop lua callback
4860 \begin_layout Itemize
4861 Faster movie loading and saving.
4864 \begin_layout Subsection
4868 \begin_layout Itemize
4872 \begin_layout Subsection
4876 \begin_layout Itemize
4880 \begin_layout Itemize
4881 Save jukebox functionality.
4884 \begin_layout Subsection
4888 \begin_layout Itemize
4889 Try to fix some nasty failing movie load edge cases
4892 \begin_layout Itemize
4893 Allow specifying scripts to run on command line.
4896 \begin_layout Subsection
4900 \begin_layout Itemize
4901 Major source code reorganization.
4904 \begin_layout Itemize
4905 Backup savestates before overwriting.
4908 \begin_layout Itemize
4909 Don't crash if loading initial state fails.
4912 \begin_layout Subsection
4916 \begin_layout Itemize
4920 \begin_layout Itemize
4921 Fix author name parsing
4924 \begin_layout Itemize
4925 Fix rerecord counting
4928 \begin_layout Itemize
4929 (SDL) Print messages to console if SDL is uninitialized
4932 \begin_layout Itemize
4933 Add movieinfo program
4936 \begin_layout Itemize
4937 Fix loading movies starting from SRAM.
4940 \begin_layout Subsection
4944 \begin_layout Itemize
4945 Add support for unattended dumping
4948 \begin_layout Itemize
4949 Fix compiling for Win32
4952 \begin_layout Itemize
4953 Don't lock up if sound can't be initialized
4956 \begin_layout Itemize
4957 Strip trailing CR from commands
4960 \begin_layout Itemize
4961 Don't try to do dubious things in global ctors (fix crash on startup)
4964 \begin_layout Subsection
4968 \begin_layout Itemize
4969 Small documentation tweaking
4972 \begin_layout Itemize
4976 \begin_layout Itemize
4977 Fix major bug in modifier matching
4980 \begin_layout Subsection
4984 \begin_layout Itemize
4985 Lots of documentation fixes
4988 \begin_layout Itemize
4989 Use dedicated callbacks for event backcomm., not commands.
4992 \begin_layout Itemize
4993 Ensure that the watchdog is not hit when executing delayed reset.
4996 \begin_layout Itemize
4997 Remove errant tab from joystick message.
5000 \begin_layout Subsection
5004 \begin_layout Itemize
5005 Make autofire operate in absolute time, not linear time
5008 \begin_layout Itemize
5009 Reinitialize controls when resuming from loadstate
5012 \begin_layout Itemize
5013 Some more code cleanups
5016 \begin_layout Itemize
5017 If Lua allocator fails, call OOM_panic()
5020 \begin_layout Itemize
5021 Byte/word/dword/qword sized host memory write/read functions.
5024 \begin_layout Itemize
5025 Dump at correct framerate if dumping interlaced NTSC (height=448).
5028 \begin_layout Subsection
5032 \begin_layout Itemize
5033 Actually include the complete source code
5036 \begin_layout Itemize
5040 \begin_layout Subsection
5044 \begin_layout Itemize
5045 Document {save,start}time.{,sub}second.
5048 \begin_layout Itemize
5049 Intercept time() from bsnes core.
5052 \begin_layout Subsection
5056 \begin_layout Itemize
5057 Allow disabling time() interception (allow build on Mac OS X)
5060 \begin_layout Itemize
5061 Use SDLMain on Mac OS X (make SDL not crash)
5064 \begin_layout Itemize
5065 Disable delayed resets (just plain too buggy for now).
5068 \begin_layout Itemize
5072 \begin_layout Itemize
5073 Use 16-bit for graphics/video instead of 32-bit.
5076 \begin_layout Itemize
5077 gui.rectangle/gui.pixel
5080 \begin_layout Itemize
5084 \begin_layout Itemize
5085 New CSCD writer implementation.
5088 \begin_layout Subsection
5092 \begin_layout Itemize
5093 Fix interaction of * and +.
5096 \begin_layout Itemize
5100 \begin_layout Itemize
5101 Use gettimeofday()/usleep(), these seem portable enough.
5104 \begin_layout Itemize
5105 Move joystick axis manipulation to keymapper code.
5108 \begin_layout Itemize
5109 Changes to how read-only works.
5112 \begin_layout Itemize
5113 Refactor controller input code.
5116 \begin_layout Subsection
5120 \begin_layout Itemize
5121 Fix mouseclick scale compensation.
5124 \begin_layout Itemize
5125 Draw area boundaries correctly in SDL code.
5128 \begin_layout Itemize
5132 \begin_layout Itemize
5133 Fix CSCD output (buffer overrun and race condition).
5136 \begin_layout Subsection
5140 \begin_layout Itemize
5141 JMD dumping support.
5144 \begin_layout Itemize
5145 Allow unattended dumping to JMD.
5148 \begin_layout Itemize
5152 \begin_layout Itemize
5153 Switch back to 32-bit colors.
5156 \begin_layout Itemize
5157 Add Lua function gui.color.
5160 \begin_layout Itemize
5161 Use some new C++11 features in GCC 4.6.
5164 \begin_layout Itemize
5165 Be prepared for core frequency changes.
5168 \begin_layout Itemize
5169 Pass colors in one chunk from Lua.
5172 \begin_layout Subsection
5176 \begin_layout Itemize
5177 New lua functions gui.line(), gui.status() and gui.circle(), memory.vma_count(),
5178 memory.read_vma() and memory.find_vma().
5181 \begin_layout Itemize
5182 Numerious documentation fixups
5185 \begin_layout Itemize
5186 RTC time format changed
5189 \begin_layout Itemize
5190 Reformat flags display
5193 \begin_layout Itemize
5194 Allow lua package name to be overridden
5197 \begin_layout Itemize
5198 SDUMP (high-quality dumping).
5201 \begin_layout Itemize
5202 Split platform support to plugins.
5205 \begin_layout Itemize
5206 Make all sound plugins support basic sound commands
5209 \begin_layout Itemize
5210 Support portaudio for sound.
5213 \begin_layout Itemize
5214 Allow disable Lua/SDL searching.
5217 \begin_layout Itemize
5218 Upconvert colors when copying lcscreen to screen.
5221 \begin_layout Itemize
5222 Reorganize source tree.
5225 \begin_layout Itemize
5226 Evdev joystick support.
5229 \begin_layout Itemize
5230 Refactor more code into generic window code.
5233 \begin_layout Subsection
5237 \begin_layout Itemize
5238 Refactor message handling.
5241 \begin_layout Itemize
5245 \begin_layout Itemize
5249 \begin_layout Itemize
5250 Finish pending saves before load/quit.
5253 \begin_layout Itemize
5254 Wxwidgets graphics plugin.
5257 \begin_layout Subsection
5261 \begin_layout Itemize
5262 Get rid of win32-crap.[ch]pp.
5265 \begin_layout Itemize
5266 Move files around a lot.
5269 \begin_layout Itemize
5270 Get rid of need for host C++ compiler.
5273 \begin_layout Itemize
5277 \begin_layout Itemize
5278 Refactor inter-component communication.
5281 \begin_layout Itemize
5285 \begin_layout Itemize
5286 Fix crash on multiline aliases.
5289 \begin_layout Itemize
5290 Load/Save settings in wxwidgets gui.
5293 \begin_layout Subsection
5297 \begin_layout Itemize
5298 Patch problems in bsnes core
5301 \begin_layout Itemize
5302 SNES is little-endian, not big-endian!
5305 \begin_layout Itemize
5306 Fix memory corruption in lcscreen::load()
5309 \begin_layout Subsection
5313 \begin_layout Itemize
5314 Fix interpretting repeat counts in rrdata loading.
5317 \begin_layout Itemize
5318 New lua callback: on_frame()
5321 \begin_layout Itemize
5322 Remove calls to runtosave() that aren't supposed to be there
5325 \begin_layout Itemize
5326 Lua function: movie.read_rtc()
5329 \begin_layout Itemize
5330 Ignore src/fonts/font.cpp
5333 \begin_layout Itemize
5334 Fix more bsnes core problems
5337 \begin_layout Itemize
5338 Control bsnes random seeding
5341 \begin_layout Itemize
5345 \begin_layout Itemize
5346 Some bsnes core debugging features (state dump and state hash)
5349 \begin_layout Itemize
5350 Fix titlebar version number (no, the last version wasn't 'lsnes-0-beta21',
5351 it was 'lsnes rr0-beta21').
5354 \begin_layout Subsection
5358 \begin_layout Itemize
5359 Fix memory corruption due to macro/field mixup
5362 \begin_layout Itemize
5363 search-memory update
5366 \begin_layout Itemize
5367 Allow direct-mapped framebuffer
5370 \begin_layout Itemize
5371 SDL: Use SDL_ANYFORMAT if possible
5374 \begin_layout Itemize
5375 SDMP2SOX: 2s delay modes.
5378 \begin_layout Itemize
5382 \begin_layout Itemize
5383 Use sed -E, not sed -r.
5384 Fixes building on Mac OS X.
5387 \begin_layout Itemize
5388 Wxwidgets: Save jukebox on exit
5391 \begin_layout Itemize
5392 Fix RTC if using load-movie on savestate.
5395 \begin_layout Itemize
5396 Fix crash related to full console mode.
5399 \begin_layout Subsection
5403 \begin_layout Itemize
5404 Wxwidgets: Allow bringing application to foreground on Mac OS X.
5407 \begin_layout Itemize
5408 Wxwidgets: Allow compiling on Mac OS X.
5411 \begin_layout Itemize
5412 Use movie compare instead of movie hashing (faster save/load).
5415 \begin_layout Itemize
5419 \begin_layout Subsection
5423 \begin_layout Itemize
5424 sdmp2sox: Pad soundtrack if using -l or -L.
5427 \begin_layout Itemize
5428 sdmp2sox: Fix NTSC overscan.
5431 \begin_layout Itemize
5432 sdmp2sox: Add AR correction mode.
5435 \begin_layout Itemize
5436 call lua_close() when exiting.
5439 \begin_layout Itemize
5440 Fix zip_writer bug causing warnings from info-zip and error from advzip.
5443 \begin_layout Subsection
5447 \begin_layout Itemize
5448 Fix IPS patching code (use bsnes core IPS patcher).
5451 \begin_layout Itemize
5452 Implement BPS patching (using bsnes core IPS patcher).
5455 \begin_layout Itemize
5456 Add feature to load headered ROMs.
5459 \begin_layout Subsection
5463 \begin_layout Itemize
5464 Show command names when showing keybindings
5467 \begin_layout Subsection
5471 \begin_layout Itemize
5472 Fix pause-on-end to be actually controllable
5475 \begin_layout Itemize
5476 SDL: Poll all events in queue, not just first one (fixes slowness in command
5480 \begin_layout Itemize
5481 Wxwidgets: Fix ROM loading.
5484 \begin_layout Subsection
5488 \begin_layout Itemize
5489 Lua: Add gui.textH, gui.textV, gui.textHV
5492 \begin_layout Itemize
5493 Fix text colors on SDL on Mac OS X
5496 \begin_layout Itemize
5497 Mode 'F' for finished in readonly mode.
5500 \begin_layout Itemize
5504 \begin_layout Itemize
5505 Reliably pause after skip poll
5508 \begin_layout Itemize
5509 Split UI and core into their own threads
5512 \begin_layout Subsection
5516 \begin_layout Itemize
5517 Remove leftover dummy SRAM slot
5520 \begin_layout Itemize
5521 Fix controller numbers.
5524 \begin_layout Subsection
5528 \begin_layout Itemize
5529 Fix lsnes-dumpavi after interface change.
5532 \begin_layout Itemize
5533 Also give BSNES patches for v085.
5536 \begin_layout Itemize
5537 Pack movie data in memory.
5540 \begin_layout Subsection
5544 \begin_layout Itemize
5545 Fix framecount/length given when loading movies.
5548 \begin_layout Itemize
5549 Controller command memory leak fixes.
5552 \begin_layout Itemize
5553 Don't leak palette if freeing screen object.
5556 \begin_layout Subsection
5560 \begin_layout Itemize
5564 \begin_layout Itemize
5565 Wxwidgets: Allow controlling dumper from the menu.
5568 \begin_layout Subsection
5572 \begin_layout Itemize
5573 Rewrite parts of manual
5576 \begin_layout Itemize
5577 Lua: Make it work with Lua 5.2.
5580 \begin_layout Subsection
5584 \begin_layout Itemize
5585 Win32: Fix compile errors.
5588 \begin_layout Subsection
5592 \begin_layout Itemize
5593 Refactor controller input code.
5596 \begin_layout Itemize
5597 Fix crash when using command line on SDL / Mac OS X.
5600 \begin_layout Subsection
5604 \begin_layout Itemize
5605 Delete core/coroutine (obsolete)
5608 \begin_layout Itemize
5609 Lag input display by one frame.
5612 \begin_layout Itemize
5613 Rewind movie to beginning function.
5616 \begin_layout Itemize
5617 Fix wrong frame number reported to Lua when repainting after loadstate
5620 \begin_layout Itemize
5621 Support UI editing of jukebox
5624 \begin_layout Itemize
5625 Wxwidgets: Save settings on exit.
5628 \begin_layout Itemize
5629 Support ${project} for filenames
5632 \begin_layout Itemize
5633 SDL: Fix command history
5636 \begin_layout Subsection
5640 \begin_layout Itemize
5641 Fix some order-of-global-ctor bugs.
5644 \begin_layout Subsection
5648 \begin_layout Itemize
5649 Fix crashes when quitting on Win32.
5652 \begin_layout Subsection
5656 \begin_layout Itemize
5657 EVDEV: Queue keypresses from joystick, don't send directly
5660 \begin_layout Itemize
5661 Wxwidgets: Load-Preserve that actually works.
5664 \begin_layout Subsection
5668 \begin_layout Itemize
5669 Wxwidgets: GUI for memory search.
5672 \begin_layout Itemize
5673 Warn about using synchronous queue in UI callback.
5676 \begin_layout Subsection
5680 \begin_layout Itemize
5681 Remember last saved file for each ROM
5684 \begin_layout Itemize
5685 Support MT dumping via boost.
5688 \begin_layout Itemize
5692 \begin_layout Itemize
5696 \begin_layout Itemize
5697 Make mouse be ordinary input instead of special-casing
5700 \begin_layout Itemize
5701 SDL: Don't screw up commands with NUL codepoints.
5704 \begin_layout Subsection
5708 \begin_layout Itemize
5709 Merge status panel and main window
5712 \begin_layout Itemize
5713 True movie slot support (the rest of it)
5716 \begin_layout Itemize
5717 SDL: Fix compilation error
5720 \begin_layout Itemize
5721 Elminate cross calls in dump menu code.
5724 \begin_layout Subsection
5728 \begin_layout Itemize
5729 Cancel pending saves command
5732 \begin_layout Itemize
5733 Wxwidgets: Code refactoring
5736 \begin_layout Itemize
5737 Wxwidgets: Fix system -> reset
5740 \begin_layout Itemize
5741 Wxwidgets: Read watch expressions in the right thread
5744 \begin_layout Subsection
5748 \begin_layout Itemize
5749 Wxwidgets: Don't prompt for member when running Lua script (Lua doesn't
5753 \begin_layout Itemize
5754 Wxwidgets: 128 -> 1024 Autohold slots (in case more are needed).
5757 \begin_layout Itemize
5758 Don't append trailing '-' to prefix when saving movie.
5761 \begin_layout Itemize
5762 Fix ROM/savestate handling (don't let user mismatch ROM and savestates).
5765 \begin_layout Subsection
5769 \begin_layout Itemize
5770 Document memory watch syntax.
5773 \begin_layout Subsection
5777 \begin_layout Itemize
5778 Fix unattended dumping (lsnes-dumpavi)
5781 \begin_layout Itemize
5785 \begin_layout Itemize
5786 Use adv_dumper instead of the old interface in lsnes-dumpavi (changes syntax)
5789 \begin_layout Itemize
5790 Add option to control sample rate preturbation in AVI dumper
5793 \begin_layout Subsection
5797 \begin_layout Itemize
5798 Wxwidgets: Fix dumper submodes
5801 \begin_layout Itemize
5802 Set core controller types before loadstate
5805 \begin_layout Subsection
5809 \begin_layout Itemize
5810 Fix compiling with bsnes v086.
5813 \begin_layout Subsection
5817 \begin_layout Itemize
5818 Don't prompt before quitting
5821 \begin_layout Itemize
5822 Start unpaused, preserve pause/unpause over load.
5825 \begin_layout Itemize
5826 Try to autodetect if ROM is headered.
5829 \begin_layout Itemize
5830 Wxwidgets: Only bring up ROM patching screen if specifically requested.
5833 \begin_layout Itemize
5834 Allow configuring some hotkeys.
5837 \begin_layout Subsection
5841 \begin_layout Itemize
5842 Lots of code cleanups
5845 \begin_layout Itemize
5846 Fix JMD compression (JMD dumping was broken)
5849 \begin_layout Itemize
5850 Don't crash if Lua C function throws an exception.
5853 \begin_layout Itemize
5854 Support bitmap drawing in Lua.
5857 \begin_layout Itemize
5858 Fix bsnes v085/v086 patches.
5861 \begin_layout Itemize
5862 Improve stability on win32.
5865 \begin_layout Subsection
5869 \begin_layout Itemize
5870 Don't corrupt movie if movie length is integer multiple of frames per page.
5873 \begin_layout Subsection
5877 \begin_layout Itemize
5878 New Lua hooks: on_rewind, on_frame_emulated, on_idle, on_timer
5881 \begin_layout Itemize
5882 New Lua functions: emulator_ready(), utime(), set_idle_timeout(), set_timer_time
5883 out(), bit.extract(), bit.value(), input.geta(), input.seta() and input.controllertyp
5887 \begin_layout Itemize
5888 Wxwidgets: Fix internal focus lost (hotkeys stop working)
5891 \begin_layout Itemize
5892 Wxwidgets: Fix broken modifiers
5895 \begin_layout Itemize
5896 on_paint has parameter now.
5899 \begin_layout Itemize
5900 Optional initital fill for bitmaps
5903 \begin_layout Itemize
5904 Fix palette changing.
5907 \begin_layout Itemize
5908 Optimize rendering a bit.
5911 \begin_layout Itemize