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 Subsubsection
769 --load-library=<library>
772 \begin_layout Standard
773 Load the specified shared object / dynamic library / dynamic link library.
776 \begin_layout Section
777 Startup file lsnes.rc
780 \begin_layout Standard
781 Upon startup, lsnes (lsnes/SDL only) executes file lsnes.rc as commands.
782 This file is located in:
785 \begin_layout Itemize
790 lsnes.rc (if %APPDATA% exists)
793 \begin_layout Itemize
794 Unix: $XDG_CONFIG_HOME/lsnes/lsnes.rc (if $XDG_CONFIG_HOME exists)
797 \begin_layout Itemize
798 Unix: $HOME/.config/lsnes/lsnes.rc (if $HOME exists)
801 \begin_layout Itemize
802 All: ./lsnes.rc (fallback default).
805 \begin_layout Standard
806 If leading directories do not exist, attempt to create them is made.
809 \begin_layout Section
813 \begin_layout Itemize
814 Commands beginning with '*' invoke the corresponding command without alias
818 \begin_layout Itemize
819 If command starts with '+' (after possible '*'), the command is executed
820 as-is when button is pressed, and when button is released, it is executed
821 with '+' replaced by '-'.
824 \begin_layout Itemize
825 Commands without '+' execute only on negative edge (release).
828 \begin_layout Subsection
832 \begin_layout Standard
833 Settings control various aspects of emulator behaviour.
836 \begin_layout Subsubsection
837 set-setting <setting> <value>
840 \begin_layout Standard
841 Sets setting <setting> to value <value> (may be empty).
844 \begin_layout Subsubsection
845 unset-setting <setting>
848 \begin_layout Standard
849 Try to unset setting <setting> (not all settings can be unset).
852 \begin_layout Subsubsection
853 get-setting <setting>
856 \begin_layout Standard
857 Read value of setting <setting>
860 \begin_layout Subsubsection
864 \begin_layout Standard
865 Print names and values of all settings.
868 \begin_layout Subsection
872 \begin_layout Standard
873 Keybindings bind commands or aliases to keys (or pseudo-keys).
877 \begin_layout Standard
881 \begin_layout Itemize
882 Do not bind edge active (+/-) commands to keys with modifiers, that won't
886 \begin_layout Itemize
887 Names of keys and modifiers are platform-dependent.
890 \begin_layout Itemize
891 Be careful before binding pseudo-keys (such as joystick axes, buttons or
892 hats) with modifiers.
893 That may or may not work right.
896 \begin_layout Subsubsection
897 bind-key [<mod>/<modmask>] <key> <command>
900 \begin_layout Standard
901 Bind <command> to key <key> (activating if modifiers in <modmask> (comma-seperat
902 ed list) are set as <mod> (comma-seperated list).
905 \begin_layout Standard
906 The names of keys and modifiers are platform-dependent.
909 \begin_layout Subsubsection
910 unbind-key [<mod>/<modmask>] <key>
913 \begin_layout Standard
914 Unbind command from <key> (with specified <mod> and <modmask>).
917 \begin_layout Subsubsection
918 set-axis <axis> [disabled | axis | axis-inverse | pressure0- | pressure0+
919 | pressure-0 | pressure-+ | pressure+0 | pressure+-] [minus=<val>] [zero=<val>]
920 [plus=<val>] [tolerance=<val>]
923 \begin_layout Standard
924 Set axis parameters for axis <axis>.
927 \begin_layout Itemize
928 disabled: Disable axis
931 \begin_layout Itemize
935 \begin_layout Itemize
936 axis-inverse: Inverse axis
939 \begin_layout Itemize
940 pressure0-: Pressure sensitive.
941 Released at 0, pressed at -.
944 \begin_layout Itemize
945 pressure0+: Pressure sensitive.
946 Released at 0, pressed at +.
949 \begin_layout Itemize
950 pressure-0: Pressure sensitive.
951 Released at -, pressed at 0.
954 \begin_layout Itemize
955 pressure-+: Pressure sensitive.
956 Released at -, pressed at +.
959 \begin_layout Itemize
960 pressure+0: Pressure sensitive.
961 Released at +, pressed at 0.
964 \begin_layout Itemize
965 pressure+-: Pressure sensitive.
966 Released at +, pressed at -.
969 \begin_layout Itemize
970 minus=<val>: Calibration at extreme minus position (-32768-32767)
973 \begin_layout Itemize
974 zero=<val>: Calibration at neutral position (-32768-32767)
977 \begin_layout Itemize
978 plus=<val>: Calibration at extreme plus position (-32768-32767)
981 \begin_layout Itemize
982 tolerance=<value>: Center band tolerance (0<x<1).
983 The smaller the value, the more sensitive the control is.
986 \begin_layout Subsubsection
990 \begin_layout Standard
991 Print all key bindings in effect.
994 \begin_layout Subsection
998 \begin_layout Standard
999 Aliases bind command to sequence of commands.
1000 After alias has been defined, it replaces the command it shadows.
1003 \begin_layout Standard
1007 \begin_layout Itemize
1008 You can't alias command to itself.
1011 \begin_layout Itemize
1012 Aliases starting with +/- are edge active just like ordinary commands starting
1016 \begin_layout Itemize
1017 One command can be aliased to multiple commands.
1020 \begin_layout Subsubsection
1021 alias-command <command> <expansion>
1024 \begin_layout Standard
1025 Append <expansion> to alias <command>.
1026 If alias does not already exist, it is created.
1029 \begin_layout Subsubsection
1030 unalias-command <command>
1033 \begin_layout Standard
1034 Clear alias expansion for <command>.
1037 \begin_layout Subsubsection
1041 \begin_layout Standard
1042 Print all aliases and their expansions in effect.
1045 \begin_layout Subsection
1049 \begin_layout Standard
1050 Run <script> as if commands were entered on the command line.
1053 \begin_layout Subsection
1057 \begin_layout Standard
1058 Following commands control video dumping:
1061 \begin_layout Subsubsection
1062 start-dump <dumper> [<mode>] <prefix/filename>
1065 \begin_layout Standard
1066 Start dumping using dumper <dumper>.
1067 If mode is present or not and if prefix or filename is present depends
1068 on the dumper and dumper mode.
1071 \begin_layout Standard
1072 The following dumpers are available:
1075 \begin_layout Itemize
1076 INTERNAL-AVI-CSCD: Internal CSCD in .avi dumper.
1080 \begin_layout Itemize
1081 Mode: uncompressed/pcm: Uncompressed video, PCM audio.
1085 \begin_layout Itemize
1086 Mode: cscd/pcm: CSCD video, PCM audio.
1091 \begin_layout Itemize
1092 INTERNAL-JMD: Internal .jmd dumper.
1096 \begin_layout Itemize
1100 \begin_layout Itemize
1105 \begin_layout Itemize
1106 INTERNAL-RAW: Internal RAW dumper.
1110 \begin_layout Itemize
1114 \begin_layout Itemize
1118 \begin_layout Itemize
1119 Sound is big-endian signed 16-bit, usually at 32040.5Hz.
1122 \begin_layout Itemize
1123 Video is always upscaled to double resolution (512x448 / 512 x 478).
1126 \begin_layout Itemize
1127 Video framerate is usually 322445/6448 fps for PAL and 10738636/178683 fps
1132 \begin_layout Itemize
1133 INTERNAL-SDMP: Internal SDMP dumper.
1137 \begin_layout Itemize
1138 Mode 'ms': Multi-segment.
1142 \begin_layout Itemize
1143 Mode 'ss': Single-segment.
1148 \begin_layout Subsubsection
1152 \begin_layout Standard
1153 End dumping using <dumper>
1156 \begin_layout Subsubsection
1157 show-dumpers [<dumper>]
1160 \begin_layout Standard
1161 Show the list of dumpers or list of modes for <dumper>
1164 \begin_layout Subsection
1168 \begin_layout Standard
1169 <address> may be decimal or hexadecimal (prefixed with '0x').
1170 <value> can be hexadecimal (prefixed with '0x'), unsigned or signed (prefixed
1174 \begin_layout Standard
1175 The available element <sizes> are:
1178 \begin_layout Itemize
1182 \begin_layout Itemize
1186 \begin_layout Itemize
1190 \begin_layout Itemize
1194 \begin_layout Standard
1195 When reading RAM and ROM, multi-byte reads/writes are big-endian.
1196 When dealing with DSP memory, multi-byte reads/writes are native-endian
1197 (do not use operand sizes exceeding DSP bitness, except dword is OK for
1201 \begin_layout Subsubsection
1202 read-<size> <address>
1205 \begin_layout Standard
1206 Read the value of byte in <address>.
1209 \begin_layout Subsubsection
1210 read-s<size> <address>
1213 \begin_layout Standard
1214 Read the value of signed byte in <address>.
1217 \begin_layout Subsubsection
1218 write-<size> <address> <value>
1221 \begin_layout Standard
1222 Write <value> to byte in address <address>.
1225 \begin_layout Subsubsection
1229 \begin_layout Standard
1230 Reset the memory search
1233 \begin_layout Subsubsection
1237 \begin_layout Standard
1238 Print number of candidates remaining
1241 \begin_layout Subsubsection
1245 \begin_layout Standard
1246 Print all candidates remaining
1249 \begin_layout Subsubsection
1250 search-memory <usflag><sizeflag><op>
1253 \begin_layout Standard
1254 Searches memory for addresses satisfying criteria.
1257 \begin_layout Standard
1261 \begin_layout Itemize
1265 \begin_layout Itemize
1269 \begin_layout Standard
1273 \begin_layout Itemize
1277 \begin_layout Itemize
1281 \begin_layout Itemize
1285 \begin_layout Itemize
1289 \begin_layout Standard
1293 \begin_layout Itemize
1294 lt: < previous value.
1297 \begin_layout Itemize
1298 le: <= previous value.
1301 \begin_layout Itemize
1302 eq: = previous value.
1305 \begin_layout Itemize
1306 ne: != previous value.
1309 \begin_layout Itemize
1310 ge: >= previous value.
1313 \begin_layout Itemize
1314 gt: > previous value.
1317 \begin_layout Subsubsection
1318 search-memory <sizeflag> <value>
1321 \begin_layout Standard
1322 Searches for addresses that currently have value <value>.
1323 <sizeflag> is as in previous command.
1326 \begin_layout Subsection
1330 \begin_layout Standard
1331 These commands are not available in lsnesrc, but are available after ROM
1335 \begin_layout Subsubsection
1339 \begin_layout Standard
1340 Quits the emulator (asking for confirmation).
1341 If /y is given, no confirmation is asked.
1344 \begin_layout Subsubsection
1348 \begin_layout Standard
1349 Toggle paused/unpaused
1352 \begin_layout Subsubsection
1356 \begin_layout Standard
1358 If the button is still held after configurable timeout expires, game unpauses
1359 for the duration frame advance is held.
1362 \begin_layout Subsubsection
1366 \begin_layout Standard
1368 If the button is still held after configurable timeout expires, game unpauses
1369 for the duration frame advance is held.
1372 \begin_layout Subsubsection
1376 \begin_layout Standard
1377 Skip to first poll in frame after current.
1380 \begin_layout Subsubsection
1384 \begin_layout Standard
1385 Reset the SNES after this frame.
1388 \begin_layout Subsubsection
1392 \begin_layout Standard
1393 Load savestate <filename> in current mode.
1396 \begin_layout Subsubsection
1397 load-state <filename>
1400 \begin_layout Standard
1401 Load savestate <filename> in readwrite mode.
1404 \begin_layout Subsubsection
1405 load-readonly <filename>
1408 \begin_layout Standard
1409 Load savestate <filename> in readonly mode.
1412 \begin_layout Subsubsection
1413 load-preserve <filename>
1416 \begin_layout Standard
1417 Load savestate <filename> in readonly mode, preserving current events.
1420 \begin_layout Subsubsection
1421 load-movie <filename>
1424 \begin_layout Standard
1425 Load savestate <filename>, ignoring save part in readonly mode.
1428 \begin_layout Subsubsection
1429 save-state <filename>
1432 \begin_layout Standard
1433 Save system state to <filename> as soon as possible.
1436 \begin_layout Subsubsection
1437 save-movie <filename>
1440 \begin_layout Standard
1441 Save movie to <filename>.
1444 \begin_layout Subsubsection
1448 \begin_layout Standard
1449 Set read-write mode.
1452 \begin_layout Subsubsection
1456 \begin_layout Standard
1460 \begin_layout Subsubsection
1464 \begin_layout Standard
1465 Toggle between read-only and read-write modes.
1468 \begin_layout Subsubsection
1472 \begin_layout Standard
1473 Set name of the game to <name>
1476 \begin_layout Subsubsection
1480 \begin_layout Standard
1481 Print the name of the game.
1484 \begin_layout Subsubsection
1488 \begin_layout Standard
1489 Adds new author <author>.
1490 If <author> does not contain '|' it is full name.
1491 If it contains '|', '|' splits the full name and nickname.
1494 \begin_layout Subsubsection
1495 edit-author <num> <author>
1498 \begin_layout Standard
1499 Edit the author in slot <num> (0-based) to be <author> (see add-author for
1503 \begin_layout Subsubsection
1507 \begin_layout Standard
1508 Remove author in slot <num>
1511 \begin_layout Subsubsection
1515 \begin_layout Standard
1519 \begin_layout Subsubsection
1520 test-1, test-2, test-3
1523 \begin_layout Standard
1524 Internal test commands.
1528 \begin_layout Subsubsection
1529 take-screenshot <filename>
1532 \begin_layout Standard
1533 Save screenshot to <filename>.
1536 \begin_layout Subsubsection
1537 +controller<num><button>
1540 \begin_layout Standard
1541 Press button <button> on controller <num> (1-8).
1542 The following button names are known:
1545 \begin_layout Itemize
1549 \begin_layout Itemize
1553 \begin_layout Itemize
1557 \begin_layout Itemize
1561 \begin_layout Itemize
1565 \begin_layout Itemize
1569 \begin_layout Itemize
1573 \begin_layout Itemize
1577 \begin_layout Itemize
1581 \begin_layout Itemize
1585 \begin_layout Itemize
1589 \begin_layout Itemize
1593 \begin_layout Itemize
1597 \begin_layout Itemize
1601 \begin_layout Itemize
1605 \begin_layout Itemize
1609 \begin_layout Subsubsection
1610 controllerh<num><button>
1613 \begin_layout Standard
1614 Hold/unhold button <button> on controller <num> (1-8).
1615 See +controller for button names.
1618 \begin_layout Subsubsection
1619 autofire (<pattern>|-)...
1622 \begin_layout Standard
1623 Set autofire pattern.
1624 Each parameter is comma-separated list of button names (in form of 1start,
1625 1A, 2B, etc..) to hold on that frame.
1626 After reaching the end of pattern, the pattern restarts from the beginning.
1629 \begin_layout Subsubsection
1633 \begin_layout Standard
1637 \begin_layout Subsection
1641 \begin_layout Subsubsection
1642 cycle-jukebox-backward
1645 \begin_layout Standard
1646 Cycle save jukebox backwards.
1649 \begin_layout Subsubsection
1650 cycle-jukebox-forward
1653 \begin_layout Standard
1654 Cycle save jukebox forwards
1657 \begin_layout Subsubsection
1658 add-jukebox-save <filename>
1661 \begin_layout Standard
1662 Add <filename> to jukebox saves.
1665 \begin_layout Subsubsection
1669 \begin_layout Standard
1670 Do load from jukebox (current mode).
1673 \begin_layout Subsubsection
1677 \begin_layout Standard
1678 Do state save to jukebox.
1681 \begin_layout Subsection
1685 \begin_layout Standard
1686 Only available if lua support is compiled in.
1689 \begin_layout Subsubsection
1690 evaluate-lua <luacode>
1693 \begin_layout Standard
1694 Run Lua code <luacode> using built-in Lua interpretter.
1697 \begin_layout Subsubsection
1701 \begin_layout Standard
1702 Run specified lua file using built-in Lua interpretter.
1705 \begin_layout Subsection
1709 \begin_layout Subsubsection
1710 add-watch <name> <expression>
1713 \begin_layout Standard
1714 Adds new watch (or modifies old one).
1717 \begin_layout Subsubsection
1721 \begin_layout Standard
1725 \begin_layout Subsection
1729 \begin_layout Subsubsection
1730 enable-sound <on/off>
1733 \begin_layout Standard
1734 Enable/Disable sound.
1737 \begin_layout Subsubsection
1738 set-sound-device <device>
1741 \begin_layout Standard
1742 Set sound device to <device>
1745 \begin_layout Subsubsection
1749 \begin_layout Standard
1750 Show status of sound system.
1753 \begin_layout Subsubsection
1757 \begin_layout Standard
1758 Show all available devices.
1761 \begin_layout Subsubsection
1762 set-volume <multiplier>
1765 \begin_layout Standard
1766 Set the volume multiplier to <multiplier>.
1767 1 is normal volume, and higher numbers are louder.
1770 \begin_layout Subsubsection
1771 set-volume <multiplier>%
1774 \begin_layout Standard
1775 Set the volume multiplier to <multiplier> percent.
1776 100 is normal volume, and higher numbers are louder.
1779 \begin_layout Subsubsection
1780 set-volume <multiplier>dB
1783 \begin_layout Standard
1784 Set the volume multiplier to <multiplier> dB.
1785 0 is normal volume, and higher numbers are louder.
1786 The value may be negative.
1789 \begin_layout Subsection
1790 SDL Platform commands
1793 \begin_layout Standard
1794 The following are valid on SDL platform.
1797 \begin_layout Subsubsection
1801 \begin_layout Standard
1802 Asks to press a key and then identifies that (pseudo-)key.
1805 \begin_layout Subsubsection
1809 \begin_layout Standard
1810 Toggle between windowed/fullscreen console.
1813 \begin_layout Subsubsection
1817 \begin_layout Standard
1818 Scroll messages window as far back as it goes.
1821 \begin_layout Subsubsection
1825 \begin_layout Standard
1826 Scroll messages window as far forward as it goes.
1829 \begin_layout Subsubsection
1833 \begin_layout Standard
1834 Scroll messages window back one screenful.
1837 \begin_layout Subsubsection
1841 \begin_layout Standard
1842 Scroll messages window forward one screenful.
1845 \begin_layout Section
1849 \begin_layout Subsection
1853 \begin_layout Subsubsection
1857 \begin_layout Standard
1858 Set where bsnes looks for firmware files.
1860 \begin_inset Quotes eld
1864 \begin_inset Quotes erd
1870 \begin_layout Subsubsection
1874 \begin_layout Standard
1876 Numeric, range is 0.001 to
1877 \begin_inset Quotes eld
1881 \begin_inset Quotes erd
1885 Default is native framerate.
1888 \begin_layout Subsubsection
1892 \begin_layout Standard
1893 Set save compression level (integer 0-9).
1894 Default is 7 (0 is no compression).
1897 \begin_layout Subsubsection
1901 \begin_layout Standard
1902 Set the frame advance timeout in milliseconds.
1903 Numeric integer, range is 0-999999999.
1907 \begin_layout Subsection
1911 \begin_layout Subsubsection
1915 \begin_layout Standard
1916 AVI dumper: Always dump at 512x448 or 512x478 regardless of what the console
1920 \begin_layout Subsubsection
1924 \begin_layout Standard
1925 AVI dumper: Set the default left border thickness (unless lua overrides)
1931 \begin_layout Subsubsection
1935 \begin_layout Standard
1936 AVI dumper: Set the default right border thickness (unless lua overrides)
1942 \begin_layout Subsubsection
1946 \begin_layout Standard
1947 AVI dumper: Set the default top border thickness (unless lua overrides)
1953 \begin_layout Subsubsection
1957 \begin_layout Standard
1958 AVI dumper: Set the default bottom border thickness (unless lua overrides)
1964 \begin_layout Subsubsection
1968 \begin_layout Standard
1969 AVI dumper: Maximum number of frames per dump segment (0 => unlimited).
1974 \begin_layout Subsubsection
1978 \begin_layout Standard
1979 AVI dumper: Compression level (0-18).
1982 \begin_layout Itemize
1983 Compression levels 10 and above are not compatible with stock CSCD codec.
1986 \begin_layout Itemize
1987 Recomended level is 7.
1990 \begin_layout Subsubsection
1994 \begin_layout Standard
1995 AVI dumper: Set method of determining the sound rate.
1998 \begin_layout Itemize
1999 0: Pick nearest of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48, 64, 88.2, 96,
2000 128, 176.4 and 192 kHz.
2003 \begin_layout Itemize
2004 1: Round down to nearest integer.
2007 \begin_layout Itemize
2008 2: Round up to nearest ingeter.
2011 \begin_layout Subsection
2015 \begin_layout Subsubsection
2019 \begin_layout Standard
2020 JMD dumper: Compression level (0-9).
2023 \begin_layout Subsection
2024 SDL platform settings
2027 \begin_layout Subsubsection
2028 autorepeat-first-delay
2031 \begin_layout Standard
2032 Sets the delay for first character in typematic autorepeat.
2035 \begin_layout Subsubsection
2036 autorepeat-subsequent-delay
2039 \begin_layout Standard
2040 Sets the delay for subsequent characters in typematic autorepeat.
2043 \begin_layout Section
2047 \begin_layout Subsection
2048 Core (in main table)
2051 \begin_layout Subsubsection
2055 \begin_layout Standard
2056 Print line to message console.
2059 \begin_layout Subsubsection
2060 exec(string command)
2063 \begin_layout Standard
2064 Run command as it was entered on the command line
2067 \begin_layout Subsubsection
2071 \begin_layout Standard
2073 First is time since some epoch in seconds, the second is microseconds mod
2074 10^6 since that epoch.
2077 \begin_layout Subsubsection
2081 \begin_layout Standard
2082 Returns true if emulator has finished booting, false if not (on_startup()
2083 will be issued later).
2086 \begin_layout Subsubsection
2087 set_idle_timeout(number timeout)
2090 \begin_layout Standard
2091 Set number of microseconds to block idle for.
2092 After this timeout has expired, on_idle() will be called once.
2095 \begin_layout Subsubsection
2096 set_timer_timeout(number timeout)
2099 \begin_layout Standard
2100 Set number of microseconds to block timer for.
2101 After this timeout has expired, on_timer() will be called once.
2104 \begin_layout Subsection
2108 \begin_layout Standard
2109 Bitwise logical functions and related.
2112 \begin_layout Subsubsection
2113 bit.none(number...) / bit.bnot(number...)
2116 \begin_layout Standard
2117 48-bit bitwise NOT / NONE function (set bits that are set in none of the
2121 \begin_layout Subsubsection
2122 bit.any(number...) / bit.bor(number...)
2125 \begin_layout Standard
2126 48-bit bitwise OR / ANY function (set bits that are set in any of the arguments).
2129 \begin_layout Subsubsection
2130 bit.all(number...) / bit.band(number...)
2133 \begin_layout Standard
2134 48-bit bitwise AND / ALL function (set bits that are set in all of the arguments
2138 \begin_layout Subsubsection
2139 bit.parity(number...) / bit.bxor(number...)
2142 \begin_layout Standard
2143 48-bit bitwise XOR / PARITY function (set bits that are set in odd number
2147 \begin_layout Subsubsection
2148 bit.lrotate(number base[, number amount[, number bits]])
2151 \begin_layout Standard
2152 Rotate bits-bit (max 48, default 48) number left by amount (default 1) places.
2155 \begin_layout Subsubsection
2156 bit.rrotate(number base[, number amount[, number bits]])
2159 \begin_layout Standard
2160 Rotate bits-bit (max 48, default 48) number right by amount (default 1)
2164 \begin_layout Subsubsection
2165 bit.lshift(number base[, number amount[, number bits]])
2168 \begin_layout Standard
2169 Shift bits-bit (max 48, default 48) number left by amount (default 1) places.
2170 The new bits are filled with zeroes.
2173 \begin_layout Subsubsection
2174 bit.lrshift(number base[, number amount[, number bits]])
2177 \begin_layout Standard
2178 Shift bits-bit (max 48, default 48) number logically right by amount (default
2180 The new bits are filled with zeroes.
2183 \begin_layout Subsubsection
2184 bit.arshift(number base[, number amount[, number bits]])
2187 \begin_layout Standard
2188 Shift bits-bit (max 48, default 48) number arithmetically right by amount
2190 The new bits are shifted in with copy of the high bit.
2193 \begin_layout Subsubsection
2194 bit.extract(number base[, number bit0[, number bit1,...]])
2197 \begin_layout Standard
2198 Returns number that has bit0-th bit as bit 0, bit1-th bit as 1 and so on.
2201 \begin_layout Standard
2205 \begin_layout Itemize
2206 Bit numbers up to 51 should work reliably (then things start falling apart
2207 due to double precision issues).
2210 \begin_layout Itemize
2211 There are two special bit positions, true and false, standing for always
2212 set bit and always clear bit.
2215 \begin_layout Subsubsection
2216 bit.value([number bit1[, number bit2,...]])
2219 \begin_layout Standard
2220 Returns bitwise OR of 1 left shifted by bit1 places, 1 left shifted by bit2
2222 As special value, nil argument is no-op.
2225 \begin_layout Subsection
2229 \begin_layout Standard
2230 Most of these functions can only be called in on_paint and on_video callbacks.
2231 Exceptions are noted.
2234 \begin_layout Standard
2236 Bits 0-7 are the blue component, bits 8-15 are the green component, bits
2237 16-23 are the red component, bits 24-31 are alpha component (0 is fully
2238 opaque, 255 is almost transparent).
2239 -1 is the fully transparent color.
2240 Alpha values greater than 127 do work.
2243 \begin_layout Standard
2244 Origin of coordinates is at top left corner of game display area.
2245 Left and top gaps correspond to negative coordinates.
2248 \begin_layout Subsubsection
2252 \begin_layout Standard
2253 Returns 2-tuple (hresolution, vresolution).
2256 \begin_layout Subsubsection
2257 gui.<class>_gap(number gap)
2260 \begin_layout Standard
2261 Set the <class> (left, right, top, bottom) gap to specified value (max gap
2265 \begin_layout Subsubsection
2266 gui.text(number x, number y, string text[, number fgc[, number bgc]])
2269 \begin_layout Standard
2270 Draw specified text on the GUI (each character cell is 8 or 16 wide and
2275 \begin_layout Itemize
2276 x: X-coordinate to start the drawing from (and x-coordinate at begining
2280 \begin_layout Itemize
2281 y: Y-coordinate to start the drawing from.
2284 \begin_layout Itemize
2285 text: The text to draw.
2288 \begin_layout Itemize
2289 fgc: Text color (default is 0xFFFFFF (white))
2292 \begin_layout Itemize
2293 bgc: Background color (default is -1 (transparent))
2296 \begin_layout Subsubsection
2297 gui.textH(number x, number y, string text[, number fgc[, number bgc]])
2300 \begin_layout Standard
2301 Like gui.text, but draw using double-width.
2304 \begin_layout Subsubsection
2305 gui.textV(number x, number y, string text[, number fgc[, number bgc]])
2308 \begin_layout Standard
2309 Like gui.text, but draw using double-height.
2312 \begin_layout Subsubsection
2313 gui.textHV(number x, number y, string text[, number fgc[, number bgc]])
2316 \begin_layout Standard
2317 Like gui.text, but draw using double-width/double-height.
2320 \begin_layout Subsubsection
2321 gui.rectangle(number x, number y, number width, number height[, number thickness[
2322 , number outline[, number fill]]])
2325 \begin_layout Standard
2326 Draw rectangle on the GUI.
2330 \begin_layout Itemize
2331 x: X-coordinate of left edge.
2334 \begin_layout Itemize
2335 y: Y-coordinate of upper edge.
2338 \begin_layout Itemize
2339 width: Width of rectangle.
2342 \begin_layout Itemize
2343 height: Height of rectangle.
2346 \begin_layout Itemize
2347 thickness: Thickness of outline (default is 1).
2350 \begin_layout Itemize
2351 outline: Color of outline (default is 0xFFFFFF (white))
2354 \begin_layout Itemize
2355 fill: Color of fil (default is -1 (transparent))
2358 \begin_layout Subsubsection
2359 gui.pixel(number x, number y[, number color])
2362 \begin_layout Standard
2363 Draw one pixel on the GUI.
2367 \begin_layout Itemize
2368 x: X-coordinate of the pixel
2371 \begin_layout Itemize
2372 y: Y-coordinate of the pixel
2375 \begin_layout Itemize
2376 color: Color of the pixel (default is 0xFFFFFF (white))
2379 \begin_layout Subsubsection
2380 gui.crosshair(number x, number y[, number length[, number color]])
2383 \begin_layout Standard
2388 \begin_layout Itemize
2389 x: X-coordinate of the crosshair
2392 \begin_layout Itemize
2393 y: Y-coordinate of the crosshair
2396 \begin_layout Itemize
2397 length: Length of the crosshair lines (default 10).
2400 \begin_layout Itemize
2401 color: Color of the crosshair (default is 0xFFFFFF (white))
2404 \begin_layout Subsubsection
2405 gui.line(number x1, number y1, number x2, number y2[, number color])
2408 \begin_layout Standard
2413 \begin_layout Itemize
2414 x1: X-coordinate of one end.
2417 \begin_layout Itemize
2418 y1: Y-coordinate of one end.
2421 \begin_layout Itemize
2422 x2: X-coordinate of the other end.
2425 \begin_layout Itemize
2426 y2: Y-coordinate of the other end.
2429 \begin_layout Itemize
2430 color: Color of the line (default is 0xFFFFFF (white)).
2433 \begin_layout Subsubsection
2434 gui.circle(number x, number y, number r[, number thick[, number border[,
2438 \begin_layout Standard
2443 \begin_layout Itemize
2444 x: X-coordinate of the center
2447 \begin_layout Itemize
2448 y: Y-coordinate of the center
2451 \begin_layout Itemize
2452 r: The radius of the circle
2455 \begin_layout Itemize
2456 thick: Border thickness
2459 \begin_layout Itemize
2460 border: Border color (default is 0xFFFFFF (white))
2463 \begin_layout Itemize
2464 fill: Fill color (default is -1 (transparent)).
2467 \begin_layout Subsubsection
2468 gui.bitmap_draw(number x, number y, bitmap bitmap, palette palette)
2471 \begin_layout Standard
2472 Draw a bitmap on screen with specified palette.
2476 \begin_layout Itemize
2477 x: X-coordinate of left edge.
2480 \begin_layout Itemize
2481 y: Y-coordinate of top edge.
2484 \begin_layout Itemize
2485 bitmap: The bitmap to draw
2488 \begin_layout Itemize
2489 palette: The palette to draw the bitmap using.
2492 \begin_layout Subsubsection
2493 gui.bitmap_draw(number x, number y, dbitmap bitmap)
2496 \begin_layout Standard
2497 Draw a bitmap on screen.
2501 \begin_layout Itemize
2502 x: X-coordinate of left edge.
2505 \begin_layout Itemize
2506 y: Y-coordinate of top edge.
2509 \begin_layout Itemize
2510 bitmap: The bitmap to draw
2513 \begin_layout Subsubsection
2517 \begin_layout Standard
2518 Returns a new palette (initially all transparent).
2519 Can be used anywhere.
2522 \begin_layout Subsubsection
2523 gui.bitmap_new(number w, number h, boolean direct[, bool icolor])
2526 \begin_layout Standard
2527 Returns a new bitmap/dbitmap.
2528 Can be used anywhere.
2532 \begin_layout Itemize
2533 w: The width of new bitmap
2536 \begin_layout Itemize
2537 h: The height of new bitmap
2540 \begin_layout Itemize
2541 direct: If true, the returned bitmap is dbitmap, otherwise bitmap.
2544 \begin_layout Itemize
2545 icolor: Initital fill color (defaults to 0 on BITMAP, -1 on DBITMAP)
2548 \begin_layout Subsubsection
2549 gui.bitmap_load(string file)
2552 \begin_layout Standard
2553 Returns loaded bitmap/dbitmap (if bitmap, the second return value is palette
2555 Can be used anywhere.
2559 \begin_layout Itemize
2560 file: The name of file to load.
2563 \begin_layout Subsubsection
2564 gui.palette_set(palette palette, number index, number color)
2567 \begin_layout Standard
2568 Sets color in palette.
2569 Can be used anywhere.
2573 \begin_layout Itemize
2574 palette: The palette to manipulate
2577 \begin_layout Itemize
2578 index: Index of color (0-65535).
2581 \begin_layout Itemize
2582 color: The color value.
2585 \begin_layout Subsubsection
2586 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y, number color)
2589 \begin_layout Standard
2590 Sets specified pixel in bitmap.
2591 Can be used anywhere.
2595 \begin_layout Itemize
2596 bitmap: The bitmap to manipulate
2599 \begin_layout Itemize
2600 x: The x-coordinate of the pixel.
2603 \begin_layout Itemize
2604 y: The y-coordinate of the pixel.
2607 \begin_layout Itemize
2608 color: If bitmap is a bitmap, color index (0-65535).
2609 Otherwise color value.
2612 \begin_layout Subsubsection
2613 gui.bitmap_size(bitmap/dbitmap bitmap)
2616 \begin_layout Standard
2618 Can be used anywhere.
2622 \begin_layout Itemize
2623 bitmap: The bitmap to query.
2626 \begin_layout Standard
2627 The first return is the width, the second is the height.
2630 \begin_layout Subsubsection
2631 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy, bitmap/dbitmap
2632 src, number sx, number sy, number w, number h[, number ck])
2635 \begin_layout Standard
2636 Blit a part of bitmap to another.
2637 Can be used anywhere.
2641 \begin_layout Itemize
2642 dest: Destination to blit to.
2645 \begin_layout Itemize
2646 dx: left edge of target
2649 \begin_layout Itemize
2650 dy: Top edge of target
2653 \begin_layout Itemize
2654 src: The source to blit from.
2655 Must be of the same type as destination.
2658 \begin_layout Itemize
2659 sx: left edge of source
2662 \begin_layout Itemize
2663 sy: Top edge of source
2666 \begin_layout Itemize
2670 \begin_layout Itemize
2671 h: Height of region.
2674 \begin_layout Itemize
2676 Pixels of this color are not blitted.
2680 \begin_layout Itemize
2681 If bitmaps are bitmaps, this is color index of colorkey.
2682 Values outside range 0-65535 cause no key to be used as colorkey.
2685 \begin_layout Itemize
2686 If bitmaps are dbitmaps, this color value of colorkey.
2689 \begin_layout Itemize
2690 May be absent or nil for no colorkey blit.
2694 \begin_layout Subsubsection
2698 \begin_layout Standard
2699 Request on_repaint() to happen as soon as possible.
2700 Can be used anywhere.
2703 \begin_layout Subsubsection
2704 gui.subframe_update(boolean on)
2707 \begin_layout Standard
2708 Request subframe updates (calling on_paint() on subframes) to happen (on=true)
2709 or not happen (on=false).
2710 Can be used anywhere.
2713 \begin_layout Subsubsection
2714 gui.screenshot(string filename)
2717 \begin_layout Standard
2718 Write PNG screenshot of the current frame (no drawings) to specified file.
2719 Can be used anywhere.
2722 \begin_layout Subsubsection
2723 gui.color(number r, number g, number b[, number a])
2726 \begin_layout Standard
2727 Returns color (in notation Lua scripts use) corresponding to color (r,g,b),
2728 each component in scale 0-255.
2729 If a is specified, that is alpha (0 is fully transparent, 256(sic) is fully
2731 The default alpha is 256.
2734 \begin_layout Subsubsection
2735 gui.status(string name, string value)
2738 \begin_layout Standard
2740 \begin_inset Quotes eld
2744 \begin_inset Quotes erd
2747 to <value> in status area.
2748 Can be used anywhere.
2751 \begin_layout Subsubsection
2752 gui.rainbow(number step, number steps[, number color])
2755 \begin_layout Standard
2756 Perform hue rotation of color <color> (default bright red), by <step> steps.
2757 The number of steps per full rotation is given by absolute value of <steps>.
2760 \begin_layout Standard
2761 If <steps> is negative, the rotation will be counterclockwise.
2764 \begin_layout Subsection
2768 \begin_layout Standard
2770 Only available in on_input callback.
2773 \begin_layout Subsubsection
2774 input.get(number controller, number index)
2777 \begin_layout Standard
2778 Read the specified index (0-11) from specified controller (0-7).
2782 \begin_layout Itemize
2783 Uses physical controller numbering.
2784 Gamepad in port 2 is controller 4, not 1!
2787 \begin_layout Subsubsection
2788 input.set(number controller, number index, number value)
2791 \begin_layout Standard
2792 Write the specified index (0-11) from specified controller (0-7), storing
2797 \begin_layout Itemize
2798 Uses physical controller numbering.
2799 Gamepad in port 2 is controller 4, not 1!
2802 \begin_layout Subsubsection
2803 input.geta(number controller)
2806 \begin_layout Standard
2807 Get input state for entiere controller.
2808 Returns 13 return values.
2811 \begin_layout Itemize
2812 1st return value: Bitmask: bit i is set if i:th index is nonzero
2815 \begin_layout Itemize
2816 2nd-13th return value: value of i:th index.
2819 \begin_layout Subsubsection
2820 input.seta(number controller, number bitmask, number args...)
2823 \begin_layout Standard
2824 Set state for entiere controller.
2825 args is up to 12 values for indices (overriding values in bitmask if specified).
2828 \begin_layout Subsubsection
2829 input.controllertype(number controller)
2832 \begin_layout Standard
2833 Get the type of controller as string.
2837 \begin_layout Itemize
2841 \begin_layout Itemize
2845 \begin_layout Itemize
2849 \begin_layout Itemize
2853 \begin_layout Subsubsection
2854 input.reset([number cycles])
2857 \begin_layout Standard
2859 If cycles is greater than zero, do delayed reset.
2860 0 (or no value) causes immediate reset.
2863 \begin_layout Itemize
2864 Only available with subframe flag false.
2867 \begin_layout Subsubsection
2871 \begin_layout Standard
2872 Returns table of tables of all available keys and axes.
2873 The first table is indexed by key name (platform-dependent!), and the inner
2874 table has the following fields:
2877 \begin_layout Itemize
2878 last_rawval: Last reported raw value for control.
2881 \begin_layout Itemize
2882 ktype: Type of key (disabled, key, mouse, axis, axis-inverse, hat, pressure-m0,
2883 pressure-mp, pressure-0m, pressure-0p, pressure-pm, pressure-p0).
2886 \begin_layout Itemize
2887 cal_left: Minimum calibration value.
2888 Only meaningful with axis and pressure types.
2891 \begin_layout Itemize
2892 cal_center: Center calibration value.
2893 Only meaningful with axis and pressure types.
2896 \begin_layout Itemize
2897 cal_right: Maximum calibration value.
2898 Only meaningful with axis and pressure types.
2901 \begin_layout Itemize
2902 cal_tolerance: Dead zone tolerance.
2903 Only meaningful with axis and pressure types.
2906 \begin_layout Subsubsection
2907 input.keyhook(key, state)
2910 \begin_layout Standard
2911 Requests that keyhook events to be sent for key (state=true) or not sent
2915 \begin_layout Subsection
2919 \begin_layout Standard
2920 Host memory handling (extra memory saved to savestates).
2921 Host memory starts empty.
2924 \begin_layout Subsubsection
2925 hostmemory.read(number address)
2928 \begin_layout Standard
2929 Reads hostmemory slot address.
2930 Slot numbers out of range return false instead of numeric.
2933 \begin_layout Subsubsection
2934 hostmemory.write(number address, number value)
2937 \begin_layout Standard
2938 Writes hostmemory slot with 0-255.
2939 Slot numbers out of range cause extension of host memory slot space.
2942 \begin_layout Subsubsection
2943 hostmemory.readbyte(number address)
2946 \begin_layout Standard
2947 Read unsigned byte (1 element) from given address.
2948 Slots out of range return false.
2951 \begin_layout Subsubsection
2952 hostmemory.writebyte(number address, number value)
2955 \begin_layout Standard
2956 Write unsigned byte (1 element) to given slot.
2957 Slot numbers out of range cause extension.
2960 \begin_layout Subsubsection
2961 hostmemory.readsbyte(number address)
2964 \begin_layout Standard
2965 Read signed byte (1 element) from given address.
2966 Slots out of range return false.
2969 \begin_layout Subsubsection
2970 hostmemory.writesbyte(number address, number value)
2973 \begin_layout Standard
2974 Write signed byte (1 element) to given slot.
2975 Slot numbers out of range cause extension.
2978 \begin_layout Subsubsection
2979 hostmemory.readword(number address)
2982 \begin_layout Standard
2983 Read unsigned word (2 elements) from given address.
2984 Slots out of range return false.
2987 \begin_layout Subsubsection
2988 hostmemory.writeword(number address, number value)
2991 \begin_layout Standard
2992 Write unsigned word (2 elements) to given slot.
2993 Slot numbers out of range cause extension.
2996 \begin_layout Subsubsection
2997 hostmemory.readsword(number address)
3000 \begin_layout Standard
3001 Read signed word (2 elements) from given address.
3002 Slots out of range return false.
3005 \begin_layout Subsubsection
3006 hostmemory.writesword(number address, number value)
3009 \begin_layout Standard
3010 Write signed word (2 elements) to given slot.
3011 Slot numbers out of range cause extension.
3014 \begin_layout Subsubsection
3015 hostmemory.readdword(number address)
3018 \begin_layout Standard
3019 Read unsigned doubleword (4 elements) from given address.
3020 Slots out of range return false.
3023 \begin_layout Subsubsection
3024 hostmemory.writedword(number address, number value)
3027 \begin_layout Standard
3028 Write unsigned doubleword (4 elements) to given slot.
3029 Slot numbers out of range cause extension.
3032 \begin_layout Subsubsection
3033 hostmemory.readsdword(number address)
3036 \begin_layout Standard
3037 Read signed doubleword (4 elements) from given address.
3038 Slots out of range return false.
3041 \begin_layout Subsubsection
3042 hostmemory.writesdword(number address, number value)
3045 \begin_layout Standard
3046 Write signed doubleword (4 elements) to given slot.
3047 Slot numbers out of range cause extension.
3050 \begin_layout Subsubsection
3051 hostmemory.readqword(number address)
3054 \begin_layout Standard
3055 Read unsigned quadword (8 elements) from given address.
3056 Slots out of range return false.
3059 \begin_layout Subsubsection
3060 hostmemory.writeqword(number address, number value)
3063 \begin_layout Standard
3064 Write unsigned quadword (4 elements) to given slot.
3065 Slot numbers out of range cause extension.
3068 \begin_layout Subsubsection
3069 hostmemory.readsqword(number address)
3072 \begin_layout Standard
3073 Read signed quadword (8 elements) from given address.
3074 Slots out of range return false.
3077 \begin_layout Subsubsection
3078 hostmemory.writesqword(number address, number value)
3081 \begin_layout Standard
3082 Write signed quadword (8 elements) to given slot.
3083 Slot numbers out of range cause extension.
3086 \begin_layout Subsection
3090 \begin_layout Standard
3094 \begin_layout Subsubsection
3095 movie.currentframe()
3098 \begin_layout Standard
3099 Return number of current frame.
3102 \begin_layout Subsubsection
3106 \begin_layout Standard
3107 Return number of frames in movie.
3110 \begin_layout Subsubsection
3114 \begin_layout Standard
3115 Return true if in readonly mode, false if in readwrite.
3118 \begin_layout Subsubsection
3119 movie.set_readwrite()
3122 \begin_layout Standard
3123 Set readwrite mode (does not cause on_readwrite callback).
3126 \begin_layout Subsubsection
3127 movie.frame_subframes(number frame)
3130 \begin_layout Standard
3131 Count number of subframes in specified frame (frame numbers are 1-based)
3135 \begin_layout Subsubsection
3136 movie.read_subframe(number frame, number subframe)
3139 \begin_layout Standard
3140 Read specifed subframe in specified frame and return data as array (100
3141 elements, numbered 0-99 currently).
3144 \begin_layout Subsection
3148 \begin_layout Standard
3149 Routines for settings manipulation
3152 \begin_layout Subsubsection
3153 settings.get(string name)
3156 \begin_layout Standard
3157 Get value of setting.
3158 If setting is blank, returns false.
3159 If setting value can't be obtained, returns (nil, error message).
3162 \begin_layout Subsubsection
3163 settings.set(string name, string value)
3166 \begin_layout Standard
3167 Set value of setting.
3168 If setting can't be set, returns (nil, error message).
3171 \begin_layout Subsubsection
3172 settings.is_set(string name)
3175 \begin_layout Standard
3176 Returns if setting is set.
3177 If setting does not exist, returns (nil, error message).
3180 \begin_layout Subsubsection
3181 settings.blank(string name)
3184 \begin_layout Standard
3185 Blanks a setting and returns true.
3186 If setting can't be blanked, returns (nil, error message).
3189 \begin_layout Subsection
3193 \begin_layout Standard
3194 Contains various functions for managing memory
3197 \begin_layout Subsubsection
3201 \begin_layout Standard
3202 Returns the number of VMAs
3205 \begin_layout Subsubsection
3206 memory.read_vma(number index)
3209 \begin_layout Standard
3210 Reads the specified VMA (indices start from zero).
3211 Trying to read invalid VMA gives nil.
3212 The read VMA is table with the following fields:
3215 \begin_layout Itemize
3216 region_name (string): The readable name of the VMA
3219 \begin_layout Itemize
3220 baseaddr (number): Base address of the VMA
3223 \begin_layout Itemize
3224 lastaddr (number): Last address in the VMA.
3227 \begin_layout Itemize
3228 size (number): The size of VMA in bytes.
3231 \begin_layout Itemize
3232 readonly (boolean): True of the VMA corresponds to ROM.
3235 \begin_layout Itemize
3236 native_endian (boolean): True if the VMA has native endian as opposed to
3240 \begin_layout Subsubsection
3241 memory.find_vma(number address)
3244 \begin_layout Standard
3245 Finds the VMA containing specified address.
3246 Returns table in the same format as read_vma or nil if not found.
3249 \begin_layout Subsubsection
3250 memory.readbyte(number address)
3253 \begin_layout Standard
3254 Reads the specified address as unsigned byte and returns the result.
3257 \begin_layout Subsubsection
3258 memory.readsbyte(number address)
3261 \begin_layout Standard
3262 Reads the specified address as signed byte and returns the result.
3265 \begin_layout Subsubsection
3266 memory.writebyte(number address, number value)
3269 \begin_layout Standard
3270 Writes the specified value (negative values undergo 2's complement) to specified
3271 address (as a byte).
3274 \begin_layout Subsubsection
3275 memory.readword(number address)
3278 \begin_layout Standard
3279 Reads the specified address as unsigned word and returns the result.
3282 \begin_layout Subsubsection
3283 memory.readsword(number address)
3286 \begin_layout Standard
3287 Reads the specified address as signed word and returns the result.
3290 \begin_layout Subsubsection
3291 memory.writeword(number address, number value)
3294 \begin_layout Standard
3295 Writes the specified value (negative values undergo 2's complement) to specified
3296 address (as a word).
3299 \begin_layout Subsubsection
3300 memory.readdword(number address)
3303 \begin_layout Standard
3304 Reads the specified address as unsigned doubleword and returns the result.
3307 \begin_layout Subsubsection
3308 memory.readsdword(number address)
3311 \begin_layout Standard
3312 Reads the specified address as signed doubleword and returns the result.
3315 \begin_layout Subsubsection
3316 memory.writedword(number address, number value)
3319 \begin_layout Standard
3320 Writes the specified value (negative values undergo 2's complement) to specified
3321 address (as a doubleword).
3324 \begin_layout Subsubsection
3325 memory.readqword(number address)
3328 \begin_layout Standard
3329 Reads the specified address as unsigned quadword and returns the result.
3332 \begin_layout Subsubsection
3333 memory.readsqword(number address)
3336 \begin_layout Standard
3337 Reads the specified address as signed quadword and returns the result.
3340 \begin_layout Subsubsection
3341 memory.writeqword(number address, number value)
3344 \begin_layout Standard
3345 Writes the specified value (negative values undergo 2's complement) to specified
3346 address (as a quadword).
3349 \begin_layout Subsection
3353 \begin_layout Standard
3354 Contains copy of global variables from time of Lua initialization.
3358 \begin_layout Subsection
3362 \begin_layout Standard
3363 Various callbacks to Lua that can occur.
3366 \begin_layout Subsubsection
3367 Callback: on_paint(bool not_synth)
3370 \begin_layout Standard
3371 Called when screen is being painted.
3372 Any gui.* calls requiring graphic context draw on the screen.
3375 \begin_layout Standard
3376 not_synth is true if this hook is being called in response to received frame,
3380 \begin_layout Subsubsection
3381 Callback: on_video()
3384 \begin_layout Standard
3385 Called when video dump frame is being painted.
3386 Any gui.* calls requiring graphic context draw on the video.
3389 \begin_layout Subsubsection
3390 Callback: on_frame_emulated()
3393 \begin_layout Standard
3394 Called when emulating frame has completed and on_paint()/on_video() calls
3395 are about to be issued.
3398 \begin_layout Subsubsection
3399 Callback: on_frame()
3402 \begin_layout Standard
3403 Called on each starting whole frame.
3406 \begin_layout Subsubsection
3407 Callback: on_startup()
3410 \begin_layout Standard
3411 Called when the emulator is starting (lsnes.rc and --run files has been run).
3414 \begin_layout Subsubsection
3415 Callback: on_rewind()
3418 \begin_layout Standard
3419 Called when rewind movie to beginning has completed.
3422 \begin_layout Subsubsection
3423 Callback: on_pre_load(string name)
3426 \begin_layout Standard
3427 Called just before savestate/movie load occurs (note: loads are always delayed,
3428 so this occurs even when load was initiated by lua).
3431 \begin_layout Subsubsection
3432 Callback: on_err_load(string name)
3435 \begin_layout Standard
3436 Called if loadstate goes wrong.
3439 \begin_layout Subsubsection
3440 Callback: on_post_load(string name, boolean was_savestate)
3443 \begin_layout Standard
3444 Called on successful loadstate.
3445 was_savestate gives if this was a savestate or a movie.
3448 \begin_layout Subsubsection
3449 Callback: on_pre_save(string name, boolean is_savestate)
3452 \begin_layout Standard
3453 Called just before savestate save occurs (note: movie saves are synchronous
3454 and won't trigger these callbacks if called from Lua).
3457 \begin_layout Subsubsection
3458 Callback: on_err_save(string name)
3461 \begin_layout Standard
3462 Called if savestate goes wrong.
3465 \begin_layout Subsubsection
3466 Callback: on_post_save(string name, boolean is_savestate)
3469 \begin_layout Standard
3470 Called on successful savaestate.
3471 is_savestate gives if this was a savestate or a movie.
3474 \begin_layout Subsubsection
3478 \begin_layout Standard
3479 Called when emulator is shutting down.
3482 \begin_layout Subsubsection
3483 Callback: on_input(boolean subframe)
3486 \begin_layout Standard
3487 Called when emulator is just sending input to bsnes core.
3488 Warning: This is called even in readonly mode, but the results are ignored.
3491 \begin_layout Subsubsection
3492 Callback: on_reset()
3495 \begin_layout Standard
3496 Called when SNES is reset.
3499 \begin_layout Subsubsection
3500 Callback: on_readwrite()
3503 \begin_layout Standard
3504 Called when moving into readwrite mode as result of
3505 \begin_inset Quotes eld
3509 \begin_inset Quotes erd
3512 command (note: moving to rwmode by Lua won't trigger this, as per recursive
3516 \begin_layout Subsubsection
3517 Callback: on_snoop(number port, number controller, number index, number
3521 \begin_layout Standard
3522 Called each time bsnes asks for input.
3523 The value is the final value to be sent to bsnes core (readonly mode, autohold
3524 and autofire have been taken into account).
3525 Might be useful when translating movies to format suitable for console
3527 Note: There is no way to modify the value to be sent.
3530 \begin_layout Subsubsection
3531 Callback: on_keyhook(string keyname, table state)
3534 \begin_layout Standard
3535 Sent when key that has keyhook events requested changes state.
3536 Keyname is name of the key (group) and state is the state (same kind as
3537 table values in input.raw).
3540 \begin_layout Subsubsection
3544 \begin_layout Standard
3545 Called when requested by set_idle_timeout(), the timeout has expired and
3546 emulator is waiting.
3549 \begin_layout Subsubsection
3550 Callback: on_timer()
3553 \begin_layout Standard
3554 Called when requested by set_idle_timeout() and the timeout has expired
3555 (regardless if emulator is waiting).
3558 \begin_layout Section
3559 Memory watch expression syntax
3562 \begin_layout Standard
3563 Memory watch expressions are in RPN (Reverse Polish Notation).
3564 At the end of expression, the top entry on stack is taken as the final
3568 \begin_layout Standard
3572 \begin_layout Itemize
3573 Evaluation order is strictly left to right.
3576 \begin_layout Itemize
3577 a is the entry on top of stack
3580 \begin_layout Itemize
3581 b is the entry immediately below top of stack
3584 \begin_layout Itemize
3585 ; separates values to be pushed (no intermediate pop).
3588 \begin_layout Itemize
3589 After end of element, all used stack slots are popped and all results are
3593 \begin_layout Itemize
3594 When pushing multiple values, the pushes occur in order shown.
3597 \begin_layout Standard
3598 The following operators are available:
3601 \begin_layout Itemize
3605 \begin_layout Itemize
3609 \begin_layout Itemize
3613 \begin_layout Itemize
3617 \begin_layout Itemize
3621 \begin_layout Itemize
3625 \begin_layout Itemize
3626 b : read_signed_byte(a)
3629 \begin_layout Itemize
3633 \begin_layout Itemize
3634 d : read_signed_dword(a)
3637 \begin_layout Itemize
3641 \begin_layout Itemize
3643 \begin_inset Formula $\pi$
3649 \begin_layout Itemize
3650 q : read_signed_qword(a)
3653 \begin_layout Itemize
3657 \begin_layout Itemize
3661 \begin_layout Itemize
3665 \begin_layout Itemize
3669 \begin_layout Itemize
3670 w : read_signed_word(a)
3673 \begin_layout Itemize
3677 \begin_layout Itemize
3678 B : read_unsigned_byte(a)
3681 \begin_layout Itemize
3682 C<number>z : Push number <number> to stack.
3685 \begin_layout Itemize
3686 D : read_unsigned_dword(a)
3689 \begin_layout Itemize
3690 C0x<number>z : Push number <number> (hexadecimal) to stack.
3693 \begin_layout Itemize
3694 Q : read_unsigned_qword(a)
3697 \begin_layout Itemize
3698 R<digit> : round a to <digit> digits.
3701 \begin_layout Itemize
3702 W : read_unsigned_word(a)
3705 \begin_layout Subsection
3709 \begin_layout Standard
3710 C0x007e0878zWC0x007e002czW-
3713 \begin_layout Enumerate
3714 Push value 0x7e0878 on top of stack (C0x007e0878z).
3717 \begin_layout Enumerate
3718 Pop the value on top of stack (0x7e0878), read word value at that address
3719 and push the result,call it x1 (W).
3722 \begin_layout Enumerate
3723 Push value 0x7e002c on top of stack (C0x007e002cz).
3726 \begin_layout Enumerate
3727 Pop the value on top of stack (0x7e002c), read word value at that address
3728 and push the result,call it x2 (W).
3731 \begin_layout Enumerate
3732 Pop the two top numbers on stack, x1 and x2, substract x1 from x2 and push
3736 \begin_layout Enumerate
3737 Since the expression ends, the final memory watch result is the top one
3738 on stack, which is x2 - x1.
3741 \begin_layout Section
3742 Modifier and key names:
3745 \begin_layout Subsection
3749 \begin_layout Subsubsection
3753 \begin_layout Standard
3754 Following modifier names are known:
3757 \begin_layout Itemize
3758 ctrl, lctrl, rctrl: Control keys
3761 \begin_layout Itemize
3762 alt, lalt, ralt: ALT keys.
3765 \begin_layout Itemize
3766 shift, lshift, rshift: Shift keys.
3769 \begin_layout Itemize
3770 meta, lmeta, rmeta: Meta keys.
3773 \begin_layout Itemize
3774 num, caps: Numlock/Capslock (these are sticky!)
3777 \begin_layout Itemize
3781 \begin_layout Subsubsection
3785 \begin_layout Standard
3786 Following key names are known:
3789 \begin_layout Itemize
3790 backspace, tab, clear, return, pause, escape, space, exclaim, quotedbl,
3791 hash, dollar, ampersand, quote, leftparen, rightparen, asterisk, plus,
3792 comma, minus, period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon,
3793 less, equals, greater, question, at, leftbracket, backslash, rightbracket,
3794 caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n,
3795 o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0, world_1, world_2,
3796 world_3, world_4, world_5, world_6, world_7, world_8, world_9, world_10,
3797 world_11, world_12, world_13, world_14, world_15, world_16, world_17, world_18,
3798 world_19, world_20, world_21, world_22, world_23, world_24, world_25, world_26,
3799 world_27, world_28, world_29, world_30, world_31, world_32, world_33, world_34,
3800 world_35, world_36, world_37, world_38, world_39, world_40, world_41, world_42,
3801 world_43, world_44, world_45, world_46, world_47, world_48, world_49, world_50,
3802 world_51, world_52, world_53, world_54, world_55, world_56, world_57, world_58,
3803 world_59, world_60, world_61, world_62, world_63, world_64, world_65, world_66,
3804 world_67, world_68, world_69, world_70, world_71, world_72, world_73, world_74,
3805 world_75, world_76, world_77, world_78, world_79, world_80, world_81, world_82,
3806 world_83, world_84, world_85, world_86, world_87, world_88, world_89, world_90,
3807 world_91, world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3, kp4,
3808 kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide, kp_multiply, kp_minus, kp_plus,
3809 kp_enter, kp_equals, up, down, right, left, insert, home, end, pageup,
3810 pagedown, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14,
3811 f15, numlock, capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt,
3812 lalt, rmeta, lmeta, lsuper, rsuper, mode, compose, help, print, sysreq,
3813 break, menu, power, euro, undo
3816 \begin_layout Itemize
3817 Names of form 'key<n>' where <n> is 0-255 are interpretted as key having
3818 hardware-dependent scan code of <n> (useful to bind those keys that don't
3819 have symbolic names).
3822 \begin_layout Subsubsection
3823 Joystick pseudo-keys:
3826 \begin_layout Itemize
3827 joystick<num>button<button>: Joystick <num> (0-based) button <button> (0-based).
3830 \begin_layout Itemize
3831 joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat> (0-based) up.
3834 \begin_layout Itemize
3835 joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat> (0-based) left.
3838 \begin_layout Itemize
3839 joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat> (0-based) down.
3842 \begin_layout Itemize
3843 joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat> (0-based) right.
3846 \begin_layout Itemize
3847 joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis> negative
3848 position (axis modes axis and axis_inverse).
3851 \begin_layout Itemize
3852 joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis> positive
3853 position (axis modes axis and axis_inverse).
3856 \begin_layout Itemize
3857 joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis> pressure (axis
3861 \begin_layout Subsubsection
3865 \begin_layout Itemize
3866 Escape: Enter/Exit Command mode, cancel modal dialogs.
3869 \begin_layout Itemize
3870 Return (also KPEnter): Execute command, ok modal dialog.
3873 \begin_layout Itemize
3874 Pgup/Up (also KP8/9 if no num lock; command mode): Previous command in command
3878 \begin_layout Itemize
3879 Pgdn/Down(also KP2/3 if no num lock; command mode): Next command in command
3883 \begin_layout Itemize
3884 Home (also KP7 if no num lock; command mode): Beginning of command.
3887 \begin_layout Itemize
3888 End (also KP1 if no num lock; command mode): End of command.
3891 \begin_layout Itemize
3892 Left (also KP4 if no num lock; command mode): Move cursor left.
3895 \begin_layout Itemize
3896 Right (also KP6 if no num lock; command mode): Move cursor right.
3899 \begin_layout Itemize
3901 if no num lock; command mode): Delete character to right of cursor.
3904 \begin_layout Itemize
3905 Insert (also KP0 if no num lock; command mode): Toggle between insert /
3909 \begin_layout Itemize
3910 Backspace (command mode): Delete character to left of cursor.
3913 \begin_layout Itemize
3914 LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump corrupted!).
3917 \begin_layout Subsection
3921 \begin_layout Subsubsection
3925 \begin_layout Standard
3926 Following modifier names are known:
3929 \begin_layout Itemize
3933 \begin_layout Itemize
3937 \begin_layout Itemize
3941 \begin_layout Itemize
3945 \begin_layout Itemize
3949 \begin_layout Subsubsection
3953 \begin_layout Standard
3954 Following key names are known:
3957 \begin_layout Itemize
3958 back, tab, return, escape, space, exclaim, quotedbl, hash, dollar, percent,
3959 ampersand, quote, leftparen, rightparen, asterisk, plus, comma, minus,
3960 period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
3961 greater, question, at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3962 q, r, s, t, u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
3963 underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3964 q, r, s, t, u, v, w, x, y, z, leftcurly, pipe, rightcurly, tilde, delete,
3965 start, lbutton, rbutton, cancel, mbutton, clear, shift, alt, control, menu,
3966 pause, capital, end, home, lefT, up, right, down, select, print, execute,
3967 snapshot, insert, help, numpad0, numpad1, numpad2, numpad3, numpad4, numpad5,
3968 numpad6, numpad7, numpad8, numpad9, multiply, add, separator, subtract,
3969 decimal, divide, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13,
3970 f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, numlock, scroll,
3971 pageup, pagedown, numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
3972 numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up, numpad_right,
3973 numpad_down, numpad_pageup, numpad_pagedown, numpad_end, numpad_begin,
3974 numpad_insert, numpad_delete, numpad_equal, numpad_multiply, numpad_add,
3975 numpad_separator, numpad_subtract, numpad_decimal, numpad_divide, windows_left,
3976 windows_right, windows_menu, command, special1, special2, special3, special4,
3977 special5, special6, special7, special8, special9, special10, special11,
3978 special12, special13, special14, special15, special16, special17, special18,
3979 special19, special20
3982 \begin_layout Section
3986 \begin_layout Standard
3987 Movie file is .zip archive in itself, normal ZIP archive tools work on it
3988 (note: If you recompress it, do not use compression methods other than
3989 store and deflate and especially do not use encryption of any kind).
3992 \begin_layout Subsection
3993 Detecting clean start/SRAM/Savestate
3996 \begin_layout Itemize
3998 \begin_inset Quotes eld
4002 \begin_inset Quotes erd
4005 it is savestate, otherwise:
4008 \begin_layout Itemize
4009 If file has members with names starting
4010 \begin_inset Quotes eld
4014 \begin_inset Quotes erd
4017 it is movie starting from SRAM, otherwise:
4020 \begin_layout Itemize
4021 It is movie starting from clear state.
4024 \begin_layout Subsection
4028 \begin_layout Standard
4029 Type of game ROM and region (as one line).
4033 \begin_layout Standard
4034 \begin_inset Tabular
4035 <lyxtabular version="3" rows="8" columns="3">
4036 <features tabularvalignment="middle">
4037 <column alignment="center" valignment="top" width="0">
4038 <column alignment="center" valignment="top" width="0">
4039 <column alignment="center" valignment="top" width="0">
4041 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4044 \begin_layout Plain Layout
4050 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4053 \begin_layout Plain Layout
4059 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4062 \begin_layout Plain Layout
4070 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4073 \begin_layout Plain Layout
4079 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4082 \begin_layout Plain Layout
4088 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4091 \begin_layout Plain Layout
4099 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4102 \begin_layout Plain Layout
4108 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4111 \begin_layout Plain Layout
4117 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4120 \begin_layout Plain Layout
4128 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4131 \begin_layout Plain Layout
4137 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4140 \begin_layout Plain Layout
4146 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4149 \begin_layout Plain Layout
4157 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4160 \begin_layout Plain Layout
4166 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4169 \begin_layout Plain Layout
4175 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4178 \begin_layout Plain Layout
4186 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4189 \begin_layout Plain Layout
4195 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4198 \begin_layout Plain Layout
4204 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4207 \begin_layout Plain Layout
4215 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4218 \begin_layout Plain Layout
4224 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4227 \begin_layout Plain Layout
4233 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4236 \begin_layout Plain Layout
4244 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4247 \begin_layout Plain Layout
4253 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4256 \begin_layout Plain Layout
4262 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4265 \begin_layout Plain Layout
4279 \begin_layout Standard
4283 \begin_layout Standard
4284 \begin_inset Tabular
4285 <lyxtabular version="3" rows="3" columns="2">
4286 <features tabularvalignment="middle">
4287 <column alignment="center" valignment="top" width="0">
4288 <column alignment="center" valignment="top" width="0">
4290 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4293 \begin_layout Plain Layout
4299 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4302 \begin_layout Plain Layout
4310 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4313 \begin_layout Plain Layout
4319 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4322 \begin_layout Plain Layout
4330 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4333 \begin_layout Plain Layout
4339 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4342 \begin_layout Plain Layout
4356 \begin_layout Subsection
4360 \begin_layout Standard
4361 Contains type of port #1 (as one line).
4362 Valid values are 'none', 'gamepad', 'multitap' and 'mouse'.
4363 If not present, defaults to 'gamepad'.
4366 \begin_layout Subsection
4370 \begin_layout Standard
4371 Contains type of port #2 (as one line).
4372 Valid values are 'none', 'gamepad', 'multitap', 'mouse', 'superscope',
4373 'justifier' and 'justifiers'.
4374 If not present, defaults to 'none'.
4377 \begin_layout Subsection
4381 \begin_layout Standard
4382 Contains name of the game (as one line).
4385 \begin_layout Subsection
4389 \begin_layout Standard
4390 Contains authors, one per line.
4391 Part before '|' is the full name, part after is the nickname.
4394 \begin_layout Subsection
4398 \begin_layout Standard
4400 \begin_inset Quotes eld
4404 \begin_inset Quotes erd
4408 Used to reject other saves.
4411 \begin_layout Subsection
4412 Member: controlsversion
4415 \begin_layout Standard
4417 \begin_inset Quotes eld
4421 \begin_inset Quotes erd
4425 Used to identify what controls are there.
4428 \begin_layout Subsection
4430 \begin_inset Quotes eld
4434 \begin_inset Quotes erd
4440 \begin_layout Standard
4441 Contains bsnes core version number (as one line).
4444 \begin_layout Subsection
4448 \begin_layout Standard
4449 Contains project ID (as one line).
4450 Used to identify if two movies are part of the same project.
4453 \begin_layout Subsection
4454 Member: {rom,slota,slotb}{,xml}.sha256
4457 \begin_layout Standard
4458 Contains SHA-256 of said ROM or ROM mapping file (as one line).
4459 Absent if corresponding file is absent.
4462 \begin_layout Subsection
4463 Member: moviesram.<name>
4466 \begin_layout Standard
4467 Raw binary startup SRAM of kind <name>.
4468 Only present in savestates and movies starting from SRAM.
4471 \begin_layout Subsection
4475 \begin_layout Standard
4476 Contains frame number (as one line) of frame movie was saved on.
4477 Only present in savestates.
4480 \begin_layout Subsection
4484 \begin_layout Standard
4485 Current value of lag counter (as one line).
4486 Only present in savestates.
4489 \begin_layout Subsection
4490 Member: pollcounters
4493 \begin_layout Standard
4494 Contains poll counters (currently 100 of them), one per line.
4495 Each line is raw poll count if DRDY is set for it.
4496 Otherwise it is negative poll count minus one.
4497 Only present in savestates.
4500 \begin_layout Subsection
4504 \begin_layout Standard
4505 Raw binary dump of host memory.
4506 Only present in savestates.
4509 \begin_layout Subsection
4513 \begin_layout Standard
4514 The raw binary savestate itself.
4515 Savestate detection uses this file, only present in savestates.
4518 \begin_layout Subsection
4522 \begin_layout Standard
4523 Screenshot of current frame.
4524 Only present in savestates.
4525 First 2 bytes are big-endian width of image, rest are 24-bit RGB image
4527 Height of image is inferred from the width and size of data.
4530 \begin_layout Subsection
4534 \begin_layout Standard
4535 Raw binary SRAM of kind <name> at time of savestate.
4536 Only present in savestates.
4539 \begin_layout Subsection
4543 \begin_layout Standard
4544 The actual input track, one line per subframe (blank lines are skipped).
4547 \begin_layout Itemize
4548 If the first byte of each line is '.', ' ', <tab> or '|', then the line is
4549 part of same frame as previous, otherwise it starts a new frame.
4552 \begin_layout Itemize
4553 First subframe must start a new frame.
4556 \begin_layout Standard
4557 Length of movie in frames is number of lines in input file that start a
4561 \begin_layout Subsection
4565 \begin_layout Standard
4566 Contains textual base-10 rerecord count (as one line; emulator just writes
4567 this, it doesn't read it) + 1.
4570 \begin_layout Subsection
4574 \begin_layout Standard
4575 This member stores set of load IDs.
4576 There is one load ID per rerecord (plus one corresponding to start of project).
4579 \begin_layout Itemize
4580 This member constists of concatenation of records
4583 \begin_layout Itemize
4584 Each record is 2-36 bytes long and can represent 1-16,843,009 consequtive
4588 \begin_layout Itemize
4589 IDs are interpretted as 256-bit big-endian integers with warparound.
4592 \begin_layout Itemize
4593 Initial predicted ID is all zeroes.
4596 \begin_layout Standard
4597 Format of each record is:
4600 \begin_layout Itemize
4601 1 byte: Opcode byte.
4602 Bits 0-4 are prefix length (prefixlen), bits 5-6 are count length (countlen).
4606 \begin_layout Itemize
4607 32-prefixlen bytes of ID.
4610 \begin_layout Itemize
4611 countlen bytes of big-endian count (count).
4614 \begin_layout Standard
4615 Records are processed as follows:
4618 \begin_layout Itemize
4619 To form the first ID encoded by record, take the first prefixlen bytes predicted
4620 ID and append the read ID value to it.
4621 The result is the first ID encoded.
4624 \begin_layout Itemize
4625 If countlen is 0, record encodes 1 ID.
4628 \begin_layout Itemize
4629 If countlen is 1, record encodes 2+count IDs.
4632 \begin_layout Itemize
4633 If countlen is 2, record encodes 258+count IDs.
4636 \begin_layout Itemize
4637 If countlen is 3, record encodes 65794+count IDs.
4640 \begin_layout Itemize
4641 The new predicted ID is the next ID after last one encoded by the record.
4644 \begin_layout Standard
4645 The number of rerecords + 1 is equal to the sum of number of IDs encoded
4649 \begin_layout Subsection
4650 Member: starttime.second
4653 \begin_layout Standard
4654 Movie starting time, second part.
4655 Epoch is Unix epoch.
4656 Default is 1,000,000,000.
4659 \begin_layout Subsection
4660 Member: starttime.subsecond
4663 \begin_layout Standard
4664 Movie starting time, subsecond part.
4669 \begin_layout Subsection
4670 Member: savetime.second
4673 \begin_layout Standard
4674 Movie saving time, second part.
4675 Default is starttime.second.
4676 Only present in savestates.
4679 \begin_layout Subsection
4680 Member: savetime.subsecond
4683 \begin_layout Standard
4684 Movie saving time, subsecond part.
4685 Default is starttime.subsecond.
4686 Only present in savestates.
4689 \begin_layout Section
4690 Quick'n'dirty encode guide
4693 \begin_layout Enumerate
4694 Start the emulator and load the movie file.
4697 \begin_layout Enumerate
4698 Set large AVI option 'set-setting avi-large on'
4701 \begin_layout Enumerate
4702 Enable dumping 'dump-avi tmpdump'
4705 \begin_layout Enumerate
4706 Unpause and let it run until you want to end dumping.
4709 \begin_layout Enumerate
4710 Close the emulator (closing the window is the easiest way).
4714 \begin_layout Enumerate
4715 For each tmpdump*.avi file created, on command prompt, do 'x264 --crf 10
4716 -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
4719 \begin_layout Enumerate
4720 Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
4723 \begin_layout Enumerate
4724 Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv + tmpdump_0000001.mkv
4725 + tmpdump_0000002.mkv' (list every tmpdump_<numbers>.mkv, with + in between).
4728 \begin_layout Enumerate
4729 Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'.
4730 Now final.mkv contains quick'n'dirty encode.
4733 \begin_layout Section
4734 Axis configurations for some gamepad types:
4737 \begin_layout Subsection
4741 \begin_layout Standard
4742 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be set to pressure-+.
4745 \begin_layout LyX-Code
4746 set-axis joystick0axis2 pressure-+
4749 \begin_layout LyX-Code
4750 set-axis joystick0axis5 pressure-+
4753 \begin_layout Itemize
4754 This is needed for SDL only.
4755 EVDEV sets those types correctly.
4758 \begin_layout Subsection
4760 \begin_inset Quotes eld
4764 \begin_inset Quotes erd
4770 \begin_layout Standard
4771 Axes 8-19 should be disabled.
4774 \begin_layout LyX-Code
4775 set-axis joystick0axis8 disabled
4778 \begin_layout LyX-Code
4779 set-axis joystick0axis9 disabled
4782 \begin_layout LyX-Code
4783 set-axis joystick0axis10 disabled
4786 \begin_layout LyX-Code
4787 set-axis joystick0axis11 disabled
4790 \begin_layout LyX-Code
4791 set-axis joystick0axis12 disabled
4794 \begin_layout LyX-Code
4795 set-axis joystick0axis13 disabled
4798 \begin_layout LyX-Code
4799 set-axis joystick0axis14 disabled
4802 \begin_layout LyX-Code
4803 set-axis joystick0axis15 disabled
4806 \begin_layout LyX-Code
4807 set-axis joystick0axis16 disabled
4810 \begin_layout LyX-Code
4811 set-axis joystick0axis17 disabled
4814 \begin_layout LyX-Code
4815 set-axis joystick0axis18 disabled
4818 \begin_layout LyX-Code
4819 set-axis joystick0axis19 disabled
4822 \begin_layout Section
4826 \begin_layout Subsection
4827 Problems from BSNES core:
4830 \begin_layout Itemize
4831 The whole pending save stuff.
4834 \begin_layout Itemize
4835 Lack of layer hiding.
4838 \begin_layout Itemize
4839 It is slow (especially accuracy).
4842 \begin_layout Itemize
4843 Firmwares can't be loaded from ZIP archives.
4846 \begin_layout Subsection
4850 \begin_layout Itemize
4851 Modifiers don't work with pseudo-keys (SDL, EVDEV).
4854 \begin_layout Itemize
4855 Audio for last dumped frame is not itself dumped.
4858 \begin_layout Itemize
4859 Audio in UI is pretty bad in quality if game doesn't run at full speed.
4862 \begin_layout Itemize
4863 AVI compression levels 10-18 are not compatible with AVISynth AVISource.
4866 \begin_layout Itemize
4867 No menus, command based interface (SDL).
4870 \begin_layout Itemize
4871 Long commands don't scroll.
4874 \begin_layout Itemize
4875 Wxwidgets UI is still buggy.
4878 \begin_layout Section
4882 \begin_layout Subsection
4886 \begin_layout Itemize
4890 \begin_layout Itemize
4891 Fix dumper video corruption with levels 10-18.
4894 \begin_layout Subsection
4898 \begin_layout Itemize
4902 \begin_layout Itemize
4903 Lots of code cleanups
4906 \begin_layout Itemize
4907 Lua interface to settings
4910 \begin_layout Itemize
4911 Allow specifying AVI borders without Lua
4914 \begin_layout Itemize
4915 Fix scaling if vscale > 1 and originx > 0 (left border exists)
4918 \begin_layout Itemize
4919 on_snoop lua callback
4922 \begin_layout Itemize
4923 Faster movie loading and saving.
4926 \begin_layout Subsection
4930 \begin_layout Itemize
4934 \begin_layout Subsection
4938 \begin_layout Itemize
4942 \begin_layout Itemize
4943 Save jukebox functionality.
4946 \begin_layout Subsection
4950 \begin_layout Itemize
4951 Try to fix some nasty failing movie load edge cases
4954 \begin_layout Itemize
4955 Allow specifying scripts to run on command line.
4958 \begin_layout Subsection
4962 \begin_layout Itemize
4963 Major source code reorganization.
4966 \begin_layout Itemize
4967 Backup savestates before overwriting.
4970 \begin_layout Itemize
4971 Don't crash if loading initial state fails.
4974 \begin_layout Subsection
4978 \begin_layout Itemize
4982 \begin_layout Itemize
4983 Fix author name parsing
4986 \begin_layout Itemize
4987 Fix rerecord counting
4990 \begin_layout Itemize
4991 (SDL) Print messages to console if SDL is uninitialized
4994 \begin_layout Itemize
4995 Add movieinfo program
4998 \begin_layout Itemize
4999 Fix loading movies starting from SRAM.
5002 \begin_layout Subsection
5006 \begin_layout Itemize
5007 Add support for unattended dumping
5010 \begin_layout Itemize
5011 Fix compiling for Win32
5014 \begin_layout Itemize
5015 Don't lock up if sound can't be initialized
5018 \begin_layout Itemize
5019 Strip trailing CR from commands
5022 \begin_layout Itemize
5023 Don't try to do dubious things in global ctors (fix crash on startup)
5026 \begin_layout Subsection
5030 \begin_layout Itemize
5031 Small documentation tweaking
5034 \begin_layout Itemize
5038 \begin_layout Itemize
5039 Fix major bug in modifier matching
5042 \begin_layout Subsection
5046 \begin_layout Itemize
5047 Lots of documentation fixes
5050 \begin_layout Itemize
5051 Use dedicated callbacks for event backcomm., not commands.
5054 \begin_layout Itemize
5055 Ensure that the watchdog is not hit when executing delayed reset.
5058 \begin_layout Itemize
5059 Remove errant tab from joystick message.
5062 \begin_layout Subsection
5066 \begin_layout Itemize
5067 Make autofire operate in absolute time, not linear time
5070 \begin_layout Itemize
5071 Reinitialize controls when resuming from loadstate
5074 \begin_layout Itemize
5075 Some more code cleanups
5078 \begin_layout Itemize
5079 If Lua allocator fails, call OOM_panic()
5082 \begin_layout Itemize
5083 Byte/word/dword/qword sized host memory write/read functions.
5086 \begin_layout Itemize
5087 Dump at correct framerate if dumping interlaced NTSC (height=448).
5090 \begin_layout Subsection
5094 \begin_layout Itemize
5095 Actually include the complete source code
5098 \begin_layout Itemize
5102 \begin_layout Subsection
5106 \begin_layout Itemize
5107 Document {save,start}time.{,sub}second.
5110 \begin_layout Itemize
5111 Intercept time() from bsnes core.
5114 \begin_layout Subsection
5118 \begin_layout Itemize
5119 Allow disabling time() interception (allow build on Mac OS X)
5122 \begin_layout Itemize
5123 Use SDLMain on Mac OS X (make SDL not crash)
5126 \begin_layout Itemize
5127 Disable delayed resets (just plain too buggy for now).
5130 \begin_layout Itemize
5134 \begin_layout Itemize
5135 Use 16-bit for graphics/video instead of 32-bit.
5138 \begin_layout Itemize
5139 gui.rectangle/gui.pixel
5142 \begin_layout Itemize
5146 \begin_layout Itemize
5147 New CSCD writer implementation.
5150 \begin_layout Subsection
5154 \begin_layout Itemize
5155 Fix interaction of * and +.
5158 \begin_layout Itemize
5162 \begin_layout Itemize
5163 Use gettimeofday()/usleep(), these seem portable enough.
5166 \begin_layout Itemize
5167 Move joystick axis manipulation to keymapper code.
5170 \begin_layout Itemize
5171 Changes to how read-only works.
5174 \begin_layout Itemize
5175 Refactor controller input code.
5178 \begin_layout Subsection
5182 \begin_layout Itemize
5183 Fix mouseclick scale compensation.
5186 \begin_layout Itemize
5187 Draw area boundaries correctly in SDL code.
5190 \begin_layout Itemize
5194 \begin_layout Itemize
5195 Fix CSCD output (buffer overrun and race condition).
5198 \begin_layout Subsection
5202 \begin_layout Itemize
5203 JMD dumping support.
5206 \begin_layout Itemize
5207 Allow unattended dumping to JMD.
5210 \begin_layout Itemize
5214 \begin_layout Itemize
5215 Switch back to 32-bit colors.
5218 \begin_layout Itemize
5219 Add Lua function gui.color.
5222 \begin_layout Itemize
5223 Use some new C++11 features in GCC 4.6.
5226 \begin_layout Itemize
5227 Be prepared for core frequency changes.
5230 \begin_layout Itemize
5231 Pass colors in one chunk from Lua.
5234 \begin_layout Subsection
5238 \begin_layout Itemize
5239 New lua functions gui.line(), gui.status() and gui.circle(), memory.vma_count(),
5240 memory.read_vma() and memory.find_vma().
5243 \begin_layout Itemize
5244 Numerious documentation fixups
5247 \begin_layout Itemize
5248 RTC time format changed
5251 \begin_layout Itemize
5252 Reformat flags display
5255 \begin_layout Itemize
5256 Allow lua package name to be overridden
5259 \begin_layout Itemize
5260 SDUMP (high-quality dumping).
5263 \begin_layout Itemize
5264 Split platform support to plugins.
5267 \begin_layout Itemize
5268 Make all sound plugins support basic sound commands
5271 \begin_layout Itemize
5272 Support portaudio for sound.
5275 \begin_layout Itemize
5276 Allow disable Lua/SDL searching.
5279 \begin_layout Itemize
5280 Upconvert colors when copying lcscreen to screen.
5283 \begin_layout Itemize
5284 Reorganize source tree.
5287 \begin_layout Itemize
5288 Evdev joystick support.
5291 \begin_layout Itemize
5292 Refactor more code into generic window code.
5295 \begin_layout Subsection
5299 \begin_layout Itemize
5300 Refactor message handling.
5303 \begin_layout Itemize
5307 \begin_layout Itemize
5311 \begin_layout Itemize
5312 Finish pending saves before load/quit.
5315 \begin_layout Itemize
5316 Wxwidgets graphics plugin.
5319 \begin_layout Subsection
5323 \begin_layout Itemize
5324 Get rid of win32-crap.[ch]pp.
5327 \begin_layout Itemize
5328 Move files around a lot.
5331 \begin_layout Itemize
5332 Get rid of need for host C++ compiler.
5335 \begin_layout Itemize
5339 \begin_layout Itemize
5340 Refactor inter-component communication.
5343 \begin_layout Itemize
5347 \begin_layout Itemize
5348 Fix crash on multiline aliases.
5351 \begin_layout Itemize
5352 Load/Save settings in wxwidgets gui.
5355 \begin_layout Subsection
5359 \begin_layout Itemize
5360 Patch problems in bsnes core
5363 \begin_layout Itemize
5364 SNES is little-endian, not big-endian!
5367 \begin_layout Itemize
5368 Fix memory corruption in lcscreen::load()
5371 \begin_layout Subsection
5375 \begin_layout Itemize
5376 Fix interpretting repeat counts in rrdata loading.
5379 \begin_layout Itemize
5380 New lua callback: on_frame()
5383 \begin_layout Itemize
5384 Remove calls to runtosave() that aren't supposed to be there
5387 \begin_layout Itemize
5388 Lua function: movie.read_rtc()
5391 \begin_layout Itemize
5392 Ignore src/fonts/font.cpp
5395 \begin_layout Itemize
5396 Fix more bsnes core problems
5399 \begin_layout Itemize
5400 Control bsnes random seeding
5403 \begin_layout Itemize
5407 \begin_layout Itemize
5408 Some bsnes core debugging features (state dump and state hash)
5411 \begin_layout Itemize
5412 Fix titlebar version number (no, the last version wasn't 'lsnes-0-beta21',
5413 it was 'lsnes rr0-beta21').
5416 \begin_layout Subsection
5420 \begin_layout Itemize
5421 Fix memory corruption due to macro/field mixup
5424 \begin_layout Itemize
5425 search-memory update
5428 \begin_layout Itemize
5429 Allow direct-mapped framebuffer
5432 \begin_layout Itemize
5433 SDL: Use SDL_ANYFORMAT if possible
5436 \begin_layout Itemize
5437 SDMP2SOX: 2s delay modes.
5440 \begin_layout Itemize
5444 \begin_layout Itemize
5445 Use sed -E, not sed -r.
5446 Fixes building on Mac OS X.
5449 \begin_layout Itemize
5450 Wxwidgets: Save jukebox on exit
5453 \begin_layout Itemize
5454 Fix RTC if using load-movie on savestate.
5457 \begin_layout Itemize
5458 Fix crash related to full console mode.
5461 \begin_layout Subsection
5465 \begin_layout Itemize
5466 Wxwidgets: Allow bringing application to foreground on Mac OS X.
5469 \begin_layout Itemize
5470 Wxwidgets: Allow compiling on Mac OS X.
5473 \begin_layout Itemize
5474 Use movie compare instead of movie hashing (faster save/load).
5477 \begin_layout Itemize
5481 \begin_layout Subsection
5485 \begin_layout Itemize
5486 sdmp2sox: Pad soundtrack if using -l or -L.
5489 \begin_layout Itemize
5490 sdmp2sox: Fix NTSC overscan.
5493 \begin_layout Itemize
5494 sdmp2sox: Add AR correction mode.
5497 \begin_layout Itemize
5498 call lua_close() when exiting.
5501 \begin_layout Itemize
5502 Fix zip_writer bug causing warnings from info-zip and error from advzip.
5505 \begin_layout Subsection
5509 \begin_layout Itemize
5510 Fix IPS patching code (use bsnes core IPS patcher).
5513 \begin_layout Itemize
5514 Implement BPS patching (using bsnes core IPS patcher).
5517 \begin_layout Itemize
5518 Add feature to load headered ROMs.
5521 \begin_layout Subsection
5525 \begin_layout Itemize
5526 Show command names when showing keybindings
5529 \begin_layout Subsection
5533 \begin_layout Itemize
5534 Fix pause-on-end to be actually controllable
5537 \begin_layout Itemize
5538 SDL: Poll all events in queue, not just first one (fixes slowness in command
5542 \begin_layout Itemize
5543 Wxwidgets: Fix ROM loading.
5546 \begin_layout Subsection
5550 \begin_layout Itemize
5551 Lua: Add gui.textH, gui.textV, gui.textHV
5554 \begin_layout Itemize
5555 Fix text colors on SDL on Mac OS X
5558 \begin_layout Itemize
5559 Mode 'F' for finished in readonly mode.
5562 \begin_layout Itemize
5566 \begin_layout Itemize
5567 Reliably pause after skip poll
5570 \begin_layout Itemize
5571 Split UI and core into their own threads
5574 \begin_layout Subsection
5578 \begin_layout Itemize
5579 Remove leftover dummy SRAM slot
5582 \begin_layout Itemize
5583 Fix controller numbers.
5586 \begin_layout Subsection
5590 \begin_layout Itemize
5591 Fix lsnes-dumpavi after interface change.
5594 \begin_layout Itemize
5595 Also give BSNES patches for v085.
5598 \begin_layout Itemize
5599 Pack movie data in memory.
5602 \begin_layout Subsection
5606 \begin_layout Itemize
5607 Fix framecount/length given when loading movies.
5610 \begin_layout Itemize
5611 Controller command memory leak fixes.
5614 \begin_layout Itemize
5615 Don't leak palette if freeing screen object.
5618 \begin_layout Subsection
5622 \begin_layout Itemize
5626 \begin_layout Itemize
5627 Wxwidgets: Allow controlling dumper from the menu.
5630 \begin_layout Subsection
5634 \begin_layout Itemize
5635 Rewrite parts of manual
5638 \begin_layout Itemize
5639 Lua: Make it work with Lua 5.2.
5642 \begin_layout Subsection
5646 \begin_layout Itemize
5647 Win32: Fix compile errors.
5650 \begin_layout Subsection
5654 \begin_layout Itemize
5655 Refactor controller input code.
5658 \begin_layout Itemize
5659 Fix crash when using command line on SDL / Mac OS X.
5662 \begin_layout Subsection
5666 \begin_layout Itemize
5667 Delete core/coroutine (obsolete)
5670 \begin_layout Itemize
5671 Lag input display by one frame.
5674 \begin_layout Itemize
5675 Rewind movie to beginning function.
5678 \begin_layout Itemize
5679 Fix wrong frame number reported to Lua when repainting after loadstate
5682 \begin_layout Itemize
5683 Support UI editing of jukebox
5686 \begin_layout Itemize
5687 Wxwidgets: Save settings on exit.
5690 \begin_layout Itemize
5691 Support ${project} for filenames
5694 \begin_layout Itemize
5695 SDL: Fix command history
5698 \begin_layout Subsection
5702 \begin_layout Itemize
5703 Fix some order-of-global-ctor bugs.
5706 \begin_layout Subsection
5710 \begin_layout Itemize
5711 Fix crashes when quitting on Win32.
5714 \begin_layout Subsection
5718 \begin_layout Itemize
5719 EVDEV: Queue keypresses from joystick, don't send directly
5722 \begin_layout Itemize
5723 Wxwidgets: Load-Preserve that actually works.
5726 \begin_layout Subsection
5730 \begin_layout Itemize
5731 Wxwidgets: GUI for memory search.
5734 \begin_layout Itemize
5735 Warn about using synchronous queue in UI callback.
5738 \begin_layout Subsection
5742 \begin_layout Itemize
5743 Remember last saved file for each ROM
5746 \begin_layout Itemize
5747 Support MT dumping via boost.
5750 \begin_layout Itemize
5754 \begin_layout Itemize
5758 \begin_layout Itemize
5759 Make mouse be ordinary input instead of special-casing
5762 \begin_layout Itemize
5763 SDL: Don't screw up commands with NUL codepoints.
5766 \begin_layout Subsection
5770 \begin_layout Itemize
5771 Merge status panel and main window
5774 \begin_layout Itemize
5775 True movie slot support (the rest of it)
5778 \begin_layout Itemize
5779 SDL: Fix compilation error
5782 \begin_layout Itemize
5783 Elminate cross calls in dump menu code.
5786 \begin_layout Subsection
5790 \begin_layout Itemize
5791 Cancel pending saves command
5794 \begin_layout Itemize
5795 Wxwidgets: Code refactoring
5798 \begin_layout Itemize
5799 Wxwidgets: Fix system -> reset
5802 \begin_layout Itemize
5803 Wxwidgets: Read watch expressions in the right thread
5806 \begin_layout Subsection
5810 \begin_layout Itemize
5811 Wxwidgets: Don't prompt for member when running Lua script (Lua doesn't
5815 \begin_layout Itemize
5816 Wxwidgets: 128 -> 1024 Autohold slots (in case more are needed).
5819 \begin_layout Itemize
5820 Don't append trailing '-' to prefix when saving movie.
5823 \begin_layout Itemize
5824 Fix ROM/savestate handling (don't let user mismatch ROM and savestates).
5827 \begin_layout Subsection
5831 \begin_layout Itemize
5832 Document memory watch syntax.
5835 \begin_layout Subsection
5839 \begin_layout Itemize
5840 Fix unattended dumping (lsnes-dumpavi)
5843 \begin_layout Itemize
5847 \begin_layout Itemize
5848 Use adv_dumper instead of the old interface in lsnes-dumpavi (changes syntax)
5851 \begin_layout Itemize
5852 Add option to control sample rate preturbation in AVI dumper
5855 \begin_layout Subsection
5859 \begin_layout Itemize
5860 Wxwidgets: Fix dumper submodes
5863 \begin_layout Itemize
5864 Set core controller types before loadstate
5867 \begin_layout Subsection
5871 \begin_layout Itemize
5872 Fix compiling with bsnes v086.
5875 \begin_layout Subsection
5879 \begin_layout Itemize
5880 Don't prompt before quitting
5883 \begin_layout Itemize
5884 Start unpaused, preserve pause/unpause over load.
5887 \begin_layout Itemize
5888 Try to autodetect if ROM is headered.
5891 \begin_layout Itemize
5892 Wxwidgets: Only bring up ROM patching screen if specifically requested.
5895 \begin_layout Itemize
5896 Allow configuring some hotkeys.
5899 \begin_layout Subsection
5903 \begin_layout Itemize
5904 Lots of code cleanups
5907 \begin_layout Itemize
5908 Fix JMD compression (JMD dumping was broken)
5911 \begin_layout Itemize
5912 Don't crash if Lua C function throws an exception.
5915 \begin_layout Itemize
5916 Support bitmap drawing in Lua.
5919 \begin_layout Itemize
5920 Fix bsnes v085/v086 patches.
5923 \begin_layout Itemize
5924 Improve stability on win32.
5927 \begin_layout Subsection
5931 \begin_layout Itemize
5932 Don't corrupt movie if movie length is integer multiple of frames per page.
5935 \begin_layout Subsection
5939 \begin_layout Itemize
5940 New Lua hooks: on_rewind, on_frame_emulated, on_idle, on_timer
5943 \begin_layout Itemize
5944 New Lua functions: emulator_ready(), utime(), set_idle_timeout(), set_timer_time
5945 out(), bit.extract(), bit.value(), input.geta(), input.seta() and input.controllertyp
5949 \begin_layout Itemize
5950 Wxwidgets: Fix internal focus lost (hotkeys stop working)
5953 \begin_layout Itemize
5954 Wxwidgets: Fix broken modifiers
5957 \begin_layout Itemize
5958 on_paint has parameter now.
5961 \begin_layout Itemize
5962 Optional initital fill for bitmaps
5965 \begin_layout Itemize
5966 Fix palette changing.
5969 \begin_layout Itemize
5970 Optimize rendering a bit.
5973 \begin_layout Itemize
5977 \begin_layout Subsection
5981 \begin_layout Itemize
5982 Movieinfo: Fix display of port #2 type.
5985 \begin_layout Itemize
5986 Call on_input() after loadstate.
5989 \begin_layout Subsection
5993 \begin_layout Itemize
5994 Fix writing port2 data to movie.
5997 \begin_layout Itemize
5998 Fix SRAM handling with Bsnes v087.