1 #LyX 2.0 created this file. For more info see http://www.lyx.org/
6 \use_default_options true
7 \maintain_unincluded_children false
9 \language_package default
14 \font_typewriter default
15 \font_default_family default
16 \use_non_tex_fonts false
23 \default_output_format default
25 \bibtex_command default
26 \index_command default
27 \paperfontsize default
38 \paperorientation portrait
47 \paragraph_separation indent
48 \paragraph_indentation default
49 \quotes_language english
52 \paperpagestyle default
53 \tracking_changes false
66 \begin_layout Standard
67 lsnes is SNES rerecording emulator based on bsnes core.
74 \begin_layout Enumerate
79 \begin_layout Enumerate
83 \begin_layout Enumerate
84 accuracy or compatiblity core.
87 \begin_layout Enumerate
88 Patched version (using included 6 patches)
92 \begin_layout Enumerate
96 \begin_layout Enumerate
100 \begin_layout Enumerate
104 \begin_layout Enumerate
108 \begin_layout Enumerate
112 \begin_layout Enumerate
113 sdlmain (SDL only, part of SDL)
116 \begin_layout Enumerate
117 boost_conversion (this is header-only library)
120 \begin_layout Enumerate
121 libswscale (wxwidgets graphics only)
124 \begin_layout Enumerate
125 Portaudio (portaudio sound only)
128 \begin_layout Enumerate
129 std::thread and co (for threaded dumper only, not needed if std::thread
133 \begin_layout Enumerate
134 Lua (if Lua support is needed).
137 \begin_layout Itemize
138 Version 5.1.X or 5.2X.
141 \begin_layout Section
145 \begin_layout Standard
146 Building is via makefile, the following options are available:
149 \begin_layout Itemize
150 CROSS_PREFIX=<prefix>
154 \begin_layout Itemize
155 Prefix to apply to commands when building executables / object files for
156 the target architecture.
160 \begin_layout Itemize
165 \begin_layout Itemize
170 \begin_layout Itemize
171 Name of C++ compiler.
174 \begin_layout Itemize
175 CROSS_PREFIX is prepended if compiling for target architecture.
178 \begin_layout Itemize
179 This needs to be at least GCC 4.6.
182 \begin_layout Itemize
183 Set to 'g++-mp-4.6' if compiling on Mac OS X using GCC 4.6 from Macports.
186 \begin_layout Itemize
191 \begin_layout Itemize
196 \begin_layout Itemize
197 Name of host C++ compiler.
200 \begin_layout Itemize
201 Default is value of 'CC' option.
205 \begin_layout Itemize
206 USER_HOSTCCFLAGS=<flags>:
210 \begin_layout Itemize
211 Compiler flags to pass when compiling/linking for host architecture.
214 \begin_layout Itemize
219 \begin_layout Itemize
224 \begin_layout Itemize
225 Extra flags to pass when compiling for target architecture
228 \begin_layout Itemize
233 \begin_layout Itemize
234 USER_LDFLAGS=<flags>:
238 \begin_layout Itemize
239 Extra flags to pass when linking for target architecture.
242 \begin_layout Itemize
247 \begin_layout Itemize
248 USER_PLATFORM_CFLAGS=<flags>
252 \begin_layout Itemize
253 Extra flags to pass when compiling files using platform-dependent code for
257 \begin_layout Itemize
262 \begin_layout Itemize
263 USER_PLATFORM_LDFLAGS=<flags>
267 \begin_layout Itemize
268 Extra flags to pass when linking files using platform-dependent code for
272 \begin_layout Itemize
277 \begin_layout Itemize
282 \begin_layout Itemize
283 Set the font file to use.
286 \begin_layout Itemize
287 Currently the valid values are:
291 \begin_layout Itemize
292 cp437.hex: Standard VGA font (256 characters).
295 \begin_layout Itemize
296 unifontfull-5.1.20080820.hex: GNU unifont (covers most of Unicode BMP)
300 \begin_layout Itemize
301 Default is 'unifontfull-5.1.20080820.hex'
305 \begin_layout Itemize
310 \begin_layout Itemize
311 Package to use for Lua support.
314 \begin_layout Itemize
315 Usually valid value is 'lua' or 'lua5.1'.
318 \begin_layout Itemize
319 Default is not to build Lua support.
323 \begin_layout Itemize
328 \begin_layout Itemize
329 Override platform default for dumper threading support.
332 \begin_layout Itemize
333 Threading is default on Linux.
336 \begin_layout Itemize
337 'YES' tries to use threading (std::thread).
340 \begin_layout Itemize
341 'BOOST' tries to use threading (boost::thread).
344 \begin_layout Itemize
345 'NO' disables threading.
348 \begin_layout Itemize
349 Note: This has absolutely nothing to do with platform threading.
353 \begin_layout Itemize
354 BSNES_IS_COMPAT=<anything>
358 \begin_layout Itemize
359 Signals that BSNES core used is compatiblity core, not accuracy core.
362 \begin_layout Itemize
363 Default is to assume accuracy core.
367 \begin_layout Itemize
368 JOYSTICK=<implementation>
372 \begin_layout Itemize
373 Set joystick implementation.
378 \begin_layout Itemize
379 SDL: Use SDL for joystick (requires SDL graphics)
382 \begin_layout Itemize
383 EVDEV: Use EVDEV for joystick (Linux only).
386 \begin_layout Itemize
387 DUMMY: Disable joystick support.
391 \begin_layout Itemize
396 \begin_layout Itemize
397 SOUND=<implementation>
401 \begin_layout Itemize
402 Set sound implementation.
407 \begin_layout Itemize
408 SDL: Use SDL for sound (requires SDL graphics)
411 \begin_layout Itemize
412 PORTAUDIO: Use Portaudio for sound.
415 \begin_layout Itemize
416 DUMMY: Disable sound support
420 \begin_layout Itemize
425 \begin_layout Itemize
426 GRAPHICS=<implementation>
430 \begin_layout Itemize
431 Set windowing library to use.
436 \begin_layout Itemize
437 SDL: Use SDL for graphics
440 \begin_layout Itemize
441 WXWIDGETS: Use wxWidgets for graphics.
445 \begin_layout Itemize
450 \begin_layout Section
454 \begin_layout Subsection
458 \begin_layout Standard
459 <kind> in the following can be one of:
462 \begin_layout Itemize
463 rom: Cartridge ROM (BIOS for special carts).
467 \begin_layout Itemize
468 bsx: BS-X (non-slotted) Game flash ROM.
471 \begin_layout Itemize
472 bsxslotted: BS-X (slotted) Game flash ROM.
475 \begin_layout Itemize
479 \begin_layout Itemize
480 slot-a: Sufami Turbo Slot A ROM
483 \begin_layout Itemize
484 slot-b: Sufami Turbo Slot B ROM
487 \begin_layout Subsubsection
488 --<kind>=<file> (lsnes/SDL, lsnes-avidump)
491 \begin_layout Standard
492 Load <file> as specified ROM (SFC/BS/DMG/ST file format).
495 \begin_layout Subsubsection
496 --<kind>-xml=<file> (lsnes/SDL, lsnes-avidump)
499 \begin_layout Standard
500 Override hardware detection for ROM, reading the values from <file> (BSNES
504 \begin_layout Subsubsection
505 --ips-<kind>=<file> (lsnes/SDL, lsnes-avidump)
508 \begin_layout Standard
509 Apply BPS/IPS patch <file> to ROM <kind>.
510 If specified multiple times, the patches are applied in order.
513 \begin_layout Subsubsection
514 --ips-<kind>-xml=<file> (lsnes/SDL, lsnes-avidump)
517 \begin_layout Standard
518 Apply BPS/IPS patch <file> to XML of ROM <kind>.
519 If specified multiple times, the patches are applied in order.
522 \begin_layout Subsubsection
523 --ips-offset=<offset> (lsnes/SDL, lsnes-avidump)
526 \begin_layout Standard
527 Set offset to apply to IPS patches.
529 Handy for applying headered IPS patches (use offset of -512 for this).
530 The offset must be 0 for BPS patches.
533 \begin_layout Subsubsection
537 \begin_layout Standard
538 Force ROM to be considered PAL-only.
541 \begin_layout Itemize
542 Only works on SNES and SGB ROMs (not BS-X or Sufami Turbo).
545 \begin_layout Itemize
546 Attempting to load NTSC movie file will error out.
549 \begin_layout Subsubsection
553 \begin_layout Standard
554 Force ROM to be considered NTSC-only.
557 \begin_layout Itemize
558 Attempting to load PAL movie file will error out.
561 \begin_layout Subsection
565 \begin_layout Subsubsection
566 <filename> (lsnes/SDL, lsnes-avidump, movieinfo)
569 \begin_layout Standard
570 Load <filename> as movie or savestate file.
571 All other session options are ignored.
574 \begin_layout Subsubsection
575 --port1=<device> (lsnes/SDL)
578 \begin_layout Standard
583 \begin_layout Itemize
584 none: No device connected
587 \begin_layout Itemize
588 gamepad: One gamepad (the default)
591 \begin_layout Itemize
592 multitap: Four gamepads (warning: makes most games refuse to start)
595 \begin_layout Itemize
599 \begin_layout Subsubsection
600 --port2=<type> (lsnes/SDL)
603 \begin_layout Standard
608 \begin_layout Itemize
609 none: No device connected (the default)
612 \begin_layout Itemize
616 \begin_layout Itemize
617 multitap: Four gamepads.
620 \begin_layout Itemize
624 \begin_layout Itemize
625 superscope: Super Scope
628 \begin_layout Itemize
629 justifier: One justifier
632 \begin_layout Itemize
633 justifiers: Two justifiers
636 \begin_layout Subsubsection
637 --gamename=<name> (lsnes/SDL)
640 \begin_layout Standard
641 Set the name of game to <name>.
645 \begin_layout Subsubsection
646 --author=<name> (lsnes/SDL)
649 \begin_layout Standard
650 Add author with full name of <name> (no nickname).
653 \begin_layout Subsubsection
654 --author=|<name> (lsnes/SDL)
657 \begin_layout Standard
658 Add author with nickname of <name> (no full name).
661 \begin_layout Subsubsection
662 --author=<fullname>|<nickname> (lsnes/SDL)
665 \begin_layout Standard
666 Add author with full name of <fullname> and nickname of <nickname>.
669 \begin_layout Subsubsection
670 --rtc-second=<value> (lsnes/SDL)
673 \begin_layout Standard
674 Set RTC second (0 is 1st January 1970 00:00:00Z).
675 Default is 1,000,000,000.
678 \begin_layout Subsubsection
679 --rtc-subsecond=<value> (lsnes/SDL)
682 \begin_layout Standard
689 \begin_layout Subsection
694 \begin_layout Subsubsection
695 --run=<file> (lsnes/SDL)
698 \begin_layout Standard
699 After running main RC file, run this file.
700 If multiple are specified, these execute in order specified.
703 \begin_layout Subsection
704 dump options (lsnes-dumpavi only)
707 \begin_layout Subsubsection
711 \begin_layout Standard
712 Set the dumper to use (required).
713 Use 'list' for listing of known dumpers.
716 \begin_layout Subsubsection
720 \begin_layout Standard
721 Set the mode to use (required for dumpers with multiple modes, forbidden
723 Use 'list' for known modes.
726 \begin_layout Subsubsection
730 \begin_layout Standard
733 \begin_inset Quotes eld
737 \begin_inset Quotes erd
743 \begin_layout Subsubsection
744 --option=<name>=<value>
747 \begin_layout Standard
748 Set option <name> to value <value>.
751 \begin_layout Subsubsection
755 \begin_layout Standard
756 Set number of frames to dump.
760 \begin_layout Subsubsection
764 \begin_layout Standard
765 Run specified lua script (lsnes-dumpavi does not have initialization files).
768 \begin_layout Subsubsection
769 --load-library=<library>
772 \begin_layout Standard
773 Load the specified shared object / dynamic library / dynamic link library.
776 \begin_layout Section
777 Startup file lsnes.rc
780 \begin_layout Standard
781 Upon startup, lsnes (lsnes/SDL only) executes file lsnes.rc as commands.
782 This file is located in:
785 \begin_layout Itemize
790 lsnes.rc (if %APPDATA% exists)
793 \begin_layout Itemize
794 Unix: $XDG_CONFIG_HOME/lsnes/lsnes.rc (if $XDG_CONFIG_HOME exists)
797 \begin_layout Itemize
798 Unix: $HOME/.config/lsnes/lsnes.rc (if $HOME exists)
801 \begin_layout Itemize
802 All: ./lsnes.rc (fallback default).
805 \begin_layout Standard
806 If leading directories do not exist, attempt to create them is made.
809 \begin_layout Section
813 \begin_layout Itemize
814 Commands beginning with '*' invoke the corresponding command without alias
818 \begin_layout Itemize
819 If command starts with '+' (after possible '*'), the command is executed
820 as-is when button is pressed, and when button is released, it is executed
821 with '+' replaced by '-'.
824 \begin_layout Itemize
825 Commands without '+' execute only on negative edge (release).
828 \begin_layout Subsection
832 \begin_layout Standard
833 Settings control various aspects of emulator behaviour.
836 \begin_layout Subsubsection
837 set-setting <setting> <value>
840 \begin_layout Standard
841 Sets setting <setting> to value <value> (may be empty).
844 \begin_layout Subsubsection
845 unset-setting <setting>
848 \begin_layout Standard
849 Try to unset setting <setting> (not all settings can be unset).
852 \begin_layout Subsubsection
853 get-setting <setting>
856 \begin_layout Standard
857 Read value of setting <setting>
860 \begin_layout Subsubsection
864 \begin_layout Standard
865 Print names and values of all settings.
868 \begin_layout Subsection
872 \begin_layout Standard
873 Keybindings bind commands or aliases to keys (or pseudo-keys).
877 \begin_layout Standard
881 \begin_layout Itemize
882 Do not bind edge active (+/-) commands to keys with modifiers, that won't
886 \begin_layout Itemize
887 Names of keys and modifiers are platform-dependent.
890 \begin_layout Itemize
891 Be careful before binding pseudo-keys (such as joystick axes, buttons or
892 hats) with modifiers.
893 That may or may not work right.
896 \begin_layout Subsubsection
897 bind-key [<mod>/<modmask>] <key> <command>
900 \begin_layout Standard
901 Bind <command> to key <key> (activating if modifiers in <modmask> (comma-seperat
902 ed list) are set as <mod> (comma-seperated list).
905 \begin_layout Standard
906 The names of keys and modifiers are platform-dependent.
909 \begin_layout Subsubsection
910 unbind-key [<mod>/<modmask>] <key>
913 \begin_layout Standard
914 Unbind command from <key> (with specified <mod> and <modmask>).
917 \begin_layout Subsubsection
918 set-axis <axis> [disabled | axis | axis-inverse | pressure0- | pressure0+
919 | pressure-0 | pressure-+ | pressure+0 | pressure+-] [minus=<val>] [zero=<val>]
920 [plus=<val>] [tolerance=<val>]
923 \begin_layout Standard
924 Set axis parameters for axis <axis>.
927 \begin_layout Itemize
928 disabled: Disable axis
931 \begin_layout Itemize
935 \begin_layout Itemize
936 axis-inverse: Inverse axis
939 \begin_layout Itemize
940 pressure0-: Pressure sensitive.
941 Released at 0, pressed at -.
944 \begin_layout Itemize
945 pressure0+: Pressure sensitive.
946 Released at 0, pressed at +.
949 \begin_layout Itemize
950 pressure-0: Pressure sensitive.
951 Released at -, pressed at 0.
954 \begin_layout Itemize
955 pressure-+: Pressure sensitive.
956 Released at -, pressed at +.
959 \begin_layout Itemize
960 pressure+0: Pressure sensitive.
961 Released at +, pressed at 0.
964 \begin_layout Itemize
965 pressure+-: Pressure sensitive.
966 Released at +, pressed at -.
969 \begin_layout Itemize
970 minus=<val>: Calibration at extreme minus position (-32768-32767)
973 \begin_layout Itemize
974 zero=<val>: Calibration at neutral position (-32768-32767)
977 \begin_layout Itemize
978 plus=<val>: Calibration at extreme plus position (-32768-32767)
981 \begin_layout Itemize
982 tolerance=<value>: Center band tolerance (0<x<1).
983 The smaller the value, the more sensitive the control is.
986 \begin_layout Subsubsection
990 \begin_layout Standard
991 Print all key bindings in effect.
994 \begin_layout Subsection
998 \begin_layout Standard
999 Aliases bind command to sequence of commands.
1000 After alias has been defined, it replaces the command it shadows.
1003 \begin_layout Standard
1007 \begin_layout Itemize
1008 You can't alias command to itself.
1011 \begin_layout Itemize
1012 Aliases starting with +/- are edge active just like ordinary commands starting
1016 \begin_layout Itemize
1017 One command can be aliased to multiple commands.
1020 \begin_layout Subsubsection
1021 alias-command <command> <expansion>
1024 \begin_layout Standard
1025 Append <expansion> to alias <command>.
1026 If alias does not already exist, it is created.
1029 \begin_layout Subsubsection
1030 unalias-command <command>
1033 \begin_layout Standard
1034 Clear alias expansion for <command>.
1037 \begin_layout Subsubsection
1041 \begin_layout Standard
1042 Print all aliases and their expansions in effect.
1045 \begin_layout Subsection
1049 \begin_layout Standard
1050 Run <script> as if commands were entered on the command line.
1053 \begin_layout Subsection
1057 \begin_layout Standard
1058 Following commands control video dumping:
1061 \begin_layout Subsubsection
1062 start-dump <dumper> [<mode>] <prefix/filename>
1065 \begin_layout Standard
1066 Start dumping using dumper <dumper>.
1067 If mode is present or not and if prefix or filename is present depends
1068 on the dumper and dumper mode.
1071 \begin_layout Standard
1072 The following dumpers are available:
1075 \begin_layout Itemize
1076 INTERNAL-AVI-CSCD: Internal CSCD in .avi dumper.
1080 \begin_layout Itemize
1081 Mode: uncompressed/pcm: Uncompressed video, PCM audio.
1085 \begin_layout Itemize
1086 Mode: cscd/pcm: CSCD video, PCM audio.
1091 \begin_layout Itemize
1092 INTERNAL-JMD: Internal .jmd dumper.
1096 \begin_layout Itemize
1100 \begin_layout Itemize
1105 \begin_layout Itemize
1106 INTERNAL-RAW: Internal RAW dumper.
1110 \begin_layout Itemize
1114 \begin_layout Itemize
1118 \begin_layout Itemize
1119 Sound is big-endian signed 16-bit, usually at 32040.5Hz.
1122 \begin_layout Itemize
1123 Video is always upscaled to double resolution (512x448 / 512 x 478).
1126 \begin_layout Itemize
1127 Video framerate is usually 322445/6448 fps for PAL and 10738636/178683 fps
1132 \begin_layout Itemize
1133 INTERNAL-SDMP: Internal SDMP dumper.
1137 \begin_layout Itemize
1138 Mode 'ms': Multi-segment.
1142 \begin_layout Itemize
1143 Mode 'ss': Single-segment.
1148 \begin_layout Subsubsection
1152 \begin_layout Standard
1153 End dumping using <dumper>
1156 \begin_layout Subsubsection
1157 show-dumpers [<dumper>]
1160 \begin_layout Standard
1161 Show the list of dumpers or list of modes for <dumper>
1164 \begin_layout Subsection
1168 \begin_layout Standard
1169 <address> may be decimal or hexadecimal (prefixed with '0x').
1170 <value> can be hexadecimal (prefixed with '0x'), unsigned or signed (prefixed
1174 \begin_layout Standard
1175 The available element <sizes> are:
1178 \begin_layout Itemize
1182 \begin_layout Itemize
1186 \begin_layout Itemize
1190 \begin_layout Itemize
1194 \begin_layout Standard
1195 When reading RAM and ROM, multi-byte reads/writes are big-endian.
1196 When dealing with DSP memory, multi-byte reads/writes are native-endian
1197 (do not use operand sizes exceeding DSP bitness, except dword is OK for
1201 \begin_layout Subsubsection
1202 read-<size> <address>
1205 \begin_layout Standard
1206 Read the value of byte in <address>.
1209 \begin_layout Subsubsection
1210 read-s<size> <address>
1213 \begin_layout Standard
1214 Read the value of signed byte in <address>.
1217 \begin_layout Subsubsection
1218 write-<size> <address> <value>
1221 \begin_layout Standard
1222 Write <value> to byte in address <address>.
1225 \begin_layout Subsubsection
1229 \begin_layout Standard
1230 Reset the memory search
1233 \begin_layout Subsubsection
1237 \begin_layout Standard
1238 Print number of candidates remaining
1241 \begin_layout Subsubsection
1245 \begin_layout Standard
1246 Print all candidates remaining
1249 \begin_layout Subsubsection
1250 search-memory <usflag><sizeflag><op>
1253 \begin_layout Standard
1254 Searches memory for addresses satisfying criteria.
1257 \begin_layout Standard
1261 \begin_layout Itemize
1265 \begin_layout Itemize
1269 \begin_layout Standard
1273 \begin_layout Itemize
1277 \begin_layout Itemize
1281 \begin_layout Itemize
1285 \begin_layout Itemize
1289 \begin_layout Standard
1293 \begin_layout Itemize
1294 lt: < previous value.
1297 \begin_layout Itemize
1298 le: <= previous value.
1301 \begin_layout Itemize
1302 eq: = previous value.
1305 \begin_layout Itemize
1306 ne: != previous value.
1309 \begin_layout Itemize
1310 ge: >= previous value.
1313 \begin_layout Itemize
1314 gt: > previous value.
1317 \begin_layout Subsubsection
1318 search-memory <sizeflag> <value>
1321 \begin_layout Standard
1322 Searches for addresses that currently have value <value>.
1323 <sizeflag> is as in previous command.
1326 \begin_layout Subsection
1330 \begin_layout Standard
1331 These commands are not available in lsnesrc, but are available after ROM
1335 \begin_layout Subsubsection
1339 \begin_layout Standard
1340 Quits the emulator (asking for confirmation).
1341 If /y is given, no confirmation is asked.
1344 \begin_layout Subsubsection
1348 \begin_layout Standard
1349 Toggle paused/unpaused
1352 \begin_layout Subsubsection
1356 \begin_layout Standard
1358 If the button is still held after configurable timeout expires, game unpauses
1359 for the duration frame advance is held.
1362 \begin_layout Subsubsection
1366 \begin_layout Standard
1368 If the button is still held after configurable timeout expires, game unpauses
1369 for the duration frame advance is held.
1372 \begin_layout Subsubsection
1376 \begin_layout Standard
1377 Skip to first poll in frame after current.
1380 \begin_layout Subsubsection
1384 \begin_layout Standard
1385 Reset the SNES after this frame.
1388 \begin_layout Subsubsection
1392 \begin_layout Standard
1393 Load savestate <filename> in current mode.
1396 \begin_layout Subsubsection
1397 load-state <filename>
1400 \begin_layout Standard
1401 Load savestate <filename> in readwrite mode.
1404 \begin_layout Subsubsection
1405 load-readonly <filename>
1408 \begin_layout Standard
1409 Load savestate <filename> in readonly mode.
1412 \begin_layout Subsubsection
1413 load-preserve <filename>
1416 \begin_layout Standard
1417 Load savestate <filename> in readonly mode, preserving current events.
1420 \begin_layout Subsubsection
1421 load-movie <filename>
1424 \begin_layout Standard
1425 Load savestate <filename>, ignoring save part in readonly mode.
1428 \begin_layout Subsubsection
1429 save-state <filename>
1432 \begin_layout Standard
1433 Save system state to <filename> as soon as possible.
1436 \begin_layout Subsubsection
1437 save-movie <filename>
1440 \begin_layout Standard
1441 Save movie to <filename>.
1444 \begin_layout Subsubsection
1448 \begin_layout Standard
1449 Set read-write mode.
1452 \begin_layout Subsubsection
1456 \begin_layout Standard
1460 \begin_layout Subsubsection
1464 \begin_layout Standard
1465 Toggle between read-only and read-write modes.
1468 \begin_layout Subsubsection
1472 \begin_layout Standard
1473 Set name of the game to <name>
1476 \begin_layout Subsubsection
1480 \begin_layout Standard
1481 Print the name of the game.
1484 \begin_layout Subsubsection
1488 \begin_layout Standard
1489 Adds new author <author>.
1490 If <author> does not contain '|' it is full name.
1491 If it contains '|', '|' splits the full name and nickname.
1494 \begin_layout Subsubsection
1495 edit-author <num> <author>
1498 \begin_layout Standard
1499 Edit the author in slot <num> (0-based) to be <author> (see add-author for
1503 \begin_layout Subsubsection
1507 \begin_layout Standard
1508 Remove author in slot <num>
1511 \begin_layout Subsubsection
1515 \begin_layout Standard
1519 \begin_layout Subsubsection
1520 test-1, test-2, test-3
1523 \begin_layout Standard
1524 Internal test commands.
1528 \begin_layout Subsubsection
1529 take-screenshot <filename>
1532 \begin_layout Standard
1533 Save screenshot to <filename>.
1536 \begin_layout Subsubsection
1537 +controller<num><button>
1540 \begin_layout Standard
1541 Press button <button> on controller <num> (1-8).
1542 The following button names are known:
1545 \begin_layout Itemize
1549 \begin_layout Itemize
1553 \begin_layout Itemize
1557 \begin_layout Itemize
1561 \begin_layout Itemize
1565 \begin_layout Itemize
1569 \begin_layout Itemize
1573 \begin_layout Itemize
1577 \begin_layout Itemize
1581 \begin_layout Itemize
1585 \begin_layout Itemize
1589 \begin_layout Itemize
1593 \begin_layout Itemize
1597 \begin_layout Itemize
1601 \begin_layout Itemize
1605 \begin_layout Itemize
1609 \begin_layout Subsubsection
1610 controllerh<num><button>
1613 \begin_layout Standard
1614 Hold/unhold button <button> on controller <num> (1-8).
1615 See +controller for button names.
1618 \begin_layout Subsubsection
1619 autofire (<pattern>|-)...
1622 \begin_layout Standard
1623 Set autofire pattern.
1624 Each parameter is comma-separated list of button names (in form of 1start,
1625 1A, 2B, etc..) to hold on that frame.
1626 After reaching the end of pattern, the pattern restarts from the beginning.
1629 \begin_layout Subsubsection
1633 \begin_layout Standard
1637 \begin_layout Subsection
1641 \begin_layout Subsubsection
1642 cycle-jukebox-backward
1645 \begin_layout Standard
1646 Cycle save jukebox backwards.
1649 \begin_layout Subsubsection
1650 cycle-jukebox-forward
1653 \begin_layout Standard
1654 Cycle save jukebox forwards
1657 \begin_layout Subsubsection
1658 add-jukebox-save <filename>
1661 \begin_layout Standard
1662 Add <filename> to jukebox saves.
1665 \begin_layout Subsubsection
1669 \begin_layout Standard
1670 Do load from jukebox (current mode).
1673 \begin_layout Subsubsection
1677 \begin_layout Standard
1678 Do state save to jukebox.
1681 \begin_layout Subsection
1685 \begin_layout Standard
1686 Only available if lua support is compiled in.
1689 \begin_layout Subsubsection
1690 evaluate-lua <luacode>
1693 \begin_layout Standard
1694 Run Lua code <luacode> using built-in Lua interpretter.
1697 \begin_layout Subsubsection
1701 \begin_layout Standard
1702 Run specified lua file using built-in Lua interpretter.
1705 \begin_layout Subsection
1709 \begin_layout Subsubsection
1710 add-watch <name> <expression>
1713 \begin_layout Standard
1714 Adds new watch (or modifies old one).
1717 \begin_layout Subsubsection
1721 \begin_layout Standard
1725 \begin_layout Subsection
1729 \begin_layout Subsubsection
1730 enable-sound <on/off>
1733 \begin_layout Standard
1734 Enable/Disable sound.
1737 \begin_layout Subsubsection
1738 set-sound-device <device>
1741 \begin_layout Standard
1742 Set sound device to <device>
1745 \begin_layout Subsubsection
1749 \begin_layout Standard
1750 Show status of sound system.
1753 \begin_layout Subsubsection
1757 \begin_layout Standard
1758 Show all available devices.
1761 \begin_layout Subsection
1762 SDL Platform commands
1765 \begin_layout Standard
1766 The following are valid on SDL platform.
1769 \begin_layout Subsubsection
1773 \begin_layout Standard
1774 Asks to press a key and then identifies that (pseudo-)key.
1777 \begin_layout Subsubsection
1781 \begin_layout Standard
1782 Toggle between windowed/fullscreen console.
1785 \begin_layout Subsubsection
1789 \begin_layout Standard
1790 Scroll messages window as far back as it goes.
1793 \begin_layout Subsubsection
1797 \begin_layout Standard
1798 Scroll messages window as far forward as it goes.
1801 \begin_layout Subsubsection
1805 \begin_layout Standard
1806 Scroll messages window back one screenful.
1809 \begin_layout Subsubsection
1813 \begin_layout Standard
1814 Scroll messages window forward one screenful.
1817 \begin_layout Section
1821 \begin_layout Subsection
1825 \begin_layout Subsubsection
1829 \begin_layout Standard
1830 Set where bsnes looks for firmware files.
1832 \begin_inset Quotes eld
1836 \begin_inset Quotes erd
1842 \begin_layout Subsubsection
1846 \begin_layout Standard
1848 Numeric, range is 0.001 to
1849 \begin_inset Quotes eld
1853 \begin_inset Quotes erd
1857 Default is native framerate.
1860 \begin_layout Subsubsection
1864 \begin_layout Standard
1865 Set save compression level (integer 0-9).
1866 Default is 7 (0 is no compression).
1869 \begin_layout Subsubsection
1873 \begin_layout Standard
1874 Set the frame advance timeout in milliseconds.
1875 Numeric integer, range is 0-999999999.
1879 \begin_layout Subsection
1883 \begin_layout Subsubsection
1887 \begin_layout Standard
1888 AVI dumper: Always dump at 512x448 or 512x478 regardless of what the console
1892 \begin_layout Subsubsection
1896 \begin_layout Standard
1897 AVI dumper: Set the default left border thickness (unless lua overrides)
1903 \begin_layout Subsubsection
1907 \begin_layout Standard
1908 AVI dumper: Set the default right border thickness (unless lua overrides)
1914 \begin_layout Subsubsection
1918 \begin_layout Standard
1919 AVI dumper: Set the default top border thickness (unless lua overrides)
1925 \begin_layout Subsubsection
1929 \begin_layout Standard
1930 AVI dumper: Set the default bottom border thickness (unless lua overrides)
1936 \begin_layout Subsubsection
1940 \begin_layout Standard
1941 AVI dumper: Maximum number of frames per dump segment (0 => unlimited).
1946 \begin_layout Subsubsection
1950 \begin_layout Standard
1951 AVI dumper: Compression level (0-18).
1954 \begin_layout Itemize
1955 Compression levels 10 and above are not compatible with stock CSCD codec.
1958 \begin_layout Itemize
1959 Recomended level is 7.
1962 \begin_layout Subsubsection
1966 \begin_layout Standard
1967 AVI dumper: Set method of determining the sound rate.
1970 \begin_layout Itemize
1971 0: Pick nearest of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48, 64, 88.2, 96,
1972 128, 176.4 and 192 kHz.
1975 \begin_layout Itemize
1976 1: Round down to nearest integer.
1979 \begin_layout Itemize
1980 2: Round up to nearest ingeter.
1983 \begin_layout Subsection
1987 \begin_layout Subsubsection
1991 \begin_layout Standard
1992 JMD dumper: Compression level (0-9).
1995 \begin_layout Subsection
1996 SDL platform settings
1999 \begin_layout Subsubsection
2000 autorepeat-first-delay
2003 \begin_layout Standard
2004 Sets the delay for first character in typematic autorepeat.
2007 \begin_layout Subsubsection
2008 autorepeat-subsequent-delay
2011 \begin_layout Standard
2012 Sets the delay for subsequent characters in typematic autorepeat.
2015 \begin_layout Section
2019 \begin_layout Subsection
2020 Core (in main table)
2023 \begin_layout Subsubsection
2027 \begin_layout Standard
2028 Print line to message console.
2031 \begin_layout Subsubsection
2032 exec(string command)
2035 \begin_layout Standard
2036 Run command as it was entered on the command line
2039 \begin_layout Subsubsection
2043 \begin_layout Standard
2045 First is time since some epoch in seconds, the second is microseconds mod
2046 10^6 since that epoch.
2049 \begin_layout Subsubsection
2053 \begin_layout Standard
2054 Returns true if emulator has finished booting, false if not (on_startup()
2055 will be issued later).
2058 \begin_layout Subsubsection
2059 set_idle_timeout(number timeout)
2062 \begin_layout Standard
2063 Set number of microseconds to block idle for.
2064 After this timeout has expired, on_idle() will be called once.
2067 \begin_layout Subsubsection
2068 set_timer_timeout(number timeout)
2071 \begin_layout Standard
2072 Set number of microseconds to block timer for.
2073 After this timeout has expired, on_timer() will be called once.
2076 \begin_layout Subsection
2080 \begin_layout Standard
2081 Bitwise logical functions and related.
2084 \begin_layout Subsubsection
2085 bit.none(number...) / bit.bnot(number...)
2088 \begin_layout Standard
2089 48-bit bitwise NOT / NONE function (set bits that are set in none of the
2093 \begin_layout Subsubsection
2094 bit.any(number...) / bit.bor(number...)
2097 \begin_layout Standard
2098 48-bit bitwise OR / ANY function (set bits that are set in any of the arguments).
2101 \begin_layout Subsubsection
2102 bit.all(number...) / bit.band(number...)
2105 \begin_layout Standard
2106 48-bit bitwise AND / ALL function (set bits that are set in all of the arguments
2110 \begin_layout Subsubsection
2111 bit.parity(number...) / bit.bxor(number...)
2114 \begin_layout Standard
2115 48-bit bitwise XOR / PARITY function (set bits that are set in odd number
2119 \begin_layout Subsubsection
2120 bit.lrotate(number base[, number amount[, number bits]])
2123 \begin_layout Standard
2124 Rotate bits-bit (max 48, default 48) number left by amount (default 1) places.
2127 \begin_layout Subsubsection
2128 bit.rrotate(number base[, number amount[, number bits]])
2131 \begin_layout Standard
2132 Rotate bits-bit (max 48, default 48) number right by amount (default 1)
2136 \begin_layout Subsubsection
2137 bit.lshift(number base[, number amount[, number bits]])
2140 \begin_layout Standard
2141 Shift bits-bit (max 48, default 48) number left by amount (default 1) places.
2142 The new bits are filled with zeroes.
2145 \begin_layout Subsubsection
2146 bit.lrshift(number base[, number amount[, number bits]])
2149 \begin_layout Standard
2150 Shift bits-bit (max 48, default 48) number logically right by amount (default
2152 The new bits are filled with zeroes.
2155 \begin_layout Subsubsection
2156 bit.arshift(number base[, number amount[, number bits]])
2159 \begin_layout Standard
2160 Shift bits-bit (max 48, default 48) number arithmetically right by amount
2162 The new bits are shifted in with copy of the high bit.
2165 \begin_layout Subsubsection
2166 bit.extract(number base[, number bit0[, number bit1,...]])
2169 \begin_layout Standard
2170 Returns number that has bit0-th bit as bit 0, bit1-th bit as 1 and so on.
2173 \begin_layout Standard
2177 \begin_layout Itemize
2178 Bit numbers up to 51 should work reliably (then things start falling apart
2179 due to double precision issues).
2182 \begin_layout Itemize
2183 There are two special bit positions, true and false, standing for always
2184 set bit and always clear bit.
2187 \begin_layout Subsection
2191 \begin_layout Standard
2192 Most of these functions can only be called in on_paint and on_video callbacks.
2193 Exceptions are noted.
2196 \begin_layout Standard
2198 Bits 0-7 are the blue component, bits 8-15 are the green component, bits
2199 16-23 are the red component, bits 24-31 are alpha component (0 is fully
2200 opaque, 255 is almost transparent).
2201 -1 is the fully transparent color.
2202 Alpha values greater than 127 do work.
2205 \begin_layout Standard
2206 Origin of coordinates is at top left corner of game display area.
2207 Left and top gaps correspond to negative coordinates.
2210 \begin_layout Subsubsection
2214 \begin_layout Standard
2215 Returns 2-tuple (hresolution, vresolution).
2218 \begin_layout Subsubsection
2219 gui.<class>_gap(number gap)
2222 \begin_layout Standard
2223 Set the <class> (left, right, top, bottom) gap to specified value (max gap
2227 \begin_layout Subsubsection
2228 gui.text(number x, number y, string text[, number fgc[, number bgc]])
2231 \begin_layout Standard
2232 Draw specified text on the GUI (each character cell is 8 or 16 wide and
2237 \begin_layout Itemize
2238 x: X-coordinate to start the drawing from (and x-coordinate at begining
2242 \begin_layout Itemize
2243 y: Y-coordinate to start the drawing from.
2246 \begin_layout Itemize
2247 text: The text to draw.
2250 \begin_layout Itemize
2251 fgc: Text color (default is 0xFFFFFF (white))
2254 \begin_layout Itemize
2255 bgc: Background color (default is -1 (transparent))
2258 \begin_layout Subsubsection
2259 gui.textH(number x, number y, string text[, number fgc[, number bgc]])
2262 \begin_layout Standard
2263 Like gui.text, but draw using double-width.
2266 \begin_layout Subsubsection
2267 gui.textV(number x, number y, string text[, number fgc[, number bgc]])
2270 \begin_layout Standard
2271 Like gui.text, but draw using double-height.
2274 \begin_layout Subsubsection
2275 gui.textHV(number x, number y, string text[, number fgc[, number bgc]])
2278 \begin_layout Standard
2279 Like gui.text, but draw using double-width/double-height.
2282 \begin_layout Subsubsection
2283 gui.rectangle(number x, number y, number width, number height[, number thickness[
2284 , number outline[, number fill]]])
2287 \begin_layout Standard
2288 Draw rectangle on the GUI.
2292 \begin_layout Itemize
2293 x: X-coordinate of left edge.
2296 \begin_layout Itemize
2297 y: Y-coordinate of upper edge.
2300 \begin_layout Itemize
2301 width: Width of rectangle.
2304 \begin_layout Itemize
2305 height: Height of rectangle.
2308 \begin_layout Itemize
2309 thickness: Thickness of outline (default is 1).
2312 \begin_layout Itemize
2313 outline: Color of outline (default is 0xFFFFFF (white))
2316 \begin_layout Itemize
2317 fill: Color of fil (default is -1 (transparent))
2320 \begin_layout Subsubsection
2321 gui.pixel(number x, number y[, number color])
2324 \begin_layout Standard
2325 Draw one pixel on the GUI.
2329 \begin_layout Itemize
2330 x: X-coordinate of the pixel
2333 \begin_layout Itemize
2334 y: Y-coordinate of the pixel
2337 \begin_layout Itemize
2338 color: Color of the pixel (default is 0xFFFFFF (white))
2341 \begin_layout Subsubsection
2342 gui.crosshair(number x, number y[, number length[, number color]])
2345 \begin_layout Standard
2350 \begin_layout Itemize
2351 x: X-coordinate of the crosshair
2354 \begin_layout Itemize
2355 y: Y-coordinate of the crosshair
2358 \begin_layout Itemize
2359 length: Length of the crosshair lines (default 10).
2362 \begin_layout Itemize
2363 color: Color of the crosshair (default is 0xFFFFFF (white))
2366 \begin_layout Subsubsection
2367 gui.line(number x1, number y1, number x2, number y2[, number color])
2370 \begin_layout Standard
2375 \begin_layout Itemize
2376 x1: X-coordinate of one end.
2379 \begin_layout Itemize
2380 y1: Y-coordinate of one end.
2383 \begin_layout Itemize
2384 x2: X-coordinate of the other end.
2387 \begin_layout Itemize
2388 y2: Y-coordinate of the other end.
2391 \begin_layout Itemize
2392 color: Color of the line (default is 0xFFFFFF (white)).
2395 \begin_layout Subsubsection
2396 gui.circle(number x, number y, number r[, number thick[, number border[,
2400 \begin_layout Standard
2405 \begin_layout Itemize
2406 x: X-coordinate of the center
2409 \begin_layout Itemize
2410 y: Y-coordinate of the center
2413 \begin_layout Itemize
2414 r: The radius of the circle
2417 \begin_layout Itemize
2418 thick: Border thickness
2421 \begin_layout Itemize
2422 border: Border color (default is 0xFFFFFF (white))
2425 \begin_layout Itemize
2426 fill: Fill color (default is -1 (transparent)).
2429 \begin_layout Subsubsection
2430 gui.bitmap_draw(number x, number y, bitmap bitmap, palette palette)
2433 \begin_layout Standard
2434 Draw a bitmap on screen with specified palette.
2438 \begin_layout Itemize
2439 x: X-coordinate of left edge.
2442 \begin_layout Itemize
2443 y: Y-coordinate of top edge.
2446 \begin_layout Itemize
2447 bitmap: The bitmap to draw
2450 \begin_layout Itemize
2451 palette: The palette to draw the bitmap using.
2454 \begin_layout Subsubsection
2455 gui.bitmap_draw(number x, number y, dbitmap bitmap)
2458 \begin_layout Standard
2459 Draw a bitmap on screen.
2463 \begin_layout Itemize
2464 x: X-coordinate of left edge.
2467 \begin_layout Itemize
2468 y: Y-coordinate of top edge.
2471 \begin_layout Itemize
2472 bitmap: The bitmap to draw
2475 \begin_layout Subsubsection
2479 \begin_layout Standard
2480 Returns a new palette (initially all transparent).
2481 Can be used anywhere.
2484 \begin_layout Subsubsection
2485 gui.bitmap_new(number w, number h, boolean direct)
2488 \begin_layout Standard
2489 Returns a new bitmap/dbitmap.
2490 Can be used anywhere.
2494 \begin_layout Itemize
2495 w: The width of new bitmap
2498 \begin_layout Itemize
2499 h: The height of new bitmap
2502 \begin_layout Itemize
2503 direct: If true, the returned bitmap is dbitmap, otherwise bitmap.
2506 \begin_layout Subsubsection
2507 gui.bitmap_load(string file)
2510 \begin_layout Standard
2511 Returns loaded bitmap/dbitmap (if bitmap, the second return value is palette
2513 Can be used anywhere.
2517 \begin_layout Itemize
2518 file: The name of file to load.
2521 \begin_layout Subsubsection
2522 gui.palette_set(palette palette, number index, number color)
2525 \begin_layout Standard
2526 Sets color in palette.
2527 Can be used anywhere.
2531 \begin_layout Itemize
2532 palette: The palette to manipulate
2535 \begin_layout Itemize
2536 index: Index of color (0-65535).
2539 \begin_layout Itemize
2540 color: The color value.
2543 \begin_layout Subsubsection
2544 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y, number color)
2547 \begin_layout Standard
2548 Sets specified pixel in bitmap.
2549 Can be used anywhere.
2553 \begin_layout Itemize
2554 bitmap: The bitmap to manipulate
2557 \begin_layout Itemize
2558 x: The x-coordinate of the pixel.
2561 \begin_layout Itemize
2562 y: The y-coordinate of the pixel.
2565 \begin_layout Itemize
2566 color: If bitmap is a bitmap, color index (0-65535).
2567 Otherwise color value.
2570 \begin_layout Subsubsection
2571 gui.bitmap_size(bitmap/dbitmap bitmap)
2574 \begin_layout Standard
2576 Can be used anywhere.
2580 \begin_layout Itemize
2581 bitmap: The bitmap to query.
2584 \begin_layout Standard
2585 The first return is the width, the second is the height.
2588 \begin_layout Subsubsection
2589 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy, bitmap/dbitmap
2590 src, number sx, number sy, number w, number h[, number ck])
2593 \begin_layout Standard
2594 Blit a part of bitmap to another.
2595 Can be used anywhere.
2599 \begin_layout Itemize
2600 dest: Destination to blit to.
2603 \begin_layout Itemize
2604 dx: left edge of target
2607 \begin_layout Itemize
2608 dy: Top edge of target
2611 \begin_layout Itemize
2612 src: The source to blit from.
2613 Must be of the same type as destination.
2616 \begin_layout Itemize
2617 sx: left edge of source
2620 \begin_layout Itemize
2621 sy: Top edge of source
2624 \begin_layout Itemize
2628 \begin_layout Itemize
2629 h: Height of region.
2632 \begin_layout Itemize
2634 Pixels of this color are not blitted.
2638 \begin_layout Itemize
2639 If bitmaps are bitmaps, this is color index of colorkey.
2640 Values outside range 0-65535 cause no key to be used as colorkey.
2643 \begin_layout Itemize
2644 If bitmaps are dbitmaps, this color value of colorkey.
2647 \begin_layout Itemize
2648 May be absent or nil for no colorkey blit.
2652 \begin_layout Subsubsection
2656 \begin_layout Standard
2657 Request on_repaint() to happen as soon as possible.
2658 Can be used anywhere.
2661 \begin_layout Subsubsection
2662 gui.subframe_update(boolean on)
2665 \begin_layout Standard
2666 Request subframe updates (calling on_paint() on subframes) to happen (on=true)
2667 or not happen (on=false).
2668 Can be used anywhere.
2671 \begin_layout Subsubsection
2672 gui.screenshot(string filename)
2675 \begin_layout Standard
2676 Write PNG screenshot of the current frame (no drawings) to specified file.
2677 Can be used anywhere.
2680 \begin_layout Subsubsection
2681 gui.color(number r, number g, number b[, number a])
2684 \begin_layout Standard
2685 Returns color (in notation Lua scripts use) corresponding to color (r,g,b),
2686 each component in scale 0-255.
2687 If a is specified, that is alpha (0 is fully transparent, 256(sic) is fully
2689 The default alpha is 256.
2692 \begin_layout Subsubsection
2693 gui.status(string name, string value)
2696 \begin_layout Standard
2698 \begin_inset Quotes eld
2702 \begin_inset Quotes erd
2705 to <value> in status area.
2706 Can be used anywhere.
2709 \begin_layout Subsection
2713 \begin_layout Standard
2715 Only available in on_input callback.
2718 \begin_layout Subsubsection
2719 input.get(number controller, number index)
2722 \begin_layout Standard
2723 Read the specified index (0-11) from specified controller (0-7).
2727 \begin_layout Itemize
2728 Uses physical controller numbering.
2729 Gamepad in port 2 is controller 4, not 1!
2732 \begin_layout Subsubsection
2733 input.set(number controller, number index, number value)
2736 \begin_layout Standard
2737 Write the specified index (0-11) from specified controller (0-7), storing
2742 \begin_layout Itemize
2743 Uses physical controller numbering.
2744 Gamepad in port 2 is controller 4, not 1!
2747 \begin_layout Subsubsection
2748 input.geta(number controller)
2751 \begin_layout Standard
2752 Get input state for entiere controller.
2753 Returns 13 return values.
2756 \begin_layout Itemize
2757 1st return value: Bitmask: bit i is set if i:th index is nonzero
2760 \begin_layout Itemize
2761 2nd-13th return value: value of i:th index.
2764 \begin_layout Subsubsection
2765 input.seta(number controller, number bitmask, number args...)
2768 \begin_layout Standard
2769 Set state for entiere controller.
2770 args is up to 12 values for indices (overriding values in bitmask if specified).
2773 \begin_layout Subsubsection
2774 input.reset([number cycles])
2777 \begin_layout Standard
2779 If cycles is greater than zero, do delayed reset.
2780 0 (or no value) causes immediate reset.
2783 \begin_layout Itemize
2784 Only available with subframe flag false.
2787 \begin_layout Subsubsection
2791 \begin_layout Standard
2792 Returns table of tables of all available keys and axes.
2793 The first table is indexed by key name (platform-dependent!), and the inner
2794 table has the following fields:
2797 \begin_layout Itemize
2798 last_rawval: Last reported raw value for control.
2801 \begin_layout Itemize
2802 ktype: Type of key (disabled, key, mouse, axis, axis-inverse, hat, pressure-m0,
2803 pressure-mp, pressure-0m, pressure-0p, pressure-pm, pressure-p0).
2806 \begin_layout Itemize
2807 cal_left: Minimum calibration value.
2808 Only meaningful with axis and pressure types.
2811 \begin_layout Itemize
2812 cal_center: Center calibration value.
2813 Only meaningful with axis and pressure types.
2816 \begin_layout Itemize
2817 cal_right: Maximum calibration value.
2818 Only meaningful with axis and pressure types.
2821 \begin_layout Itemize
2822 cal_tolerance: Dead zone tolerance.
2823 Only meaningful with axis and pressure types.
2826 \begin_layout Subsubsection
2827 input.keyhook(key, state)
2830 \begin_layout Standard
2831 Requests that keyhook events to be sent for key (state=true) or not sent
2835 \begin_layout Subsection
2839 \begin_layout Standard
2840 Host memory handling (extra memory saved to savestates).
2841 Host memory starts empty.
2844 \begin_layout Subsubsection
2845 hostmemory.read(number address)
2848 \begin_layout Standard
2849 Reads hostmemory slot address.
2850 Slot numbers out of range return false instead of numeric.
2853 \begin_layout Subsubsection
2854 hostmemory.write(number address, number value)
2857 \begin_layout Standard
2858 Writes hostmemory slot with 0-255.
2859 Slot numbers out of range cause extension of host memory slot space.
2862 \begin_layout Subsubsection
2863 hostmemory.readbyte(number address)
2866 \begin_layout Standard
2867 Read unsigned byte (1 element) from given address.
2868 Slots out of range return false.
2871 \begin_layout Subsubsection
2872 hostmemory.writebyte(number address, number value)
2875 \begin_layout Standard
2876 Write unsigned byte (1 element) to given slot.
2877 Slot numbers out of range cause extension.
2880 \begin_layout Subsubsection
2881 hostmemory.readsbyte(number address)
2884 \begin_layout Standard
2885 Read signed byte (1 element) from given address.
2886 Slots out of range return false.
2889 \begin_layout Subsubsection
2890 hostmemory.writesbyte(number address, number value)
2893 \begin_layout Standard
2894 Write signed byte (1 element) to given slot.
2895 Slot numbers out of range cause extension.
2898 \begin_layout Subsubsection
2899 hostmemory.readword(number address)
2902 \begin_layout Standard
2903 Read unsigned word (2 elements) from given address.
2904 Slots out of range return false.
2907 \begin_layout Subsubsection
2908 hostmemory.writeword(number address, number value)
2911 \begin_layout Standard
2912 Write unsigned word (2 elements) to given slot.
2913 Slot numbers out of range cause extension.
2916 \begin_layout Subsubsection
2917 hostmemory.readsword(number address)
2920 \begin_layout Standard
2921 Read signed word (2 elements) from given address.
2922 Slots out of range return false.
2925 \begin_layout Subsubsection
2926 hostmemory.writesword(number address, number value)
2929 \begin_layout Standard
2930 Write signed word (2 elements) to given slot.
2931 Slot numbers out of range cause extension.
2934 \begin_layout Subsubsection
2935 hostmemory.readdword(number address)
2938 \begin_layout Standard
2939 Read unsigned doubleword (4 elements) from given address.
2940 Slots out of range return false.
2943 \begin_layout Subsubsection
2944 hostmemory.writedword(number address, number value)
2947 \begin_layout Standard
2948 Write unsigned doubleword (4 elements) to given slot.
2949 Slot numbers out of range cause extension.
2952 \begin_layout Subsubsection
2953 hostmemory.readsdword(number address)
2956 \begin_layout Standard
2957 Read signed doubleword (4 elements) from given address.
2958 Slots out of range return false.
2961 \begin_layout Subsubsection
2962 hostmemory.writesdword(number address, number value)
2965 \begin_layout Standard
2966 Write signed doubleword (4 elements) to given slot.
2967 Slot numbers out of range cause extension.
2970 \begin_layout Subsubsection
2971 hostmemory.readqword(number address)
2974 \begin_layout Standard
2975 Read unsigned quadword (8 elements) from given address.
2976 Slots out of range return false.
2979 \begin_layout Subsubsection
2980 hostmemory.writeqword(number address, number value)
2983 \begin_layout Standard
2984 Write unsigned quadword (4 elements) to given slot.
2985 Slot numbers out of range cause extension.
2988 \begin_layout Subsubsection
2989 hostmemory.readsqword(number address)
2992 \begin_layout Standard
2993 Read signed quadword (8 elements) from given address.
2994 Slots out of range return false.
2997 \begin_layout Subsubsection
2998 hostmemory.writesqword(number address, number value)
3001 \begin_layout Standard
3002 Write signed quadword (8 elements) to given slot.
3003 Slot numbers out of range cause extension.
3006 \begin_layout Subsection
3010 \begin_layout Standard
3014 \begin_layout Subsubsection
3015 movie.currentframe()
3018 \begin_layout Standard
3019 Return number of current frame.
3022 \begin_layout Subsubsection
3026 \begin_layout Standard
3027 Return number of frames in movie.
3030 \begin_layout Subsubsection
3034 \begin_layout Standard
3035 Return true if in readonly mode, false if in readwrite.
3038 \begin_layout Subsubsection
3039 movie.set_readwrite()
3042 \begin_layout Standard
3043 Set readwrite mode (does not cause on_readwrite callback).
3046 \begin_layout Subsubsection
3047 movie.frame_subframes(number frame)
3050 \begin_layout Standard
3051 Count number of subframes in specified frame (frame numbers are 1-based)
3055 \begin_layout Subsubsection
3056 movie.read_subframe(number frame, number subframe)
3059 \begin_layout Standard
3060 Read specifed subframe in specified frame and return data as array (100
3061 elements, numbered 0-99 currently).
3064 \begin_layout Subsection
3068 \begin_layout Standard
3069 Routines for settings manipulation
3072 \begin_layout Subsubsection
3073 settings.get(string name)
3076 \begin_layout Standard
3077 Get value of setting.
3078 If setting is blank, returns false.
3079 If setting value can't be obtained, returns (nil, error message).
3082 \begin_layout Subsubsection
3083 settings.set(string name, string value)
3086 \begin_layout Standard
3087 Set value of setting.
3088 If setting can't be set, returns (nil, error message).
3091 \begin_layout Subsubsection
3092 settings.is_set(string name)
3095 \begin_layout Standard
3096 Returns if setting is set.
3097 If setting does not exist, returns (nil, error message).
3100 \begin_layout Subsubsection
3101 settings.blank(string name)
3104 \begin_layout Standard
3105 Blanks a setting and returns true.
3106 If setting can't be blanked, returns (nil, error message).
3109 \begin_layout Subsection
3113 \begin_layout Standard
3114 Contains various functions for managing memory
3117 \begin_layout Subsubsection
3121 \begin_layout Standard
3122 Returns the number of VMAs
3125 \begin_layout Subsubsection
3126 memory.read_vma(number index)
3129 \begin_layout Standard
3130 Reads the specified VMA (indices start from zero).
3131 Trying to read invalid VMA gives nil.
3132 The read VMA is table with the following fields:
3135 \begin_layout Itemize
3136 region_name (string): The readable name of the VMA
3139 \begin_layout Itemize
3140 baseaddr (number): Base address of the VMA
3143 \begin_layout Itemize
3144 lastaddr (number): Last address in the VMA.
3147 \begin_layout Itemize
3148 size (number): The size of VMA in bytes.
3151 \begin_layout Itemize
3152 readonly (boolean): True of the VMA corresponds to ROM.
3155 \begin_layout Itemize
3156 native_endian (boolean): True if the VMA has native endian as opposed to
3160 \begin_layout Subsubsection
3161 memory.find_vma(number address)
3164 \begin_layout Standard
3165 Finds the VMA containing specified address.
3166 Returns table in the same format as read_vma or nil if not found.
3169 \begin_layout Subsubsection
3170 memory.readbyte(number address)
3173 \begin_layout Standard
3174 Reads the specified address as unsigned byte and returns the result.
3177 \begin_layout Subsubsection
3178 memory.readsbyte(number address)
3181 \begin_layout Standard
3182 Reads the specified address as signed byte and returns the result.
3185 \begin_layout Subsubsection
3186 memory.writebyte(number address, number value)
3189 \begin_layout Standard
3190 Writes the specified value (negative values undergo 2's complement) to specified
3191 address (as a byte).
3194 \begin_layout Subsubsection
3195 memory.readword(number address)
3198 \begin_layout Standard
3199 Reads the specified address as unsigned word and returns the result.
3202 \begin_layout Subsubsection
3203 memory.readsword(number address)
3206 \begin_layout Standard
3207 Reads the specified address as signed word and returns the result.
3210 \begin_layout Subsubsection
3211 memory.writeword(number address, number value)
3214 \begin_layout Standard
3215 Writes the specified value (negative values undergo 2's complement) to specified
3216 address (as a word).
3219 \begin_layout Subsubsection
3220 memory.readdword(number address)
3223 \begin_layout Standard
3224 Reads the specified address as unsigned doubleword and returns the result.
3227 \begin_layout Subsubsection
3228 memory.readsdword(number address)
3231 \begin_layout Standard
3232 Reads the specified address as signed doubleword and returns the result.
3235 \begin_layout Subsubsection
3236 memory.writedword(number address, number value)
3239 \begin_layout Standard
3240 Writes the specified value (negative values undergo 2's complement) to specified
3241 address (as a doubleword).
3244 \begin_layout Subsubsection
3245 memory.readqword(number address)
3248 \begin_layout Standard
3249 Reads the specified address as unsigned quadword and returns the result.
3252 \begin_layout Subsubsection
3253 memory.readsqword(number address)
3256 \begin_layout Standard
3257 Reads the specified address as signed quadword and returns the result.
3260 \begin_layout Subsubsection
3261 memory.writeqword(number address, number value)
3264 \begin_layout Standard
3265 Writes the specified value (negative values undergo 2's complement) to specified
3266 address (as a quadword).
3269 \begin_layout Subsection
3273 \begin_layout Standard
3274 Contains copy of global variables from time of Lua initialization.
3278 \begin_layout Subsection
3282 \begin_layout Standard
3283 Various callbacks to Lua that can occur.
3286 \begin_layout Subsubsection
3287 Callback: on_paint(bool not_synth)
3290 \begin_layout Standard
3291 Called when screen is being painted.
3292 Any gui.* calls requiring graphic context draw on the screen.
3295 \begin_layout Standard
3296 not_synth is true if this hook is being called in response to received frame,
3300 \begin_layout Subsubsection
3301 Callback: on_video()
3304 \begin_layout Standard
3305 Called when video dump frame is being painted.
3306 Any gui.* calls requiring graphic context draw on the video.
3309 \begin_layout Subsubsection
3310 Callback: on_frame_emulated()
3313 \begin_layout Standard
3314 Called when emulating frame has completed and on_paint()/on_video() calls
3315 are about to be issued.
3318 \begin_layout Subsubsection
3319 Callback: on_frame()
3322 \begin_layout Standard
3323 Called on each starting whole frame.
3326 \begin_layout Subsubsection
3327 Callback: on_startup()
3330 \begin_layout Standard
3331 Called when the emulator is starting (lsnes.rc and --run files has been run).
3334 \begin_layout Subsubsection
3335 Callback: on_rewind()
3338 \begin_layout Standard
3339 Called when rewind movie to beginning has completed.
3342 \begin_layout Subsubsection
3343 Callback: on_pre_load(string name)
3346 \begin_layout Standard
3347 Called just before savestate/movie load occurs (note: loads are always delayed,
3348 so this occurs even when load was initiated by lua).
3351 \begin_layout Subsubsection
3352 Callback: on_err_load(string name)
3355 \begin_layout Standard
3356 Called if loadstate goes wrong.
3359 \begin_layout Subsubsection
3360 Callback: on_post_load(string name, boolean was_savestate)
3363 \begin_layout Standard
3364 Called on successful loadstate.
3365 was_savestate gives if this was a savestate or a movie.
3368 \begin_layout Subsubsection
3369 Callback: on_pre_save(string name, boolean is_savestate)
3372 \begin_layout Standard
3373 Called just before savestate save occurs (note: movie saves are synchronous
3374 and won't trigger these callbacks if called from Lua).
3377 \begin_layout Subsubsection
3378 Callback: on_err_save(string name)
3381 \begin_layout Standard
3382 Called if savestate goes wrong.
3385 \begin_layout Subsubsection
3386 Callback: on_post_save(string name, boolean is_savestate)
3389 \begin_layout Standard
3390 Called on successful savaestate.
3391 is_savestate gives if this was a savestate or a movie.
3394 \begin_layout Subsubsection
3398 \begin_layout Standard
3399 Called when emulator is shutting down.
3402 \begin_layout Subsubsection
3403 Callback: on_input(boolean subframe)
3406 \begin_layout Standard
3407 Called when emulator is just sending input to bsnes core.
3408 Warning: This is called even in readonly mode, but the results are ignored.
3411 \begin_layout Subsubsection
3412 Callback: on_reset()
3415 \begin_layout Standard
3416 Called when SNES is reset.
3419 \begin_layout Subsubsection
3420 Callback: on_readwrite()
3423 \begin_layout Standard
3424 Called when moving into readwrite mode as result of
3425 \begin_inset Quotes eld
3429 \begin_inset Quotes erd
3432 command (note: moving to rwmode by Lua won't trigger this, as per recursive
3436 \begin_layout Subsubsection
3437 Callback: on_snoop(number port, number controller, number index, number
3441 \begin_layout Standard
3442 Called each time bsnes asks for input.
3443 The value is the final value to be sent to bsnes core (readonly mode, autohold
3444 and autofire have been taken into account).
3445 Might be useful when translating movies to format suitable for console
3447 Note: There is no way to modify the value to be sent.
3450 \begin_layout Subsubsection
3451 Callback: on_keyhook(string keyname, table state)
3454 \begin_layout Standard
3455 Sent when key that has keyhook events requested changes state.
3456 Keyname is name of the key (group) and state is the state (same kind as
3457 table values in input.raw).
3460 \begin_layout Subsubsection
3464 \begin_layout Standard
3465 Called when requested by set_idle_timeout(), the timeout has expired and
3466 emulator is waiting.
3469 \begin_layout Subsubsection
3470 Callback: on_timer()
3473 \begin_layout Standard
3474 Called when requested by set_idle_timeout() and the timeout has expired
3475 (regardless if emulator is waiting).
3478 \begin_layout Section
3479 Memory watch expression syntax
3482 \begin_layout Standard
3483 Memory watch expressions are in RPN (Reverse Polish Notation).
3484 At the end of expression, the top entry on stack is taken as the final
3488 \begin_layout Standard
3492 \begin_layout Itemize
3493 Evaluation order is strictly left to right.
3496 \begin_layout Itemize
3497 a is the entry on top of stack
3500 \begin_layout Itemize
3501 b is the entry immediately below top of stack
3504 \begin_layout Itemize
3505 ; separates values to be pushed (no intermediate pop).
3508 \begin_layout Itemize
3509 After end of element, all used stack slots are popped and all results are
3513 \begin_layout Itemize
3514 When pushing multiple values, the pushes occur in order shown.
3517 \begin_layout Standard
3518 The following operators are available:
3521 \begin_layout Itemize
3525 \begin_layout Itemize
3529 \begin_layout Itemize
3533 \begin_layout Itemize
3537 \begin_layout Itemize
3541 \begin_layout Itemize
3545 \begin_layout Itemize
3546 b : read_signed_byte(a)
3549 \begin_layout Itemize
3553 \begin_layout Itemize
3554 d : read_signed_dword(a)
3557 \begin_layout Itemize
3561 \begin_layout Itemize
3563 \begin_inset Formula $\pi$
3569 \begin_layout Itemize
3570 q : read_signed_qword(a)
3573 \begin_layout Itemize
3577 \begin_layout Itemize
3581 \begin_layout Itemize
3585 \begin_layout Itemize
3589 \begin_layout Itemize
3590 w : read_signed_word(a)
3593 \begin_layout Itemize
3597 \begin_layout Itemize
3598 B : read_unsigned_byte(a)
3601 \begin_layout Itemize
3602 C<number>z : Push number <number> to stack.
3605 \begin_layout Itemize
3606 D : read_unsigned_dword(a)
3609 \begin_layout Itemize
3610 C0x<number>z : Push number <number> (hexadecimal) to stack.
3613 \begin_layout Itemize
3614 Q : read_unsigned_qword(a)
3617 \begin_layout Itemize
3618 R<digit> : round a to <digit> digits.
3621 \begin_layout Itemize
3622 W : read_unsigned_word(a)
3625 \begin_layout Subsection
3629 \begin_layout Standard
3630 C0x007e0878zWC0x007e002czW-
3633 \begin_layout Enumerate
3634 Push value 0x7e0878 on top of stack (C0x007e0878z).
3637 \begin_layout Enumerate
3638 Pop the value on top of stack (0x7e0878), read word value at that address
3639 and push the result,call it x1 (W).
3642 \begin_layout Enumerate
3643 Push value 0x7e002c on top of stack (C0x007e002cz).
3646 \begin_layout Enumerate
3647 Pop the value on top of stack (0x7e002c), read word value at that address
3648 and push the result,call it x2 (W).
3651 \begin_layout Enumerate
3652 Pop the two top numbers on stack, x1 and x2, substract x1 from x2 and push
3656 \begin_layout Enumerate
3657 Since the expression ends, the final memory watch result is the top one
3658 on stack, which is x2 - x1.
3661 \begin_layout Section
3662 Modifier and key names:
3665 \begin_layout Subsection
3669 \begin_layout Subsubsection
3673 \begin_layout Standard
3674 Following modifier names are known:
3677 \begin_layout Itemize
3678 ctrl, lctrl, rctrl: Control keys
3681 \begin_layout Itemize
3682 alt, lalt, ralt: ALT keys.
3685 \begin_layout Itemize
3686 shift, lshift, rshift: Shift keys.
3689 \begin_layout Itemize
3690 meta, lmeta, rmeta: Meta keys.
3693 \begin_layout Itemize
3694 num, caps: Numlock/Capslock (these are sticky!)
3697 \begin_layout Itemize
3701 \begin_layout Subsubsection
3705 \begin_layout Standard
3706 Following key names are known:
3709 \begin_layout Itemize
3710 backspace, tab, clear, return, pause, escape, space, exclaim, quotedbl,
3711 hash, dollar, ampersand, quote, leftparen, rightparen, asterisk, plus,
3712 comma, minus, period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon,
3713 less, equals, greater, question, at, leftbracket, backslash, rightbracket,
3714 caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n,
3715 o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0, world_1, world_2,
3716 world_3, world_4, world_5, world_6, world_7, world_8, world_9, world_10,
3717 world_11, world_12, world_13, world_14, world_15, world_16, world_17, world_18,
3718 world_19, world_20, world_21, world_22, world_23, world_24, world_25, world_26,
3719 world_27, world_28, world_29, world_30, world_31, world_32, world_33, world_34,
3720 world_35, world_36, world_37, world_38, world_39, world_40, world_41, world_42,
3721 world_43, world_44, world_45, world_46, world_47, world_48, world_49, world_50,
3722 world_51, world_52, world_53, world_54, world_55, world_56, world_57, world_58,
3723 world_59, world_60, world_61, world_62, world_63, world_64, world_65, world_66,
3724 world_67, world_68, world_69, world_70, world_71, world_72, world_73, world_74,
3725 world_75, world_76, world_77, world_78, world_79, world_80, world_81, world_82,
3726 world_83, world_84, world_85, world_86, world_87, world_88, world_89, world_90,
3727 world_91, world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3, kp4,
3728 kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide, kp_multiply, kp_minus, kp_plus,
3729 kp_enter, kp_equals, up, down, right, left, insert, home, end, pageup,
3730 pagedown, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14,
3731 f15, numlock, capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt,
3732 lalt, rmeta, lmeta, lsuper, rsuper, mode, compose, help, print, sysreq,
3733 break, menu, power, euro, undo
3736 \begin_layout Itemize
3737 Names of form 'key<n>' where <n> is 0-255 are interpretted as key having
3738 hardware-dependent scan code of <n> (useful to bind those keys that don't
3739 have symbolic names).
3742 \begin_layout Subsubsection
3743 Joystick pseudo-keys:
3746 \begin_layout Itemize
3747 joystick<num>button<button>: Joystick <num> (0-based) button <button> (0-based).
3750 \begin_layout Itemize
3751 joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat> (0-based) up.
3754 \begin_layout Itemize
3755 joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat> (0-based) left.
3758 \begin_layout Itemize
3759 joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat> (0-based) down.
3762 \begin_layout Itemize
3763 joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat> (0-based) right.
3766 \begin_layout Itemize
3767 joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis> negative
3768 position (axis modes axis and axis_inverse).
3771 \begin_layout Itemize
3772 joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis> positive
3773 position (axis modes axis and axis_inverse).
3776 \begin_layout Itemize
3777 joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis> pressure (axis
3781 \begin_layout Subsubsection
3785 \begin_layout Itemize
3786 Escape: Enter/Exit Command mode, cancel modal dialogs.
3789 \begin_layout Itemize
3790 Return (also KPEnter): Execute command, ok modal dialog.
3793 \begin_layout Itemize
3794 Pgup/Up (also KP8/9 if no num lock; command mode): Previous command in command
3798 \begin_layout Itemize
3799 Pgdn/Down(also KP2/3 if no num lock; command mode): Next command in command
3803 \begin_layout Itemize
3804 Home (also KP7 if no num lock; command mode): Beginning of command.
3807 \begin_layout Itemize
3808 End (also KP1 if no num lock; command mode): End of command.
3811 \begin_layout Itemize
3812 Left (also KP4 if no num lock; command mode): Move cursor left.
3815 \begin_layout Itemize
3816 Right (also KP6 if no num lock; command mode): Move cursor right.
3819 \begin_layout Itemize
3821 if no num lock; command mode): Delete character to right of cursor.
3824 \begin_layout Itemize
3825 Insert (also KP0 if no num lock; command mode): Toggle between insert /
3829 \begin_layout Itemize
3830 Backspace (command mode): Delete character to left of cursor.
3833 \begin_layout Itemize
3834 LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump corrupted!).
3837 \begin_layout Subsection
3841 \begin_layout Subsubsection
3845 \begin_layout Standard
3846 Following modifier names are known:
3849 \begin_layout Itemize
3853 \begin_layout Itemize
3857 \begin_layout Itemize
3861 \begin_layout Itemize
3865 \begin_layout Itemize
3869 \begin_layout Subsubsection
3873 \begin_layout Standard
3874 Following key names are known:
3877 \begin_layout Itemize
3878 back, tab, return, escape, space, exclaim, quotedbl, hash, dollar, percent,
3879 ampersand, quote, leftparen, rightparen, asterisk, plus, comma, minus,
3880 period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
3881 greater, question, at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3882 q, r, s, t, u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
3883 underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3884 q, r, s, t, u, v, w, x, y, z, leftcurly, pipe, rightcurly, tilde, delete,
3885 start, lbutton, rbutton, cancel, mbutton, clear, shift, alt, control, menu,
3886 pause, capital, end, home, lefT, up, right, down, select, print, execute,
3887 snapshot, insert, help, numpad0, numpad1, numpad2, numpad3, numpad4, numpad5,
3888 numpad6, numpad7, numpad8, numpad9, multiply, add, separator, subtract,
3889 decimal, divide, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13,
3890 f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, numlock, scroll,
3891 pageup, pagedown, numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
3892 numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up, numpad_right,
3893 numpad_down, numpad_pageup, numpad_pagedown, numpad_end, numpad_begin,
3894 numpad_insert, numpad_delete, numpad_equal, numpad_multiply, numpad_add,
3895 numpad_separator, numpad_subtract, numpad_decimal, numpad_divide, windows_left,
3896 windows_right, windows_menu, command, special1, special2, special3, special4,
3897 special5, special6, special7, special8, special9, special10, special11,
3898 special12, special13, special14, special15, special16, special17, special18,
3899 special19, special20
3902 \begin_layout Section
3906 \begin_layout Standard
3907 Movie file is .zip archive in itself, normal ZIP archive tools work on it
3908 (note: If you recompress it, do not use compression methods other than
3909 store and deflate and especially do not use encryption of any kind).
3912 \begin_layout Subsection
3913 Detecting clean start/SRAM/Savestate
3916 \begin_layout Itemize
3918 \begin_inset Quotes eld
3922 \begin_inset Quotes erd
3925 it is savestate, otherwise:
3928 \begin_layout Itemize
3929 If file has members with names starting
3930 \begin_inset Quotes eld
3934 \begin_inset Quotes erd
3937 it is movie starting from SRAM, otherwise:
3940 \begin_layout Itemize
3941 It is movie starting from clear state.
3944 \begin_layout Subsection
3948 \begin_layout Standard
3949 Type of game ROM and region (as one line).
3953 \begin_layout Standard
3954 \begin_inset Tabular
3955 <lyxtabular version="3" rows="8" columns="3">
3956 <features tabularvalignment="middle">
3957 <column alignment="center" valignment="top" width="0">
3958 <column alignment="center" valignment="top" width="0">
3959 <column alignment="center" valignment="top" width="0">
3961 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3964 \begin_layout Plain Layout
3970 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3973 \begin_layout Plain Layout
3979 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3982 \begin_layout Plain Layout
3990 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3993 \begin_layout Plain Layout
3999 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4002 \begin_layout Plain Layout
4008 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4011 \begin_layout Plain Layout
4019 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4022 \begin_layout Plain Layout
4028 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4031 \begin_layout Plain Layout
4037 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4040 \begin_layout Plain Layout
4048 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4051 \begin_layout Plain Layout
4057 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4060 \begin_layout Plain Layout
4066 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4069 \begin_layout Plain Layout
4077 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4080 \begin_layout Plain Layout
4086 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4089 \begin_layout Plain Layout
4095 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4098 \begin_layout Plain Layout
4106 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4109 \begin_layout Plain Layout
4115 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4118 \begin_layout Plain Layout
4124 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4127 \begin_layout Plain Layout
4135 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4138 \begin_layout Plain Layout
4144 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4147 \begin_layout Plain Layout
4153 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4156 \begin_layout Plain Layout
4164 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4167 \begin_layout Plain Layout
4173 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4176 \begin_layout Plain Layout
4182 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4185 \begin_layout Plain Layout
4199 \begin_layout Standard
4203 \begin_layout Standard
4204 \begin_inset Tabular
4205 <lyxtabular version="3" rows="3" columns="2">
4206 <features tabularvalignment="middle">
4207 <column alignment="center" valignment="top" width="0">
4208 <column alignment="center" valignment="top" width="0">
4210 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4213 \begin_layout Plain Layout
4219 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4222 \begin_layout Plain Layout
4230 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4233 \begin_layout Plain Layout
4239 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4242 \begin_layout Plain Layout
4250 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4253 \begin_layout Plain Layout
4259 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4262 \begin_layout Plain Layout
4276 \begin_layout Subsection
4280 \begin_layout Standard
4281 Contains type of port #1 (as one line).
4282 Valid values are 'none', 'gamepad', 'multitap' and 'mouse'.
4283 If not present, defaults to 'gamepad'.
4286 \begin_layout Subsection
4290 \begin_layout Standard
4291 Contains type of port #2 (as one line).
4292 Valid values are 'none', 'gamepad', 'multitap', 'mouse', 'superscope',
4293 'justifier' and 'justifiers'.
4294 If not present, defaults to 'none'.
4297 \begin_layout Subsection
4301 \begin_layout Standard
4302 Contains name of the game (as one line).
4305 \begin_layout Subsection
4309 \begin_layout Standard
4310 Contains authors, one per line.
4311 Part before '|' is the full name, part after is the nickname.
4314 \begin_layout Subsection
4318 \begin_layout Standard
4320 \begin_inset Quotes eld
4324 \begin_inset Quotes erd
4328 Used to reject other saves.
4331 \begin_layout Subsection
4332 Member: controlsversion
4335 \begin_layout Standard
4337 \begin_inset Quotes eld
4341 \begin_inset Quotes erd
4345 Used to identify what controls are there.
4348 \begin_layout Subsection
4350 \begin_inset Quotes eld
4354 \begin_inset Quotes erd
4360 \begin_layout Standard
4361 Contains bsnes core version number (as one line).
4364 \begin_layout Subsection
4368 \begin_layout Standard
4369 Contains project ID (as one line).
4370 Used to identify if two movies are part of the same project.
4373 \begin_layout Subsection
4374 Member: {rom,slota,slotb}{,xml}.sha256
4377 \begin_layout Standard
4378 Contains SHA-256 of said ROM or ROM mapping file (as one line).
4379 Absent if corresponding file is absent.
4382 \begin_layout Subsection
4383 Member: moviesram.<name>
4386 \begin_layout Standard
4387 Raw binary startup SRAM of kind <name>.
4388 Only present in savestates and movies starting from SRAM.
4391 \begin_layout Subsection
4395 \begin_layout Standard
4396 Contains frame number (as one line) of frame movie was saved on.
4397 Only present in savestates.
4400 \begin_layout Subsection
4404 \begin_layout Standard
4405 Current value of lag counter (as one line).
4406 Only present in savestates.
4409 \begin_layout Subsection
4410 Member: pollcounters
4413 \begin_layout Standard
4414 Contains poll counters (currently 100 of them), one per line.
4415 Each line is raw poll count if DRDY is set for it.
4416 Otherwise it is negative poll count minus one.
4417 Only present in savestates.
4420 \begin_layout Subsection
4424 \begin_layout Standard
4425 Raw binary dump of host memory.
4426 Only present in savestates.
4429 \begin_layout Subsection
4433 \begin_layout Standard
4434 The raw binary savestate itself.
4435 Savestate detection uses this file, only present in savestates.
4438 \begin_layout Subsection
4442 \begin_layout Standard
4443 Screenshot of current frame.
4444 Only present in savestates.
4445 First 2 bytes are big-endian width of image, rest are 24-bit RGB image
4447 Height of image is inferred from the width and size of data.
4450 \begin_layout Subsection
4454 \begin_layout Standard
4455 Raw binary SRAM of kind <name> at time of savestate.
4456 Only present in savestates.
4459 \begin_layout Subsection
4463 \begin_layout Standard
4464 The actual input track, one line per subframe (blank lines are skipped).
4467 \begin_layout Itemize
4468 If the first byte of each line is '.', ' ', <tab> or '|', then the line is
4469 part of same frame as previous, otherwise it starts a new frame.
4472 \begin_layout Itemize
4473 First subframe must start a new frame.
4476 \begin_layout Standard
4477 Length of movie in frames is number of lines in input file that start a
4481 \begin_layout Subsection
4485 \begin_layout Standard
4486 Contains textual base-10 rerecord count (as one line; emulator just writes
4487 this, it doesn't read it) + 1.
4490 \begin_layout Subsection
4494 \begin_layout Standard
4495 This member stores set of load IDs.
4496 There is one load ID per rerecord (plus one corresponding to start of project).
4499 \begin_layout Itemize
4500 This member constists of concatenation of records
4503 \begin_layout Itemize
4504 Each record is 2-36 bytes long and can represent 1-16,843,009 consequtive
4508 \begin_layout Itemize
4509 IDs are interpretted as 256-bit big-endian integers with warparound.
4512 \begin_layout Itemize
4513 Initial predicted ID is all zeroes.
4516 \begin_layout Standard
4517 Format of each record is:
4520 \begin_layout Itemize
4521 1 byte: Opcode byte.
4522 Bits 0-4 are prefix length (prefixlen), bits 5-6 are count length (countlen).
4526 \begin_layout Itemize
4527 32-prefixlen bytes of ID.
4530 \begin_layout Itemize
4531 countlen bytes of big-endian count (count).
4534 \begin_layout Standard
4535 Records are processed as follows:
4538 \begin_layout Itemize
4539 To form the first ID encoded by record, take the first prefixlen bytes predicted
4540 ID and append the read ID value to it.
4541 The result is the first ID encoded.
4544 \begin_layout Itemize
4545 If countlen is 0, record encodes 1 ID.
4548 \begin_layout Itemize
4549 If countlen is 1, record encodes 2+count IDs.
4552 \begin_layout Itemize
4553 If countlen is 2, record encodes 258+count IDs.
4556 \begin_layout Itemize
4557 If countlen is 3, record encodes 65794+count IDs.
4560 \begin_layout Itemize
4561 The new predicted ID is the next ID after last one encoded by the record.
4564 \begin_layout Standard
4565 The number of rerecords + 1 is equal to the sum of number of IDs encoded
4569 \begin_layout Subsection
4570 Member: starttime.second
4573 \begin_layout Standard
4574 Movie starting time, second part.
4575 Epoch is Unix epoch.
4576 Default is 1,000,000,000.
4579 \begin_layout Subsection
4580 Member: starttime.subsecond
4583 \begin_layout Standard
4584 Movie starting time, subsecond part.
4589 \begin_layout Subsection
4590 Member: savetime.second
4593 \begin_layout Standard
4594 Movie saving time, second part.
4595 Default is starttime.second.
4596 Only present in savestates.
4599 \begin_layout Subsection
4600 Member: savetime.subsecond
4603 \begin_layout Standard
4604 Movie saving time, subsecond part.
4605 Default is starttime.subsecond.
4606 Only present in savestates.
4609 \begin_layout Section
4610 Quick'n'dirty encode guide
4613 \begin_layout Enumerate
4614 Start the emulator and load the movie file.
4617 \begin_layout Enumerate
4618 Set large AVI option 'set-setting avi-large on'
4621 \begin_layout Enumerate
4622 Enable dumping 'dump-avi tmpdump'
4625 \begin_layout Enumerate
4626 Unpause and let it run until you want to end dumping.
4629 \begin_layout Enumerate
4630 Close the emulator (closing the window is the easiest way).
4634 \begin_layout Enumerate
4635 For each tmpdump*.avi file created, on command prompt, do 'x264 --crf 10
4636 -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
4639 \begin_layout Enumerate
4640 Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
4643 \begin_layout Enumerate
4644 Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv + tmpdump_0000001.mkv
4645 + tmpdump_0000002.mkv' (list every tmpdump_<numbers>.mkv, with + in between).
4648 \begin_layout Enumerate
4649 Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'.
4650 Now final.mkv contains quick'n'dirty encode.
4653 \begin_layout Section
4654 Axis configurations for some gamepad types:
4657 \begin_layout Subsection
4661 \begin_layout Standard
4662 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be set to pressure-+.
4665 \begin_layout LyX-Code
4666 set-axis joystick0axis2 pressure-+
4669 \begin_layout LyX-Code
4670 set-axis joystick0axis5 pressure-+
4673 \begin_layout Itemize
4674 This is needed for SDL only.
4675 EVDEV sets those types correctly.
4678 \begin_layout Subsection
4680 \begin_inset Quotes eld
4684 \begin_inset Quotes erd
4690 \begin_layout Standard
4691 Axes 8-19 should be disabled.
4694 \begin_layout LyX-Code
4695 set-axis joystick0axis8 disabled
4698 \begin_layout LyX-Code
4699 set-axis joystick0axis9 disabled
4702 \begin_layout LyX-Code
4703 set-axis joystick0axis10 disabled
4706 \begin_layout LyX-Code
4707 set-axis joystick0axis11 disabled
4710 \begin_layout LyX-Code
4711 set-axis joystick0axis12 disabled
4714 \begin_layout LyX-Code
4715 set-axis joystick0axis13 disabled
4718 \begin_layout LyX-Code
4719 set-axis joystick0axis14 disabled
4722 \begin_layout LyX-Code
4723 set-axis joystick0axis15 disabled
4726 \begin_layout LyX-Code
4727 set-axis joystick0axis16 disabled
4730 \begin_layout LyX-Code
4731 set-axis joystick0axis17 disabled
4734 \begin_layout LyX-Code
4735 set-axis joystick0axis18 disabled
4738 \begin_layout LyX-Code
4739 set-axis joystick0axis19 disabled
4742 \begin_layout Section
4746 \begin_layout Subsection
4747 Problems from BSNES core:
4750 \begin_layout Itemize
4751 The whole pending save stuff.
4754 \begin_layout Itemize
4755 Lack of layer hiding.
4758 \begin_layout Itemize
4759 It is slow (especially accuracy).
4762 \begin_layout Itemize
4763 Firmwares can't be loaded from ZIP archives.
4766 \begin_layout Subsection
4770 \begin_layout Itemize
4771 Modifiers don't work with pseudo-keys (SDL, EVDEV).
4774 \begin_layout Itemize
4775 Audio for last dumped frame is not itself dumped.
4778 \begin_layout Itemize
4779 Audio in UI is pretty bad in quality if game doesn't run at full speed.
4782 \begin_layout Itemize
4783 AVI compression levels 10-18 are not compatible with AVISynth AVISource.
4786 \begin_layout Itemize
4787 No menus, command based interface (SDL).
4790 \begin_layout Itemize
4791 Long commands don't scroll.
4794 \begin_layout Itemize
4795 Wxwidgets UI is still buggy.
4798 \begin_layout Section
4802 \begin_layout Subsection
4806 \begin_layout Itemize
4810 \begin_layout Itemize
4811 Fix dumper video corruption with levels 10-18.
4814 \begin_layout Subsection
4818 \begin_layout Itemize
4822 \begin_layout Itemize
4823 Lots of code cleanups
4826 \begin_layout Itemize
4827 Lua interface to settings
4830 \begin_layout Itemize
4831 Allow specifying AVI borders without Lua
4834 \begin_layout Itemize
4835 Fix scaling if vscale > 1 and originx > 0 (left border exists)
4838 \begin_layout Itemize
4839 on_snoop lua callback
4842 \begin_layout Itemize
4843 Faster movie loading and saving.
4846 \begin_layout Subsection
4850 \begin_layout Itemize
4854 \begin_layout Subsection
4858 \begin_layout Itemize
4862 \begin_layout Itemize
4863 Save jukebox functionality.
4866 \begin_layout Subsection
4870 \begin_layout Itemize
4871 Try to fix some nasty failing movie load edge cases
4874 \begin_layout Itemize
4875 Allow specifying scripts to run on command line.
4878 \begin_layout Subsection
4882 \begin_layout Itemize
4883 Major source code reorganization.
4886 \begin_layout Itemize
4887 Backup savestates before overwriting.
4890 \begin_layout Itemize
4891 Don't crash if loading initial state fails.
4894 \begin_layout Subsection
4898 \begin_layout Itemize
4902 \begin_layout Itemize
4903 Fix author name parsing
4906 \begin_layout Itemize
4907 Fix rerecord counting
4910 \begin_layout Itemize
4911 (SDL) Print messages to console if SDL is uninitialized
4914 \begin_layout Itemize
4915 Add movieinfo program
4918 \begin_layout Itemize
4919 Fix loading movies starting from SRAM.
4922 \begin_layout Subsection
4926 \begin_layout Itemize
4927 Add support for unattended dumping
4930 \begin_layout Itemize
4931 Fix compiling for Win32
4934 \begin_layout Itemize
4935 Don't lock up if sound can't be initialized
4938 \begin_layout Itemize
4939 Strip trailing CR from commands
4942 \begin_layout Itemize
4943 Don't try to do dubious things in global ctors (fix crash on startup)
4946 \begin_layout Subsection
4950 \begin_layout Itemize
4951 Small documentation tweaking
4954 \begin_layout Itemize
4958 \begin_layout Itemize
4959 Fix major bug in modifier matching
4962 \begin_layout Subsection
4966 \begin_layout Itemize
4967 Lots of documentation fixes
4970 \begin_layout Itemize
4971 Use dedicated callbacks for event backcomm., not commands.
4974 \begin_layout Itemize
4975 Ensure that the watchdog is not hit when executing delayed reset.
4978 \begin_layout Itemize
4979 Remove errant tab from joystick message.
4982 \begin_layout Subsection
4986 \begin_layout Itemize
4987 Make autofire operate in absolute time, not linear time
4990 \begin_layout Itemize
4991 Reinitialize controls when resuming from loadstate
4994 \begin_layout Itemize
4995 Some more code cleanups
4998 \begin_layout Itemize
4999 If Lua allocator fails, call OOM_panic()
5002 \begin_layout Itemize
5003 Byte/word/dword/qword sized host memory write/read functions.
5006 \begin_layout Itemize
5007 Dump at correct framerate if dumping interlaced NTSC (height=448).
5010 \begin_layout Subsection
5014 \begin_layout Itemize
5015 Actually include the complete source code
5018 \begin_layout Itemize
5022 \begin_layout Subsection
5026 \begin_layout Itemize
5027 Document {save,start}time.{,sub}second.
5030 \begin_layout Itemize
5031 Intercept time() from bsnes core.
5034 \begin_layout Subsection
5038 \begin_layout Itemize
5039 Allow disabling time() interception (allow build on Mac OS X)
5042 \begin_layout Itemize
5043 Use SDLMain on Mac OS X (make SDL not crash)
5046 \begin_layout Itemize
5047 Disable delayed resets (just plain too buggy for now).
5050 \begin_layout Itemize
5054 \begin_layout Itemize
5055 Use 16-bit for graphics/video instead of 32-bit.
5058 \begin_layout Itemize
5059 gui.rectangle/gui.pixel
5062 \begin_layout Itemize
5066 \begin_layout Itemize
5067 New CSCD writer implementation.
5070 \begin_layout Subsection
5074 \begin_layout Itemize
5075 Fix interaction of * and +.
5078 \begin_layout Itemize
5082 \begin_layout Itemize
5083 Use gettimeofday()/usleep(), these seem portable enough.
5086 \begin_layout Itemize
5087 Move joystick axis manipulation to keymapper code.
5090 \begin_layout Itemize
5091 Changes to how read-only works.
5094 \begin_layout Itemize
5095 Refactor controller input code.
5098 \begin_layout Subsection
5102 \begin_layout Itemize
5103 Fix mouseclick scale compensation.
5106 \begin_layout Itemize
5107 Draw area boundaries correctly in SDL code.
5110 \begin_layout Itemize
5114 \begin_layout Itemize
5115 Fix CSCD output (buffer overrun and race condition).
5118 \begin_layout Subsection
5122 \begin_layout Itemize
5123 JMD dumping support.
5126 \begin_layout Itemize
5127 Allow unattended dumping to JMD.
5130 \begin_layout Itemize
5134 \begin_layout Itemize
5135 Switch back to 32-bit colors.
5138 \begin_layout Itemize
5139 Add Lua function gui.color.
5142 \begin_layout Itemize
5143 Use some new C++11 features in GCC 4.6.
5146 \begin_layout Itemize
5147 Be prepared for core frequency changes.
5150 \begin_layout Itemize
5151 Pass colors in one chunk from Lua.
5154 \begin_layout Subsection
5158 \begin_layout Itemize
5159 New lua functions gui.line(), gui.status() and gui.circle(), memory.vma_count(),
5160 memory.read_vma() and memory.find_vma().
5163 \begin_layout Itemize
5164 Numerious documentation fixups
5167 \begin_layout Itemize
5168 RTC time format changed
5171 \begin_layout Itemize
5172 Reformat flags display
5175 \begin_layout Itemize
5176 Allow lua package name to be overridden
5179 \begin_layout Itemize
5180 SDUMP (high-quality dumping).
5183 \begin_layout Itemize
5184 Split platform support to plugins.
5187 \begin_layout Itemize
5188 Make all sound plugins support basic sound commands
5191 \begin_layout Itemize
5192 Support portaudio for sound.
5195 \begin_layout Itemize
5196 Allow disable Lua/SDL searching.
5199 \begin_layout Itemize
5200 Upconvert colors when copying lcscreen to screen.
5203 \begin_layout Itemize
5204 Reorganize source tree.
5207 \begin_layout Itemize
5208 Evdev joystick support.
5211 \begin_layout Itemize
5212 Refactor more code into generic window code.
5215 \begin_layout Subsection
5219 \begin_layout Itemize
5220 Refactor message handling.
5223 \begin_layout Itemize
5227 \begin_layout Itemize
5231 \begin_layout Itemize
5232 Finish pending saves before load/quit.
5235 \begin_layout Itemize
5236 Wxwidgets graphics plugin.
5239 \begin_layout Subsection
5243 \begin_layout Itemize
5244 Get rid of win32-crap.[ch]pp.
5247 \begin_layout Itemize
5248 Move files around a lot.
5251 \begin_layout Itemize
5252 Get rid of need for host C++ compiler.
5255 \begin_layout Itemize
5259 \begin_layout Itemize
5260 Refactor inter-component communication.
5263 \begin_layout Itemize
5267 \begin_layout Itemize
5268 Fix crash on multiline aliases.
5271 \begin_layout Itemize
5272 Load/Save settings in wxwidgets gui.
5275 \begin_layout Subsection
5279 \begin_layout Itemize
5280 Patch problems in bsnes core
5283 \begin_layout Itemize
5284 SNES is little-endian, not big-endian!
5287 \begin_layout Itemize
5288 Fix memory corruption in lcscreen::load()
5291 \begin_layout Subsection
5295 \begin_layout Itemize
5296 Fix interpretting repeat counts in rrdata loading.
5299 \begin_layout Itemize
5300 New lua callback: on_frame()
5303 \begin_layout Itemize
5304 Remove calls to runtosave() that aren't supposed to be there
5307 \begin_layout Itemize
5308 Lua function: movie.read_rtc()
5311 \begin_layout Itemize
5312 Ignore src/fonts/font.cpp
5315 \begin_layout Itemize
5316 Fix more bsnes core problems
5319 \begin_layout Itemize
5320 Control bsnes random seeding
5323 \begin_layout Itemize
5327 \begin_layout Itemize
5328 Some bsnes core debugging features (state dump and state hash)
5331 \begin_layout Itemize
5332 Fix titlebar version number (no, the last version wasn't 'lsnes-0-beta21',
5333 it was 'lsnes rr0-beta21').
5336 \begin_layout Subsection
5340 \begin_layout Itemize
5341 Fix memory corruption due to macro/field mixup
5344 \begin_layout Itemize
5345 search-memory update
5348 \begin_layout Itemize
5349 Allow direct-mapped framebuffer
5352 \begin_layout Itemize
5353 SDL: Use SDL_ANYFORMAT if possible
5356 \begin_layout Itemize
5357 SDMP2SOX: 2s delay modes.
5360 \begin_layout Itemize
5364 \begin_layout Itemize
5365 Use sed -E, not sed -r.
5366 Fixes building on Mac OS X.
5369 \begin_layout Itemize
5370 Wxwidgets: Save jukebox on exit
5373 \begin_layout Itemize
5374 Fix RTC if using load-movie on savestate.
5377 \begin_layout Itemize
5378 Fix crash related to full console mode.
5381 \begin_layout Subsection
5385 \begin_layout Itemize
5386 Wxwidgets: Allow bringing application to foreground on Mac OS X.
5389 \begin_layout Itemize
5390 Wxwidgets: Allow compiling on Mac OS X.
5393 \begin_layout Itemize
5394 Use movie compare instead of movie hashing (faster save/load).
5397 \begin_layout Itemize
5401 \begin_layout Subsection
5405 \begin_layout Itemize
5406 sdmp2sox: Pad soundtrack if using -l or -L.
5409 \begin_layout Itemize
5410 sdmp2sox: Fix NTSC overscan.
5413 \begin_layout Itemize
5414 sdmp2sox: Add AR correction mode.
5417 \begin_layout Itemize
5418 call lua_close() when exiting.
5421 \begin_layout Itemize
5422 Fix zip_writer bug causing warnings from info-zip and error from advzip.
5425 \begin_layout Subsection
5429 \begin_layout Itemize
5430 Fix IPS patching code (use bsnes core IPS patcher).
5433 \begin_layout Itemize
5434 Implement BPS patching (using bsnes core IPS patcher).
5437 \begin_layout Itemize
5438 Add feature to load headered ROMs.
5441 \begin_layout Subsection
5445 \begin_layout Itemize
5446 Show command names when showing keybindings
5449 \begin_layout Subsection
5453 \begin_layout Itemize
5454 Fix pause-on-end to be actually controllable
5457 \begin_layout Itemize
5458 SDL: Poll all events in queue, not just first one (fixes slowness in command
5462 \begin_layout Itemize
5463 Wxwidgets: Fix ROM loading.
5466 \begin_layout Subsection
5470 \begin_layout Itemize
5471 Lua: Add gui.textH, gui.textV, gui.textHV
5474 \begin_layout Itemize
5475 Fix text colors on SDL on Mac OS X
5478 \begin_layout Itemize
5479 Mode 'F' for finished in readonly mode.
5482 \begin_layout Itemize
5486 \begin_layout Itemize
5487 Reliably pause after skip poll
5490 \begin_layout Itemize
5491 Split UI and core into their own threads
5494 \begin_layout Subsection
5498 \begin_layout Itemize
5499 Remove leftover dummy SRAM slot
5502 \begin_layout Itemize
5503 Fix controller numbers.
5506 \begin_layout Subsection
5510 \begin_layout Itemize
5511 Fix lsnes-dumpavi after interface change.
5514 \begin_layout Itemize
5515 Also give BSNES patches for v085.
5518 \begin_layout Itemize
5519 Pack movie data in memory.
5522 \begin_layout Subsection
5526 \begin_layout Itemize
5527 Fix framecount/length given when loading movies.
5530 \begin_layout Itemize
5531 Controller command memory leak fixes.
5534 \begin_layout Itemize
5535 Don't leak palette if freeing screen object.
5538 \begin_layout Subsection
5542 \begin_layout Itemize
5546 \begin_layout Itemize
5547 Wxwidgets: Allow controlling dumper from the menu.
5550 \begin_layout Subsection
5554 \begin_layout Itemize
5555 Rewrite parts of manual
5558 \begin_layout Itemize
5559 Lua: Make it work with Lua 5.2.
5562 \begin_layout Subsection
5566 \begin_layout Itemize
5567 Win32: Fix compile errors.
5570 \begin_layout Subsection
5574 \begin_layout Itemize
5575 Refactor controller input code.
5578 \begin_layout Itemize
5579 Fix crash when using command line on SDL / Mac OS X.
5582 \begin_layout Subsection
5586 \begin_layout Itemize
5587 Delete core/coroutine (obsolete)
5590 \begin_layout Itemize
5591 Lag input display by one frame.
5594 \begin_layout Itemize
5595 Rewind movie to beginning function.
5598 \begin_layout Itemize
5599 Fix wrong frame number reported to Lua when repainting after loadstate
5602 \begin_layout Itemize
5603 Support UI editing of jukebox
5606 \begin_layout Itemize
5607 Wxwidgets: Save settings on exit.
5610 \begin_layout Itemize
5611 Support ${project} for filenames
5614 \begin_layout Itemize
5615 SDL: Fix command history
5618 \begin_layout Subsection
5622 \begin_layout Itemize
5623 Fix some order-of-global-ctor bugs.
5626 \begin_layout Subsection
5630 \begin_layout Itemize
5631 Fix crashes when quitting on Win32.
5634 \begin_layout Subsection
5638 \begin_layout Itemize
5639 EVDEV: Queue keypresses from joystick, don't send directly
5642 \begin_layout Itemize
5643 Wxwidgets: Load-Preserve that actually works.
5646 \begin_layout Subsection
5650 \begin_layout Itemize
5651 Wxwidgets: GUI for memory search.
5654 \begin_layout Itemize
5655 Warn about using synchronous queue in UI callback.
5658 \begin_layout Subsection
5662 \begin_layout Itemize
5663 Remember last saved file for each ROM
5666 \begin_layout Itemize
5667 Support MT dumping via boost.
5670 \begin_layout Itemize
5674 \begin_layout Itemize
5678 \begin_layout Itemize
5679 Make mouse be ordinary input instead of special-casing
5682 \begin_layout Itemize
5683 SDL: Don't screw up commands with NUL codepoints.
5686 \begin_layout Subsection
5690 \begin_layout Itemize
5691 Merge status panel and main window
5694 \begin_layout Itemize
5695 True movie slot support (the rest of it)
5698 \begin_layout Itemize
5699 SDL: Fix compilation error
5702 \begin_layout Itemize
5703 Elminate cross calls in dump menu code.
5706 \begin_layout Subsection
5710 \begin_layout Itemize
5711 Cancel pending saves command
5714 \begin_layout Itemize
5715 Wxwidgets: Code refactoring
5718 \begin_layout Itemize
5719 Wxwidgets: Fix system -> reset
5722 \begin_layout Itemize
5723 Wxwidgets: Read watch expressions in the right thread
5726 \begin_layout Subsection
5730 \begin_layout Itemize
5731 Wxwidgets: Don't prompt for member when running Lua script (Lua doesn't
5735 \begin_layout Itemize
5736 Wxwidgets: 128 -> 1024 Autohold slots (in case more are needed).
5739 \begin_layout Itemize
5740 Don't append trailing '-' to prefix when saving movie.
5743 \begin_layout Itemize
5744 Fix ROM/savestate handling (don't let user mismatch ROM and savestates).
5747 \begin_layout Subsection
5751 \begin_layout Itemize
5752 Document memory watch syntax.
5755 \begin_layout Subsection
5759 \begin_layout Itemize
5760 Fix unattended dumping (lsnes-dumpavi)
5763 \begin_layout Itemize
5767 \begin_layout Itemize
5768 Use adv_dumper instead of the old interface in lsnes-dumpavi (changes syntax)
5771 \begin_layout Itemize
5772 Add option to control sample rate preturbation in AVI dumper
5775 \begin_layout Subsection
5779 \begin_layout Itemize
5780 Wxwidgets: Fix dumper submodes
5783 \begin_layout Itemize
5784 Set core controller types before loadstate
5787 \begin_layout Subsection
5791 \begin_layout Itemize
5792 Fix compiling with bsnes v086.
5795 \begin_layout Subsection
5799 \begin_layout Itemize
5800 Don't prompt before quitting
5803 \begin_layout Itemize
5804 Start unpaused, preserve pause/unpause over load.
5807 \begin_layout Itemize
5808 Try to autodetect if ROM is headered.
5811 \begin_layout Itemize
5812 Wxwidgets: Only bring up ROM patching screen if specifically requested.
5815 \begin_layout Itemize
5816 Allow configuring some hotkeys.
5819 \begin_layout Subsection
5823 \begin_layout Itemize
5824 Lots of code cleanups
5827 \begin_layout Itemize
5828 Fix JMD compression (JMD dumping was broken)
5831 \begin_layout Itemize
5832 Don't crash if Lua C function throws an exception.
5835 \begin_layout Itemize
5836 Support bitmap drawing in Lua.
5839 \begin_layout Itemize
5840 Fix bsnes v085/v086 patches.
5843 \begin_layout Itemize
5844 Improve stability on win32.
5847 \begin_layout Subsection
5851 \begin_layout Itemize
5852 Don't corrupt movie if movie length is integer multiple of frames per page.