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 --headered-<kind>=<file> (lsnes/SDL, lsnes-avidump)
499 \begin_layout Standard
500 Load <file> as specified ROM, stripping first 512 bytes.
501 Handy for loading SMC / FIG and such files.
504 \begin_layout Subsubsection
505 --<kind>-xml=<file> (lsnes/SDL, lsnes-avidump)
508 \begin_layout Standard
509 Override hardware detection for ROM, reading the values from <file> (BSNES
513 \begin_layout Subsubsection
514 --ips-<kind>=<file> (lsnes/SDL, lsnes-avidump)
517 \begin_layout Standard
518 Apply BPS/IPS patch <file> to ROM <kind>.
519 If specified multiple times, the patches are applied in order.
522 \begin_layout Subsubsection
523 --ips-<kind>-xml=<file> (lsnes/SDL, lsnes-avidump)
526 \begin_layout Standard
527 Apply BPS/IPS patch <file> to XML of ROM <kind>.
528 If specified multiple times, the patches are applied in order.
531 \begin_layout Subsubsection
532 --ips-offset=<offset> (lsnes/SDL, lsnes-avidump)
535 \begin_layout Standard
536 Set offset to apply to IPS patches.
538 Handy for applying headered IPS patches (use offset of -512 for this).
539 The offset must be 0 for BPS patches.
542 \begin_layout Subsubsection
546 \begin_layout Standard
547 Force ROM to be considered PAL-only.
550 \begin_layout Itemize
551 Only works on SNES and SGB ROMs (not BS-X or Sufami Turbo).
554 \begin_layout Itemize
555 Attempting to load NTSC movie file will error out.
558 \begin_layout Subsubsection
562 \begin_layout Standard
563 Force ROM to be considered NTSC-only.
566 \begin_layout Itemize
567 Attempting to load PAL movie file will error out.
570 \begin_layout Subsection
574 \begin_layout Subsubsection
575 <filename> (lsnes/SDL, lsnes-avidump, movieinfo)
578 \begin_layout Standard
579 Load <filename> as movie or savestate file.
580 All other session options are ignored.
583 \begin_layout Subsubsection
584 --port1=<device> (lsnes/SDL)
587 \begin_layout Standard
592 \begin_layout Itemize
593 none: No device connected
596 \begin_layout Itemize
597 gamepad: One gamepad (the default)
600 \begin_layout Itemize
601 multitap: Four gamepads (warning: makes most games refuse to start)
604 \begin_layout Itemize
608 \begin_layout Subsubsection
609 --port2=<type> (lsnes/SDL)
612 \begin_layout Standard
617 \begin_layout Itemize
618 none: No device connected (the default)
621 \begin_layout Itemize
625 \begin_layout Itemize
626 multitap: Four gamepads.
629 \begin_layout Itemize
633 \begin_layout Itemize
634 superscope: Super Scope
637 \begin_layout Itemize
638 justifier: One justifier
641 \begin_layout Itemize
642 justifiers: Two justifiers
645 \begin_layout Subsubsection
646 --gamename=<name> (lsnes/SDL)
649 \begin_layout Standard
650 Set the name of game to <name>.
654 \begin_layout Subsubsection
655 --author=<name> (lsnes/SDL)
658 \begin_layout Standard
659 Add author with full name of <name> (no nickname).
662 \begin_layout Subsubsection
663 --author=|<name> (lsnes/SDL)
666 \begin_layout Standard
667 Add author with nickname of <name> (no full name).
670 \begin_layout Subsubsection
671 --author=<fullname>|<nickname> (lsnes/SDL)
674 \begin_layout Standard
675 Add author with full name of <fullname> and nickname of <nickname>.
678 \begin_layout Subsubsection
679 --rtc-second=<value> (lsnes/SDL)
682 \begin_layout Standard
683 Set RTC second (0 is 1st January 1970 00:00:00Z).
684 Default is 1,000,000,000.
687 \begin_layout Subsubsection
688 --rtc-subsecond=<value> (lsnes/SDL)
691 \begin_layout Standard
698 \begin_layout Subsection
703 \begin_layout Subsubsection
704 --run=<file> (lsnes/SDL)
707 \begin_layout Standard
708 After running main RC file, run this file.
709 If multiple are specified, these execute in order specified.
712 \begin_layout Subsection
713 dump options (lsnes-dumpavi only)
716 \begin_layout Subsubsection
720 \begin_layout Standard
721 Set the dumper to use (required).
722 Use 'list' for listing of known dumpers.
725 \begin_layout Subsubsection
729 \begin_layout Standard
730 Set the mode to use (required for dumpers with multiple modes, forbidden
732 Use 'list' for known modes.
735 \begin_layout Subsubsection
739 \begin_layout Standard
742 \begin_inset Quotes eld
746 \begin_inset Quotes erd
752 \begin_layout Subsubsection
753 --option=<name>=<value>
756 \begin_layout Standard
757 Set option <name> to value <value>.
760 \begin_layout Subsubsection
764 \begin_layout Standard
765 Set number of frames to dump.
769 \begin_layout Subsubsection
773 \begin_layout Standard
774 Run specified lua script (lsnes-dumpavi does not have initialization files).
777 \begin_layout Section
778 Startup file lsnes.rc
781 \begin_layout Standard
782 Upon startup, lsnes (lsnes/SDL only) executes file lsnes.rc as commands.
783 This file is located in:
786 \begin_layout Itemize
791 lsnes.rc (if %APPDATA% exists)
794 \begin_layout Itemize
795 Unix: $XDG_CONFIG_HOME/lsnes/lsnes.rc (if $XDG_CONFIG_HOME exists)
798 \begin_layout Itemize
799 Unix: $HOME/.config/lsnes/lsnes.rc (if $HOME exists)
802 \begin_layout Itemize
803 All: ./lsnes.rc (fallback default).
806 \begin_layout Standard
807 If leading directories do not exist, attempt to create them is made.
810 \begin_layout Section
814 \begin_layout Itemize
815 Commands beginning with '*' invoke the corresponding command without alias
819 \begin_layout Itemize
820 If command starts with '+' (after possible '*'), the command is executed
821 as-is when button is pressed, and when button is released, it is executed
822 with '+' replaced by '-'.
825 \begin_layout Itemize
826 Commands without '+' execute only on negative edge (release).
829 \begin_layout Subsection
833 \begin_layout Standard
834 Settings control various aspects of emulator behaviour.
837 \begin_layout Subsubsection
838 set-setting <setting> <value>
841 \begin_layout Standard
842 Sets setting <setting> to value <value> (may be empty).
845 \begin_layout Subsubsection
846 unset-setting <setting>
849 \begin_layout Standard
850 Try to unset setting <setting> (not all settings can be unset).
853 \begin_layout Subsubsection
854 get-setting <setting>
857 \begin_layout Standard
858 Read value of setting <setting>
861 \begin_layout Subsubsection
865 \begin_layout Standard
866 Print names and values of all settings.
869 \begin_layout Subsection
873 \begin_layout Standard
874 Keybindings bind commands or aliases to keys (or pseudo-keys).
878 \begin_layout Standard
882 \begin_layout Itemize
883 Do not bind edge active (+/-) commands to keys with modifiers, that won't
887 \begin_layout Itemize
888 Names of keys and modifiers are platform-dependent.
891 \begin_layout Itemize
892 Be careful before binding pseudo-keys (such as joystick axes, buttons or
893 hats) with modifiers.
894 That may or may not work right.
897 \begin_layout Subsubsection
898 bind-key [<mod>/<modmask>] <key> <command>
901 \begin_layout Standard
902 Bind <command> to key <key> (activating if modifiers in <modmask> (comma-seperat
903 ed list) are set as <mod> (comma-seperated list).
906 \begin_layout Standard
907 The names of keys and modifiers are platform-dependent.
910 \begin_layout Subsubsection
911 unbind-key [<mod>/<modmask>] <key>
914 \begin_layout Standard
915 Unbind command from <key> (with specified <mod> and <modmask>).
918 \begin_layout Subsubsection
919 set-axis <axis> [disabled | axis | axis-inverse | pressure0- | pressure0+
920 | pressure-0 | pressure-+ | pressure+0 | pressure+-] [minus=<val>] [zero=<val>]
921 [plus=<val>] [tolerance=<val>]
924 \begin_layout Standard
925 Set axis parameters for axis <axis>.
928 \begin_layout Itemize
929 disabled: Disable axis
932 \begin_layout Itemize
936 \begin_layout Itemize
937 axis-inverse: Inverse axis
940 \begin_layout Itemize
941 pressure0-: Pressure sensitive.
942 Released at 0, pressed at -.
945 \begin_layout Itemize
946 pressure0+: Pressure sensitive.
947 Released at 0, pressed at +.
950 \begin_layout Itemize
951 pressure-0: Pressure sensitive.
952 Released at -, pressed at 0.
955 \begin_layout Itemize
956 pressure-+: Pressure sensitive.
957 Released at -, pressed at +.
960 \begin_layout Itemize
961 pressure+0: Pressure sensitive.
962 Released at +, pressed at 0.
965 \begin_layout Itemize
966 pressure+-: Pressure sensitive.
967 Released at +, pressed at -.
970 \begin_layout Itemize
971 minus=<val>: Calibration at extreme minus position (-32768-32767)
974 \begin_layout Itemize
975 zero=<val>: Calibration at neutral position (-32768-32767)
978 \begin_layout Itemize
979 plus=<val>: Calibration at extreme plus position (-32768-32767)
982 \begin_layout Itemize
983 tolerance=<value>: Center band tolerance (0<x<1).
984 The smaller the value, the more sensitive the control is.
987 \begin_layout Subsubsection
991 \begin_layout Standard
992 Print all key bindings in effect.
995 \begin_layout Subsection
999 \begin_layout Standard
1000 Aliases bind command to sequence of commands.
1001 After alias has been defined, it replaces the command it shadows.
1004 \begin_layout Standard
1008 \begin_layout Itemize
1009 You can't alias command to itself.
1012 \begin_layout Itemize
1013 Aliases starting with +/- are edge active just like ordinary commands starting
1017 \begin_layout Itemize
1018 One command can be aliased to multiple commands.
1021 \begin_layout Subsubsection
1022 alias-command <command> <expansion>
1025 \begin_layout Standard
1026 Append <expansion> to alias <command>.
1027 If alias does not already exist, it is created.
1030 \begin_layout Subsubsection
1031 unalias-command <command>
1034 \begin_layout Standard
1035 Clear alias expansion for <command>.
1038 \begin_layout Subsubsection
1042 \begin_layout Standard
1043 Print all aliases and their expansions in effect.
1046 \begin_layout Subsection
1050 \begin_layout Standard
1051 Run <script> as if commands were entered on the command line.
1054 \begin_layout Subsection
1058 \begin_layout Standard
1059 Following commands control video dumping:
1062 \begin_layout Subsubsection
1066 \begin_layout Standard
1067 Dump AVI video to prefix <prefix> Notes:
1070 \begin_layout Itemize
1071 The codec is Camstudio Codec in gzip mode.
1074 \begin_layout Itemize
1075 Encoder and muxer are internal, available on all platforms.
1078 \begin_layout Itemize
1079 Audio enable/disable and framerate has no effect.
1082 \begin_layout Itemize
1083 The audio dumped to .avi is low-quality version.
1084 The high-quality version is dumped to .sox file.
1087 \begin_layout Subsubsection
1091 \begin_layout Standard
1092 End current AVI video dump (closing the emulator also closes the dump).
1095 \begin_layout Subsubsection
1099 \begin_layout Standard
1100 Dump JMD video to file <file>.
1103 \begin_layout Subsubsection
1107 \begin_layout Standard
1108 End the current JMD dump in progress.
1111 \begin_layout Subsubsection
1115 \begin_layout Standard
1116 Dump SDMP to <prefix>, splitting at 2GB.
1119 \begin_layout Subsubsection
1123 \begin_layout Standard
1124 Dump SDMP to <file>, no splitting
1127 \begin_layout Subsubsection
1131 \begin_layout Standard
1132 End the current SDMP dump in progress.
1135 \begin_layout Subsubsection
1139 \begin_layout Standard
1140 Dump raw audio (to <prefix>.audio, at 32040.5Hz) and video (to <prefix>.video>,
1141 at nominal framerate and 512x448 / 512x478 size).
1144 \begin_layout Subsubsection
1148 \begin_layout Standard
1149 End the current RAW dump in progress.
1152 \begin_layout Subsection
1156 \begin_layout Standard
1157 <address> may be decimal or hexadecimal (prefixed with '0x').
1158 <value> can be hexadecimal (prefixed with '0x'), unsigned or signed (prefixed
1162 \begin_layout Standard
1163 The available element <sizes> are:
1166 \begin_layout Itemize
1170 \begin_layout Itemize
1174 \begin_layout Itemize
1178 \begin_layout Itemize
1182 \begin_layout Standard
1183 When reading RAM and ROM, multi-byte reads/writes are big-endian.
1184 When dealing with DSP memory, multi-byte reads/writes are native-endian
1185 (do not use operand sizes exceeding DSP bitness, except dword is OK for
1189 \begin_layout Subsubsection
1190 read-<size> <address>
1193 \begin_layout Standard
1194 Read the value of byte in <address>.
1197 \begin_layout Subsubsection
1198 read-s<size> <address>
1201 \begin_layout Standard
1202 Read the value of signed byte in <address>.
1205 \begin_layout Subsubsection
1206 write-<size> <address> <value>
1209 \begin_layout Standard
1210 Write <value> to byte in address <address>.
1213 \begin_layout Subsubsection
1217 \begin_layout Standard
1218 Reset the memory search
1221 \begin_layout Subsubsection
1225 \begin_layout Standard
1226 Print number of candidates remaining
1229 \begin_layout Subsubsection
1233 \begin_layout Standard
1234 Print all candidates remaining
1237 \begin_layout Subsubsection
1238 search-memory <usflag><sizeflag><op>
1241 \begin_layout Standard
1242 Searches memory for addresses satisfying criteria.
1245 \begin_layout Standard
1249 \begin_layout Itemize
1253 \begin_layout Itemize
1257 \begin_layout Standard
1261 \begin_layout Itemize
1265 \begin_layout Itemize
1269 \begin_layout Itemize
1273 \begin_layout Itemize
1277 \begin_layout Standard
1281 \begin_layout Itemize
1282 lt: < previous value.
1285 \begin_layout Itemize
1286 le: <= previous value.
1289 \begin_layout Itemize
1290 eq: = previous value.
1293 \begin_layout Itemize
1294 ne: != previous value.
1297 \begin_layout Itemize
1298 ge: >= previous value.
1301 \begin_layout Itemize
1302 gt: > previous value.
1305 \begin_layout Subsubsection
1306 search-memory <sizeflag> <value>
1309 \begin_layout Standard
1310 Searches for addresses that currently have value <value>.
1311 <sizeflag> is as in previous command.
1314 \begin_layout Subsection
1318 \begin_layout Standard
1319 These commands are not available in lsnesrc, but are available after ROM
1323 \begin_layout Subsubsection
1327 \begin_layout Standard
1328 Quits the emulator (asking for confirmation).
1329 If /y is given, no confirmation is asked.
1332 \begin_layout Subsubsection
1336 \begin_layout Standard
1337 Toggle paused/unpaused
1340 \begin_layout Subsubsection
1344 \begin_layout Standard
1346 If the button is still held after configurable timeout expires, game unpauses
1347 for the duration frame advance is held.
1350 \begin_layout Subsubsection
1354 \begin_layout Standard
1356 If the button is still held after configurable timeout expires, game unpauses
1357 for the duration frame advance is held.
1360 \begin_layout Subsubsection
1364 \begin_layout Standard
1365 Skip to first poll in frame after current.
1368 \begin_layout Subsubsection
1372 \begin_layout Standard
1373 Reset the SNES after this frame.
1376 \begin_layout Subsubsection
1380 \begin_layout Standard
1381 Load savestate <filename> in current mode.
1384 \begin_layout Subsubsection
1385 load-state <filename>
1388 \begin_layout Standard
1389 Load savestate <filename> in readwrite mode.
1392 \begin_layout Subsubsection
1393 load-readonly <filename>
1396 \begin_layout Standard
1397 Load savestate <filename> in readonly mode.
1400 \begin_layout Subsubsection
1401 load-preserve <filename>
1404 \begin_layout Standard
1405 Load savestate <filename> in readonly mode, preserving current events.
1408 \begin_layout Subsubsection
1409 load-movie <filename>
1412 \begin_layout Standard
1413 Load savestate <filename>, ignoring save part in readonly mode.
1416 \begin_layout Subsubsection
1417 save-state <filename>
1420 \begin_layout Standard
1421 Save system state to <filename> as soon as possible.
1424 \begin_layout Subsubsection
1425 save-movie <filename>
1428 \begin_layout Standard
1429 Save movie to <filename>.
1432 \begin_layout Subsubsection
1436 \begin_layout Standard
1437 Set read-write mode.
1440 \begin_layout Subsubsection
1444 \begin_layout Standard
1448 \begin_layout Subsubsection
1452 \begin_layout Standard
1453 Toggle between read-only and read-write modes.
1456 \begin_layout Subsubsection
1460 \begin_layout Standard
1461 Set name of the game to <name>
1464 \begin_layout Subsubsection
1468 \begin_layout Standard
1469 Print the name of the game.
1472 \begin_layout Subsubsection
1476 \begin_layout Standard
1477 Adds new author <author>.
1478 If <author> does not contain '|' it is full name.
1479 If it contains '|', '|' splits the full name and nickname.
1482 \begin_layout Subsubsection
1483 edit-author <num> <author>
1486 \begin_layout Standard
1487 Edit the author in slot <num> (0-based) to be <author> (see add-author for
1491 \begin_layout Subsubsection
1495 \begin_layout Standard
1496 Remove author in slot <num>
1499 \begin_layout Subsubsection
1503 \begin_layout Standard
1507 \begin_layout Subsubsection
1508 test-1, test-2, test-3
1511 \begin_layout Standard
1512 Internal test commands.
1516 \begin_layout Subsubsection
1517 take-screenshot <filename>
1520 \begin_layout Standard
1521 Save screenshot to <filename>.
1524 \begin_layout Subsubsection
1525 +controller<num><button>
1528 \begin_layout Standard
1529 Press button <button> on controller <num> (1-8).
1530 The following button names are known:
1533 \begin_layout Itemize
1537 \begin_layout Itemize
1541 \begin_layout Itemize
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 Subsubsection
1598 controllerh<num><button>
1601 \begin_layout Standard
1602 Hold/unhold button <button> on controller <num> (1-8).
1603 See +controller for button names.
1606 \begin_layout Subsubsection
1607 autofire (<pattern>|-)...
1610 \begin_layout Standard
1611 Set autofire pattern.
1612 Each parameter is comma-separated list of button names (in form of 1start,
1613 1A, 2B, etc..) to hold on that frame.
1614 After reaching the end of pattern, the pattern restarts from the beginning.
1617 \begin_layout Subsubsection
1621 \begin_layout Standard
1625 \begin_layout Subsection
1629 \begin_layout Subsubsection
1630 cycle-jukebox-backward
1633 \begin_layout Standard
1634 Cycle save jukebox backwards.
1637 \begin_layout Subsubsection
1638 cycle-jukebox-forward
1641 \begin_layout Standard
1642 Cycle save jukebox forwards
1645 \begin_layout Subsubsection
1646 add-jukebox-save <filename>
1649 \begin_layout Standard
1650 Add <filename> to jukebox saves.
1653 \begin_layout Subsubsection
1657 \begin_layout Standard
1658 Do load from jukebox (current mode).
1661 \begin_layout Subsubsection
1665 \begin_layout Standard
1666 Do state save to jukebox.
1669 \begin_layout Subsection
1673 \begin_layout Standard
1674 Only available if lua support is compiled in.
1677 \begin_layout Subsubsection
1678 evaluate-lua <luacode>
1681 \begin_layout Standard
1682 Run Lua code <luacode> using built-in Lua interpretter.
1685 \begin_layout Subsubsection
1689 \begin_layout Standard
1690 Run specified lua file using built-in Lua interpretter.
1693 \begin_layout Subsection
1697 \begin_layout Subsubsection
1698 add-watch <name> <expression>
1701 \begin_layout Standard
1702 Adds new watch (or modifies old one).
1705 \begin_layout Subsubsection
1709 \begin_layout Standard
1713 \begin_layout Subsection
1717 \begin_layout Subsubsection
1718 enable-sound <on/off>
1721 \begin_layout Standard
1722 Enable/Disable sound.
1725 \begin_layout Subsubsection
1726 set-sound-device <device>
1729 \begin_layout Standard
1730 Set sound device to <device>
1733 \begin_layout Subsubsection
1737 \begin_layout Standard
1738 Show status of sound system.
1741 \begin_layout Subsubsection
1745 \begin_layout Standard
1746 Show all available devices.
1749 \begin_layout Subsection
1750 SDL Platform commands
1753 \begin_layout Standard
1754 The following are valid on SDL platform.
1757 \begin_layout Subsubsection
1761 \begin_layout Standard
1762 Asks to press a key and then identifies that (pseudo-)key.
1765 \begin_layout Subsubsection
1769 \begin_layout Standard
1770 Toggle between windowed/fullscreen console.
1773 \begin_layout Subsubsection
1777 \begin_layout Standard
1778 Scroll messages window as far back as it goes.
1781 \begin_layout Subsubsection
1785 \begin_layout Standard
1786 Scroll messages window as far forward as it goes.
1789 \begin_layout Subsubsection
1793 \begin_layout Standard
1794 Scroll messages window back one screenful.
1797 \begin_layout Subsubsection
1801 \begin_layout Standard
1802 Scroll messages window forward one screenful.
1805 \begin_layout Section
1809 \begin_layout Subsection
1813 \begin_layout Subsubsection
1817 \begin_layout Standard
1818 Set where bsnes looks for firmware files.
1820 \begin_inset Quotes eld
1824 \begin_inset Quotes erd
1830 \begin_layout Subsubsection
1834 \begin_layout Standard
1836 Numeric, range is 0.001 to
1837 \begin_inset Quotes eld
1841 \begin_inset Quotes erd
1845 Default is native framerate.
1848 \begin_layout Subsubsection
1852 \begin_layout Standard
1853 Set save compression level (integer 0-9).
1854 Default is 7 (0 is no compression).
1857 \begin_layout Subsubsection
1861 \begin_layout Standard
1862 Set the frame advance timeout in milliseconds.
1863 Numeric integer, range is 0-999999999.
1867 \begin_layout Subsection
1871 \begin_layout Subsubsection
1875 \begin_layout Standard
1876 AVI dumper: Always dump at 512x448 or 512x478 regardless of what the console
1880 \begin_layout Subsubsection
1884 \begin_layout Standard
1885 AVI dumper: Set the default left border thickness (unless lua overrides)
1891 \begin_layout Subsubsection
1895 \begin_layout Standard
1896 AVI dumper: Set the default right border thickness (unless lua overrides)
1902 \begin_layout Subsubsection
1906 \begin_layout Standard
1907 AVI dumper: Set the default top border thickness (unless lua overrides)
1913 \begin_layout Subsubsection
1917 \begin_layout Standard
1918 AVI dumper: Set the default bottom border thickness (unless lua overrides)
1924 \begin_layout Subsubsection
1928 \begin_layout Standard
1929 AVI dumper: Maximum number of frames per dump segment (0 => unlimited).
1934 \begin_layout Subsubsection
1938 \begin_layout Standard
1939 AVI dumper: Compression level (0-18).
1942 \begin_layout Itemize
1943 Compression levels 10 and above are not compatible with stock CSCD codec.
1946 \begin_layout Itemize
1947 Recomended level is 7.
1950 \begin_layout Subsubsection
1954 \begin_layout Standard
1955 AVI dumper: Set method of determining the sound rate.
1958 \begin_layout Itemize
1959 0: Pick nearest of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48, 64, 88.2, 96,
1960 128, 176.4 and 192 kHz.
1963 \begin_layout Itemize
1964 1: Round down to nearest integer.
1967 \begin_layout Itemize
1968 2: Round up to nearest ingeter.
1971 \begin_layout Subsection
1975 \begin_layout Subsubsection
1979 \begin_layout Standard
1980 JMD dumper: Compression level (0-9).
1983 \begin_layout Subsection
1984 SDL platform settings
1987 \begin_layout Subsubsection
1988 autorepeat-first-delay
1991 \begin_layout Standard
1992 Sets the delay for first character in typematic autorepeat.
1995 \begin_layout Subsubsection
1996 autorepeat-subsequent-delay
1999 \begin_layout Standard
2000 Sets the delay for subsequent characters in typematic autorepeat.
2003 \begin_layout Section
2007 \begin_layout Subsection
2008 Core (in main table)
2011 \begin_layout Subsubsection
2015 \begin_layout Standard
2016 Print line to message console.
2019 \begin_layout Subsubsection
2020 exec(string command)
2023 \begin_layout Standard
2024 Run command as it was entered on the command line
2027 \begin_layout Subsection
2031 \begin_layout Standard
2032 Bitwise logical functions and related.
2035 \begin_layout Subsubsection
2036 bit.none(number...) / bit.bnot(number...)
2039 \begin_layout Standard
2040 48-bit bitwise NOT / NONE function (set bits that are set in none of the
2044 \begin_layout Subsubsection
2045 bit.any(number...) / bit.bor(number...)
2048 \begin_layout Standard
2049 48-bit bitwise OR / ANY function (set bits that are set in any of the arguments).
2052 \begin_layout Subsubsection
2053 bit.all(number...) / bit.band(number...)
2056 \begin_layout Standard
2057 48-bit bitwise AND / ALL function (set bits that are set in all of the arguments
2061 \begin_layout Subsubsection
2062 bit.parity(number...) / bit.bxor(number...)
2065 \begin_layout Standard
2066 48-bit bitwise XOR / PARITY function (set bits that are set in odd number
2070 \begin_layout Subsubsection
2071 bit.lrotate(number base[, number amount[, number bits]])
2074 \begin_layout Standard
2075 Rotate bits-bit (max 48, default 48) number left by amount (default 1) places.
2078 \begin_layout Subsubsection
2079 bit.rrotate(number base[, number amount[, number bits]])
2082 \begin_layout Standard
2083 Rotate bits-bit (max 48, default 48) number right by amount (default 1)
2087 \begin_layout Subsubsection
2088 bit.lshift(number base[, number amount[, number bits]])
2091 \begin_layout Standard
2092 Shift bits-bit (max 48, default 48) number left by amount (default 1) places.
2093 The new bits are filled with zeroes.
2096 \begin_layout Subsubsection
2097 bit.lrshift(number base[, number amount[, number bits]])
2100 \begin_layout Standard
2101 Shift bits-bit (max 48, default 48) number logically right by amount (default
2103 The new bits are filled with zeroes.
2106 \begin_layout Subsubsection
2107 bit.arshift(number base[, number amount[, number bits]])
2110 \begin_layout Standard
2111 Shift bits-bit (max 48, default 48) number arithmetically right by amount
2113 The new bits are shifted in with copy of the high bit.
2116 \begin_layout Subsection
2120 \begin_layout Standard
2121 Most of these functions can only be called in on_paint and on_video callbacks.
2122 Exceptions are noted.
2125 \begin_layout Standard
2127 Bits 0-7 are the blue component, bits 8-15 are the green component, bits
2128 16-23 are the red component, bits 24-31 are alpha component (0 is fully
2129 opaque, 255 is almost transparent).
2130 -1 is the fully transparent color.
2131 Alpha values greater than 127 do work.
2134 \begin_layout Standard
2135 Origin of coordinates is at top left corner of game display area.
2136 Left and top gaps correspond to negative coordinates.
2139 \begin_layout Subsubsection
2143 \begin_layout Standard
2144 Returns 2-tuple (hresolution, vresolution).
2147 \begin_layout Subsubsection
2148 gui.<class>_gap(number gap)
2151 \begin_layout Standard
2152 Set the <class> (left, right, top, bottom) gap to specified value (max gap
2156 \begin_layout Subsubsection
2157 gui.text(number x, number y, string text[, number fgc[, number bgc]])
2160 \begin_layout Standard
2161 Draw specified text on the GUI (each character cell is 8 or 16 wide and
2166 \begin_layout Itemize
2167 x: X-coordinate to start the drawing from (and x-coordinate at begining
2171 \begin_layout Itemize
2172 y: Y-coordinate to start the drawing from.
2175 \begin_layout Itemize
2176 text: The text to draw.
2179 \begin_layout Itemize
2180 fgc: Text color (default is 0xFFFFFF (white))
2183 \begin_layout Itemize
2184 bgc: Background color (default is -1 (transparent))
2187 \begin_layout Subsubsection
2188 gui.textH(number x, number y, string text[, number fgc[, number bgc]])
2191 \begin_layout Standard
2192 Like gui.text, but draw using double-width.
2195 \begin_layout Subsubsection
2196 gui.textV(number x, number y, string text[, number fgc[, number bgc]])
2199 \begin_layout Standard
2200 Like gui.text, but draw using double-height.
2203 \begin_layout Subsubsection
2204 gui.textHV(number x, number y, string text[, number fgc[, number bgc]])
2207 \begin_layout Standard
2208 Like gui.text, but draw using double-width/double-height.
2211 \begin_layout Subsubsection
2212 gui.rectangle(number x, number y, number width, number height[, number thickness[
2213 , number outline[, number fill]]])
2216 \begin_layout Standard
2217 Draw rectangle on the GUI.
2221 \begin_layout Itemize
2222 x: X-coordinate of left edge.
2225 \begin_layout Itemize
2226 y: Y-coordinate of upper edge.
2229 \begin_layout Itemize
2230 width: Width of rectangle.
2233 \begin_layout Itemize
2234 height: Height of rectangle.
2237 \begin_layout Itemize
2238 thickness: Thickness of outline (default is 1).
2241 \begin_layout Itemize
2242 outline: Color of outline (default is 0xFFFFFF (white))
2245 \begin_layout Itemize
2246 fill: Color of fil (default is -1 (transparent))
2249 \begin_layout Subsubsection
2250 gui.pixel(number x, number y[, number color])
2253 \begin_layout Standard
2254 Draw one pixel on the GUI.
2258 \begin_layout Itemize
2259 x: X-coordinate of the pixel
2262 \begin_layout Itemize
2263 y: Y-coordinate of the pixel
2266 \begin_layout Itemize
2267 color: Color of the pixel (default is 0xFFFFFF (white))
2270 \begin_layout Subsubsection
2271 gui.crosshair(number x, number y[, number length[, number color]])
2274 \begin_layout Standard
2279 \begin_layout Itemize
2280 x: X-coordinate of the crosshair
2283 \begin_layout Itemize
2284 y: Y-coordinate of the crosshair
2287 \begin_layout Itemize
2288 length: Length of the crosshair lines (default 10).
2291 \begin_layout Itemize
2292 color: Color of the crosshair (default is 0xFFFFFF (white))
2295 \begin_layout Subsubsection
2296 gui.line(number x1, number y1, number x2, number y2[, number color])
2299 \begin_layout Standard
2304 \begin_layout Itemize
2305 x1: X-coordinate of one end.
2308 \begin_layout Itemize
2309 y1: Y-coordinate of one end.
2312 \begin_layout Itemize
2313 x2: X-coordinate of the other end.
2316 \begin_layout Itemize
2317 y2: Y-coordinate of the other end.
2320 \begin_layout Itemize
2321 color: Color of the line (default is 0xFFFFFF (white)).
2324 \begin_layout Subsubsection
2325 gui.circle(number x, number y, number r[, number thick[, number border[,
2329 \begin_layout Standard
2334 \begin_layout Itemize
2335 x: X-coordinate of the center
2338 \begin_layout Itemize
2339 y: Y-coordinate of the center
2342 \begin_layout Itemize
2343 r: The radius of the circle
2346 \begin_layout Itemize
2347 thick: Border thickness
2350 \begin_layout Itemize
2351 border: Border color (default is 0xFFFFFF (white))
2354 \begin_layout Itemize
2355 fill: Fill color (default is -1 (transparent)).
2358 \begin_layout Subsubsection
2362 \begin_layout Standard
2363 Request on_repaint() to happen as soon as possible.
2364 Can be used anywhere.
2367 \begin_layout Subsubsection
2368 gui.subframe_update(boolean on)
2371 \begin_layout Standard
2372 Request subframe updates (calling on_paint() on subframes) to happen (on=true)
2373 or not happen (on=false).
2374 Can be used anywhere.
2377 \begin_layout Subsubsection
2378 gui.screenshot(string filename)
2381 \begin_layout Standard
2382 Write PNG screenshot of the current frame (no drawings) to specified file.
2383 Can be used anywhere.
2386 \begin_layout Subsubsection
2387 gui.color(number r, number g, number b[, number a])
2390 \begin_layout Standard
2391 Returns color (in notation Lua scripts use) corresponding to color (r,g,b),
2392 each component in scale 0-255.
2393 If a is specified, that is alpha (0 is fully transparent, 256(sic) is fully
2395 The default alpha is 256.
2398 \begin_layout Subsubsection
2399 gui.status(string name, string value)
2402 \begin_layout Standard
2404 \begin_inset Quotes eld
2408 \begin_inset Quotes erd
2411 to <value> in status area.
2412 Can be used anywhere.
2415 \begin_layout Subsection
2419 \begin_layout Standard
2421 Only available in on_input callback.
2424 \begin_layout Subsubsection
2425 input.get(number controller, number index)
2428 \begin_layout Standard
2429 Read the specified index (0-11) from specified controller (0-7).
2433 \begin_layout Itemize
2434 Uses physical controller numbering.
2435 Gamepad in port 2 is controller 4, not 1!
2438 \begin_layout Subsubsection
2439 input.set(number controller, number index, number value)
2442 \begin_layout Standard
2443 Write the specified index (0-11) from specified controller (0-7), storing
2448 \begin_layout Itemize
2449 Uses physical controller numbering.
2450 Gamepad in port 2 is controller 4, not 1!
2453 \begin_layout Subsubsection
2454 input.reset([number cycles])
2457 \begin_layout Standard
2459 If cycles is greater than zero, do delayed reset.
2460 0 (or no value) causes immediate reset.
2463 \begin_layout Itemize
2464 Only available with subframe flag false.
2467 \begin_layout Subsubsection
2471 \begin_layout Standard
2472 Returns table of tables of all available keys and axes.
2473 The first table is indexed by key name (platform-dependent!), and the inner
2474 table has the following fields:
2477 \begin_layout Itemize
2478 last_rawval: Last reported raw value for control.
2481 \begin_layout Itemize
2482 ktype: Type of key (disabled, key, mouse, axis, axis-inverse, hat, pressure-m0,
2483 pressure-mp, pressure-0m, pressure-0p, pressure-pm, pressure-p0).
2486 \begin_layout Itemize
2487 cal_left: Minimum calibration value.
2488 Only meaningful with axis and pressure types.
2491 \begin_layout Itemize
2492 cal_center: Center calibration value.
2493 Only meaningful with axis and pressure types.
2496 \begin_layout Itemize
2497 cal_right: Maximum calibration value.
2498 Only meaningful with axis and pressure types.
2501 \begin_layout Itemize
2502 cal_tolerance: Dead zone tolerance.
2503 Only meaningful with axis and pressure types.
2506 \begin_layout Subsubsection
2507 input.keyhook(key, state)
2510 \begin_layout Standard
2511 Requests that keyhook events to be sent for key (state=true) or not sent
2515 \begin_layout Subsection
2519 \begin_layout Standard
2520 Host memory handling (extra memory saved to savestates).
2521 Host memory starts empty.
2524 \begin_layout Subsubsection
2525 hostmemory.read(number address)
2528 \begin_layout Standard
2529 Reads hostmemory slot address.
2530 Slot numbers out of range return false instead of numeric.
2533 \begin_layout Subsubsection
2534 hostmemory.write(number address, number value)
2537 \begin_layout Standard
2538 Writes hostmemory slot with 0-255.
2539 Slot numbers out of range cause extension of host memory slot space.
2542 \begin_layout Subsubsection
2543 hostmemory.readbyte(number address)
2546 \begin_layout Standard
2547 Read unsigned byte (1 element) from given address.
2548 Slots out of range return false.
2551 \begin_layout Subsubsection
2552 hostmemory.writebyte(number address, number value)
2555 \begin_layout Standard
2556 Write unsigned byte (1 element) to given slot.
2557 Slot numbers out of range cause extension.
2560 \begin_layout Subsubsection
2561 hostmemory.readsbyte(number address)
2564 \begin_layout Standard
2565 Read signed byte (1 element) from given address.
2566 Slots out of range return false.
2569 \begin_layout Subsubsection
2570 hostmemory.writesbyte(number address, number value)
2573 \begin_layout Standard
2574 Write signed byte (1 element) to given slot.
2575 Slot numbers out of range cause extension.
2578 \begin_layout Subsubsection
2579 hostmemory.readword(number address)
2582 \begin_layout Standard
2583 Read unsigned word (2 elements) from given address.
2584 Slots out of range return false.
2587 \begin_layout Subsubsection
2588 hostmemory.writeword(number address, number value)
2591 \begin_layout Standard
2592 Write unsigned word (2 elements) to given slot.
2593 Slot numbers out of range cause extension.
2596 \begin_layout Subsubsection
2597 hostmemory.readsword(number address)
2600 \begin_layout Standard
2601 Read signed word (2 elements) from given address.
2602 Slots out of range return false.
2605 \begin_layout Subsubsection
2606 hostmemory.writesword(number address, number value)
2609 \begin_layout Standard
2610 Write signed word (2 elements) to given slot.
2611 Slot numbers out of range cause extension.
2614 \begin_layout Subsubsection
2615 hostmemory.readdword(number address)
2618 \begin_layout Standard
2619 Read unsigned doubleword (4 elements) from given address.
2620 Slots out of range return false.
2623 \begin_layout Subsubsection
2624 hostmemory.writedword(number address, number value)
2627 \begin_layout Standard
2628 Write unsigned doubleword (4 elements) to given slot.
2629 Slot numbers out of range cause extension.
2632 \begin_layout Subsubsection
2633 hostmemory.readsdword(number address)
2636 \begin_layout Standard
2637 Read signed doubleword (4 elements) from given address.
2638 Slots out of range return false.
2641 \begin_layout Subsubsection
2642 hostmemory.writesdword(number address, number value)
2645 \begin_layout Standard
2646 Write signed doubleword (4 elements) to given slot.
2647 Slot numbers out of range cause extension.
2650 \begin_layout Subsubsection
2651 hostmemory.readqword(number address)
2654 \begin_layout Standard
2655 Read unsigned quadword (8 elements) from given address.
2656 Slots out of range return false.
2659 \begin_layout Subsubsection
2660 hostmemory.writeqword(number address, number value)
2663 \begin_layout Standard
2664 Write unsigned quadword (4 elements) to given slot.
2665 Slot numbers out of range cause extension.
2668 \begin_layout Subsubsection
2669 hostmemory.readsqword(number address)
2672 \begin_layout Standard
2673 Read signed quadword (8 elements) from given address.
2674 Slots out of range return false.
2677 \begin_layout Subsubsection
2678 hostmemory.writesqword(number address, number value)
2681 \begin_layout Standard
2682 Write signed quadword (8 elements) to given slot.
2683 Slot numbers out of range cause extension.
2686 \begin_layout Subsection
2690 \begin_layout Standard
2694 \begin_layout Subsubsection
2695 movie.currentframe()
2698 \begin_layout Standard
2699 Return number of current frame.
2702 \begin_layout Subsubsection
2706 \begin_layout Standard
2707 Return number of frames in movie.
2710 \begin_layout Subsubsection
2714 \begin_layout Standard
2715 Return true if in readonly mode, false if in readwrite.
2718 \begin_layout Subsubsection
2719 movie.set_readwrite()
2722 \begin_layout Standard
2723 Set readwrite mode (does not cause on_readwrite callback).
2726 \begin_layout Subsubsection
2727 movie.frame_subframes(number frame)
2730 \begin_layout Standard
2731 Count number of subframes in specified frame (frame numbers are 1-based)
2735 \begin_layout Subsubsection
2736 movie.read_subframe(number frame, number subframe)
2739 \begin_layout Standard
2740 Read specifed subframe in specified frame and return data as array (100
2741 elements, numbered 0-99 currently).
2744 \begin_layout Subsection
2748 \begin_layout Standard
2749 Routines for settings manipulation
2752 \begin_layout Subsubsection
2753 settings.get(string name)
2756 \begin_layout Standard
2757 Get value of setting.
2758 If setting is blank, returns false.
2759 If setting value can't be obtained, returns (nil, error message).
2762 \begin_layout Subsubsection
2763 settings.set(string name, string value)
2766 \begin_layout Standard
2767 Set value of setting.
2768 If setting can't be set, returns (nil, error message).
2771 \begin_layout Subsubsection
2772 settings.is_set(string name)
2775 \begin_layout Standard
2776 Returns if setting is set.
2777 If setting does not exist, returns (nil, error message).
2780 \begin_layout Subsubsection
2781 settings.blank(string name)
2784 \begin_layout Standard
2785 Blanks a setting and returns true.
2786 If setting can't be blanked, returns (nil, error message).
2789 \begin_layout Subsection
2793 \begin_layout Standard
2794 Contains various functions for managing memory
2797 \begin_layout Subsubsection
2801 \begin_layout Standard
2802 Returns the number of VMAs
2805 \begin_layout Subsubsection
2806 memory.read_vma(number index)
2809 \begin_layout Standard
2810 Reads the specified VMA (indices start from zero).
2811 Trying to read invalid VMA gives nil.
2812 The read VMA is table with the following fields:
2815 \begin_layout Itemize
2816 region_name (string): The readable name of the VMA
2819 \begin_layout Itemize
2820 baseaddr (number): Base address of the VMA
2823 \begin_layout Itemize
2824 lastaddr (number): Last address in the VMA.
2827 \begin_layout Itemize
2828 size (number): The size of VMA in bytes.
2831 \begin_layout Itemize
2832 readonly (boolean): True of the VMA corresponds to ROM.
2835 \begin_layout Itemize
2836 native_endian (boolean): True if the VMA has native endian as opposed to
2840 \begin_layout Subsubsection
2841 memory.find_vma(number address)
2844 \begin_layout Standard
2845 Finds the VMA containing specified address.
2846 Returns table in the same format as read_vma or nil if not found.
2849 \begin_layout Subsubsection
2850 memory.readbyte(number address)
2853 \begin_layout Standard
2854 Reads the specified address as unsigned byte and returns the result.
2857 \begin_layout Subsubsection
2858 memory.readsbyte(number address)
2861 \begin_layout Standard
2862 Reads the specified address as signed byte and returns the result.
2865 \begin_layout Subsubsection
2866 memory.writebyte(number address, number value)
2869 \begin_layout Standard
2870 Writes the specified value (negative values undergo 2's complement) to specified
2871 address (as a byte).
2874 \begin_layout Subsubsection
2875 memory.readword(number address)
2878 \begin_layout Standard
2879 Reads the specified address as unsigned word and returns the result.
2882 \begin_layout Subsubsection
2883 memory.readsword(number address)
2886 \begin_layout Standard
2887 Reads the specified address as signed word and returns the result.
2890 \begin_layout Subsubsection
2891 memory.writeword(number address, number value)
2894 \begin_layout Standard
2895 Writes the specified value (negative values undergo 2's complement) to specified
2896 address (as a word).
2899 \begin_layout Subsubsection
2900 memory.readdword(number address)
2903 \begin_layout Standard
2904 Reads the specified address as unsigned doubleword and returns the result.
2907 \begin_layout Subsubsection
2908 memory.readsdword(number address)
2911 \begin_layout Standard
2912 Reads the specified address as signed doubleword and returns the result.
2915 \begin_layout Subsubsection
2916 memory.writedword(number address, number value)
2919 \begin_layout Standard
2920 Writes the specified value (negative values undergo 2's complement) to specified
2921 address (as a doubleword).
2924 \begin_layout Subsubsection
2925 memory.readqword(number address)
2928 \begin_layout Standard
2929 Reads the specified address as unsigned quadword and returns the result.
2932 \begin_layout Subsubsection
2933 memory.readsqword(number address)
2936 \begin_layout Standard
2937 Reads the specified address as signed quadword and returns the result.
2940 \begin_layout Subsubsection
2941 memory.writeqword(number address, number value)
2944 \begin_layout Standard
2945 Writes the specified value (negative values undergo 2's complement) to specified
2946 address (as a quadword).
2949 \begin_layout Subsection
2953 \begin_layout Standard
2954 Contains copy of global variables from time of Lua initialization.
2958 \begin_layout Subsection
2962 \begin_layout Standard
2963 Various callbacks to Lua that can occur.
2966 \begin_layout Subsubsection
2967 Callback: on_paint()
2970 \begin_layout Standard
2971 Called when screen is being painted.
2972 Any gui.* calls requiring graphic context draw on the screen.
2975 \begin_layout Subsubsection
2976 Callback: on_video()
2979 \begin_layout Standard
2980 Called when video dump frame is being painted.
2981 Any gui.* calls requiring graphic context draw on the video.
2984 \begin_layout Subsubsection
2985 Callback: on_frame()
2988 \begin_layout Standard
2989 Called on each starting whole frame.
2992 \begin_layout Subsubsection
2993 Callback: on_startup()
2996 \begin_layout Standard
2997 Called when the emulator is starting (lsnes.rc and --run files has been run).
3000 \begin_layout Subsubsection
3001 Callback: on_pre_load(string name)
3004 \begin_layout Standard
3005 Called just before savestate/movie load occurs (note: loads are always delayed,
3006 so this occurs even when load was initiated by lua).
3009 \begin_layout Subsubsection
3010 Callback: on_err_load(string name)
3013 \begin_layout Standard
3014 Called if loadstate goes wrong.
3017 \begin_layout Subsubsection
3018 Callback: on_post_load(string name, boolean was_savestate)
3021 \begin_layout Standard
3022 Called on successful loadstate.
3023 was_savestate gives if this was a savestate or a movie.
3026 \begin_layout Subsubsection
3027 Callback: on_pre_save(string name, boolean is_savestate)
3030 \begin_layout Standard
3031 Called just before savestate save occurs (note: movie saves are synchronous
3032 and won't trigger these callbacks if called from Lua).
3035 \begin_layout Subsubsection
3036 Callback: on_err_save(string name)
3039 \begin_layout Standard
3040 Called if savestate goes wrong.
3043 \begin_layout Subsubsection
3044 Callback: on_post_save(string name, boolean is_savestate)
3047 \begin_layout Standard
3048 Called on successful savaestate.
3049 is_savestate gives if this was a savestate or a movie.
3052 \begin_layout Subsubsection
3056 \begin_layout Standard
3057 Called when emulator is shutting down.
3060 \begin_layout Subsubsection
3061 Callback: on_input(boolean subframe)
3064 \begin_layout Standard
3065 Called when emulator is just sending input to bsnes core.
3066 Warning: This is called even in readonly mode, but the results are ignored.
3069 \begin_layout Subsubsection
3070 Callback: on_reset()
3073 \begin_layout Standard
3074 Called when SNES is reset.
3077 \begin_layout Subsubsection
3078 Callback: on_readwrite()
3081 \begin_layout Standard
3082 Called when moving into readwrite mode as result of
3083 \begin_inset Quotes eld
3087 \begin_inset Quotes erd
3090 command (note: moving to rwmode by Lua won't trigger this, as per recursive
3094 \begin_layout Subsubsection
3095 Callback: on_snoop(number port, number controller, number index, number
3099 \begin_layout Standard
3100 Called each time bsnes asks for input.
3101 The value is the final value to be sent to bsnes core (readonly mode, autohold
3102 and autofire have been taken into account).
3103 Might be useful when translating movies to format suitable for console
3105 Note: There is no way to modify the value to be sent.
3108 \begin_layout Subsubsection
3109 Callback: on_keyhook(string keyname, table state)
3112 \begin_layout Standard
3113 Sent when key that has keyhook events requested changes state.
3114 Keyname is name of the key (group) and state is the state (same kind as
3115 table values in input.raw).
3118 \begin_layout Section
3119 Memory watch expression syntax
3122 \begin_layout Standard
3123 Memory watch expressions are in RPN (Reverse Polish Notation).
3124 At the end of expression, the top entry on stack is taken as the final
3128 \begin_layout Standard
3132 \begin_layout Itemize
3133 Evaluation order is strictly left to right.
3136 \begin_layout Itemize
3137 a is the entry on top of stack
3140 \begin_layout Itemize
3141 b is the entry immediately below top of stack
3144 \begin_layout Itemize
3145 ; separates values to be pushed (no intermediate pop).
3148 \begin_layout Itemize
3149 After end of element, all used stack slots are popped and all results are
3153 \begin_layout Itemize
3154 When pushing multiple values, the pushes occur in order shown.
3157 \begin_layout Standard
3158 The following operators are available:
3161 \begin_layout Itemize
3165 \begin_layout Itemize
3169 \begin_layout Itemize
3173 \begin_layout Itemize
3177 \begin_layout Itemize
3181 \begin_layout Itemize
3185 \begin_layout Itemize
3186 b : read_signed_byte(a)
3189 \begin_layout Itemize
3193 \begin_layout Itemize
3194 d : read_signed_dword(a)
3197 \begin_layout Itemize
3201 \begin_layout Itemize
3203 \begin_inset Formula $\pi$
3209 \begin_layout Itemize
3210 q : read_signed_qword(a)
3213 \begin_layout Itemize
3217 \begin_layout Itemize
3221 \begin_layout Itemize
3225 \begin_layout Itemize
3229 \begin_layout Itemize
3230 w : read_signed_word(a)
3233 \begin_layout Itemize
3237 \begin_layout Itemize
3238 B : read_unsigned_byte(a)
3241 \begin_layout Itemize
3242 C<number>z : Push number <number> to stack.
3245 \begin_layout Itemize
3246 D : read_unsigned_dword(a)
3249 \begin_layout Itemize
3250 C0x<number>z : Push number <number> (hexadecimal) to stack.
3253 \begin_layout Itemize
3254 Q : read_unsigned_qword(a)
3257 \begin_layout Itemize
3258 R<digit> : round a to <digit> digits.
3261 \begin_layout Itemize
3262 W : read_unsigned_word(a)
3265 \begin_layout Subsection
3269 \begin_layout Standard
3270 C0x007e0878zWC0x007e002czW-
3273 \begin_layout Enumerate
3274 Push value 0x7e0878 on top of stack (C0x007e0878z).
3277 \begin_layout Enumerate
3278 Pop the value on top of stack (0x7e0878), read word value at that address
3279 and push the result,call it x1 (W).
3282 \begin_layout Enumerate
3283 Push value 0x7e002c on top of stack (C0x007e002cz).
3286 \begin_layout Enumerate
3287 Pop the value on top of stack (0x7e002c), read word value at that address
3288 and push the result,call it x2 (W).
3291 \begin_layout Enumerate
3292 Pop the two top numbers on stack, x1 and x2, substract x1 from x2 and push
3296 \begin_layout Enumerate
3297 Since the expression ends, the final memory watch result is the top one
3298 on stack, which is x2 - x1.
3301 \begin_layout Section
3302 Modifier and key names:
3305 \begin_layout Subsection
3309 \begin_layout Subsubsection
3313 \begin_layout Standard
3314 Following modifier names are known:
3317 \begin_layout Itemize
3318 ctrl, lctrl, rctrl: Control keys
3321 \begin_layout Itemize
3322 alt, lalt, ralt: ALT keys.
3325 \begin_layout Itemize
3326 shift, lshift, rshift: Shift keys.
3329 \begin_layout Itemize
3330 meta, lmeta, rmeta: Meta keys.
3333 \begin_layout Itemize
3334 num, caps: Numlock/Capslock (these are sticky!)
3337 \begin_layout Itemize
3341 \begin_layout Subsubsection
3345 \begin_layout Standard
3346 Following key names are known:
3349 \begin_layout Itemize
3350 backspace, tab, clear, return, pause, escape, space, exclaim, quotedbl,
3351 hash, dollar, ampersand, quote, leftparen, rightparen, asterisk, plus,
3352 comma, minus, period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon,
3353 less, equals, greater, question, at, leftbracket, backslash, rightbracket,
3354 caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n,
3355 o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0, world_1, world_2,
3356 world_3, world_4, world_5, world_6, world_7, world_8, world_9, world_10,
3357 world_11, world_12, world_13, world_14, world_15, world_16, world_17, world_18,
3358 world_19, world_20, world_21, world_22, world_23, world_24, world_25, world_26,
3359 world_27, world_28, world_29, world_30, world_31, world_32, world_33, world_34,
3360 world_35, world_36, world_37, world_38, world_39, world_40, world_41, world_42,
3361 world_43, world_44, world_45, world_46, world_47, world_48, world_49, world_50,
3362 world_51, world_52, world_53, world_54, world_55, world_56, world_57, world_58,
3363 world_59, world_60, world_61, world_62, world_63, world_64, world_65, world_66,
3364 world_67, world_68, world_69, world_70, world_71, world_72, world_73, world_74,
3365 world_75, world_76, world_77, world_78, world_79, world_80, world_81, world_82,
3366 world_83, world_84, world_85, world_86, world_87, world_88, world_89, world_90,
3367 world_91, world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3, kp4,
3368 kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide, kp_multiply, kp_minus, kp_plus,
3369 kp_enter, kp_equals, up, down, right, left, insert, home, end, pageup,
3370 pagedown, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14,
3371 f15, numlock, capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt,
3372 lalt, rmeta, lmeta, lsuper, rsuper, mode, compose, help, print, sysreq,
3373 break, menu, power, euro, undo
3376 \begin_layout Itemize
3377 Names of form 'key<n>' where <n> is 0-255 are interpretted as key having
3378 hardware-dependent scan code of <n> (useful to bind those keys that don't
3379 have symbolic names).
3382 \begin_layout Subsubsection
3383 Joystick pseudo-keys:
3386 \begin_layout Itemize
3387 joystick<num>button<button>: Joystick <num> (0-based) button <button> (0-based).
3390 \begin_layout Itemize
3391 joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat> (0-based) up.
3394 \begin_layout Itemize
3395 joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat> (0-based) left.
3398 \begin_layout Itemize
3399 joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat> (0-based) down.
3402 \begin_layout Itemize
3403 joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat> (0-based) right.
3406 \begin_layout Itemize
3407 joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis> negative
3408 position (axis modes axis and axis_inverse).
3411 \begin_layout Itemize
3412 joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis> positive
3413 position (axis modes axis and axis_inverse).
3416 \begin_layout Itemize
3417 joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis> pressure (axis
3421 \begin_layout Subsubsection
3425 \begin_layout Itemize
3426 Escape: Enter/Exit Command mode, cancel modal dialogs.
3429 \begin_layout Itemize
3430 Return (also KPEnter): Execute command, ok modal dialog.
3433 \begin_layout Itemize
3434 Pgup/Up (also KP8/9 if no num lock; command mode): Previous command in command
3438 \begin_layout Itemize
3439 Pgdn/Down(also KP2/3 if no num lock; command mode): Next command in command
3443 \begin_layout Itemize
3444 Home (also KP7 if no num lock; command mode): Beginning of command.
3447 \begin_layout Itemize
3448 End (also KP1 if no num lock; command mode): End of command.
3451 \begin_layout Itemize
3452 Left (also KP4 if no num lock; command mode): Move cursor left.
3455 \begin_layout Itemize
3456 Right (also KP6 if no num lock; command mode): Move cursor right.
3459 \begin_layout Itemize
3461 if no num lock; command mode): Delete character to right of cursor.
3464 \begin_layout Itemize
3465 Insert (also KP0 if no num lock; command mode): Toggle between insert /
3469 \begin_layout Itemize
3470 Backspace (command mode): Delete character to left of cursor.
3473 \begin_layout Itemize
3474 LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump corrupted!).
3477 \begin_layout Subsection
3481 \begin_layout Subsubsection
3485 \begin_layout Standard
3486 Following modifier names are known:
3489 \begin_layout Itemize
3493 \begin_layout Itemize
3497 \begin_layout Itemize
3501 \begin_layout Itemize
3505 \begin_layout Itemize
3509 \begin_layout Subsubsection
3513 \begin_layout Standard
3514 Following key names are known:
3517 \begin_layout Itemize
3518 back, tab, return, escape, space, exclaim, quotedbl, hash, dollar, percent,
3519 ampersand, quote, leftparen, rightparen, asterisk, plus, comma, minus,
3520 period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
3521 greater, question, at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3522 q, r, s, t, u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
3523 underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3524 q, r, s, t, u, v, w, x, y, z, leftcurly, pipe, rightcurly, tilde, delete,
3525 start, lbutton, rbutton, cancel, mbutton, clear, shift, alt, control, menu,
3526 pause, capital, end, home, lefT, up, right, down, select, print, execute,
3527 snapshot, insert, help, numpad0, numpad1, numpad2, numpad3, numpad4, numpad5,
3528 numpad6, numpad7, numpad8, numpad9, multiply, add, separator, subtract,
3529 decimal, divide, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13,
3530 f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, numlock, scroll,
3531 pageup, pagedown, numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
3532 numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up, numpad_right,
3533 numpad_down, numpad_pageup, numpad_pagedown, numpad_end, numpad_begin,
3534 numpad_insert, numpad_delete, numpad_equal, numpad_multiply, numpad_add,
3535 numpad_separator, numpad_subtract, numpad_decimal, numpad_divide, windows_left,
3536 windows_right, windows_menu, command, special1, special2, special3, special4,
3537 special5, special6, special7, special8, special9, special10, special11,
3538 special12, special13, special14, special15, special16, special17, special18,
3539 special19, special20
3542 \begin_layout Section
3546 \begin_layout Standard
3547 Movie file is .zip archive in itself, normal ZIP archive tools work on it
3548 (note: If you recompress it, do not use compression methods other than
3549 store and deflate and especially do not use encryption of any kind).
3552 \begin_layout Subsection
3553 Detecting clean start/SRAM/Savestate
3556 \begin_layout Itemize
3558 \begin_inset Quotes eld
3562 \begin_inset Quotes erd
3565 it is savestate, otherwise:
3568 \begin_layout Itemize
3569 If file has members with names starting
3570 \begin_inset Quotes eld
3574 \begin_inset Quotes erd
3577 it is movie starting from SRAM, otherwise:
3580 \begin_layout Itemize
3581 It is movie starting from clear state.
3584 \begin_layout Subsection
3588 \begin_layout Standard
3589 Type of game ROM and region (as one line).
3593 \begin_layout Standard
3594 \begin_inset Tabular
3595 <lyxtabular version="3" rows="8" columns="3">
3596 <features tabularvalignment="middle">
3597 <column alignment="center" valignment="top" width="0">
3598 <column alignment="center" valignment="top" width="0">
3599 <column alignment="center" valignment="top" width="0">
3601 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3604 \begin_layout Plain Layout
3610 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3613 \begin_layout Plain Layout
3619 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3622 \begin_layout Plain Layout
3630 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3633 \begin_layout Plain Layout
3639 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3642 \begin_layout Plain Layout
3648 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3651 \begin_layout Plain Layout
3659 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3662 \begin_layout Plain Layout
3668 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3671 \begin_layout Plain Layout
3677 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3680 \begin_layout Plain Layout
3688 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3691 \begin_layout Plain Layout
3697 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3700 \begin_layout Plain Layout
3706 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3709 \begin_layout Plain Layout
3717 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3720 \begin_layout Plain Layout
3726 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3729 \begin_layout Plain Layout
3735 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3738 \begin_layout Plain Layout
3746 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3749 \begin_layout Plain Layout
3755 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3758 \begin_layout Plain Layout
3764 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3767 \begin_layout Plain Layout
3775 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3778 \begin_layout Plain Layout
3784 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3787 \begin_layout Plain Layout
3793 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3796 \begin_layout Plain Layout
3804 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3807 \begin_layout Plain Layout
3813 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3816 \begin_layout Plain Layout
3822 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3825 \begin_layout Plain Layout
3839 \begin_layout Standard
3843 \begin_layout Standard
3844 \begin_inset Tabular
3845 <lyxtabular version="3" rows="3" columns="2">
3846 <features tabularvalignment="middle">
3847 <column alignment="center" valignment="top" width="0">
3848 <column alignment="center" valignment="top" width="0">
3850 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3853 \begin_layout Plain Layout
3859 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3862 \begin_layout Plain Layout
3870 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3873 \begin_layout Plain Layout
3879 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3882 \begin_layout Plain Layout
3890 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3893 \begin_layout Plain Layout
3899 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3902 \begin_layout Plain Layout
3916 \begin_layout Subsection
3920 \begin_layout Standard
3921 Contains type of port #1 (as one line).
3922 Valid values are 'none', 'gamepad', 'multitap' and 'mouse'.
3923 If not present, defaults to 'gamepad'.
3926 \begin_layout Subsection
3930 \begin_layout Standard
3931 Contains type of port #2 (as one line).
3932 Valid values are 'none', 'gamepad', 'multitap', 'mouse', 'superscope',
3933 'justifier' and 'justifiers'.
3934 If not present, defaults to 'none'.
3937 \begin_layout Subsection
3941 \begin_layout Standard
3942 Contains name of the game (as one line).
3945 \begin_layout Subsection
3949 \begin_layout Standard
3950 Contains authors, one per line.
3951 Part before '|' is the full name, part after is the nickname.
3954 \begin_layout Subsection
3958 \begin_layout Standard
3960 \begin_inset Quotes eld
3964 \begin_inset Quotes erd
3968 Used to reject other saves.
3971 \begin_layout Subsection
3972 Member: controlsversion
3975 \begin_layout Standard
3977 \begin_inset Quotes eld
3981 \begin_inset Quotes erd
3985 Used to identify what controls are there.
3988 \begin_layout Subsection
3990 \begin_inset Quotes eld
3994 \begin_inset Quotes erd
4000 \begin_layout Standard
4001 Contains bsnes core version number (as one line).
4004 \begin_layout Subsection
4008 \begin_layout Standard
4009 Contains project ID (as one line).
4010 Used to identify if two movies are part of the same project.
4013 \begin_layout Subsection
4014 Member: {rom,slota,slotb}{,xml}.sha256
4017 \begin_layout Standard
4018 Contains SHA-256 of said ROM or ROM mapping file (as one line).
4019 Absent if corresponding file is absent.
4022 \begin_layout Subsection
4023 Member: moviesram.<name>
4026 \begin_layout Standard
4027 Raw binary startup SRAM of kind <name>.
4028 Only present in savestates and movies starting from SRAM.
4031 \begin_layout Subsection
4035 \begin_layout Standard
4036 Contains frame number (as one line) of frame movie was saved on.
4037 Only present in savestates.
4040 \begin_layout Subsection
4044 \begin_layout Standard
4045 Current value of lag counter (as one line).
4046 Only present in savestates.
4049 \begin_layout Subsection
4050 Member: pollcounters
4053 \begin_layout Standard
4054 Contains poll counters (currently 100 of them), one per line.
4055 Each line is raw poll count if DRDY is set for it.
4056 Otherwise it is negative poll count minus one.
4057 Only present in savestates.
4060 \begin_layout Subsection
4064 \begin_layout Standard
4065 Raw binary dump of host memory.
4066 Only present in savestates.
4069 \begin_layout Subsection
4073 \begin_layout Standard
4074 The raw binary savestate itself.
4075 Savestate detection uses this file, only present in savestates.
4078 \begin_layout Subsection
4082 \begin_layout Standard
4083 Screenshot of current frame.
4084 Only present in savestates.
4085 First 2 bytes are big-endian width of image, rest are 24-bit RGB image
4087 Height of image is inferred from the width and size of data.
4090 \begin_layout Subsection
4094 \begin_layout Standard
4095 Raw binary SRAM of kind <name> at time of savestate.
4096 Only present in savestates.
4099 \begin_layout Subsection
4103 \begin_layout Standard
4104 The actual input track, one line per subframe (blank lines are skipped).
4107 \begin_layout Itemize
4108 If the first byte of each line is '.', ' ', <tab> or '|', then the line is
4109 part of same frame as previous, otherwise it starts a new frame.
4112 \begin_layout Itemize
4113 First subframe must start a new frame.
4116 \begin_layout Standard
4117 Length of movie in frames is number of lines in input file that start a
4121 \begin_layout Subsection
4125 \begin_layout Standard
4126 Contains textual base-10 rerecord count (as one line; emulator just writes
4127 this, it doesn't read it) + 1.
4130 \begin_layout Subsection
4134 \begin_layout Standard
4135 This member stores set of load IDs.
4136 There is one load ID per rerecord (plus one corresponding to start of project).
4139 \begin_layout Itemize
4140 This member constists of concatenation of records
4143 \begin_layout Itemize
4144 Each record is 2-36 bytes long and can represent 1-16,843,009 consequtive
4148 \begin_layout Itemize
4149 IDs are interpretted as 256-bit big-endian integers with warparound.
4152 \begin_layout Itemize
4153 Initial predicted ID is all zeroes.
4156 \begin_layout Standard
4157 Format of each record is:
4160 \begin_layout Itemize
4161 1 byte: Opcode byte.
4162 Bits 0-4 are prefix length (prefixlen), bits 5-6 are count length (countlen).
4166 \begin_layout Itemize
4167 32-prefixlen bytes of ID.
4170 \begin_layout Itemize
4171 countlen bytes of big-endian count (count).
4174 \begin_layout Standard
4175 Records are processed as follows:
4178 \begin_layout Itemize
4179 To form the first ID encoded by record, take the first prefixlen bytes predicted
4180 ID and append the read ID value to it.
4181 The result is the first ID encoded.
4184 \begin_layout Itemize
4185 If countlen is 0, record encodes 1 ID.
4188 \begin_layout Itemize
4189 If countlen is 1, record encodes 2+count IDs.
4192 \begin_layout Itemize
4193 If countlen is 2, record encodes 258+count IDs.
4196 \begin_layout Itemize
4197 If countlen is 3, record encodes 65794+count IDs.
4200 \begin_layout Itemize
4201 The new predicted ID is the next ID after last one encoded by the record.
4204 \begin_layout Standard
4205 The number of rerecords + 1 is equal to the sum of number of IDs encoded
4209 \begin_layout Subsection
4210 Member: starttime.second
4213 \begin_layout Standard
4214 Movie starting time, second part.
4215 Epoch is Unix epoch.
4216 Default is 1,000,000,000.
4219 \begin_layout Subsection
4220 Member: starttime.subsecond
4223 \begin_layout Standard
4224 Movie starting time, subsecond part.
4229 \begin_layout Subsection
4230 Member: savetime.second
4233 \begin_layout Standard
4234 Movie saving time, second part.
4235 Default is starttime.second.
4236 Only present in savestates.
4239 \begin_layout Subsection
4240 Member: savetime.subsecond
4243 \begin_layout Standard
4244 Movie saving time, subsecond part.
4245 Default is starttime.subsecond.
4246 Only present in savestates.
4249 \begin_layout Section
4250 Quick'n'dirty encode guide
4253 \begin_layout Enumerate
4254 Start the emulator and load the movie file.
4257 \begin_layout Enumerate
4258 Set large AVI option 'set-setting avi-large on'
4261 \begin_layout Enumerate
4262 Enable dumping 'dump-avi tmpdump'
4265 \begin_layout Enumerate
4266 Unpause and let it run until you want to end dumping.
4269 \begin_layout Enumerate
4270 Close the emulator (closing the window is the easiest way).
4274 \begin_layout Enumerate
4275 For each tmpdump*.avi file created, on command prompt, do 'x264 --crf 10
4276 -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
4279 \begin_layout Enumerate
4280 Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
4283 \begin_layout Enumerate
4284 Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv + tmpdump_0000001.mkv
4285 + tmpdump_0000002.mkv' (list every tmpdump_<numbers>.mkv, with + in between).
4288 \begin_layout Enumerate
4289 Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'.
4290 Now final.mkv contains quick'n'dirty encode.
4293 \begin_layout Section
4294 Axis configurations for some gamepad types:
4297 \begin_layout Subsection
4301 \begin_layout Standard
4302 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be set to pressure-+.
4305 \begin_layout LyX-Code
4306 set-axis joystick0axis2 pressure-+
4309 \begin_layout LyX-Code
4310 set-axis joystick0axis5 pressure-+
4313 \begin_layout Itemize
4314 This is needed for SDL only.
4315 EVDEV sets those types correctly.
4318 \begin_layout Subsection
4320 \begin_inset Quotes eld
4324 \begin_inset Quotes erd
4330 \begin_layout Standard
4331 Axes 8-19 should be disabled.
4334 \begin_layout LyX-Code
4335 set-axis joystick0axis8 disabled
4338 \begin_layout LyX-Code
4339 set-axis joystick0axis9 disabled
4342 \begin_layout LyX-Code
4343 set-axis joystick0axis10 disabled
4346 \begin_layout LyX-Code
4347 set-axis joystick0axis11 disabled
4350 \begin_layout LyX-Code
4351 set-axis joystick0axis12 disabled
4354 \begin_layout LyX-Code
4355 set-axis joystick0axis13 disabled
4358 \begin_layout LyX-Code
4359 set-axis joystick0axis14 disabled
4362 \begin_layout LyX-Code
4363 set-axis joystick0axis15 disabled
4366 \begin_layout LyX-Code
4367 set-axis joystick0axis16 disabled
4370 \begin_layout LyX-Code
4371 set-axis joystick0axis17 disabled
4374 \begin_layout LyX-Code
4375 set-axis joystick0axis18 disabled
4378 \begin_layout LyX-Code
4379 set-axis joystick0axis19 disabled
4382 \begin_layout Section
4386 \begin_layout Subsection
4387 Problems from BSNES core:
4390 \begin_layout Itemize
4391 The whole pending save stuff.
4394 \begin_layout Itemize
4395 Lack of layer hiding.
4398 \begin_layout Itemize
4399 It is slow (especially accuracy).
4402 \begin_layout Itemize
4403 Firmwares can't be loaded from ZIP archives.
4406 \begin_layout Subsection
4410 \begin_layout Itemize
4411 Modifiers don't work with pseudo-keys (SDL, EVDEV).
4414 \begin_layout Itemize
4415 Audio for last dumped frame is not itself dumped.
4418 \begin_layout Itemize
4419 Audio in UI is pretty bad in quality if game doesn't run at full speed.
4422 \begin_layout Itemize
4423 AVI compression levels 10-18 are not compatible with AVISynth AVISource.
4426 \begin_layout Itemize
4427 No menus, command based interface (SDL).
4430 \begin_layout Itemize
4431 Long commands don't scroll.
4434 \begin_layout Itemize
4435 Wxwidgets UI is still buggy.
4438 \begin_layout Section
4442 \begin_layout Subsection
4446 \begin_layout Itemize
4450 \begin_layout Itemize
4451 Fix dumper video corruption with levels 10-18.
4454 \begin_layout Subsection
4458 \begin_layout Itemize
4462 \begin_layout Itemize
4463 Lots of code cleanups
4466 \begin_layout Itemize
4467 Lua interface to settings
4470 \begin_layout Itemize
4471 Allow specifying AVI borders without Lua
4474 \begin_layout Itemize
4475 Fix scaling if vscale > 1 and originx > 0 (left border exists)
4478 \begin_layout Itemize
4479 on_snoop lua callback
4482 \begin_layout Itemize
4483 Faster movie loading and saving.
4486 \begin_layout Subsection
4490 \begin_layout Itemize
4494 \begin_layout Subsection
4498 \begin_layout Itemize
4502 \begin_layout Itemize
4503 Save jukebox functionality.
4506 \begin_layout Subsection
4510 \begin_layout Itemize
4511 Try to fix some nasty failing movie load edge cases
4514 \begin_layout Itemize
4515 Allow specifying scripts to run on command line.
4518 \begin_layout Subsection
4522 \begin_layout Itemize
4523 Major source code reorganization.
4526 \begin_layout Itemize
4527 Backup savestates before overwriting.
4530 \begin_layout Itemize
4531 Don't crash if loading initial state fails.
4534 \begin_layout Subsection
4538 \begin_layout Itemize
4542 \begin_layout Itemize
4543 Fix author name parsing
4546 \begin_layout Itemize
4547 Fix rerecord counting
4550 \begin_layout Itemize
4551 (SDL) Print messages to console if SDL is uninitialized
4554 \begin_layout Itemize
4555 Add movieinfo program
4558 \begin_layout Itemize
4559 Fix loading movies starting from SRAM.
4562 \begin_layout Subsection
4566 \begin_layout Itemize
4567 Add support for unattended dumping
4570 \begin_layout Itemize
4571 Fix compiling for Win32
4574 \begin_layout Itemize
4575 Don't lock up if sound can't be initialized
4578 \begin_layout Itemize
4579 Strip trailing CR from commands
4582 \begin_layout Itemize
4583 Don't try to do dubious things in global ctors (fix crash on startup)
4586 \begin_layout Subsection
4590 \begin_layout Itemize
4591 Small documentation tweaking
4594 \begin_layout Itemize
4598 \begin_layout Itemize
4599 Fix major bug in modifier matching
4602 \begin_layout Subsection
4606 \begin_layout Itemize
4607 Lots of documentation fixes
4610 \begin_layout Itemize
4611 Use dedicated callbacks for event backcomm., not commands.
4614 \begin_layout Itemize
4615 Ensure that the watchdog is not hit when executing delayed reset.
4618 \begin_layout Itemize
4619 Remove errant tab from joystick message.
4622 \begin_layout Subsection
4626 \begin_layout Itemize
4627 Make autofire operate in absolute time, not linear time
4630 \begin_layout Itemize
4631 Reinitialize controls when resuming from loadstate
4634 \begin_layout Itemize
4635 Some more code cleanups
4638 \begin_layout Itemize
4639 If Lua allocator fails, call OOM_panic()
4642 \begin_layout Itemize
4643 Byte/word/dword/qword sized host memory write/read functions.
4646 \begin_layout Itemize
4647 Dump at correct framerate if dumping interlaced NTSC (height=448).
4650 \begin_layout Subsection
4654 \begin_layout Itemize
4655 Actually include the complete source code
4658 \begin_layout Itemize
4662 \begin_layout Subsection
4666 \begin_layout Itemize
4667 Document {save,start}time.{,sub}second.
4670 \begin_layout Itemize
4671 Intercept time() from bsnes core.
4674 \begin_layout Subsection
4678 \begin_layout Itemize
4679 Allow disabling time() interception (allow build on Mac OS X)
4682 \begin_layout Itemize
4683 Use SDLMain on Mac OS X (make SDL not crash)
4686 \begin_layout Itemize
4687 Disable delayed resets (just plain too buggy for now).
4690 \begin_layout Itemize
4694 \begin_layout Itemize
4695 Use 16-bit for graphics/video instead of 32-bit.
4698 \begin_layout Itemize
4699 gui.rectangle/gui.pixel
4702 \begin_layout Itemize
4706 \begin_layout Itemize
4707 New CSCD writer implementation.
4710 \begin_layout Subsection
4714 \begin_layout Itemize
4715 Fix interaction of * and +.
4718 \begin_layout Itemize
4722 \begin_layout Itemize
4723 Use gettimeofday()/usleep(), these seem portable enough.
4726 \begin_layout Itemize
4727 Move joystick axis manipulation to keymapper code.
4730 \begin_layout Itemize
4731 Changes to how read-only works.
4734 \begin_layout Itemize
4735 Refactor controller input code.
4738 \begin_layout Subsection
4742 \begin_layout Itemize
4743 Fix mouseclick scale compensation.
4746 \begin_layout Itemize
4747 Draw area boundaries correctly in SDL code.
4750 \begin_layout Itemize
4754 \begin_layout Itemize
4755 Fix CSCD output (buffer overrun and race condition).
4758 \begin_layout Subsection
4762 \begin_layout Itemize
4763 JMD dumping support.
4766 \begin_layout Itemize
4767 Allow unattended dumping to JMD.
4770 \begin_layout Itemize
4774 \begin_layout Itemize
4775 Switch back to 32-bit colors.
4778 \begin_layout Itemize
4779 Add Lua function gui.color.
4782 \begin_layout Itemize
4783 Use some new C++11 features in GCC 4.6.
4786 \begin_layout Itemize
4787 Be prepared for core frequency changes.
4790 \begin_layout Itemize
4791 Pass colors in one chunk from Lua.
4794 \begin_layout Subsection
4798 \begin_layout Itemize
4799 New lua functions gui.line(), gui.status() and gui.circle(), memory.vma_count(),
4800 memory.read_vma() and memory.find_vma().
4803 \begin_layout Itemize
4804 Numerious documentation fixups
4807 \begin_layout Itemize
4808 RTC time format changed
4811 \begin_layout Itemize
4812 Reformat flags display
4815 \begin_layout Itemize
4816 Allow lua package name to be overridden
4819 \begin_layout Itemize
4820 SDUMP (high-quality dumping).
4823 \begin_layout Itemize
4824 Split platform support to plugins.
4827 \begin_layout Itemize
4828 Make all sound plugins support basic sound commands
4831 \begin_layout Itemize
4832 Support portaudio for sound.
4835 \begin_layout Itemize
4836 Allow disable Lua/SDL searching.
4839 \begin_layout Itemize
4840 Upconvert colors when copying lcscreen to screen.
4843 \begin_layout Itemize
4844 Reorganize source tree.
4847 \begin_layout Itemize
4848 Evdev joystick support.
4851 \begin_layout Itemize
4852 Refactor more code into generic window code.
4855 \begin_layout Subsection
4859 \begin_layout Itemize
4860 Refactor message handling.
4863 \begin_layout Itemize
4867 \begin_layout Itemize
4871 \begin_layout Itemize
4872 Finish pending saves before load/quit.
4875 \begin_layout Itemize
4876 Wxwidgets graphics plugin.
4879 \begin_layout Subsection
4883 \begin_layout Itemize
4884 Get rid of win32-crap.[ch]pp.
4887 \begin_layout Itemize
4888 Move files around a lot.
4891 \begin_layout Itemize
4892 Get rid of need for host C++ compiler.
4895 \begin_layout Itemize
4899 \begin_layout Itemize
4900 Refactor inter-component communication.
4903 \begin_layout Itemize
4907 \begin_layout Itemize
4908 Fix crash on multiline aliases.
4911 \begin_layout Itemize
4912 Load/Save settings in wxwidgets gui.
4915 \begin_layout Subsection
4919 \begin_layout Itemize
4920 Patch problems in bsnes core
4923 \begin_layout Itemize
4924 SNES is little-endian, not big-endian!
4927 \begin_layout Itemize
4928 Fix memory corruption in lcscreen::load()
4931 \begin_layout Subsection
4935 \begin_layout Itemize
4936 Fix interpretting repeat counts in rrdata loading.
4939 \begin_layout Itemize
4940 New lua callback: on_frame()
4943 \begin_layout Itemize
4944 Remove calls to runtosave() that aren't supposed to be there
4947 \begin_layout Itemize
4948 Lua function: movie.read_rtc()
4951 \begin_layout Itemize
4952 Ignore src/fonts/font.cpp
4955 \begin_layout Itemize
4956 Fix more bsnes core problems
4959 \begin_layout Itemize
4960 Control bsnes random seeding
4963 \begin_layout Itemize
4967 \begin_layout Itemize
4968 Some bsnes core debugging features (state dump and state hash)
4971 \begin_layout Itemize
4972 Fix titlebar version number (no, the last version wasn't 'lsnes-0-beta21',
4973 it was 'lsnes rr0-beta21').
4976 \begin_layout Subsection
4980 \begin_layout Itemize
4981 Fix memory corruption due to macro/field mixup
4984 \begin_layout Itemize
4985 search-memory update
4988 \begin_layout Itemize
4989 Allow direct-mapped framebuffer
4992 \begin_layout Itemize
4993 SDL: Use SDL_ANYFORMAT if possible
4996 \begin_layout Itemize
4997 SDMP2SOX: 2s delay modes.
5000 \begin_layout Itemize
5004 \begin_layout Itemize
5005 Use sed -E, not sed -r.
5006 Fixes building on Mac OS X.
5009 \begin_layout Itemize
5010 Wxwidgets: Save jukebox on exit
5013 \begin_layout Itemize
5014 Fix RTC if using load-movie on savestate.
5017 \begin_layout Itemize
5018 Fix crash related to full console mode.
5021 \begin_layout Subsection
5025 \begin_layout Itemize
5026 Wxwidgets: Allow bringing application to foreground on Mac OS X.
5029 \begin_layout Itemize
5030 Wxwidgets: Allow compiling on Mac OS X.
5033 \begin_layout Itemize
5034 Use movie compare instead of movie hashing (faster save/load).
5037 \begin_layout Itemize
5041 \begin_layout Subsection
5045 \begin_layout Itemize
5046 sdmp2sox: Pad soundtrack if using -l or -L.
5049 \begin_layout Itemize
5050 sdmp2sox: Fix NTSC overscan.
5053 \begin_layout Itemize
5054 sdmp2sox: Add AR correction mode.
5057 \begin_layout Itemize
5058 call lua_close() when exiting.
5061 \begin_layout Itemize
5062 Fix zip_writer bug causing warnings from info-zip and error from advzip.
5065 \begin_layout Subsection
5069 \begin_layout Itemize
5070 Fix IPS patching code (use bsnes core IPS patcher).
5073 \begin_layout Itemize
5074 Implement BPS patching (using bsnes core IPS patcher).
5077 \begin_layout Itemize
5078 Add feature to load headered ROMs.
5081 \begin_layout Subsection
5085 \begin_layout Itemize
5086 Show command names when showing keybindings
5089 \begin_layout Subsection
5093 \begin_layout Itemize
5094 Fix pause-on-end to be actually controllable
5097 \begin_layout Itemize
5098 SDL: Poll all events in queue, not just first one (fixes slowness in command
5102 \begin_layout Itemize
5103 Wxwidgets: Fix ROM loading.
5106 \begin_layout Subsection
5110 \begin_layout Itemize
5111 Lua: Add gui.textH, gui.textV, gui.textHV
5114 \begin_layout Itemize
5115 Fix text colors on SDL on Mac OS X
5118 \begin_layout Itemize
5119 Mode 'F' for finished in readonly mode.
5122 \begin_layout Itemize
5126 \begin_layout Itemize
5127 Reliably pause after skip poll
5130 \begin_layout Itemize
5131 Split UI and core into their own threads
5134 \begin_layout Subsection
5138 \begin_layout Itemize
5139 Remove leftover dummy SRAM slot
5142 \begin_layout Itemize
5143 Fix controller numbers.
5146 \begin_layout Subsection
5150 \begin_layout Itemize
5151 Fix lsnes-dumpavi after interface change.
5154 \begin_layout Itemize
5155 Also give BSNES patches for v085.
5158 \begin_layout Itemize
5159 Pack movie data in memory.
5162 \begin_layout Subsection
5166 \begin_layout Itemize
5167 Fix framecount/length given when loading movies.
5170 \begin_layout Itemize
5171 Controller command memory leak fixes.
5174 \begin_layout Itemize
5175 Don't leak palette if freeing screen object.
5178 \begin_layout Subsection
5182 \begin_layout Itemize
5186 \begin_layout Itemize
5187 Wxwidgets: Allow controlling dumper from the menu.
5190 \begin_layout Subsection
5194 \begin_layout Itemize
5195 Rewrite parts of manual
5198 \begin_layout Itemize
5199 Lua: Make it work with Lua 5.2.
5202 \begin_layout Subsection
5206 \begin_layout Itemize
5207 Win32: Fix compile errors.
5210 \begin_layout Subsection
5214 \begin_layout Itemize
5215 Refactor controller input code.
5218 \begin_layout Itemize
5219 Fix crash when using command line on SDL / Mac OS X.
5222 \begin_layout Subsection
5226 \begin_layout Itemize
5227 Delete core/coroutine (obsolete)
5230 \begin_layout Itemize
5231 Lag input display by one frame.
5234 \begin_layout Itemize
5235 Rewind movie to beginning function.
5238 \begin_layout Itemize
5239 Fix wrong frame number reported to Lua when repainting after loadstate
5242 \begin_layout Itemize
5243 Support UI editing of jukebox
5246 \begin_layout Itemize
5247 Wxwidgets: Save settings on exit.
5250 \begin_layout Itemize
5251 Support ${project} for filenames
5254 \begin_layout Itemize
5255 SDL: Fix command history
5258 \begin_layout Subsection
5262 \begin_layout Itemize
5263 Fix some order-of-global-ctor bugs.
5266 \begin_layout Subsection
5270 \begin_layout Itemize
5271 Fix crashes when quitting on Win32.
5274 \begin_layout Subsection
5278 \begin_layout Itemize
5279 EVDEV: Queue keypresses from joystick, don't send directly
5282 \begin_layout Itemize
5283 Wxwidgets: Load-Preserve that actually works.
5286 \begin_layout Subsection
5290 \begin_layout Itemize
5291 Wxwidgets: GUI for memory search.
5294 \begin_layout Itemize
5295 Warn about using synchronous queue in UI callback.
5298 \begin_layout Subsection
5302 \begin_layout Itemize
5303 Remember last saved file for each ROM
5306 \begin_layout Itemize
5307 Support MT dumping via boost.
5310 \begin_layout Itemize
5314 \begin_layout Itemize
5318 \begin_layout Itemize
5319 Make mouse be ordinary input instead of special-casing
5322 \begin_layout Itemize
5323 SDL: Don't screw up commands with NUL codepoints.
5326 \begin_layout Subsection
5330 \begin_layout Itemize
5331 Merge status panel and main window
5334 \begin_layout Itemize
5335 True movie slot support (the rest of it)
5338 \begin_layout Itemize
5339 SDL: Fix compilation error
5342 \begin_layout Itemize
5343 Elminate cross calls in dump menu code.
5346 \begin_layout Subsection
5350 \begin_layout Itemize
5351 Cancel pending saves command
5354 \begin_layout Itemize
5355 Wxwidgets: Code refactoring
5358 \begin_layout Itemize
5359 Wxwidgets: Fix system -> reset
5362 \begin_layout Itemize
5363 Wxwidgets: Read watch expressions in the right thread
5366 \begin_layout Subsection
5370 \begin_layout Itemize
5371 Wxwidgets: Don't prompt for member when running Lua script (Lua doesn't
5375 \begin_layout Itemize
5376 Wxwidgets: 128 -> 1024 Autohold slots (in case more are needed).
5379 \begin_layout Itemize
5380 Don't append trailing '-' to prefix when saving movie.
5383 \begin_layout Itemize
5384 Fix ROM/savestate handling (don't let user mismatch ROM and savestates).
5387 \begin_layout Subsection
5391 \begin_layout Itemize
5392 Document memory watch syntax.