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
1661 \begin_layout Standard
1662 Do load from jukebox (current mode).
1665 \begin_layout Subsubsection
1669 \begin_layout Standard
1670 Do state save to jukebox.
1673 \begin_layout Subsection
1677 \begin_layout Standard
1678 Only available if lua support is compiled in.
1681 \begin_layout Subsubsection
1682 evaluate-lua <luacode>
1685 \begin_layout Standard
1686 Run Lua code <luacode> using built-in Lua interpretter.
1689 \begin_layout Subsubsection
1693 \begin_layout Standard
1694 Run specified lua file using built-in Lua interpretter.
1697 \begin_layout Subsection
1701 \begin_layout Subsubsection
1702 add-watch <name> <expression>
1705 \begin_layout Standard
1706 Adds new watch (or modifies old one).
1709 \begin_layout Subsubsection
1713 \begin_layout Standard
1717 \begin_layout Subsection
1721 \begin_layout Subsubsection
1722 enable-sound <on/off>
1725 \begin_layout Standard
1726 Enable/Disable sound.
1729 \begin_layout Subsubsection
1730 set-sound-device <device>
1733 \begin_layout Standard
1734 Set sound device to <device>
1737 \begin_layout Subsubsection
1741 \begin_layout Standard
1742 Show status of sound system.
1745 \begin_layout Subsubsection
1749 \begin_layout Standard
1750 Show all available devices.
1753 \begin_layout Subsubsection
1754 set-volume <multiplier>
1757 \begin_layout Standard
1758 Set the volume multiplier to <multiplier>.
1759 1 is normal volume, and higher numbers are louder.
1762 \begin_layout Subsubsection
1763 set-volume <multiplier>%
1766 \begin_layout Standard
1767 Set the volume multiplier to <multiplier> percent.
1768 100 is normal volume, and higher numbers are louder.
1771 \begin_layout Subsubsection
1772 set-volume <multiplier>dB
1775 \begin_layout Standard
1776 Set the volume multiplier to <multiplier> dB.
1777 0 is normal volume, and higher numbers are louder.
1778 The value may be negative.
1781 \begin_layout Subsection
1782 SDL Platform commands
1785 \begin_layout Standard
1786 The following are valid on SDL platform.
1789 \begin_layout Subsubsection
1793 \begin_layout Standard
1794 Asks to press a key and then identifies that (pseudo-)key.
1797 \begin_layout Subsubsection
1801 \begin_layout Standard
1802 Toggle between windowed/fullscreen console.
1805 \begin_layout Subsubsection
1809 \begin_layout Standard
1810 Scroll messages window as far back as it goes.
1813 \begin_layout Subsubsection
1817 \begin_layout Standard
1818 Scroll messages window as far forward as it goes.
1821 \begin_layout Subsubsection
1825 \begin_layout Standard
1826 Scroll messages window back one screenful.
1829 \begin_layout Subsubsection
1833 \begin_layout Standard
1834 Scroll messages window forward one screenful.
1837 \begin_layout Section
1841 \begin_layout Subsection
1845 \begin_layout Subsubsection
1849 \begin_layout Standard
1850 Set where bsnes looks for firmware files.
1852 \begin_inset Quotes eld
1856 \begin_inset Quotes erd
1862 \begin_layout Subsubsection
1866 \begin_layout Standard
1868 Numeric, range is 0.001 to
1869 \begin_inset Quotes eld
1873 \begin_inset Quotes erd
1877 Default is native framerate.
1880 \begin_layout Subsubsection
1884 \begin_layout Standard
1885 Set save compression level (integer 0-9).
1886 Default is 7 (0 is no compression).
1889 \begin_layout Subsubsection
1893 \begin_layout Standard
1894 Set the frame advance timeout in milliseconds.
1895 Numeric integer, range is 0-999999999.
1899 \begin_layout Subsection
1903 \begin_layout Subsubsection
1907 \begin_layout Standard
1908 AVI dumper: Always dump at 512x448 or 512x478 regardless of what the console
1912 \begin_layout Subsubsection
1916 \begin_layout Standard
1917 AVI dumper: Set the default left border thickness (unless lua overrides)
1923 \begin_layout Subsubsection
1927 \begin_layout Standard
1928 AVI dumper: Set the default right border thickness (unless lua overrides)
1934 \begin_layout Subsubsection
1938 \begin_layout Standard
1939 AVI dumper: Set the default top border thickness (unless lua overrides)
1945 \begin_layout Subsubsection
1949 \begin_layout Standard
1950 AVI dumper: Set the default bottom border thickness (unless lua overrides)
1956 \begin_layout Subsubsection
1960 \begin_layout Standard
1961 AVI dumper: Maximum number of frames per dump segment (0 => unlimited).
1966 \begin_layout Subsubsection
1970 \begin_layout Standard
1971 AVI dumper: Compression level (0-18).
1974 \begin_layout Itemize
1975 Compression levels 10 and above are not compatible with stock CSCD codec.
1978 \begin_layout Itemize
1979 Recomended level is 7.
1982 \begin_layout Subsubsection
1986 \begin_layout Standard
1987 AVI dumper: Set method of determining the sound rate.
1990 \begin_layout Itemize
1991 0: Pick nearest of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48, 64, 88.2, 96,
1992 128, 176.4 and 192 kHz.
1995 \begin_layout Itemize
1996 1: Round down to nearest integer.
1999 \begin_layout Itemize
2000 2: Round up to nearest ingeter.
2003 \begin_layout Subsection
2007 \begin_layout Subsubsection
2011 \begin_layout Standard
2012 JMD dumper: Compression level (0-9).
2015 \begin_layout Subsection
2016 SDL platform settings
2019 \begin_layout Subsubsection
2020 autorepeat-first-delay
2023 \begin_layout Standard
2024 Sets the delay for first character in typematic autorepeat.
2027 \begin_layout Subsubsection
2028 autorepeat-subsequent-delay
2031 \begin_layout Standard
2032 Sets the delay for subsequent characters in typematic autorepeat.
2035 \begin_layout Section
2039 \begin_layout Subsection
2040 Core (in main table)
2043 \begin_layout Subsubsection
2047 \begin_layout Standard
2048 Print line to message console.
2051 \begin_layout Subsubsection
2052 exec(string command)
2055 \begin_layout Standard
2056 Run command as it was entered on the command line
2059 \begin_layout Subsubsection
2063 \begin_layout Standard
2065 First is time since some epoch in seconds, the second is microseconds mod
2066 10^6 since that epoch.
2069 \begin_layout Subsubsection
2073 \begin_layout Standard
2074 Returns true if emulator has finished booting, false if not (on_startup()
2075 will be issued later).
2078 \begin_layout Subsubsection
2079 set_idle_timeout(number timeout)
2082 \begin_layout Standard
2083 Set number of microseconds to block idle for.
2084 After this timeout has expired, on_idle() will be called once.
2087 \begin_layout Subsubsection
2088 set_timer_timeout(number timeout)
2091 \begin_layout Standard
2092 Set number of microseconds to block timer for.
2093 After this timeout has expired, on_timer() will be called once.
2096 \begin_layout Subsection
2100 \begin_layout Standard
2101 Bitwise logical functions and related.
2104 \begin_layout Subsubsection
2105 bit.none(number...) / bit.bnot(number...)
2108 \begin_layout Standard
2109 48-bit bitwise NOT / NONE function (set bits that are set in none of the
2113 \begin_layout Subsubsection
2114 bit.any(number...) / bit.bor(number...)
2117 \begin_layout Standard
2118 48-bit bitwise OR / ANY function (set bits that are set in any of the arguments).
2121 \begin_layout Subsubsection
2122 bit.all(number...) / bit.band(number...)
2125 \begin_layout Standard
2126 48-bit bitwise AND / ALL function (set bits that are set in all of the arguments
2130 \begin_layout Subsubsection
2131 bit.parity(number...) / bit.bxor(number...)
2134 \begin_layout Standard
2135 48-bit bitwise XOR / PARITY function (set bits that are set in odd number
2139 \begin_layout Subsubsection
2140 bit.lrotate(number base[, number amount[, number bits]])
2143 \begin_layout Standard
2144 Rotate bits-bit (max 48, default 48) number left by amount (default 1) places.
2147 \begin_layout Subsubsection
2148 bit.rrotate(number base[, number amount[, number bits]])
2151 \begin_layout Standard
2152 Rotate bits-bit (max 48, default 48) number right by amount (default 1)
2156 \begin_layout Subsubsection
2157 bit.lshift(number base[, number amount[, number bits]])
2160 \begin_layout Standard
2161 Shift bits-bit (max 48, default 48) number left by amount (default 1) places.
2162 The new bits are filled with zeroes.
2165 \begin_layout Subsubsection
2166 bit.lrshift(number base[, number amount[, number bits]])
2169 \begin_layout Standard
2170 Shift bits-bit (max 48, default 48) number logically right by amount (default
2172 The new bits are filled with zeroes.
2175 \begin_layout Subsubsection
2176 bit.arshift(number base[, number amount[, number bits]])
2179 \begin_layout Standard
2180 Shift bits-bit (max 48, default 48) number arithmetically right by amount
2182 The new bits are shifted in with copy of the high bit.
2185 \begin_layout Subsubsection
2186 bit.extract(number base[, number bit0[, number bit1,...]])
2189 \begin_layout Standard
2190 Returns number that has bit0-th bit as bit 0, bit1-th bit as 1 and so on.
2193 \begin_layout Standard
2197 \begin_layout Itemize
2198 Bit numbers up to 51 should work reliably (then things start falling apart
2199 due to double precision issues).
2202 \begin_layout Itemize
2203 There are two special bit positions, true and false, standing for always
2204 set bit and always clear bit.
2207 \begin_layout Subsubsection
2208 bit.value([number bit1[, number bit2,...]])
2211 \begin_layout Standard
2212 Returns bitwise OR of 1 left shifted by bit1 places, 1 left shifted by bit2
2214 As special value, nil argument is no-op.
2217 \begin_layout Subsection
2221 \begin_layout Standard
2222 Most of these functions can only be called in on_paint and on_video callbacks.
2223 Exceptions are noted.
2226 \begin_layout Standard
2228 Bits 0-7 are the blue component, bits 8-15 are the green component, bits
2229 16-23 are the red component, bits 24-31 are alpha component (0 is fully
2230 opaque, 255 is almost transparent).
2231 -1 is the fully transparent color.
2232 Alpha values greater than 127 do work.
2235 \begin_layout Standard
2236 Origin of coordinates is at top left corner of game display area.
2237 Left and top gaps correspond to negative coordinates.
2240 \begin_layout Subsubsection
2244 \begin_layout Standard
2245 Returns 2-tuple (hresolution, vresolution).
2248 \begin_layout Subsubsection
2249 gui.<class>_gap(number gap)
2252 \begin_layout Standard
2253 Set the <class> (left, right, top, bottom) gap to specified value (max gap
2257 \begin_layout Subsubsection
2258 gui.text(number x, number y, string text[, number fgc[, number bgc]])
2261 \begin_layout Standard
2262 Draw specified text on the GUI (each character cell is 8 or 16 wide and
2267 \begin_layout Itemize
2268 x: X-coordinate to start the drawing from (and x-coordinate at begining
2272 \begin_layout Itemize
2273 y: Y-coordinate to start the drawing from.
2276 \begin_layout Itemize
2277 text: The text to draw.
2280 \begin_layout Itemize
2281 fgc: Text color (default is 0xFFFFFF (white))
2284 \begin_layout Itemize
2285 bgc: Background color (default is -1 (transparent))
2288 \begin_layout Subsubsection
2289 gui.textH(number x, number y, string text[, number fgc[, number bgc]])
2292 \begin_layout Standard
2293 Like gui.text, but draw using double-width.
2296 \begin_layout Subsubsection
2297 gui.textV(number x, number y, string text[, number fgc[, number bgc]])
2300 \begin_layout Standard
2301 Like gui.text, but draw using double-height.
2304 \begin_layout Subsubsection
2305 gui.textHV(number x, number y, string text[, number fgc[, number bgc]])
2308 \begin_layout Standard
2309 Like gui.text, but draw using double-width/double-height.
2312 \begin_layout Subsubsection
2313 gui.rectangle(number x, number y, number width, number height[, number thickness[
2314 , number outline[, number fill]]])
2317 \begin_layout Standard
2318 Draw rectangle on the GUI.
2322 \begin_layout Itemize
2323 x: X-coordinate of left edge.
2326 \begin_layout Itemize
2327 y: Y-coordinate of upper edge.
2330 \begin_layout Itemize
2331 width: Width of rectangle.
2334 \begin_layout Itemize
2335 height: Height of rectangle.
2338 \begin_layout Itemize
2339 thickness: Thickness of outline (default is 1).
2342 \begin_layout Itemize
2343 outline: Color of outline (default is 0xFFFFFF (white))
2346 \begin_layout Itemize
2347 fill: Color of fill (default is -1 (transparent))
2350 \begin_layout Subsubsection
2351 gui.box(number x, number y, number width, number height[, number thickness[,
2352 number outline1[,number outline2[, number fill]]]])
2355 \begin_layout Standard
2356 Draw rectangle with 3D effect on the GUI.
2360 \begin_layout Itemize
2361 x: X-coordinate of left edge.
2364 \begin_layout Itemize
2365 y: Y-coordinate of upper edge.
2368 \begin_layout Itemize
2369 width: Width of rectangle.
2372 \begin_layout Itemize
2373 height: Height of rectangle.
2376 \begin_layout Itemize
2377 thickness: Thickness of outline (default is 1).
2380 \begin_layout Itemize
2381 outline1: First color of outline (default is 0xFFFFFF (white))
2384 \begin_layout Itemize
2385 outline2: First color of outline (default is 0x808080 (dark gray))
2388 \begin_layout Itemize
2389 fill: Color of fill (default is 0xC0C0C0 (light grayy))
2392 \begin_layout Subsubsection
2393 gui.pixel(number x, number y[, number color])
2396 \begin_layout Standard
2397 Draw one pixel on the GUI.
2401 \begin_layout Itemize
2402 x: X-coordinate of the pixel
2405 \begin_layout Itemize
2406 y: Y-coordinate of the pixel
2409 \begin_layout Itemize
2410 color: Color of the pixel (default is 0xFFFFFF (white))
2413 \begin_layout Subsubsection
2414 gui.crosshair(number x, number y[, number length[, number color]])
2417 \begin_layout Standard
2422 \begin_layout Itemize
2423 x: X-coordinate of the crosshair
2426 \begin_layout Itemize
2427 y: Y-coordinate of the crosshair
2430 \begin_layout Itemize
2431 length: Length of the crosshair lines (default 10).
2434 \begin_layout Itemize
2435 color: Color of the crosshair (default is 0xFFFFFF (white))
2438 \begin_layout Subsubsection
2439 gui.line(number x1, number y1, number x2, number y2[, number color])
2442 \begin_layout Standard
2447 \begin_layout Itemize
2448 x1: X-coordinate of one end.
2451 \begin_layout Itemize
2452 y1: Y-coordinate of one end.
2455 \begin_layout Itemize
2456 x2: X-coordinate of the other end.
2459 \begin_layout Itemize
2460 y2: Y-coordinate of the other end.
2463 \begin_layout Itemize
2464 color: Color of the line (default is 0xFFFFFF (white)).
2467 \begin_layout Subsubsection
2468 gui.circle(number x, number y, number r[, number thick[, number border[,
2472 \begin_layout Standard
2477 \begin_layout Itemize
2478 x: X-coordinate of the center
2481 \begin_layout Itemize
2482 y: Y-coordinate of the center
2485 \begin_layout Itemize
2486 r: The radius of the circle
2489 \begin_layout Itemize
2490 thick: Border thickness
2493 \begin_layout Itemize
2494 border: Border color (default is 0xFFFFFF (white))
2497 \begin_layout Itemize
2498 fill: Fill color (default is -1 (transparent)).
2501 \begin_layout Subsubsection
2502 gui.bitmap_draw(number x, number y, bitmap bitmap, palette palette)
2505 \begin_layout Standard
2506 Draw a bitmap on screen with specified palette.
2510 \begin_layout Itemize
2511 x: X-coordinate of left edge.
2514 \begin_layout Itemize
2515 y: Y-coordinate of top edge.
2518 \begin_layout Itemize
2519 bitmap: The bitmap to draw
2522 \begin_layout Itemize
2523 palette: The palette to draw the bitmap using.
2526 \begin_layout Subsubsection
2527 gui.bitmap_draw(number x, number y, dbitmap bitmap)
2530 \begin_layout Standard
2531 Draw a bitmap on screen.
2535 \begin_layout Itemize
2536 x: X-coordinate of left edge.
2539 \begin_layout Itemize
2540 y: Y-coordinate of top edge.
2543 \begin_layout Itemize
2544 bitmap: The bitmap to draw
2547 \begin_layout Subsubsection
2551 \begin_layout Standard
2552 Returns a new palette (initially all transparent).
2553 Can be used anywhere.
2556 \begin_layout Subsubsection
2557 gui.bitmap_new(number w, number h, boolean direct[, bool icolor])
2560 \begin_layout Standard
2561 Returns a new bitmap/dbitmap.
2562 Can be used anywhere.
2566 \begin_layout Itemize
2567 w: The width of new bitmap
2570 \begin_layout Itemize
2571 h: The height of new bitmap
2574 \begin_layout Itemize
2575 direct: If true, the returned bitmap is dbitmap, otherwise bitmap.
2578 \begin_layout Itemize
2579 icolor: Initital fill color (defaults to 0 on BITMAP, -1 on DBITMAP)
2582 \begin_layout Subsubsection
2583 gui.bitmap_load(string file)
2586 \begin_layout Standard
2587 Returns loaded bitmap/dbitmap (if bitmap, the second return value is palette
2589 Can be used anywhere.
2593 \begin_layout Itemize
2594 file: The name of file to load.
2597 \begin_layout Subsubsection
2598 gui.palette_set(palette palette, number index, number color)
2601 \begin_layout Standard
2602 Sets color in palette.
2603 Can be used anywhere.
2607 \begin_layout Itemize
2608 palette: The palette to manipulate
2611 \begin_layout Itemize
2612 index: Index of color (0-65535).
2615 \begin_layout Itemize
2616 color: The color value.
2619 \begin_layout Subsubsection
2620 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y, number color)
2623 \begin_layout Standard
2624 Sets specified pixel in bitmap.
2625 Can be used anywhere.
2629 \begin_layout Itemize
2630 bitmap: The bitmap to manipulate
2633 \begin_layout Itemize
2634 x: The x-coordinate of the pixel.
2637 \begin_layout Itemize
2638 y: The y-coordinate of the pixel.
2641 \begin_layout Itemize
2642 color: If bitmap is a bitmap, color index (0-65535).
2643 Otherwise color value.
2646 \begin_layout Subsubsection
2647 gui.bitmap_size(bitmap/dbitmap bitmap)
2650 \begin_layout Standard
2652 Can be used anywhere.
2656 \begin_layout Itemize
2657 bitmap: The bitmap to query.
2660 \begin_layout Standard
2661 The first return is the width, the second is the height.
2664 \begin_layout Subsubsection
2665 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy, bitmap/dbitmap
2666 src, number sx, number sy, number w, number h[, number ck])
2669 \begin_layout Standard
2670 Blit a part of bitmap to another.
2671 Can be used anywhere.
2675 \begin_layout Itemize
2676 dest: Destination to blit to.
2679 \begin_layout Itemize
2680 dx: left edge of target
2683 \begin_layout Itemize
2684 dy: Top edge of target
2687 \begin_layout Itemize
2688 src: The source to blit from.
2689 Must be of the same type as destination.
2692 \begin_layout Itemize
2693 sx: left edge of source
2696 \begin_layout Itemize
2697 sy: Top edge of source
2700 \begin_layout Itemize
2704 \begin_layout Itemize
2705 h: Height of region.
2708 \begin_layout Itemize
2710 Pixels of this color are not blitted.
2714 \begin_layout Itemize
2715 If bitmaps are bitmaps, this is color index of colorkey.
2716 Values outside range 0-65535 cause no key to be used as colorkey.
2719 \begin_layout Itemize
2720 If bitmaps are dbitmaps, this color value of colorkey.
2723 \begin_layout Itemize
2724 May be absent or nil for no colorkey blit.
2728 \begin_layout Subsubsection
2732 \begin_layout Standard
2733 Request on_repaint() to happen as soon as possible.
2734 Can be used anywhere.
2737 \begin_layout Subsubsection
2738 gui.subframe_update(boolean on)
2741 \begin_layout Standard
2742 Request subframe updates (calling on_paint() on subframes) to happen (on=true)
2743 or not happen (on=false).
2744 Can be used anywhere.
2747 \begin_layout Subsubsection
2748 gui.screenshot(string filename)
2751 \begin_layout Standard
2752 Write PNG screenshot of the current frame (no drawings) to specified file.
2753 Can be used anywhere.
2756 \begin_layout Subsubsection
2757 gui.color(number r, number g, number b[, number a])
2760 \begin_layout Standard
2761 Returns color (in notation Lua scripts use) corresponding to color (r,g,b),
2762 each component in scale 0-255.
2763 If a is specified, that is alpha (0 is fully transparent, 256(sic) is fully
2765 The default alpha is 256.
2768 \begin_layout Subsubsection
2769 gui.status(string name, string value)
2772 \begin_layout Standard
2774 \begin_inset Quotes eld
2778 \begin_inset Quotes erd
2781 to <value> in status area.
2782 Can be used anywhere.
2785 \begin_layout Subsubsection
2786 gui.rainbow(number step, number steps[, number color])
2789 \begin_layout Standard
2790 Perform hue rotation of color <color> (default bright red), by <step> steps.
2791 The number of steps per full rotation is given by absolute value of <steps>.
2794 \begin_layout Standard
2795 If <steps> is negative, the rotation will be counterclockwise.
2798 \begin_layout Subsection
2802 \begin_layout Standard
2804 Only available in on_input callback.
2807 \begin_layout Subsubsection
2808 input.get(number controller, number index)
2811 \begin_layout Standard
2812 Read the specified index (0-11) from specified controller (0-7).
2816 \begin_layout Itemize
2817 Uses physical controller numbering.
2818 Gamepad in port 2 is controller 4, not 1!
2821 \begin_layout Subsubsection
2822 input.set(number controller, number index, number value)
2825 \begin_layout Standard
2826 Write the specified index (0-11) from specified controller (0-7), storing
2831 \begin_layout Itemize
2832 Uses physical controller numbering.
2833 Gamepad in port 2 is controller 4, not 1!
2836 \begin_layout Subsubsection
2837 input.geta(number controller)
2840 \begin_layout Standard
2841 Get input state for entiere controller.
2842 Returns 13 return values.
2845 \begin_layout Itemize
2846 1st return value: Bitmask: bit i is set if i:th index is nonzero
2849 \begin_layout Itemize
2850 2nd-13th return value: value of i:th index.
2853 \begin_layout Subsubsection
2854 input.seta(number controller, number bitmask, number args...)
2857 \begin_layout Standard
2858 Set state for entiere controller.
2859 args is up to 12 values for indices (overriding values in bitmask if specified).
2862 \begin_layout Subsubsection
2863 input.controllertype(number controller)
2866 \begin_layout Standard
2867 Get the type of controller as string.
2871 \begin_layout Itemize
2875 \begin_layout Itemize
2879 \begin_layout Itemize
2883 \begin_layout Itemize
2887 \begin_layout Subsubsection
2888 input.reset([number cycles])
2891 \begin_layout Standard
2893 If cycles is greater than zero, do delayed reset.
2894 0 (or no value) causes immediate reset.
2897 \begin_layout Itemize
2898 Only available with subframe flag false.
2901 \begin_layout Subsubsection
2905 \begin_layout Standard
2906 Returns table of tables of all available keys and axes.
2907 The first table is indexed by key name (platform-dependent!), and the inner
2908 table has the following fields:
2911 \begin_layout Itemize
2912 last_rawval: Last reported raw value for control.
2915 \begin_layout Itemize
2916 ktype: Type of key (disabled, key, mouse, axis, axis-inverse, hat, pressure-m0,
2917 pressure-mp, pressure-0m, pressure-0p, pressure-pm, pressure-p0).
2920 \begin_layout Itemize
2921 cal_left: Minimum calibration value.
2922 Only meaningful with axis and pressure types.
2925 \begin_layout Itemize
2926 cal_center: Center calibration value.
2927 Only meaningful with axis and pressure types.
2930 \begin_layout Itemize
2931 cal_right: Maximum calibration value.
2932 Only meaningful with axis and pressure types.
2935 \begin_layout Itemize
2936 cal_tolerance: Dead zone tolerance.
2937 Only meaningful with axis and pressure types.
2940 \begin_layout Subsubsection
2941 input.keyhook(key, state)
2944 \begin_layout Standard
2945 Requests that keyhook events to be sent for key (state=true) or not sent
2949 \begin_layout Subsection
2953 \begin_layout Standard
2954 Host memory handling (extra memory saved to savestates).
2955 Host memory starts empty.
2958 \begin_layout Subsubsection
2959 hostmemory.read(number address)
2962 \begin_layout Standard
2963 Reads hostmemory slot address.
2964 Slot numbers out of range return false instead of numeric.
2967 \begin_layout Subsubsection
2968 hostmemory.write(number address, number value)
2971 \begin_layout Standard
2972 Writes hostmemory slot with 0-255.
2973 Slot numbers out of range cause extension of host memory slot space.
2976 \begin_layout Subsubsection
2977 hostmemory.readbyte(number address)
2980 \begin_layout Standard
2981 Read unsigned byte (1 element) from given address.
2982 Slots out of range return false.
2985 \begin_layout Subsubsection
2986 hostmemory.writebyte(number address, number value)
2989 \begin_layout Standard
2990 Write unsigned byte (1 element) to given slot.
2991 Slot numbers out of range cause extension.
2994 \begin_layout Subsubsection
2995 hostmemory.readsbyte(number address)
2998 \begin_layout Standard
2999 Read signed byte (1 element) from given address.
3000 Slots out of range return false.
3003 \begin_layout Subsubsection
3004 hostmemory.writesbyte(number address, number value)
3007 \begin_layout Standard
3008 Write signed byte (1 element) to given slot.
3009 Slot numbers out of range cause extension.
3012 \begin_layout Subsubsection
3013 hostmemory.readword(number address)
3016 \begin_layout Standard
3017 Read unsigned word (2 elements) from given address.
3018 Slots out of range return false.
3021 \begin_layout Subsubsection
3022 hostmemory.writeword(number address, number value)
3025 \begin_layout Standard
3026 Write unsigned word (2 elements) to given slot.
3027 Slot numbers out of range cause extension.
3030 \begin_layout Subsubsection
3031 hostmemory.readsword(number address)
3034 \begin_layout Standard
3035 Read signed word (2 elements) from given address.
3036 Slots out of range return false.
3039 \begin_layout Subsubsection
3040 hostmemory.writesword(number address, number value)
3043 \begin_layout Standard
3044 Write signed word (2 elements) to given slot.
3045 Slot numbers out of range cause extension.
3048 \begin_layout Subsubsection
3049 hostmemory.readdword(number address)
3052 \begin_layout Standard
3053 Read unsigned doubleword (4 elements) from given address.
3054 Slots out of range return false.
3057 \begin_layout Subsubsection
3058 hostmemory.writedword(number address, number value)
3061 \begin_layout Standard
3062 Write unsigned doubleword (4 elements) to given slot.
3063 Slot numbers out of range cause extension.
3066 \begin_layout Subsubsection
3067 hostmemory.readsdword(number address)
3070 \begin_layout Standard
3071 Read signed doubleword (4 elements) from given address.
3072 Slots out of range return false.
3075 \begin_layout Subsubsection
3076 hostmemory.writesdword(number address, number value)
3079 \begin_layout Standard
3080 Write signed doubleword (4 elements) to given slot.
3081 Slot numbers out of range cause extension.
3084 \begin_layout Subsubsection
3085 hostmemory.readqword(number address)
3088 \begin_layout Standard
3089 Read unsigned quadword (8 elements) from given address.
3090 Slots out of range return false.
3093 \begin_layout Subsubsection
3094 hostmemory.writeqword(number address, number value)
3097 \begin_layout Standard
3098 Write unsigned quadword (4 elements) to given slot.
3099 Slot numbers out of range cause extension.
3102 \begin_layout Subsubsection
3103 hostmemory.readsqword(number address)
3106 \begin_layout Standard
3107 Read signed quadword (8 elements) from given address.
3108 Slots out of range return false.
3111 \begin_layout Subsubsection
3112 hostmemory.writesqword(number address, number value)
3115 \begin_layout Standard
3116 Write signed quadword (8 elements) to given slot.
3117 Slot numbers out of range cause extension.
3120 \begin_layout Subsection
3124 \begin_layout Standard
3128 \begin_layout Subsubsection
3129 movie.currentframe()
3132 \begin_layout Standard
3133 Return number of current frame.
3136 \begin_layout Subsubsection
3140 \begin_layout Standard
3141 Return number of frames in movie.
3144 \begin_layout Subsubsection
3148 \begin_layout Standard
3149 Return true if in readonly mode, false if in readwrite.
3152 \begin_layout Subsubsection
3153 movie.set_readwrite()
3156 \begin_layout Standard
3157 Set readwrite mode (does not cause on_readwrite callback).
3160 \begin_layout Subsubsection
3161 movie.frame_subframes(number frame)
3164 \begin_layout Standard
3165 Count number of subframes in specified frame (frame numbers are 1-based)
3169 \begin_layout Subsubsection
3170 movie.read_subframe(number frame, number subframe)
3173 \begin_layout Standard
3174 Read specifed subframe in specified frame and return data as array (100
3175 elements, numbered 0-99 currently).
3178 \begin_layout Subsection
3182 \begin_layout Standard
3183 Routines for settings manipulation
3186 \begin_layout Subsubsection
3187 settings.get(string name)
3190 \begin_layout Standard
3191 Get value of setting.
3192 If setting is blank, returns false.
3193 If setting value can't be obtained, returns (nil, error message).
3196 \begin_layout Subsubsection
3197 settings.set(string name, string value)
3200 \begin_layout Standard
3201 Set value of setting.
3202 If setting can't be set, returns (nil, error message).
3205 \begin_layout Subsubsection
3206 settings.is_set(string name)
3209 \begin_layout Standard
3210 Returns if setting is set.
3211 If setting does not exist, returns (nil, error message).
3214 \begin_layout Subsubsection
3215 settings.blank(string name)
3218 \begin_layout Standard
3219 Blanks a setting and returns true.
3220 If setting can't be blanked, returns (nil, error message).
3223 \begin_layout Subsection
3227 \begin_layout Standard
3228 Contains various functions for managing memory
3231 \begin_layout Subsubsection
3235 \begin_layout Standard
3236 Returns the number of VMAs
3239 \begin_layout Subsubsection
3240 memory.read_vma(number index)
3243 \begin_layout Standard
3244 Reads the specified VMA (indices start from zero).
3245 Trying to read invalid VMA gives nil.
3246 The read VMA is table with the following fields:
3249 \begin_layout Itemize
3250 region_name (string): The readable name of the VMA
3253 \begin_layout Itemize
3254 baseaddr (number): Base address of the VMA
3257 \begin_layout Itemize
3258 lastaddr (number): Last address in the VMA.
3261 \begin_layout Itemize
3262 size (number): The size of VMA in bytes.
3265 \begin_layout Itemize
3266 readonly (boolean): True of the VMA corresponds to ROM.
3269 \begin_layout Itemize
3270 native_endian (boolean): True if the VMA has native endian as opposed to
3274 \begin_layout Subsubsection
3275 memory.find_vma(number address)
3278 \begin_layout Standard
3279 Finds the VMA containing specified address.
3280 Returns table in the same format as read_vma or nil if not found.
3283 \begin_layout Subsubsection
3284 memory.readbyte(number address)
3287 \begin_layout Standard
3288 Reads the specified address as unsigned byte and returns the result.
3291 \begin_layout Subsubsection
3292 memory.readsbyte(number address)
3295 \begin_layout Standard
3296 Reads the specified address as signed byte and returns the result.
3299 \begin_layout Subsubsection
3300 memory.writebyte(number address, number value)
3303 \begin_layout Standard
3304 Writes the specified value (negative values undergo 2's complement) to specified
3305 address (as a byte).
3308 \begin_layout Subsubsection
3309 memory.readword(number address)
3312 \begin_layout Standard
3313 Reads the specified address as unsigned word and returns the result.
3316 \begin_layout Subsubsection
3317 memory.readsword(number address)
3320 \begin_layout Standard
3321 Reads the specified address as signed word and returns the result.
3324 \begin_layout Subsubsection
3325 memory.writeword(number address, number value)
3328 \begin_layout Standard
3329 Writes the specified value (negative values undergo 2's complement) to specified
3330 address (as a word).
3333 \begin_layout Subsubsection
3334 memory.readdword(number address)
3337 \begin_layout Standard
3338 Reads the specified address as unsigned doubleword and returns the result.
3341 \begin_layout Subsubsection
3342 memory.readsdword(number address)
3345 \begin_layout Standard
3346 Reads the specified address as signed doubleword and returns the result.
3349 \begin_layout Subsubsection
3350 memory.writedword(number address, number value)
3353 \begin_layout Standard
3354 Writes the specified value (negative values undergo 2's complement) to specified
3355 address (as a doubleword).
3358 \begin_layout Subsubsection
3359 memory.readqword(number address)
3362 \begin_layout Standard
3363 Reads the specified address as unsigned quadword and returns the result.
3366 \begin_layout Subsubsection
3367 memory.readsqword(number address)
3370 \begin_layout Standard
3371 Reads the specified address as signed quadword and returns the result.
3374 \begin_layout Subsubsection
3375 memory.writeqword(number address, number value)
3378 \begin_layout Standard
3379 Writes the specified value (negative values undergo 2's complement) to specified
3380 address (as a quadword).
3383 \begin_layout Subsection
3387 \begin_layout Standard
3388 Contains copy of global variables from time of Lua initialization.
3392 \begin_layout Subsection
3396 \begin_layout Standard
3397 Various callbacks to Lua that can occur.
3400 \begin_layout Subsubsection
3401 Callback: on_paint(bool not_synth)
3404 \begin_layout Standard
3405 Called when screen is being painted.
3406 Any gui.* calls requiring graphic context draw on the screen.
3409 \begin_layout Standard
3410 not_synth is true if this hook is being called in response to received frame,
3414 \begin_layout Subsubsection
3415 Callback: on_video()
3418 \begin_layout Standard
3419 Called when video dump frame is being painted.
3420 Any gui.* calls requiring graphic context draw on the video.
3423 \begin_layout Subsubsection
3424 Callback: on_frame_emulated()
3427 \begin_layout Standard
3428 Called when emulating frame has completed and on_paint()/on_video() calls
3429 are about to be issued.
3432 \begin_layout Subsubsection
3433 Callback: on_frame()
3436 \begin_layout Standard
3437 Called on each starting whole frame.
3440 \begin_layout Subsubsection
3441 Callback: on_startup()
3444 \begin_layout Standard
3445 Called when the emulator is starting (lsnes.rc and --run files has been run).
3448 \begin_layout Subsubsection
3449 Callback: on_rewind()
3452 \begin_layout Standard
3453 Called when rewind movie to beginning has completed.
3456 \begin_layout Subsubsection
3457 Callback: on_pre_load(string name)
3460 \begin_layout Standard
3461 Called just before savestate/movie load occurs (note: loads are always delayed,
3462 so this occurs even when load was initiated by lua).
3465 \begin_layout Subsubsection
3466 Callback: on_err_load(string name)
3469 \begin_layout Standard
3470 Called if loadstate goes wrong.
3473 \begin_layout Subsubsection
3474 Callback: on_post_load(string name, boolean was_savestate)
3477 \begin_layout Standard
3478 Called on successful loadstate.
3479 was_savestate gives if this was a savestate or a movie.
3482 \begin_layout Subsubsection
3483 Callback: on_pre_save(string name, boolean is_savestate)
3486 \begin_layout Standard
3487 Called just before savestate save occurs (note: movie saves are synchronous
3488 and won't trigger these callbacks if called from Lua).
3491 \begin_layout Subsubsection
3492 Callback: on_err_save(string name)
3495 \begin_layout Standard
3496 Called if savestate goes wrong.
3499 \begin_layout Subsubsection
3500 Callback: on_post_save(string name, boolean is_savestate)
3503 \begin_layout Standard
3504 Called on successful savaestate.
3505 is_savestate gives if this was a savestate or a movie.
3508 \begin_layout Subsubsection
3512 \begin_layout Standard
3513 Called when emulator is shutting down.
3516 \begin_layout Subsubsection
3517 Callback: on_input(boolean subframe)
3520 \begin_layout Standard
3521 Called when emulator is just sending input to bsnes core.
3522 Warning: This is called even in readonly mode, but the results are ignored.
3525 \begin_layout Subsubsection
3526 Callback: on_reset()
3529 \begin_layout Standard
3530 Called when SNES is reset.
3533 \begin_layout Subsubsection
3534 Callback: on_readwrite()
3537 \begin_layout Standard
3538 Called when moving into readwrite mode as result of
3539 \begin_inset Quotes eld
3543 \begin_inset Quotes erd
3546 command (note: moving to rwmode by Lua won't trigger this, as per recursive
3550 \begin_layout Subsubsection
3551 Callback: on_snoop(number port, number controller, number index, number
3555 \begin_layout Standard
3556 Called each time bsnes asks for input.
3557 The value is the final value to be sent to bsnes core (readonly mode, autohold
3558 and autofire have been taken into account).
3559 Might be useful when translating movies to format suitable for console
3561 Note: There is no way to modify the value to be sent.
3564 \begin_layout Subsubsection
3565 Callback: on_keyhook(string keyname, table state)
3568 \begin_layout Standard
3569 Sent when key that has keyhook events requested changes state.
3570 Keyname is name of the key (group) and state is the state (same kind as
3571 table values in input.raw).
3574 \begin_layout Subsubsection
3578 \begin_layout Standard
3579 Called when requested by set_idle_timeout(), the timeout has expired and
3580 emulator is waiting.
3583 \begin_layout Subsubsection
3584 Callback: on_timer()
3587 \begin_layout Standard
3588 Called when requested by set_idle_timeout() and the timeout has expired
3589 (regardless if emulator is waiting).
3592 \begin_layout Section
3593 Memory watch expression syntax
3596 \begin_layout Standard
3597 Memory watch expressions are in RPN (Reverse Polish Notation).
3598 At the end of expression, the top entry on stack is taken as the final
3602 \begin_layout Standard
3606 \begin_layout Itemize
3607 Evaluation order is strictly left to right.
3610 \begin_layout Itemize
3611 a is the entry on top of stack
3614 \begin_layout Itemize
3615 b is the entry immediately below top of stack
3618 \begin_layout Itemize
3619 ; separates values to be pushed (no intermediate pop).
3622 \begin_layout Itemize
3623 After end of element, all used stack slots are popped and all results are
3627 \begin_layout Itemize
3628 When pushing multiple values, the pushes occur in order shown.
3631 \begin_layout Standard
3632 The following operators are available:
3635 \begin_layout Itemize
3639 \begin_layout Itemize
3643 \begin_layout Itemize
3647 \begin_layout Itemize
3651 \begin_layout Itemize
3655 \begin_layout Itemize
3659 \begin_layout Itemize
3660 b : read_signed_byte(a)
3663 \begin_layout Itemize
3667 \begin_layout Itemize
3668 d : read_signed_dword(a)
3671 \begin_layout Itemize
3675 \begin_layout Itemize
3677 \begin_inset Formula $\pi$
3683 \begin_layout Itemize
3684 q : read_signed_qword(a)
3687 \begin_layout Itemize
3691 \begin_layout Itemize
3695 \begin_layout Itemize
3699 \begin_layout Itemize
3703 \begin_layout Itemize
3704 w : read_signed_word(a)
3707 \begin_layout Itemize
3711 \begin_layout Itemize
3712 B : read_unsigned_byte(a)
3715 \begin_layout Itemize
3716 C<number>z : Push number <number> to stack.
3719 \begin_layout Itemize
3720 D : read_unsigned_dword(a)
3723 \begin_layout Itemize
3724 C0x<number>z : Push number <number> (hexadecimal) to stack.
3727 \begin_layout Itemize
3728 Q : read_unsigned_qword(a)
3731 \begin_layout Itemize
3732 R<digit> : round a to <digit> digits.
3735 \begin_layout Itemize
3736 W : read_unsigned_word(a)
3739 \begin_layout Subsection
3743 \begin_layout Standard
3744 C0x007e0878zWC0x007e002czW-
3747 \begin_layout Enumerate
3748 Push value 0x7e0878 on top of stack (C0x007e0878z).
3751 \begin_layout Enumerate
3752 Pop the value on top of stack (0x7e0878), read word value at that address
3753 and push the result,call it x1 (W).
3756 \begin_layout Enumerate
3757 Push value 0x7e002c on top of stack (C0x007e002cz).
3760 \begin_layout Enumerate
3761 Pop the value on top of stack (0x7e002c), read word value at that address
3762 and push the result,call it x2 (W).
3765 \begin_layout Enumerate
3766 Pop the two top numbers on stack, x1 and x2, substract x1 from x2 and push
3770 \begin_layout Enumerate
3771 Since the expression ends, the final memory watch result is the top one
3772 on stack, which is x2 - x1.
3775 \begin_layout Section
3776 Modifier and key names:
3779 \begin_layout Subsection
3783 \begin_layout Subsubsection
3787 \begin_layout Standard
3788 Following modifier names are known:
3791 \begin_layout Itemize
3792 ctrl, lctrl, rctrl: Control keys
3795 \begin_layout Itemize
3796 alt, lalt, ralt: ALT keys.
3799 \begin_layout Itemize
3800 shift, lshift, rshift: Shift keys.
3803 \begin_layout Itemize
3804 meta, lmeta, rmeta: Meta keys.
3807 \begin_layout Itemize
3808 num, caps: Numlock/Capslock (these are sticky!)
3811 \begin_layout Itemize
3815 \begin_layout Subsubsection
3819 \begin_layout Standard
3820 Following key names are known:
3823 \begin_layout Itemize
3824 backspace, tab, clear, return, pause, escape, space, exclaim, quotedbl,
3825 hash, dollar, ampersand, quote, leftparen, rightparen, asterisk, plus,
3826 comma, minus, period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon,
3827 less, equals, greater, question, at, leftbracket, backslash, rightbracket,
3828 caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n,
3829 o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0, world_1, world_2,
3830 world_3, world_4, world_5, world_6, world_7, world_8, world_9, world_10,
3831 world_11, world_12, world_13, world_14, world_15, world_16, world_17, world_18,
3832 world_19, world_20, world_21, world_22, world_23, world_24, world_25, world_26,
3833 world_27, world_28, world_29, world_30, world_31, world_32, world_33, world_34,
3834 world_35, world_36, world_37, world_38, world_39, world_40, world_41, world_42,
3835 world_43, world_44, world_45, world_46, world_47, world_48, world_49, world_50,
3836 world_51, world_52, world_53, world_54, world_55, world_56, world_57, world_58,
3837 world_59, world_60, world_61, world_62, world_63, world_64, world_65, world_66,
3838 world_67, world_68, world_69, world_70, world_71, world_72, world_73, world_74,
3839 world_75, world_76, world_77, world_78, world_79, world_80, world_81, world_82,
3840 world_83, world_84, world_85, world_86, world_87, world_88, world_89, world_90,
3841 world_91, world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3, kp4,
3842 kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide, kp_multiply, kp_minus, kp_plus,
3843 kp_enter, kp_equals, up, down, right, left, insert, home, end, pageup,
3844 pagedown, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14,
3845 f15, numlock, capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt,
3846 lalt, rmeta, lmeta, lsuper, rsuper, mode, compose, help, print, sysreq,
3847 break, menu, power, euro, undo
3850 \begin_layout Itemize
3851 Names of form 'key<n>' where <n> is 0-255 are interpretted as key having
3852 hardware-dependent scan code of <n> (useful to bind those keys that don't
3853 have symbolic names).
3856 \begin_layout Subsubsection
3857 Joystick pseudo-keys:
3860 \begin_layout Itemize
3861 joystick<num>button<button>: Joystick <num> (0-based) button <button> (0-based).
3864 \begin_layout Itemize
3865 joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat> (0-based) up.
3868 \begin_layout Itemize
3869 joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat> (0-based) left.
3872 \begin_layout Itemize
3873 joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat> (0-based) down.
3876 \begin_layout Itemize
3877 joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat> (0-based) right.
3880 \begin_layout Itemize
3881 joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis> negative
3882 position (axis modes axis and axis_inverse).
3885 \begin_layout Itemize
3886 joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis> positive
3887 position (axis modes axis and axis_inverse).
3890 \begin_layout Itemize
3891 joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis> pressure (axis
3895 \begin_layout Subsubsection
3899 \begin_layout Itemize
3900 Escape: Enter/Exit Command mode, cancel modal dialogs.
3903 \begin_layout Itemize
3904 Return (also KPEnter): Execute command, ok modal dialog.
3907 \begin_layout Itemize
3908 Pgup/Up (also KP8/9 if no num lock; command mode): Previous command in command
3912 \begin_layout Itemize
3913 Pgdn/Down(also KP2/3 if no num lock; command mode): Next command in command
3917 \begin_layout Itemize
3918 Home (also KP7 if no num lock; command mode): Beginning of command.
3921 \begin_layout Itemize
3922 End (also KP1 if no num lock; command mode): End of command.
3925 \begin_layout Itemize
3926 Left (also KP4 if no num lock; command mode): Move cursor left.
3929 \begin_layout Itemize
3930 Right (also KP6 if no num lock; command mode): Move cursor right.
3933 \begin_layout Itemize
3935 if no num lock; command mode): Delete character to right of cursor.
3938 \begin_layout Itemize
3939 Insert (also KP0 if no num lock; command mode): Toggle between insert /
3943 \begin_layout Itemize
3944 Backspace (command mode): Delete character to left of cursor.
3947 \begin_layout Itemize
3948 LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump corrupted!).
3951 \begin_layout Subsection
3955 \begin_layout Subsubsection
3959 \begin_layout Standard
3960 Following modifier names are known:
3963 \begin_layout Itemize
3967 \begin_layout Itemize
3971 \begin_layout Itemize
3975 \begin_layout Itemize
3979 \begin_layout Itemize
3983 \begin_layout Subsubsection
3987 \begin_layout Standard
3988 Following key names are known:
3991 \begin_layout Itemize
3992 back, tab, return, escape, space, exclaim, quotedbl, hash, dollar, percent,
3993 ampersand, quote, leftparen, rightparen, asterisk, plus, comma, minus,
3994 period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
3995 greater, question, at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3996 q, r, s, t, u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
3997 underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3998 q, r, s, t, u, v, w, x, y, z, leftcurly, pipe, rightcurly, tilde, delete,
3999 start, lbutton, rbutton, cancel, mbutton, clear, shift, alt, control, menu,
4000 pause, capital, end, home, lefT, up, right, down, select, print, execute,
4001 snapshot, insert, help, numpad0, numpad1, numpad2, numpad3, numpad4, numpad5,
4002 numpad6, numpad7, numpad8, numpad9, multiply, add, separator, subtract,
4003 decimal, divide, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13,
4004 f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, numlock, scroll,
4005 pageup, pagedown, numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
4006 numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up, numpad_right,
4007 numpad_down, numpad_pageup, numpad_pagedown, numpad_end, numpad_begin,
4008 numpad_insert, numpad_delete, numpad_equal, numpad_multiply, numpad_add,
4009 numpad_separator, numpad_subtract, numpad_decimal, numpad_divide, windows_left,
4010 windows_right, windows_menu, command, special1, special2, special3, special4,
4011 special5, special6, special7, special8, special9, special10, special11,
4012 special12, special13, special14, special15, special16, special17, special18,
4013 special19, special20
4016 \begin_layout Section
4020 \begin_layout Standard
4021 Movie file is .zip archive in itself, normal ZIP archive tools work on it
4022 (note: If you recompress it, do not use compression methods other than
4023 store and deflate and especially do not use encryption of any kind).
4026 \begin_layout Subsection
4027 Detecting clean start/SRAM/Savestate
4030 \begin_layout Itemize
4032 \begin_inset Quotes eld
4036 \begin_inset Quotes erd
4039 it is savestate, otherwise:
4042 \begin_layout Itemize
4043 If file has members with names starting
4044 \begin_inset Quotes eld
4048 \begin_inset Quotes erd
4051 it is movie starting from SRAM, otherwise:
4054 \begin_layout Itemize
4055 It is movie starting from clear state.
4058 \begin_layout Subsection
4062 \begin_layout Standard
4063 Type of game ROM and region (as one line).
4067 \begin_layout Standard
4068 \begin_inset Tabular
4069 <lyxtabular version="3" rows="8" columns="3">
4070 <features tabularvalignment="middle">
4071 <column alignment="center" valignment="top" width="0">
4072 <column alignment="center" valignment="top" width="0">
4073 <column alignment="center" valignment="top" width="0">
4075 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4078 \begin_layout Plain Layout
4084 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4087 \begin_layout Plain Layout
4093 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4096 \begin_layout Plain Layout
4104 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4107 \begin_layout Plain Layout
4113 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4116 \begin_layout Plain Layout
4122 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4125 \begin_layout Plain Layout
4133 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4136 \begin_layout Plain Layout
4142 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4145 \begin_layout Plain Layout
4151 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4154 \begin_layout Plain Layout
4162 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4165 \begin_layout Plain Layout
4171 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4174 \begin_layout Plain Layout
4180 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4183 \begin_layout Plain Layout
4191 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4194 \begin_layout Plain Layout
4200 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4203 \begin_layout Plain Layout
4209 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4212 \begin_layout Plain Layout
4220 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4223 \begin_layout Plain Layout
4229 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4232 \begin_layout Plain Layout
4238 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4241 \begin_layout Plain Layout
4249 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4252 \begin_layout Plain Layout
4258 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4261 \begin_layout Plain Layout
4267 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4270 \begin_layout Plain Layout
4278 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4281 \begin_layout Plain Layout
4287 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4290 \begin_layout Plain Layout
4296 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4299 \begin_layout Plain Layout
4313 \begin_layout Standard
4317 \begin_layout Standard
4318 \begin_inset Tabular
4319 <lyxtabular version="3" rows="3" columns="2">
4320 <features tabularvalignment="middle">
4321 <column alignment="center" valignment="top" width="0">
4322 <column alignment="center" valignment="top" width="0">
4324 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4327 \begin_layout Plain Layout
4333 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4336 \begin_layout Plain Layout
4344 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4347 \begin_layout Plain Layout
4353 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4356 \begin_layout Plain Layout
4364 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4367 \begin_layout Plain Layout
4373 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4376 \begin_layout Plain Layout
4390 \begin_layout Subsection
4394 \begin_layout Standard
4395 Contains type of port #1 (as one line).
4396 Valid values are 'none', 'gamepad', 'multitap' and 'mouse'.
4397 If not present, defaults to 'gamepad'.
4400 \begin_layout Subsection
4404 \begin_layout Standard
4405 Contains type of port #2 (as one line).
4406 Valid values are 'none', 'gamepad', 'multitap', 'mouse', 'superscope',
4407 'justifier' and 'justifiers'.
4408 If not present, defaults to 'none'.
4411 \begin_layout Subsection
4415 \begin_layout Standard
4416 Contains name of the game (as one line).
4419 \begin_layout Subsection
4423 \begin_layout Standard
4424 Contains authors, one per line.
4425 Part before '|' is the full name, part after is the nickname.
4428 \begin_layout Subsection
4432 \begin_layout Standard
4434 \begin_inset Quotes eld
4438 \begin_inset Quotes erd
4442 Used to reject other saves.
4445 \begin_layout Subsection
4446 Member: controlsversion
4449 \begin_layout Standard
4451 \begin_inset Quotes eld
4455 \begin_inset Quotes erd
4459 Used to identify what controls are there.
4462 \begin_layout Subsection
4464 \begin_inset Quotes eld
4468 \begin_inset Quotes erd
4474 \begin_layout Standard
4475 Contains bsnes core version number (as one line).
4478 \begin_layout Subsection
4482 \begin_layout Standard
4483 Contains project ID (as one line).
4484 Used to identify if two movies are part of the same project.
4487 \begin_layout Subsection
4488 Member: {rom,slota,slotb}{,xml}.sha256
4491 \begin_layout Standard
4492 Contains SHA-256 of said ROM or ROM mapping file (as one line).
4493 Absent if corresponding file is absent.
4496 \begin_layout Subsection
4497 Member: moviesram.<name>
4500 \begin_layout Standard
4501 Raw binary startup SRAM of kind <name>.
4502 Only present in savestates and movies starting from SRAM.
4505 \begin_layout Subsection
4509 \begin_layout Standard
4510 Contains frame number (as one line) of frame movie was saved on.
4511 Only present in savestates.
4514 \begin_layout Subsection
4518 \begin_layout Standard
4519 Current value of lag counter (as one line).
4520 Only present in savestates.
4523 \begin_layout Subsection
4524 Member: pollcounters
4527 \begin_layout Standard
4528 Contains poll counters (currently 100 of them), one per line.
4529 Each line is raw poll count if DRDY is set for it.
4530 Otherwise it is negative poll count minus one.
4531 Only present in savestates.
4534 \begin_layout Subsection
4538 \begin_layout Standard
4539 Raw binary dump of host memory.
4540 Only present in savestates.
4543 \begin_layout Subsection
4547 \begin_layout Standard
4548 The raw binary savestate itself.
4549 Savestate detection uses this file, only present in savestates.
4552 \begin_layout Subsection
4556 \begin_layout Standard
4557 Screenshot of current frame.
4558 Only present in savestates.
4559 First 2 bytes are big-endian width of image, rest are 24-bit RGB image
4561 Height of image is inferred from the width and size of data.
4564 \begin_layout Subsection
4568 \begin_layout Standard
4569 Raw binary SRAM of kind <name> at time of savestate.
4570 Only present in savestates.
4573 \begin_layout Subsection
4577 \begin_layout Standard
4578 The actual input track, one line per subframe (blank lines are skipped).
4581 \begin_layout Itemize
4582 If the first byte of each line is '.', ' ', <tab> or '|', then the line is
4583 part of same frame as previous, otherwise it starts a new frame.
4586 \begin_layout Itemize
4587 First subframe must start a new frame.
4590 \begin_layout Standard
4591 Length of movie in frames is number of lines in input file that start a
4595 \begin_layout Subsection
4599 \begin_layout Standard
4600 Contains textual base-10 rerecord count (as one line; emulator just writes
4601 this, it doesn't read it) + 1.
4604 \begin_layout Subsection
4608 \begin_layout Standard
4609 This member stores set of load IDs.
4610 There is one load ID per rerecord (plus one corresponding to start of project).
4613 \begin_layout Itemize
4614 This member constists of concatenation of records
4617 \begin_layout Itemize
4618 Each record is 2-36 bytes long and can represent 1-16,843,009 consequtive
4622 \begin_layout Itemize
4623 IDs are interpretted as 256-bit big-endian integers with warparound.
4626 \begin_layout Itemize
4627 Initial predicted ID is all zeroes.
4630 \begin_layout Standard
4631 Format of each record is:
4634 \begin_layout Itemize
4635 1 byte: Opcode byte.
4636 Bits 0-4 are prefix length (prefixlen), bits 5-6 are count length (countlen).
4640 \begin_layout Itemize
4641 32-prefixlen bytes of ID.
4644 \begin_layout Itemize
4645 countlen bytes of big-endian count (count).
4648 \begin_layout Standard
4649 Records are processed as follows:
4652 \begin_layout Itemize
4653 To form the first ID encoded by record, take the first prefixlen bytes predicted
4654 ID and append the read ID value to it.
4655 The result is the first ID encoded.
4658 \begin_layout Itemize
4659 If countlen is 0, record encodes 1 ID.
4662 \begin_layout Itemize
4663 If countlen is 1, record encodes 2+count IDs.
4666 \begin_layout Itemize
4667 If countlen is 2, record encodes 258+count IDs.
4670 \begin_layout Itemize
4671 If countlen is 3, record encodes 65794+count IDs.
4674 \begin_layout Itemize
4675 The new predicted ID is the next ID after last one encoded by the record.
4678 \begin_layout Standard
4679 The number of rerecords + 1 is equal to the sum of number of IDs encoded
4683 \begin_layout Subsection
4684 Member: starttime.second
4687 \begin_layout Standard
4688 Movie starting time, second part.
4689 Epoch is Unix epoch.
4690 Default is 1,000,000,000.
4693 \begin_layout Subsection
4694 Member: starttime.subsecond
4697 \begin_layout Standard
4698 Movie starting time, subsecond part.
4703 \begin_layout Subsection
4704 Member: savetime.second
4707 \begin_layout Standard
4708 Movie saving time, second part.
4709 Default is starttime.second.
4710 Only present in savestates.
4713 \begin_layout Subsection
4714 Member: savetime.subsecond
4717 \begin_layout Standard
4718 Movie saving time, subsecond part.
4719 Default is starttime.subsecond.
4720 Only present in savestates.
4723 \begin_layout Section
4724 Quick'n'dirty encode guide
4727 \begin_layout Enumerate
4728 Start the emulator and load the movie file.
4731 \begin_layout Enumerate
4732 Set large AVI option 'set-setting avi-large on'
4735 \begin_layout Enumerate
4736 Enable dumping 'dump-avi tmpdump'
4739 \begin_layout Enumerate
4740 Unpause and let it run until you want to end dumping.
4743 \begin_layout Enumerate
4744 Close the emulator (closing the window is the easiest way).
4748 \begin_layout Enumerate
4749 For each tmpdump*.avi file created, on command prompt, do 'x264 --crf 10
4750 -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
4753 \begin_layout Enumerate
4754 Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
4757 \begin_layout Enumerate
4758 Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv + tmpdump_0000001.mkv
4759 + tmpdump_0000002.mkv' (list every tmpdump_<numbers>.mkv, with + in between).
4762 \begin_layout Enumerate
4763 Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'.
4764 Now final.mkv contains quick'n'dirty encode.
4767 \begin_layout Section
4768 Axis configurations for some gamepad types:
4771 \begin_layout Subsection
4775 \begin_layout Standard
4776 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be set to pressure-+.
4779 \begin_layout LyX-Code
4780 set-axis joystick0axis2 pressure-+
4783 \begin_layout LyX-Code
4784 set-axis joystick0axis5 pressure-+
4787 \begin_layout Itemize
4788 This is needed for SDL only.
4789 EVDEV sets those types correctly.
4792 \begin_layout Subsection
4794 \begin_inset Quotes eld
4798 \begin_inset Quotes erd
4804 \begin_layout Standard
4805 Axes 8-19 should be disabled.
4808 \begin_layout LyX-Code
4809 set-axis joystick0axis8 disabled
4812 \begin_layout LyX-Code
4813 set-axis joystick0axis9 disabled
4816 \begin_layout LyX-Code
4817 set-axis joystick0axis10 disabled
4820 \begin_layout LyX-Code
4821 set-axis joystick0axis11 disabled
4824 \begin_layout LyX-Code
4825 set-axis joystick0axis12 disabled
4828 \begin_layout LyX-Code
4829 set-axis joystick0axis13 disabled
4832 \begin_layout LyX-Code
4833 set-axis joystick0axis14 disabled
4836 \begin_layout LyX-Code
4837 set-axis joystick0axis15 disabled
4840 \begin_layout LyX-Code
4841 set-axis joystick0axis16 disabled
4844 \begin_layout LyX-Code
4845 set-axis joystick0axis17 disabled
4848 \begin_layout LyX-Code
4849 set-axis joystick0axis18 disabled
4852 \begin_layout LyX-Code
4853 set-axis joystick0axis19 disabled
4856 \begin_layout Section
4860 \begin_layout Subsection
4861 Problems from BSNES core:
4864 \begin_layout Itemize
4865 The whole pending save stuff.
4868 \begin_layout Itemize
4869 Lack of layer hiding.
4872 \begin_layout Itemize
4873 It is slow (especially accuracy).
4876 \begin_layout Itemize
4877 Firmwares can't be loaded from ZIP archives.
4880 \begin_layout Subsection
4884 \begin_layout Itemize
4885 Modifiers don't work with pseudo-keys (SDL, EVDEV).
4888 \begin_layout Itemize
4889 Audio for last dumped frame is not itself dumped.
4892 \begin_layout Itemize
4893 Audio in UI is pretty bad in quality if game doesn't run at full speed.
4896 \begin_layout Itemize
4897 AVI compression levels 10-18 are not compatible with AVISynth AVISource.
4900 \begin_layout Itemize
4901 No menus, command based interface (SDL).
4904 \begin_layout Itemize
4905 Long commands don't scroll.
4908 \begin_layout Itemize
4909 Wxwidgets UI is still buggy.
4912 \begin_layout Section
4916 \begin_layout Subsection
4920 \begin_layout Itemize
4924 \begin_layout Itemize
4925 Fix dumper video corruption with levels 10-18.
4928 \begin_layout Subsection
4932 \begin_layout Itemize
4936 \begin_layout Itemize
4937 Lots of code cleanups
4940 \begin_layout Itemize
4941 Lua interface to settings
4944 \begin_layout Itemize
4945 Allow specifying AVI borders without Lua
4948 \begin_layout Itemize
4949 Fix scaling if vscale > 1 and originx > 0 (left border exists)
4952 \begin_layout Itemize
4953 on_snoop lua callback
4956 \begin_layout Itemize
4957 Faster movie loading and saving.
4960 \begin_layout Subsection
4964 \begin_layout Itemize
4968 \begin_layout Subsection
4972 \begin_layout Itemize
4976 \begin_layout Itemize
4977 Save jukebox functionality.
4980 \begin_layout Subsection
4984 \begin_layout Itemize
4985 Try to fix some nasty failing movie load edge cases
4988 \begin_layout Itemize
4989 Allow specifying scripts to run on command line.
4992 \begin_layout Subsection
4996 \begin_layout Itemize
4997 Major source code reorganization.
5000 \begin_layout Itemize
5001 Backup savestates before overwriting.
5004 \begin_layout Itemize
5005 Don't crash if loading initial state fails.
5008 \begin_layout Subsection
5012 \begin_layout Itemize
5016 \begin_layout Itemize
5017 Fix author name parsing
5020 \begin_layout Itemize
5021 Fix rerecord counting
5024 \begin_layout Itemize
5025 (SDL) Print messages to console if SDL is uninitialized
5028 \begin_layout Itemize
5029 Add movieinfo program
5032 \begin_layout Itemize
5033 Fix loading movies starting from SRAM.
5036 \begin_layout Subsection
5040 \begin_layout Itemize
5041 Add support for unattended dumping
5044 \begin_layout Itemize
5045 Fix compiling for Win32
5048 \begin_layout Itemize
5049 Don't lock up if sound can't be initialized
5052 \begin_layout Itemize
5053 Strip trailing CR from commands
5056 \begin_layout Itemize
5057 Don't try to do dubious things in global ctors (fix crash on startup)
5060 \begin_layout Subsection
5064 \begin_layout Itemize
5065 Small documentation tweaking
5068 \begin_layout Itemize
5072 \begin_layout Itemize
5073 Fix major bug in modifier matching
5076 \begin_layout Subsection
5080 \begin_layout Itemize
5081 Lots of documentation fixes
5084 \begin_layout Itemize
5085 Use dedicated callbacks for event backcomm., not commands.
5088 \begin_layout Itemize
5089 Ensure that the watchdog is not hit when executing delayed reset.
5092 \begin_layout Itemize
5093 Remove errant tab from joystick message.
5096 \begin_layout Subsection
5100 \begin_layout Itemize
5101 Make autofire operate in absolute time, not linear time
5104 \begin_layout Itemize
5105 Reinitialize controls when resuming from loadstate
5108 \begin_layout Itemize
5109 Some more code cleanups
5112 \begin_layout Itemize
5113 If Lua allocator fails, call OOM_panic()
5116 \begin_layout Itemize
5117 Byte/word/dword/qword sized host memory write/read functions.
5120 \begin_layout Itemize
5121 Dump at correct framerate if dumping interlaced NTSC (height=448).
5124 \begin_layout Subsection
5128 \begin_layout Itemize
5129 Actually include the complete source code
5132 \begin_layout Itemize
5136 \begin_layout Subsection
5140 \begin_layout Itemize
5141 Document {save,start}time.{,sub}second.
5144 \begin_layout Itemize
5145 Intercept time() from bsnes core.
5148 \begin_layout Subsection
5152 \begin_layout Itemize
5153 Allow disabling time() interception (allow build on Mac OS X)
5156 \begin_layout Itemize
5157 Use SDLMain on Mac OS X (make SDL not crash)
5160 \begin_layout Itemize
5161 Disable delayed resets (just plain too buggy for now).
5164 \begin_layout Itemize
5168 \begin_layout Itemize
5169 Use 16-bit for graphics/video instead of 32-bit.
5172 \begin_layout Itemize
5173 gui.rectangle/gui.pixel
5176 \begin_layout Itemize
5180 \begin_layout Itemize
5181 New CSCD writer implementation.
5184 \begin_layout Subsection
5188 \begin_layout Itemize
5189 Fix interaction of * and +.
5192 \begin_layout Itemize
5196 \begin_layout Itemize
5197 Use gettimeofday()/usleep(), these seem portable enough.
5200 \begin_layout Itemize
5201 Move joystick axis manipulation to keymapper code.
5204 \begin_layout Itemize
5205 Changes to how read-only works.
5208 \begin_layout Itemize
5209 Refactor controller input code.
5212 \begin_layout Subsection
5216 \begin_layout Itemize
5217 Fix mouseclick scale compensation.
5220 \begin_layout Itemize
5221 Draw area boundaries correctly in SDL code.
5224 \begin_layout Itemize
5228 \begin_layout Itemize
5229 Fix CSCD output (buffer overrun and race condition).
5232 \begin_layout Subsection
5236 \begin_layout Itemize
5237 JMD dumping support.
5240 \begin_layout Itemize
5241 Allow unattended dumping to JMD.
5244 \begin_layout Itemize
5248 \begin_layout Itemize
5249 Switch back to 32-bit colors.
5252 \begin_layout Itemize
5253 Add Lua function gui.color.
5256 \begin_layout Itemize
5257 Use some new C++11 features in GCC 4.6.
5260 \begin_layout Itemize
5261 Be prepared for core frequency changes.
5264 \begin_layout Itemize
5265 Pass colors in one chunk from Lua.
5268 \begin_layout Subsection
5272 \begin_layout Itemize
5273 New lua functions gui.line(), gui.status() and gui.circle(), memory.vma_count(),
5274 memory.read_vma() and memory.find_vma().
5277 \begin_layout Itemize
5278 Numerious documentation fixups
5281 \begin_layout Itemize
5282 RTC time format changed
5285 \begin_layout Itemize
5286 Reformat flags display
5289 \begin_layout Itemize
5290 Allow lua package name to be overridden
5293 \begin_layout Itemize
5294 SDUMP (high-quality dumping).
5297 \begin_layout Itemize
5298 Split platform support to plugins.
5301 \begin_layout Itemize
5302 Make all sound plugins support basic sound commands
5305 \begin_layout Itemize
5306 Support portaudio for sound.
5309 \begin_layout Itemize
5310 Allow disable Lua/SDL searching.
5313 \begin_layout Itemize
5314 Upconvert colors when copying lcscreen to screen.
5317 \begin_layout Itemize
5318 Reorganize source tree.
5321 \begin_layout Itemize
5322 Evdev joystick support.
5325 \begin_layout Itemize
5326 Refactor more code into generic window code.
5329 \begin_layout Subsection
5333 \begin_layout Itemize
5334 Refactor message handling.
5337 \begin_layout Itemize
5341 \begin_layout Itemize
5345 \begin_layout Itemize
5346 Finish pending saves before load/quit.
5349 \begin_layout Itemize
5350 Wxwidgets graphics plugin.
5353 \begin_layout Subsection
5357 \begin_layout Itemize
5358 Get rid of win32-crap.[ch]pp.
5361 \begin_layout Itemize
5362 Move files around a lot.
5365 \begin_layout Itemize
5366 Get rid of need for host C++ compiler.
5369 \begin_layout Itemize
5373 \begin_layout Itemize
5374 Refactor inter-component communication.
5377 \begin_layout Itemize
5381 \begin_layout Itemize
5382 Fix crash on multiline aliases.
5385 \begin_layout Itemize
5386 Load/Save settings in wxwidgets gui.
5389 \begin_layout Subsection
5393 \begin_layout Itemize
5394 Patch problems in bsnes core
5397 \begin_layout Itemize
5398 SNES is little-endian, not big-endian!
5401 \begin_layout Itemize
5402 Fix memory corruption in lcscreen::load()
5405 \begin_layout Subsection
5409 \begin_layout Itemize
5410 Fix interpretting repeat counts in rrdata loading.
5413 \begin_layout Itemize
5414 New lua callback: on_frame()
5417 \begin_layout Itemize
5418 Remove calls to runtosave() that aren't supposed to be there
5421 \begin_layout Itemize
5422 Lua function: movie.read_rtc()
5425 \begin_layout Itemize
5426 Ignore src/fonts/font.cpp
5429 \begin_layout Itemize
5430 Fix more bsnes core problems
5433 \begin_layout Itemize
5434 Control bsnes random seeding
5437 \begin_layout Itemize
5441 \begin_layout Itemize
5442 Some bsnes core debugging features (state dump and state hash)
5445 \begin_layout Itemize
5446 Fix titlebar version number (no, the last version wasn't 'lsnes-0-beta21',
5447 it was 'lsnes rr0-beta21').
5450 \begin_layout Subsection
5454 \begin_layout Itemize
5455 Fix memory corruption due to macro/field mixup
5458 \begin_layout Itemize
5459 search-memory update
5462 \begin_layout Itemize
5463 Allow direct-mapped framebuffer
5466 \begin_layout Itemize
5467 SDL: Use SDL_ANYFORMAT if possible
5470 \begin_layout Itemize
5471 SDMP2SOX: 2s delay modes.
5474 \begin_layout Itemize
5478 \begin_layout Itemize
5479 Use sed -E, not sed -r.
5480 Fixes building on Mac OS X.
5483 \begin_layout Itemize
5484 Wxwidgets: Save jukebox on exit
5487 \begin_layout Itemize
5488 Fix RTC if using load-movie on savestate.
5491 \begin_layout Itemize
5492 Fix crash related to full console mode.
5495 \begin_layout Subsection
5499 \begin_layout Itemize
5500 Wxwidgets: Allow bringing application to foreground on Mac OS X.
5503 \begin_layout Itemize
5504 Wxwidgets: Allow compiling on Mac OS X.
5507 \begin_layout Itemize
5508 Use movie compare instead of movie hashing (faster save/load).
5511 \begin_layout Itemize
5515 \begin_layout Subsection
5519 \begin_layout Itemize
5520 sdmp2sox: Pad soundtrack if using -l or -L.
5523 \begin_layout Itemize
5524 sdmp2sox: Fix NTSC overscan.
5527 \begin_layout Itemize
5528 sdmp2sox: Add AR correction mode.
5531 \begin_layout Itemize
5532 call lua_close() when exiting.
5535 \begin_layout Itemize
5536 Fix zip_writer bug causing warnings from info-zip and error from advzip.
5539 \begin_layout Subsection
5543 \begin_layout Itemize
5544 Fix IPS patching code (use bsnes core IPS patcher).
5547 \begin_layout Itemize
5548 Implement BPS patching (using bsnes core IPS patcher).
5551 \begin_layout Itemize
5552 Add feature to load headered ROMs.
5555 \begin_layout Subsection
5559 \begin_layout Itemize
5560 Show command names when showing keybindings
5563 \begin_layout Subsection
5567 \begin_layout Itemize
5568 Fix pause-on-end to be actually controllable
5571 \begin_layout Itemize
5572 SDL: Poll all events in queue, not just first one (fixes slowness in command
5576 \begin_layout Itemize
5577 Wxwidgets: Fix ROM loading.
5580 \begin_layout Subsection
5584 \begin_layout Itemize
5585 Lua: Add gui.textH, gui.textV, gui.textHV
5588 \begin_layout Itemize
5589 Fix text colors on SDL on Mac OS X
5592 \begin_layout Itemize
5593 Mode 'F' for finished in readonly mode.
5596 \begin_layout Itemize
5600 \begin_layout Itemize
5601 Reliably pause after skip poll
5604 \begin_layout Itemize
5605 Split UI and core into their own threads
5608 \begin_layout Subsection
5612 \begin_layout Itemize
5613 Remove leftover dummy SRAM slot
5616 \begin_layout Itemize
5617 Fix controller numbers.
5620 \begin_layout Subsection
5624 \begin_layout Itemize
5625 Fix lsnes-dumpavi after interface change.
5628 \begin_layout Itemize
5629 Also give BSNES patches for v085.
5632 \begin_layout Itemize
5633 Pack movie data in memory.
5636 \begin_layout Subsection
5640 \begin_layout Itemize
5641 Fix framecount/length given when loading movies.
5644 \begin_layout Itemize
5645 Controller command memory leak fixes.
5648 \begin_layout Itemize
5649 Don't leak palette if freeing screen object.
5652 \begin_layout Subsection
5656 \begin_layout Itemize
5660 \begin_layout Itemize
5661 Wxwidgets: Allow controlling dumper from the menu.
5664 \begin_layout Subsection
5668 \begin_layout Itemize
5669 Rewrite parts of manual
5672 \begin_layout Itemize
5673 Lua: Make it work with Lua 5.2.
5676 \begin_layout Subsection
5680 \begin_layout Itemize
5681 Win32: Fix compile errors.
5684 \begin_layout Subsection
5688 \begin_layout Itemize
5689 Refactor controller input code.
5692 \begin_layout Itemize
5693 Fix crash when using command line on SDL / Mac OS X.
5696 \begin_layout Subsection
5700 \begin_layout Itemize
5701 Delete core/coroutine (obsolete)
5704 \begin_layout Itemize
5705 Lag input display by one frame.
5708 \begin_layout Itemize
5709 Rewind movie to beginning function.
5712 \begin_layout Itemize
5713 Fix wrong frame number reported to Lua when repainting after loadstate
5716 \begin_layout Itemize
5717 Support UI editing of jukebox
5720 \begin_layout Itemize
5721 Wxwidgets: Save settings on exit.
5724 \begin_layout Itemize
5725 Support ${project} for filenames
5728 \begin_layout Itemize
5729 SDL: Fix command history
5732 \begin_layout Subsection
5736 \begin_layout Itemize
5737 Fix some order-of-global-ctor bugs.
5740 \begin_layout Subsection
5744 \begin_layout Itemize
5745 Fix crashes when quitting on Win32.
5748 \begin_layout Subsection
5752 \begin_layout Itemize
5753 EVDEV: Queue keypresses from joystick, don't send directly
5756 \begin_layout Itemize
5757 Wxwidgets: Load-Preserve that actually works.
5760 \begin_layout Subsection
5764 \begin_layout Itemize
5765 Wxwidgets: GUI for memory search.
5768 \begin_layout Itemize
5769 Warn about using synchronous queue in UI callback.
5772 \begin_layout Subsection
5776 \begin_layout Itemize
5777 Remember last saved file for each ROM
5780 \begin_layout Itemize
5781 Support MT dumping via boost.
5784 \begin_layout Itemize
5788 \begin_layout Itemize
5792 \begin_layout Itemize
5793 Make mouse be ordinary input instead of special-casing
5796 \begin_layout Itemize
5797 SDL: Don't screw up commands with NUL codepoints.
5800 \begin_layout Subsection
5804 \begin_layout Itemize
5805 Merge status panel and main window
5808 \begin_layout Itemize
5809 True movie slot support (the rest of it)
5812 \begin_layout Itemize
5813 SDL: Fix compilation error
5816 \begin_layout Itemize
5817 Elminate cross calls in dump menu code.
5820 \begin_layout Subsection
5824 \begin_layout Itemize
5825 Cancel pending saves command
5828 \begin_layout Itemize
5829 Wxwidgets: Code refactoring
5832 \begin_layout Itemize
5833 Wxwidgets: Fix system -> reset
5836 \begin_layout Itemize
5837 Wxwidgets: Read watch expressions in the right thread
5840 \begin_layout Subsection
5844 \begin_layout Itemize
5845 Wxwidgets: Don't prompt for member when running Lua script (Lua doesn't
5849 \begin_layout Itemize
5850 Wxwidgets: 128 -> 1024 Autohold slots (in case more are needed).
5853 \begin_layout Itemize
5854 Don't append trailing '-' to prefix when saving movie.
5857 \begin_layout Itemize
5858 Fix ROM/savestate handling (don't let user mismatch ROM and savestates).
5861 \begin_layout Subsection
5865 \begin_layout Itemize
5866 Document memory watch syntax.
5869 \begin_layout Subsection
5873 \begin_layout Itemize
5874 Fix unattended dumping (lsnes-dumpavi)
5877 \begin_layout Itemize
5881 \begin_layout Itemize
5882 Use adv_dumper instead of the old interface in lsnes-dumpavi (changes syntax)
5885 \begin_layout Itemize
5886 Add option to control sample rate preturbation in AVI dumper
5889 \begin_layout Subsection
5893 \begin_layout Itemize
5894 Wxwidgets: Fix dumper submodes
5897 \begin_layout Itemize
5898 Set core controller types before loadstate
5901 \begin_layout Subsection
5905 \begin_layout Itemize
5906 Fix compiling with bsnes v086.
5909 \begin_layout Subsection
5913 \begin_layout Itemize
5914 Don't prompt before quitting
5917 \begin_layout Itemize
5918 Start unpaused, preserve pause/unpause over load.
5921 \begin_layout Itemize
5922 Try to autodetect if ROM is headered.
5925 \begin_layout Itemize
5926 Wxwidgets: Only bring up ROM patching screen if specifically requested.
5929 \begin_layout Itemize
5930 Allow configuring some hotkeys.
5933 \begin_layout Subsection
5937 \begin_layout Itemize
5938 Lots of code cleanups
5941 \begin_layout Itemize
5942 Fix JMD compression (JMD dumping was broken)
5945 \begin_layout Itemize
5946 Don't crash if Lua C function throws an exception.
5949 \begin_layout Itemize
5950 Support bitmap drawing in Lua.
5953 \begin_layout Itemize
5954 Fix bsnes v085/v086 patches.
5957 \begin_layout Itemize
5958 Improve stability on win32.
5961 \begin_layout Subsection
5965 \begin_layout Itemize
5966 Don't corrupt movie if movie length is integer multiple of frames per page.
5969 \begin_layout Subsection
5973 \begin_layout Itemize
5974 New Lua hooks: on_rewind, on_frame_emulated, on_idle, on_timer
5977 \begin_layout Itemize
5978 New Lua functions: emulator_ready(), utime(), set_idle_timeout(), set_timer_time
5979 out(), bit.extract(), bit.value(), input.geta(), input.seta() and input.controllertyp
5983 \begin_layout Itemize
5984 Wxwidgets: Fix internal focus lost (hotkeys stop working)
5987 \begin_layout Itemize
5988 Wxwidgets: Fix broken modifiers
5991 \begin_layout Itemize
5992 on_paint has parameter now.
5995 \begin_layout Itemize
5996 Optional initital fill for bitmaps
5999 \begin_layout Itemize
6000 Fix palette changing.
6003 \begin_layout Itemize
6004 Optimize rendering a bit.
6007 \begin_layout Itemize
6011 \begin_layout Subsection
6015 \begin_layout Itemize
6016 Movieinfo: Fix display of port #2 type.
6019 \begin_layout Itemize
6020 Call on_input() after loadstate.
6023 \begin_layout Subsection
6027 \begin_layout Itemize
6028 Fix writing port2 data to movie.
6031 \begin_layout Itemize
6032 Fix SRAM handling with Bsnes v087.