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.
75 Syntax: lsnes.exe <rom-options> <misc-options> (<new-session-options>|<filename>)
79 Syntax: lsnes-avidump <dump-options> <misc-options> <rom-options> <filename>
83 Syntax: movieinfo.exe <filename>
86 \begin_layout Subsection
90 \begin_layout Standard
91 These options control loading the ROM.
94 \begin_layout Subsubsection
98 \begin_layout Standard
99 Load <file> (SFC file format) as main SNES cartridge ROM.
100 This is the game ROM for SNES and cartridge BIOS for other types.
104 \begin_layout Subsubsection
108 \begin_layout Standard
109 Set the mapping XML file for main cartridge ROM.
110 If not specified, defaults are used.
113 \begin_layout Subsubsection
117 \begin_layout Standard
118 Load <file> (BS file format) as BS-X non-slotted flash memory.
119 Also sets system type to BS-X non-slotted (not compatible with --bsxslotted=<fi
120 le>, --dmg=<file>, --slot-a=<file> nor --slot-b=<file>).
123 \begin_layout Subsubsection
127 \begin_layout Standard
128 Set mapping XML file for BS-X non-slotted flash memory.
129 If not specified, defaults are used.
130 Only can be used together with --bsx=<file>.
133 \begin_layout Subsubsection
137 \begin_layout Standard
138 Load <file> (BS file format) as BS-X slotted flash memory.
139 Also sets system type to BS-X slotted (not compatible with --bsx=<file>,
140 --dmg=<file>, --slot-a=<file> nor --slot-b=<file>).
143 \begin_layout Subsubsection
144 --bsxslotted-xml=<file>
147 \begin_layout Standard
148 Set mapping XML file for BS-X slotted flash memory.
149 If not specified, defaults are used.
150 Only can be used together with --bsxslotted=<file>.
153 \begin_layout Subsubsection
157 \begin_layout Standard
158 Load <file> (GB file format) as Game Boy ROM.
159 Also sets system type to SGB (not compatible with --bsx=<file>, --bsxslotted=<f
160 ile>, --slot-a=<file> nor --slot-b=<file>).
163 \begin_layout Subsubsection
167 \begin_layout Standard
168 Set mapping XML file for Game Boy ROM.
169 If not specified, defaults are used.
170 Only can be used together with --dmg=<file>.
173 \begin_layout Subsubsection
177 \begin_layout Standard
178 Load <file> (ST file format) as Sufami turbo cartridge A ROM.
179 Also sets system type to Sufami Turbo (not compatible with --bsx=<file>,
180 --bsxslotted=<file> nor --dmg=<file>).
183 \begin_layout Subsubsection
187 \begin_layout Standard
188 Set mapping XML file for Sufami turbo cartridge A ROM.
189 If not specified, defaults are used.
190 Only can be used together with --slot-a=<file>.
193 \begin_layout Subsubsection
197 \begin_layout Standard
198 Load <file> (ST file format) as Sufami turbo cartridge B ROM.
199 Also sets system type to Sufami Turbo (not compatible with --bsx=<file>,
200 --bsxslotted=<file> nor --dmg=<file>).
203 \begin_layout Subsubsection
207 \begin_layout Standard
208 Set mapping XML file for Sufami turbo cartridge B ROM.
209 If not specified, defaults are used.
210 Only can be used together with --slot-b=<file>.
213 \begin_layout Subsubsection
217 \begin_layout Standard
218 Apply IPS patch <file> to main cartridge ROM.
219 Requires --rom=<file>.
222 \begin_layout Subsubsection
226 \begin_layout Standard
227 Apply IPS patch <file> to main cartridge ROM mapping XML.
228 Requires --rom-xml=<file>.
231 \begin_layout Subsubsection
235 \begin_layout Standard
236 Apply IPS patch <file> to BS-X non-slotted flash.
237 Requires --bsx=<file>.
240 \begin_layout Subsubsection
244 \begin_layout Standard
245 Apply IPS patch <file> to BS-X non-slotted flash mapping XML.
246 Requires --bsx-xml=<file>.
249 \begin_layout Subsubsection
250 --ips-bsxslotted=<file>
253 \begin_layout Standard
254 Apply IPS patch <file> to BS-X slotted flash.
255 Requires --bsxslotted=<file>.
258 \begin_layout Subsubsection
259 --ips-bsxslotted-xml=<file>
262 \begin_layout Standard
263 Apply IPS patch <file> to BS-X slotted flash mapping XML.
264 Requires --bsxslotted-xml=<file>.
267 \begin_layout Subsubsection
271 \begin_layout Standard
272 Apply IPS patch <file> to Game Boy ROM.
273 Requires --dmg=<file>.
276 \begin_layout Subsubsection
280 \begin_layout Standard
281 Apply IPS patch <file> to Game Boy ROM mapping XML.
282 Requires --dmg-xml=<file>.
285 \begin_layout Subsubsection
289 \begin_layout Standard
290 Apply IPS patch <file> to Sufami turbo cartridge A ROM.
291 Requires --slot-a=<file>.
294 \begin_layout Subsubsection
295 --ips-slot-a-xml=<file>
298 \begin_layout Standard
299 Apply IPS patch <file> to Sufami turbo cartridge A ROM mapping XML.
300 Requires --slot-a-xml=<file>.
303 \begin_layout Subsubsection
307 \begin_layout Standard
308 Apply IPS patch <file> to Sufami turbo cartridge B ROM.
309 Requires --slot-b=<file>.
312 \begin_layout Subsubsection
313 --ips-slot-b-xml=<file>
316 \begin_layout Standard
317 Apply IPS patch <file> to Sufami turbo cartridge B ROM mapping XML.
318 Requires --slot-b-xml=<file>.
321 \begin_layout Subsubsection
322 --ips-offset=<offset>
325 \begin_layout Standard
326 Set IPS apply offset to <offset> (can be negative).
327 IPS apply offset is added to all addresses inside IPS file before applying.
328 If the resulting address is negative, write is ignored (with a warning).
329 If resulting address exceeds ROM size, the ROM is extended.
332 \begin_layout Subsubsection
336 \begin_layout Standard
337 Force ROM to be considered PAL-only (warning: Will cause error if used on
338 anything except SNES and SGB).
341 \begin_layout Subsubsection
345 \begin_layout Standard
346 Force ROM to be considered NTSC-only (default for everything except SNES
350 \begin_layout Subsection
351 New session options (lsnes.exe only)
354 \begin_layout Standard
355 If filename is not specified, new session is started.
356 These options control the properties of new session:
359 \begin_layout Subsubsection
363 \begin_layout Standard
368 \begin_layout Itemize
369 none: No device connected
372 \begin_layout Itemize
373 gamepad: One gamepad (the default)
376 \begin_layout Itemize
377 multitap: Four gamepads (warning: makes most games refuse to start)
380 \begin_layout Itemize
384 \begin_layout Subsubsection
388 \begin_layout Standard
393 \begin_layout Itemize
394 none: No device connected (the default)
397 \begin_layout Itemize
401 \begin_layout Itemize
402 multitap: Four gamepads.
405 \begin_layout Itemize
409 \begin_layout Itemize
410 superscope: Super Scope
413 \begin_layout Itemize
414 justifier: One justifier
417 \begin_layout Itemize
418 justifiers: Two justifiers
421 \begin_layout Subsubsection
425 \begin_layout Standard
426 Set the name of game to <name>
429 \begin_layout Subsubsection
433 \begin_layout Standard
434 Add author with full name of <name> (no nickname).
437 \begin_layout Subsubsection
441 \begin_layout Standard
442 Add author with nickname of <name> (no full name).
445 \begin_layout Subsubsection
446 --author=<fullname>|<nickname>
449 \begin_layout Standard
450 Add author with full name of <fullname> and nickname of <nickname>.
453 \begin_layout Subsubsection
457 \begin_layout Standard
458 Set RTC second (0 is 1st January 1970 00:00:00Z).
461 \begin_layout Subsubsection
462 --rtc-subsecond=<value>
465 \begin_layout Standard
467 Range is 0-3,462,619,485,019.
470 \begin_layout Subsection
474 \begin_layout Standard
475 If filename is specified on command line, it is loaded as initial state
476 (instead of constructing one).
477 Mandatory for lsnes-avidump.exe and movieinfo.exe.
480 \begin_layout Subsection
485 \begin_layout Subsubsection
486 --run=<file> (lsnes.exe only)
489 \begin_layout Standard
490 After running main RC file, run this file.
491 If multiple are specified, these execute in order specified.
494 \begin_layout Subsection
495 dump options (lsnes-avidump.exe only)
498 \begin_layout Subsubsection
502 \begin_layout Standard
505 \begin_inset Quotes eld
509 \begin_inset Quotes erd
515 \begin_layout Subsubsection
519 \begin_layout Standard
520 Set compression level (0-18).
524 \begin_layout Subsubsection
528 \begin_layout Standard
529 Set number of frames to dump.
533 \begin_layout Subsubsection
537 \begin_layout Standard
538 Run specified lua script (lsnes-avidump.exe does not have initialization
542 \begin_layout Subsubsection
546 \begin_layout Standard
547 Use JMD dumping instead of AVI dumping.
550 \begin_layout Section
551 Startup file lsnes.rc
554 \begin_layout Standard
555 Upon startup, lsnes (lsnes.exe only) executes file lsnes.rc as commands.
556 This file is located in:
559 \begin_layout Itemize
564 lsnes.rc (if %APPDATA% exists)
567 \begin_layout Itemize
568 Unix: $XDG_CONFIG_HOME/lsnes/lsnes.rc (if $XDG_CONFIG_HOME exists)
571 \begin_layout Itemize
572 Unix: $HOME/.config/lsnes/lsnes.rc (if $HOME exists)
575 \begin_layout Itemize
576 All: ./lsnes.rc (fallback default).
579 \begin_layout Standard
580 If leading directories do not exist, attempt to create them is made.
583 \begin_layout Section
584 Game internal commands
587 \begin_layout Itemize
588 Commands beginning with '*' invoke the corresponding command without alias
592 \begin_layout Itemize
593 If command starts with '+' (after possible '*'), the command is executed
594 as-is when button is pressed, and when button is released, it is executed
595 with '+' replaced by '-'.
598 \begin_layout Subsection
602 \begin_layout Standard
603 Settings control various aspects of emulator behaviour.
606 \begin_layout Subsubsection
607 set-setting <setting> <value>
610 \begin_layout Standard
611 Sets setting <setting> to value <value> (may be empty).
614 \begin_layout Subsubsection
615 unset-setting <setting>
618 \begin_layout Standard
619 Try to unset setting <setting> (not all settings can be unset).
622 \begin_layout Subsubsection
623 get-setting <setting>
626 \begin_layout Standard
627 Read value of setting <setting>
630 \begin_layout Subsubsection
634 \begin_layout Standard
635 Print names and values of all settings.
638 \begin_layout Subsection
642 \begin_layout Standard
643 Keybindings bind commands or aliases to keys (or pseudo-keys).
647 \begin_layout Standard
651 \begin_layout Itemize
652 Do not bind edge active (+/-) commands to keys with modifiers, that won't
656 \begin_layout Itemize
657 Names of keys and modifiers are platform-dependent.
660 \begin_layout Itemize
661 Be careful before binding pseudo-keys (such as joystick axes, buttons or
662 hats) with modifiers.
663 That may or may not work right.
666 \begin_layout Subsubsection
667 bind-key [<mod>/<modmask>] <key> <command>
670 \begin_layout Standard
671 Bind <command> to key <key> (activating if modifiers in <modmask> (comma-seperat
672 ed list) are set as <mod> (comma-seperated list).
675 \begin_layout Standard
676 The names of keys and modifiers are platform-dependent.
679 \begin_layout Subsubsection
680 unbind-key [<mod>/<modmask>] <key>
683 \begin_layout Standard
684 Unbind command from <key> (with specified <mod> and <modmask>).
687 \begin_layout Subsection
688 set-axis <axis> [disabled | axis | axis-inverse | pressure0- | pressure0+
689 | pressure-0 | pressure-+ | pressure+0 | pressure+-] [minus=<val>] [zero=<val>]
690 [plus=<val>] [tolerance=<val>]
693 \begin_layout Standard
694 Set axis parameters for axis <axis>.
697 \begin_layout Itemize
698 disabled: Disable axis
701 \begin_layout Itemize
705 \begin_layout Itemize
706 axis-inverse: Inverse axis
709 \begin_layout Itemize
710 pressure0-: Pressure sensitive.
711 Released at 0, pressed at -.
714 \begin_layout Itemize
715 pressure0+: Pressure sensitive.
716 Released at 0, pressed at +.
719 \begin_layout Itemize
720 pressure-0: Pressure sensitive.
721 Released at -, pressed at 0.
724 \begin_layout Itemize
725 pressure-+: Pressure sensitive.
726 Released at -, pressed at +.
729 \begin_layout Itemize
730 pressure+0: Pressure sensitive.
731 Released at +, pressed at 0.
734 \begin_layout Itemize
735 pressure+-: Pressure sensitive.
736 Released at +, pressed at -.
739 \begin_layout Itemize
740 minus=<val>: Calibration at extreme minus position (-32768-32767)
743 \begin_layout Itemize
744 zero=<val>: Calibration at neutral position (-32768-32767)
747 \begin_layout Itemize
748 plus=<val>: Calibration at extreme plus position (-32768-32767)
751 \begin_layout Itemize
752 tolerance=<value>: Center band tolerance (0<x<1).
753 The smaller the value, the more sensitive the control is.
756 \begin_layout Subsubsection
760 \begin_layout Standard
761 Print all key bindings in effect.
764 \begin_layout Subsection
768 \begin_layout Standard
769 Aliases bind command to sequence of commands.
770 After alias has been defined, it replaces the command it shadows.
773 \begin_layout Standard
777 \begin_layout Itemize
778 You can't alias command to itself.
781 \begin_layout Itemize
782 Aliases starting with +/- are edge active just like ordinary commands starting
786 \begin_layout Itemize
787 One command can be aliased to multiple commands.
790 \begin_layout Subsubsection
791 alias-command <command> <expansion>
794 \begin_layout Standard
795 Append <expansion> to alias <command>.
796 If alias does not already exist, it is created.
799 \begin_layout Subsubsection
800 unalias-command <command>
803 \begin_layout Standard
804 Clear alias expansion for <command>.
807 \begin_layout Subsubsection
811 \begin_layout Standard
812 Print all aliases and their expansions in effect.
815 \begin_layout Subsection
819 \begin_layout Standard
820 Run <script> as if commands were entered on the command line.
823 \begin_layout Subsection
827 \begin_layout Standard
828 Following commands control AVI video dumping:
831 \begin_layout Subsubsection
832 dump-avi <level> <prefix>
835 \begin_layout Standard
836 Dump AVI video to prefix <prefix> at level <level> (0-18).
840 \begin_layout Itemize
841 The codec is Camstudio Codec in gzip mode.
844 \begin_layout Itemize
845 Encoder and muxer are internal, available on all platforms.
848 \begin_layout Itemize
849 Audio enable/disable and framerate has no effect.
852 \begin_layout Itemize
853 Levels 10-18 are not compatible with AVISource.
856 \begin_layout Itemize
857 Recomended level is 7 if decoded by AVISource.
860 \begin_layout Itemize
861 Recomended level is 16 if decoded by ffmpeg, mencoder or FFMpegSource.
864 \begin_layout Itemize
865 Dumps of low-res PAL games are 256x239 (with all the consequences odd height
869 \begin_layout Itemize
870 The audio dumped to .avi is low-quality version.
871 The high-quality version is dumped to .sox file.
874 \begin_layout Subsubsection
878 \begin_layout Standard
879 End current AVI video dump (closing the emulator also closes the dump).
882 \begin_layout Subsection
886 \begin_layout Standard
887 Following commands control JMD video dumping:
890 \begin_layout Subsubsection
891 dump-jmd <level> <file>
894 \begin_layout Standard
895 Dump JMD video to file <file> at level <level> (0-9).
898 \begin_layout Subsubsection
902 \begin_layout Standard
903 End the current JMD dump in progress.
906 \begin_layout Subsection
910 \begin_layout Standard
911 <address> may be decimal or hexadecimal (prefixed with '0x').
912 <value> can be hexadecimal (prefixed with '0x'), unsigned or signed (prefixed
916 \begin_layout Standard
917 The available element <sizes> are:
920 \begin_layout Itemize
924 \begin_layout Itemize
928 \begin_layout Itemize
932 \begin_layout Itemize
936 \begin_layout Standard
937 When reading RAM and ROM, multi-byte reads/writes are big-endian.
938 When dealing with DSP memory, multi-byte reads/writes are native-endian
939 (do not use operand sizes exceeding DSP bitness, except dword is OK for
943 \begin_layout Subsubsection
944 read-<size> <address>
947 \begin_layout Standard
948 Read the value of byte in <address>.
951 \begin_layout Subsubsection
952 read-s<size> <address>
955 \begin_layout Standard
956 Read the value of signed byte in <address>.
959 \begin_layout Subsubsection
960 write-<size> <address> <value>
963 \begin_layout Standard
964 Write <value> to byte in address <address>.
967 \begin_layout Subsubsection
971 \begin_layout Standard
972 Reset the memory search
975 \begin_layout Subsubsection
979 \begin_layout Standard
980 Print number of candidates remaining
983 \begin_layout Subsubsection
987 \begin_layout Standard
988 Print all candidates remaining
991 \begin_layout Subsubsection
992 search-memory <usflag><sizeflag><op>
995 \begin_layout Standard
996 Searches memory for addresses satisfying criteria.
999 \begin_layout Standard
1003 \begin_layout Itemize
1007 \begin_layout Itemize
1011 \begin_layout Standard
1015 \begin_layout Itemize
1019 \begin_layout Itemize
1023 \begin_layout Itemize
1027 \begin_layout Itemize
1031 \begin_layout Standard
1035 \begin_layout Itemize
1036 lt: < previous value.
1039 \begin_layout Itemize
1040 le: <= previous value.
1043 \begin_layout Itemize
1044 eq: = previous value.
1047 \begin_layout Itemize
1048 ne: != previous value.
1051 \begin_layout Itemize
1052 ge: >= previous value.
1055 \begin_layout Itemize
1056 gt: > previous value.
1059 \begin_layout Subsubsection
1060 search-memory <sizeflag> <value>
1063 \begin_layout Standard
1064 Searches for addresses that currently have value <value>.
1065 <sizeflag> is as in previous command.
1068 \begin_layout Subsection
1072 \begin_layout Standard
1073 These commands are not available in lsnesrc, but are available after ROM
1077 \begin_layout Subsubsection
1081 \begin_layout Standard
1082 Quits the emulator (asking for confirmation).
1083 If /y is given, no confirmation is asked.
1086 \begin_layout Subsubsection
1090 \begin_layout Standard
1091 Toggle paused/unpaused
1094 \begin_layout Subsubsection
1098 \begin_layout Standard
1100 If the button is still held after configurable timeout expires, game unpauses
1101 for the duration frame advance is held.
1104 \begin_layout Subsubsection
1108 \begin_layout Standard
1110 If the button is still held after configurable timeout expires, game unpauses
1111 for the duration frame advance is held.
1114 \begin_layout Subsubsection
1118 \begin_layout Standard
1119 Skip to first poll in frame after current.
1122 \begin_layout Subsubsection
1126 \begin_layout Standard
1127 Reset the SNES after this frame.
1130 \begin_layout Subsubsection
1134 \begin_layout Standard
1135 Load savestate <filename> in current mode.
1138 \begin_layout Subsubsection
1139 load-state <filename>
1142 \begin_layout Standard
1143 Load savestate <filename> in readwrite mode.
1146 \begin_layout Subsubsection
1147 load-readonly <filename>
1150 \begin_layout Standard
1151 Load savestate <filename> in readonly mode.
1154 \begin_layout Subsubsection
1155 load-preserve <filename>
1158 \begin_layout Standard
1159 Load savestate <filename> in readonly mode, preserving current events.
1162 \begin_layout Subsubsection
1163 load-movie <filename>
1166 \begin_layout Standard
1167 Load savestate <filename>, ignoring save part in readonly mode.
1170 \begin_layout Subsubsection
1171 save-state <filename>
1174 \begin_layout Standard
1175 Save system state to <filename> as soon as possible.
1178 \begin_layout Subsubsection
1179 save-movie <filename>
1182 \begin_layout Standard
1183 Save movie to <filename>.
1186 \begin_layout Subsubsection
1190 \begin_layout Standard
1191 Set read-write mode.
1194 \begin_layout Subsubsection
1198 \begin_layout Standard
1202 \begin_layout Subsubsection
1206 \begin_layout Standard
1207 Toggle between read-only and read-write modes.
1210 \begin_layout Subsubsection
1214 \begin_layout Standard
1215 Set name of the game to <name>
1218 \begin_layout Subsubsection
1222 \begin_layout Standard
1223 Print the name of the game.
1226 \begin_layout Subsubsection
1230 \begin_layout Standard
1231 Adds new author <author>.
1232 If <author> does not contain '|' it is full name.
1233 If it contains '|', '|' splits the full name and nickname.
1236 \begin_layout Subsubsection
1237 edit-author <num> <author>
1240 \begin_layout Standard
1241 Edit the author in slot <num> (0-based) to be <author> (see add-author for
1245 \begin_layout Subsubsection
1249 \begin_layout Standard
1250 Remove author in slot <num>
1253 \begin_layout Subsubsection
1257 \begin_layout Standard
1261 \begin_layout Subsubsection
1262 test-1, test-2, test-3
1265 \begin_layout Standard
1266 Internal test commands.
1270 \begin_layout Subsubsection
1271 take-screenshot <filename>
1274 \begin_layout Standard
1275 Save screenshot to <filename>.
1278 \begin_layout Subsubsection
1279 +controller<num><button>
1282 \begin_layout Standard
1283 Press button <button> on controller <num> (1-8).
1284 The following button names are known:
1287 \begin_layout Itemize
1291 \begin_layout Itemize
1295 \begin_layout Itemize
1299 \begin_layout Itemize
1303 \begin_layout Itemize
1307 \begin_layout Itemize
1311 \begin_layout Itemize
1315 \begin_layout Itemize
1319 \begin_layout Itemize
1323 \begin_layout Itemize
1327 \begin_layout Itemize
1331 \begin_layout Itemize
1335 \begin_layout Itemize
1339 \begin_layout Itemize
1343 \begin_layout Itemize
1347 \begin_layout Itemize
1351 \begin_layout Subsubsection
1352 controllerh<num><button>
1355 \begin_layout Standard
1356 Hold/unhold button <button> on controller <num> (1-8).
1357 See +controller for button names.
1360 \begin_layout Subsubsection
1361 autofire (<pattern>|-)...
1364 \begin_layout Standard
1365 Set autofire pattern.
1366 Each parameter is comma-separated list of button names (in form of 1start,
1367 1A, 2B, etc..) to hold on that frame.
1368 After reaching the end of pattern, the pattern restarts from the beginning.
1371 \begin_layout Subsubsection
1375 \begin_layout Standard
1379 \begin_layout Subsection
1383 \begin_layout Subsubsection
1384 cycle-jukebox-backward
1387 \begin_layout Standard
1388 Cycle save jukebox backwards.
1391 \begin_layout Subsubsection
1392 cycle-jukebox-forward
1395 \begin_layout Standard
1396 Cycle save jukebox forwards
1399 \begin_layout Subsubsection
1400 add-jukebox-save <filename>
1403 \begin_layout Standard
1404 Add <filename> to jukebox saves.
1407 \begin_layout Subsubsection
1411 \begin_layout Standard
1412 Do load from jukebox (current mode).
1415 \begin_layout Subsubsection
1419 \begin_layout Standard
1420 Do state save to jukebox.
1423 \begin_layout Subsection
1427 \begin_layout Standard
1428 Only available if lua support is compiled in.
1431 \begin_layout Subsubsection
1435 \begin_layout Standard
1436 Run Lua code <luacode> using built-in Lua interpretter.
1439 \begin_layout Subsubsection
1443 \begin_layout Standard
1444 Run specified lua file using built-in Lua interpretter.
1447 \begin_layout Subsection
1451 \begin_layout Subsubsection
1452 add-watch <name> <expression>
1455 \begin_layout Standard
1456 Adds new watch (or modifies old one).
1459 \begin_layout Subsubsection
1463 \begin_layout Standard
1467 \begin_layout Subsection
1471 \begin_layout Subsubsection
1472 enable-sound <on/off>
1475 \begin_layout Standard
1476 Enable/Disable sound.
1479 \begin_layout Subsubsection
1480 set-sound-device <device>
1483 \begin_layout Standard
1484 Set sound device to <device>
1487 \begin_layout Subsubsection
1491 \begin_layout Standard
1492 Show status of sound system.
1495 \begin_layout Subsubsection
1499 \begin_layout Standard
1500 Show all available devices.
1503 \begin_layout Subsection
1504 SDL Platform commands
1507 \begin_layout Standard
1508 The following are valid on SDL platform.
1511 \begin_layout Subsubsection
1515 \begin_layout Standard
1516 Asks to press a key and then identifies that (pseudo-)key.
1519 \begin_layout Subsubsection
1523 \begin_layout Standard
1524 Toggle between windowed/fullscreen console.
1527 \begin_layout Subsubsection
1531 \begin_layout Standard
1532 Scroll messages window as far back as it goes.
1535 \begin_layout Subsubsection
1539 \begin_layout Standard
1540 Scroll messages window as far forward as it goes.
1543 \begin_layout Subsubsection
1547 \begin_layout Standard
1548 Scroll messages window back one screenful.
1551 \begin_layout Subsubsection
1555 \begin_layout Standard
1556 Scroll messages window forward one screenful.
1559 \begin_layout Section
1563 \begin_layout Subsection
1567 \begin_layout Subsubsection
1571 \begin_layout Standard
1572 Set where bsnes looks for firmware files.
1574 \begin_inset Quotes eld
1578 \begin_inset Quotes erd
1584 \begin_layout Subsubsection
1588 \begin_layout Standard
1590 Numeric, range is 0.001 to
1591 \begin_inset Quotes eld
1595 \begin_inset Quotes erd
1599 Default is native framerate.
1602 \begin_layout Subsubsection
1606 \begin_layout Standard
1607 Set save compression level (integer 0-9).
1608 Default is 7 (0 is no compression).
1611 \begin_layout Subsubsection
1615 \begin_layout Standard
1616 Set the frame advance timeout in milliseconds.
1617 Numeric integer, range is 0-999999999.
1621 \begin_layout Subsection
1625 \begin_layout Subsubsection
1629 \begin_layout Standard
1630 AVI dumper: Always dump at 512x448 or 512x478 regardless of what the console
1634 \begin_layout Subsubsection
1638 \begin_layout Standard
1639 AVI dumper: Set the default left border thickness (unless lua overrides)
1645 \begin_layout Subsubsection
1649 \begin_layout Standard
1650 AVI dumper: Set the default right border thickness (unless lua overrides)
1656 \begin_layout Subsubsection
1660 \begin_layout Standard
1661 AVI dumper: Set the default top border thickness (unless lua overrides)
1667 \begin_layout Subsubsection
1671 \begin_layout Standard
1672 AVI dumper: Set the default bottom border thickness (unless lua overrides)
1678 \begin_layout Subsubsection
1682 \begin_layout Standard
1683 AVI dumper: Maximum number of frames per dump segment (0 => unlimited).
1688 \begin_layout Subsection
1689 SDL platform settings
1692 \begin_layout Subsubsection
1693 autorepeat-first-delay
1696 \begin_layout Standard
1697 Sets the delay for first character in typematic autorepeat.
1700 \begin_layout Subsubsection
1701 autorepeat-subsequent-delay
1704 \begin_layout Standard
1705 Sets the delay for subsequent characters in typematic autorepeat.
1708 \begin_layout Section
1712 \begin_layout Subsection
1713 Core (in main table)
1716 \begin_layout Subsubsection
1720 \begin_layout Standard
1721 Print line to message console.
1724 \begin_layout Subsubsection
1725 exec(string command)
1728 \begin_layout Standard
1729 Run command as it was entered on the command line
1732 \begin_layout Subsection
1736 \begin_layout Standard
1737 Bitwise logical functions and related.
1740 \begin_layout Subsubsection
1741 none(number...) / bnot(number...)
1744 \begin_layout Standard
1745 48-bit bitwise NOT / NONE function (set bits that are set in none of the
1749 \begin_layout Subsubsection
1750 any(number...) / bor(number...)
1753 \begin_layout Standard
1754 48-bit bitwise OR / ANY function (set bits that are set in any of the arguments).
1757 \begin_layout Subsubsection
1758 all(number...) / band(number...)
1761 \begin_layout Standard
1762 48-bit bitwise AND / ALL function (set bits that are set in all of the arguments
1766 \begin_layout Subsubsection
1767 parity(number...) / bxor(number...)
1770 \begin_layout Standard
1771 48-bit bitwise XOR / PARITY function (set bits that are set in odd number
1775 \begin_layout Subsubsection
1776 lrotate(number base[, number amount[, number bits]])
1779 \begin_layout Standard
1780 Rotate bits-bit (max 48, default 48) number left by amount (default 1) places.
1783 \begin_layout Subsubsection
1784 rrotate(number base[, number amount[, number bits]])
1787 \begin_layout Standard
1788 Rotate bits-bit (max 48, default 48) number right by amount (default 1)
1792 \begin_layout Subsubsection
1793 lshift(number base[, number amount[, number bits]])
1796 \begin_layout Standard
1797 Shift bits-bit (max 48, default 48) number left by amount (default 1) places.
1798 The new bits are filled with zeroes.
1801 \begin_layout Subsubsection
1802 lrshift(number base[, number amount[, number bits]])
1805 \begin_layout Standard
1806 Shift bits-bit (max 48, default 48) number logically right by amount (default
1808 The new bits are filled with zeroes.
1811 \begin_layout Subsubsection
1812 arshift(number base[, number amount[, number bits]])
1815 \begin_layout Standard
1816 Shift bits-bit (max 48, default 48) number arithmetically right by amount
1818 The new bits are shifted in with copy of the high bit.
1821 \begin_layout Subsection
1825 \begin_layout Standard
1826 Most of these functions can only be called in on_paint and on_video callbacks.
1827 Exceptions are noted.
1830 \begin_layout Standard
1832 Bits 0-7 are the blue component, bits 8-15 are the green component, bits
1833 16-23 are the red component, bits 24-31 are alpha component (0 is fully
1834 opaque, 255 is almost transparent).
1835 -1 is the fully transparent color.
1836 Alpha values greater than 127 do work.
1839 \begin_layout Standard
1840 Origin of coordinates is at top left corner of game display area.
1841 Left and top gaps correspond to negative coordinates.
1844 \begin_layout Subsubsection
1848 \begin_layout Standard
1849 Returns 2-tuple (hresolution, vresolution).
1852 \begin_layout Subsubsection
1853 gui.<class>_gap(number gap)
1856 \begin_layout Standard
1857 Set the <class> (left, right, top, bottom) gap to specified value (max gap
1861 \begin_layout Subsubsection
1862 gui.text(number x, number y, string text[, number fgc[, number bgc]])
1865 \begin_layout Standard
1866 Draw specified text on the GUI (each character cell is 8 or 16 wide and
1871 \begin_layout Itemize
1872 x: X-coordinate to start the drawing from (and x-coordinate at begining
1876 \begin_layout Itemize
1877 y: Y-coordinate to start the drawing from.
1880 \begin_layout Itemize
1881 text: The text to draw.
1884 \begin_layout Itemize
1885 fgc: Text color (default is 0xFFFFFF (white))
1888 \begin_layout Itemize
1889 bgc: Background color (default is -1 (transparent))
1892 \begin_layout Subsubsection
1893 gui.rectangle(number x, number y, number width, number height[, number thickness[
1894 , number outline[, number fill]]])
1897 \begin_layout Standard
1898 Draw rectangle on the GUI.
1902 \begin_layout Itemize
1903 x: X-coordinate of left edge.
1906 \begin_layout Itemize
1907 y: Y-coordinate of upper edge.
1910 \begin_layout Itemize
1911 width: Width of rectangle.
1914 \begin_layout Itemize
1915 height: Height of rectangle.
1918 \begin_layout Itemize
1919 thickness: Thickness of outline (default is 1).
1922 \begin_layout Itemize
1923 outline: Color of outline (default is 0xFFFFFF (white))
1926 \begin_layout Itemize
1927 fill: Color of fil (default is -1 (transparent))
1930 \begin_layout Subsubsection
1931 gui.pixel(number x, number y[, number color])
1934 \begin_layout Standard
1935 Draw one pixel on the GUI.
1939 \begin_layout Itemize
1940 x: X-coordinate of the pixel
1943 \begin_layout Itemize
1944 y: Y-coordinate of the pixel
1947 \begin_layout Itemize
1948 color: Color of the pixel (default is 0xFFFFFF (white))
1951 \begin_layout Subsubsection
1952 gui.crosshair(number x, number y[, number length[, number color]])
1955 \begin_layout Standard
1960 \begin_layout Itemize
1961 x: X-coordinate of the crosshair
1964 \begin_layout Itemize
1965 y: Y-coordinate of the crosshair
1968 \begin_layout Itemize
1969 length: Length of the crosshair lines (default 10).
1972 \begin_layout Itemize
1973 color: Color of the crosshair (default is 0xFFFFFF (white))
1976 \begin_layout Subsubsection
1977 gui.line(number x1, number y1, number x2, number y2[, number color])
1980 \begin_layout Standard
1985 \begin_layout Itemize
1986 x1: X-coordinate of one end.
1989 \begin_layout Itemize
1990 y1: Y-coordinate of one end.
1993 \begin_layout Itemize
1994 x2: X-coordinate of the other end.
1997 \begin_layout Itemize
1998 y2: Y-coordinate of the other end.
2001 \begin_layout Itemize
2002 color: Color of the line (default is 0xFFFFFF (white)).
2005 \begin_layout Subsubsection
2006 gui.circle(number x, number y, number r[, number thick[, number border[,
2010 \begin_layout Standard
2015 \begin_layout Itemize
2016 x: X-coordinate of the center
2019 \begin_layout Itemize
2020 y: Y-coordinate of the center
2023 \begin_layout Itemize
2024 r: The radius of the circle
2027 \begin_layout Itemize
2028 thick: Border thickness
2031 \begin_layout Itemize
2032 border: Border color (default is 0xFFFFFF (white))
2035 \begin_layout Itemize
2036 fill: Fill color (default is -1 (transparent)).
2039 \begin_layout Subsubsection
2043 \begin_layout Standard
2044 Request on_repaint() to happen as soon as possible.
2045 Can be used anywhere.
2048 \begin_layout Subsubsection
2049 gui.subframe_update(boolean on)
2052 \begin_layout Standard
2053 Request subframe updates (calling on_paint() on subframes) to happen (on=true)
2054 or not happen (on=false).
2055 Can be used anywhere.
2058 \begin_layout Subsubsection
2059 gui.screenshot(string filename)
2062 \begin_layout Standard
2063 Write PNG screenshot of the current frame (no drawings) to specified file.
2064 Can be used anywhere.
2067 \begin_layout Subsubsection
2068 gui.color(number r, number g, number b[, number a])
2071 \begin_layout Standard
2072 Returns color (in notation Lua scripts use) corresponding to color (r,g,b),
2073 each component in scale 0-255.
2074 If a is specified, that is alpha (0 is fully transparent, 256(sic) is fully
2076 The default alpha is 256.
2079 \begin_layout Subsubsection
2080 gui.status(string name, string value)
2083 \begin_layout Standard
2085 \begin_inset Quotes eld
2089 \begin_inset Quotes erd
2092 to <value> in status area.
2093 Can be used anywhere.
2096 \begin_layout Subsection
2100 \begin_layout Standard
2102 Only available in on_input callback.
2105 \begin_layout Subsection
2106 get(number controller, number index)
2109 \begin_layout Standard
2110 Read the specified index (0-11) from specified controller (0-7).
2114 \begin_layout Itemize
2115 Uses physical controller numbering.
2116 Gamepad in port 2 is controller 4, not 1!
2119 \begin_layout Subsection
2120 set(number controller, number index, number value)
2123 \begin_layout Standard
2124 Write the specified index (0-11) from specified controller (0-7), storing
2129 \begin_layout Itemize
2130 Uses physical controller numbering.
2131 Gamepad in port 2 is controller 4, not 1!
2134 \begin_layout Subsection
2135 reset([number cycles])
2138 \begin_layout Standard
2140 If cycles is greater than zero, do delayed reset.
2141 0 (or no value) causes immediate reset.
2144 \begin_layout Itemize
2145 Only available with subframe flag false.
2148 \begin_layout Subsection
2152 \begin_layout Standard
2153 Host memory handling (extra memory saved to savestates).
2154 Host memory starts empty.
2157 \begin_layout Subsubsection
2158 read(number address)
2161 \begin_layout Standard
2162 Reads hostmemory slot address.
2163 Slot numbers out of range return false instead of numeric.
2166 \begin_layout Subsubsection
2167 write(number address, number value)
2170 \begin_layout Standard
2171 Writes hostmemory slot with 0-255.
2172 Slot numbers out of range cause extension of host memory slot space.
2175 \begin_layout Subsubsection
2176 readbyte(number address)
2179 \begin_layout Standard
2180 Read unsigned byte (1 element) from given address.
2181 Slots out of range return false.
2184 \begin_layout Subsubsection
2185 writebyte(number address, number value)
2188 \begin_layout Standard
2189 Write unsigned byte (1 element) to given slot.
2190 Slot numbers out of range cause extension.
2193 \begin_layout Subsubsection
2194 readsbyte(number address)
2197 \begin_layout Standard
2198 Read signed byte (1 element) from given address.
2199 Slots out of range return false.
2202 \begin_layout Subsubsection
2203 writesbyte(number address, number value)
2206 \begin_layout Standard
2207 Write signed byte (1 element) to given slot.
2208 Slot numbers out of range cause extension.
2211 \begin_layout Subsubsection
2212 readword(number address)
2215 \begin_layout Standard
2216 Read unsigned word (2 elements) from given address.
2217 Slots out of range return false.
2220 \begin_layout Subsubsection
2221 writeword(number address, number value)
2224 \begin_layout Standard
2225 Write unsigned word (2 elements) to given slot.
2226 Slot numbers out of range cause extension.
2229 \begin_layout Subsubsection
2230 readsword(number address)
2233 \begin_layout Standard
2234 Read signed word (2 elements) from given address.
2235 Slots out of range return false.
2238 \begin_layout Subsubsection
2239 writesword(number address, number value)
2242 \begin_layout Standard
2243 Write signed word (2 elements) to given slot.
2244 Slot numbers out of range cause extension.
2247 \begin_layout Subsubsection
2248 readdword(number address)
2251 \begin_layout Standard
2252 Read unsigned doubleword (4 elements) from given address.
2253 Slots out of range return false.
2256 \begin_layout Subsubsection
2257 writedword(number address, number value)
2260 \begin_layout Standard
2261 Write unsigned doubleword (4 elements) to given slot.
2262 Slot numbers out of range cause extension.
2265 \begin_layout Subsubsection
2266 readsdword(number address)
2269 \begin_layout Standard
2270 Read signed doubleword (4 elements) from given address.
2271 Slots out of range return false.
2274 \begin_layout Subsubsection
2275 writesdword(number address, number value)
2278 \begin_layout Standard
2279 Write signed doubleword (4 elements) to given slot.
2280 Slot numbers out of range cause extension.
2283 \begin_layout Subsubsection
2284 readqword(number address)
2287 \begin_layout Standard
2288 Read unsigned quadword (8 elements) from given address.
2289 Slots out of range return false.
2292 \begin_layout Subsubsection
2293 writeqword(number address, number value)
2296 \begin_layout Standard
2297 Write unsigned quadword (4 elements) to given slot.
2298 Slot numbers out of range cause extension.
2301 \begin_layout Subsubsection
2302 readsqword(number address)
2305 \begin_layout Standard
2306 Read signed quadword (8 elements) from given address.
2307 Slots out of range return false.
2310 \begin_layout Subsubsection
2311 writesqword(number address, number value)
2314 \begin_layout Standard
2315 Write signed quadword (8 elements) to given slot.
2316 Slot numbers out of range cause extension.
2319 \begin_layout Subsection
2323 \begin_layout Standard
2327 \begin_layout Subsubsection
2328 movie.currentframe()
2331 \begin_layout Standard
2332 Return number of current frame.
2335 \begin_layout Subsubsection
2339 \begin_layout Standard
2340 Return number of frames in movie.
2343 \begin_layout Subsubsection
2347 \begin_layout Standard
2348 Return true if in readonly mode, false if in readwrite.
2351 \begin_layout Subsubsection
2352 movie.set_readwrite()
2355 \begin_layout Standard
2356 Set readwrite mode (does not cause on_readwrite callback).
2359 \begin_layout Subsubsection
2360 movie.frame_subframes(number frame)
2363 \begin_layout Standard
2364 Count number of subframes in specified frame (frame numbers are 1-based)
2368 \begin_layout Subsubsection
2369 movie.read_subframe(number frame, number subframe)
2372 \begin_layout Standard
2373 Read specifed subframe in specified frame and return data as array (100
2374 elements, numbered 0-99 currently).
2377 \begin_layout Subsection
2381 \begin_layout Standard
2382 Routines for settings manipulation
2385 \begin_layout Subsubsection
2389 \begin_layout Standard
2390 Get value of setting.
2391 If setting is blank, returns false.
2392 If setting value can't be obtained, returns (nil, error message).
2395 \begin_layout Subsubsection
2396 set(string name, string value)
2399 \begin_layout Standard
2400 Set value of setting.
2401 If setting can't be set, returns (nil, error message).
2404 \begin_layout Subsubsection
2408 \begin_layout Standard
2409 Returns if setting is set.
2410 If setting does not exist, returns (nil, error message).
2413 \begin_layout Subsubsection
2417 \begin_layout Standard
2418 Blanks a setting and returns true.
2419 If setting can't be blanked, returns (nil, error message).
2422 \begin_layout Subsection
2426 \begin_layout Standard
2427 Contains various functions for managing memory
2430 \begin_layout Subsubsection
2434 \begin_layout Standard
2435 Returns the number of VMAs
2438 \begin_layout Subsubsection
2439 read_vma(number index)
2442 \begin_layout Standard
2443 Reads the specified VMA (indices start from zero).
2444 Trying to read invalid VMA gives nil.
2445 The read VMA is table with the following fields:
2448 \begin_layout Itemize
2449 region_name (string): The readable name of the VMA
2452 \begin_layout Itemize
2453 baseaddr (number): Base address of the VMA
2456 \begin_layout Itemize
2457 lastaddr (number): Last address in the VMA.
2460 \begin_layout Itemize
2461 size (number): The size of VMA in bytes.
2464 \begin_layout Itemize
2465 readonly (boolean): True of the VMA corresponds to ROM.
2468 \begin_layout Itemize
2469 native_endian (boolean): True if the VMA has native endian as opposed to
2473 \begin_layout Subsubsection
2474 find_vma(number address)
2477 \begin_layout Standard
2478 Finds the VMA containing specified address.
2479 Returns table in the same format as read_vma or nil if not found.
2482 \begin_layout Subsubsection
2483 readbyte(number address)
2486 \begin_layout Standard
2487 Reads the specified address as unsigned byte and returns the result.
2490 \begin_layout Subsubsection
2491 readsbyte(number address)
2494 \begin_layout Standard
2495 Reads the specified address as signed byte and returns the result.
2498 \begin_layout Subsubsection
2499 writebyte(number address, number value)
2502 \begin_layout Standard
2503 Writes the specified value (negative values undergo 2's complement) to specified
2504 address (as a byte).
2507 \begin_layout Subsubsection
2508 readword(number address)
2511 \begin_layout Standard
2512 Reads the specified address as unsigned word and returns the result.
2515 \begin_layout Subsubsection
2516 readsword(number address)
2519 \begin_layout Standard
2520 Reads the specified address as signed word and returns the result.
2523 \begin_layout Subsubsection
2524 writeword(number address, number value)
2527 \begin_layout Standard
2528 Writes the specified value (negative values undergo 2's complement) to specified
2529 address (as a word).
2532 \begin_layout Subsubsection
2533 readdword(number address)
2536 \begin_layout Standard
2537 Reads the specified address as unsigned doubleword and returns the result.
2540 \begin_layout Subsubsection
2541 readsdword(number address)
2544 \begin_layout Standard
2545 Reads the specified address as signed doubleword and returns the result.
2548 \begin_layout Subsubsection
2549 writedword(number address, number value)
2552 \begin_layout Standard
2553 Writes the specified value (negative values undergo 2's complement) to specified
2554 address (as a doubleword).
2557 \begin_layout Subsubsection
2558 readqword(number address)
2561 \begin_layout Standard
2562 Reads the specified address as unsigned quadword and returns the result.
2565 \begin_layout Subsubsection
2566 readsqword(number address)
2569 \begin_layout Standard
2570 Reads the specified address as signed quadword and returns the result.
2573 \begin_layout Subsubsection
2574 writeqword(number address, number value)
2577 \begin_layout Standard
2578 Writes the specified value (negative values undergo 2's complement) to specified
2579 address (as a quadword).
2582 \begin_layout Subsection
2586 \begin_layout Standard
2587 Various callbacks to Lua that can occur.
2590 \begin_layout Subsubsection
2591 Callback: on_paint()
2594 \begin_layout Standard
2595 Called when screen is being painted.
2596 Any gui.* calls requiring graphic context draw on the screen.
2599 \begin_layout Subsubsection
2600 Callback: on_video()
2603 \begin_layout Standard
2604 Called when video dump frame is being painted.
2605 Any gui.* calls requiring graphic context draw on the video.
2608 \begin_layout Subsubsection
2609 Callback: on_startup()
2612 \begin_layout Standard
2613 Called when the emulator is starting (lsnes.rc and --run files has been run).
2616 \begin_layout Subsubsection
2617 Callback: on_pre_load(string name)
2620 \begin_layout Standard
2621 Called just before savestate/movie load occurs (note: loads are always delayed,
2622 so this occurs even when load was initiated by lua).
2625 \begin_layout Subsubsection
2626 Callback: on_err_load(string name)
2629 \begin_layout Standard
2630 Called if loadstate goes wrong.
2633 \begin_layout Subsubsection
2634 Callback: on_post_load(string name, boolean was_savestate)
2637 \begin_layout Standard
2638 Called on successful loadstate.
2639 was_savestate gives if this was a savestate or a movie.
2642 \begin_layout Subsubsection
2643 Callback: on_pre_save(string name, boolean is_savestate)
2646 \begin_layout Standard
2647 Called just before savestate save occurs (note: movie saves are synchronous
2648 and won't trigger these callbacks if called from Lua).
2651 \begin_layout Subsubsection
2652 Callback: on_err_save(string name)
2655 \begin_layout Standard
2656 Called if savestate goes wrong.
2659 \begin_layout Subsubsection
2660 Callback: on_post_save(string name, boolean is_savestate)
2663 \begin_layout Standard
2664 Called on successful savaestate.
2665 is_savestate gives if this was a savestate or a movie.
2668 \begin_layout Subsubsection
2672 \begin_layout Standard
2673 Called when emulator is shutting down.
2676 \begin_layout Subsubsection
2677 Callback: on_input(boolean subframe)
2680 \begin_layout Standard
2681 Called when emulator is just sending input to bsnes core.
2682 Warning: This is called even in readonly mode, but the results are ignored.
2685 \begin_layout Subsubsection
2686 Callback: on_reset()
2689 \begin_layout Standard
2690 Called when SNES is reset.
2693 \begin_layout Subsubsection
2694 Callback: on_readwrite()
2697 \begin_layout Standard
2698 Called when moving into readwrite mode as result of
2699 \begin_inset Quotes eld
2703 \begin_inset Quotes erd
2706 command (note: moving to rwmode by Lua won't trigger this, as per recursive
2710 \begin_layout Subsubsection
2711 Callback: on_snoop(number port, number controller, number index, number
2715 \begin_layout Standard
2716 Called each time bsnes asks for input.
2717 The value is the final value to be sent to bsnes core (readonly mode, autohold
2718 and autofire have been taken into account).
2719 Might be useful when translating movies to format suitable for console
2721 Note: There is no way to modify the value to be sent.
2724 \begin_layout Section
2725 Modifier and key names:
2728 \begin_layout Subsection
2732 \begin_layout Subsubsection
2736 \begin_layout Standard
2737 Following modifier names are known:
2740 \begin_layout Itemize
2741 ctrl, lctrl, rctrl: Control keys
2744 \begin_layout Itemize
2745 alt, lalt, ralt: ALT keys.
2748 \begin_layout Itemize
2749 shift, lshift, rshift: Shift keys.
2752 \begin_layout Itemize
2753 meta, lmeta, rmeta: Meta keys.
2756 \begin_layout Itemize
2757 num, caps: Numlock/Capslock (these are sticky!)
2760 \begin_layout Itemize
2764 \begin_layout Subsubsection
2768 \begin_layout Standard
2769 Following key names are known:
2772 \begin_layout Itemize
2773 backspace, tab, clear, return, pause, escape, space, exclaim, quotedbl,
2774 hash, dollar, ampersand, quote, leftparen, rightparen, asterisk, plus,
2775 comma, minus, period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon,
2776 less, equals, greater, question, at, leftbracket, backslash, rightbracket,
2777 caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n,
2778 o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0, world_1, world_2,
2779 world_3, world_4, world_5, world_6, world_7, world_8, world_9, world_10,
2780 world_11, world_12, world_13, world_14, world_15, world_16, world_17, world_18,
2781 world_19, world_20, world_21, world_22, world_23, world_24, world_25, world_26,
2782 world_27, world_28, world_29, world_30, world_31, world_32, world_33, world_34,
2783 world_35, world_36, world_37, world_38, world_39, world_40, world_41, world_42,
2784 world_43, world_44, world_45, world_46, world_47, world_48, world_49, world_50,
2785 world_51, world_52, world_53, world_54, world_55, world_56, world_57, world_58,
2786 world_59, world_60, world_61, world_62, world_63, world_64, world_65, world_66,
2787 world_67, world_68, world_69, world_70, world_71, world_72, world_73, world_74,
2788 world_75, world_76, world_77, world_78, world_79, world_80, world_81, world_82,
2789 world_83, world_84, world_85, world_86, world_87, world_88, world_89, world_90,
2790 world_91, world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3, kp4,
2791 kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide, kp_multiply, kp_minus, kp_plus,
2792 kp_enter, kp_equals, up, down, right, left, insert, home, end, pageup,
2793 pagedown, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14,
2794 f15, numlock, capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt,
2795 lalt, rmeta, lmeta, lsuper, rsuper, mode, compose, help, print, sysreq,
2796 break, menu, power, euro, undo
2799 \begin_layout Itemize
2800 Names of form 'key<n>' where <n> is 0-255 are interpretted as key having
2801 hardware-dependent scan code of <n> (useful to bind those keys that don't
2802 have symbolic names).
2805 \begin_layout Standard
2806 In addition, following pseudo-keys are known (note: these do not work in
2807 conjunction with modifers):
2810 \begin_layout Itemize
2811 joystick<num>button<button>: Joystick <num> (0-based) button <button> (0-based).
2814 \begin_layout Itemize
2815 joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat> (0-based) up.
2818 \begin_layout Itemize
2819 joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat> (0-based) left.
2822 \begin_layout Itemize
2823 joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat> (0-based) down.
2826 \begin_layout Itemize
2827 joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat> (0-based) right.
2830 \begin_layout Itemize
2831 joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis> negative
2832 position (axis modes axis and axis_inverse).
2835 \begin_layout Itemize
2836 joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis> positive
2837 position (axis modes axis and axis_inverse).
2840 \begin_layout Itemize
2841 joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis> pressure (axis
2845 \begin_layout Subsubsection
2849 \begin_layout Itemize
2850 Escape: Enter/Exit Command mode, cancel modal dialogs.
2853 \begin_layout Itemize
2854 Return (also KPEnter): Execute command, ok modal dialog.
2857 \begin_layout Itemize
2858 Pgup/Up (also KP8/9 if no num lock; command mode): Previous command in command
2862 \begin_layout Itemize
2863 Pgdn/Down(also KP2/3 if no num lock; command mode): Next command in command
2867 \begin_layout Itemize
2868 Home (also KP7 if no num lock; command mode): Beginning of command.
2871 \begin_layout Itemize
2872 End (also KP1 if no num lock; command mode): End of command.
2875 \begin_layout Itemize
2876 Left (also KP4 if no num lock; command mode): Move cursor left.
2879 \begin_layout Itemize
2880 Right (also KP6 if no num lock; command mode): Move cursor right.
2883 \begin_layout Itemize
2885 if no num lock; command mode): Delete character to right of cursor.
2888 \begin_layout Itemize
2889 Insert (also KP0 if no num lock; command mode): Toggle between insert /
2893 \begin_layout Itemize
2894 Backspace (command mode): Delete character to left of cursor.
2897 \begin_layout Itemize
2898 LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump corrupted!).
2901 \begin_layout Subsubsection
2905 \begin_layout Standard
2906 If emulator does not reach internal polling loop in 15 seconds after leaving
2907 it or 15 seconds after starting, the emulator instantly bombs out.
2910 \begin_layout Section
2914 \begin_layout Standard
2915 Movie file is .zip archive in itself, normal ZIP archive tools work on it
2916 (note: If you recompress it, do not use compression methods other than
2917 store and deflate and especially do not use encryption of any kind).
2920 \begin_layout Subsection
2921 Detecting clean start/SRAM/Savestate
2924 \begin_layout Itemize
2926 \begin_inset Quotes eld
2930 \begin_inset Quotes erd
2933 it is savestate, otherwise:
2936 \begin_layout Itemize
2937 If file has members with names starting
2938 \begin_inset Quotes eld
2942 \begin_inset Quotes erd
2945 it is movie starting from SRAM, otherwise:
2948 \begin_layout Itemize
2949 It is movie starting from clear state.
2952 \begin_layout Subsection
2956 \begin_layout Standard
2957 Type of game ROM and region (as one line).
2961 \begin_layout Standard
2962 \begin_inset Tabular
2963 <lyxtabular version="3" rows="8" columns="3">
2964 <features tabularvalignment="middle">
2965 <column alignment="center" valignment="top" width="0">
2966 <column alignment="center" valignment="top" width="0">
2967 <column alignment="center" valignment="top" width="0">
2969 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2972 \begin_layout Plain Layout
2978 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2981 \begin_layout Plain Layout
2987 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
2990 \begin_layout Plain Layout
2998 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3001 \begin_layout Plain Layout
3007 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3010 \begin_layout Plain Layout
3016 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3019 \begin_layout Plain Layout
3027 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3030 \begin_layout Plain Layout
3036 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3039 \begin_layout Plain Layout
3045 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3048 \begin_layout Plain Layout
3056 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3059 \begin_layout Plain Layout
3065 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3068 \begin_layout Plain Layout
3074 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3077 \begin_layout Plain Layout
3085 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3088 \begin_layout Plain Layout
3094 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3097 \begin_layout Plain Layout
3103 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3106 \begin_layout Plain Layout
3114 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3117 \begin_layout Plain Layout
3123 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3126 \begin_layout Plain Layout
3132 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3135 \begin_layout Plain Layout
3143 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3146 \begin_layout Plain Layout
3152 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3155 \begin_layout Plain Layout
3161 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3164 \begin_layout Plain Layout
3172 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3175 \begin_layout Plain Layout
3181 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3184 \begin_layout Plain Layout
3190 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3193 \begin_layout Plain Layout
3207 \begin_layout Standard
3211 \begin_layout Standard
3212 \begin_inset Tabular
3213 <lyxtabular version="3" rows="3" columns="2">
3214 <features tabularvalignment="middle">
3215 <column alignment="center" valignment="top" width="0">
3216 <column alignment="center" valignment="top" width="0">
3218 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3221 \begin_layout Plain Layout
3227 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3230 \begin_layout Plain Layout
3238 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3241 \begin_layout Plain Layout
3247 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3250 \begin_layout Plain Layout
3258 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3261 \begin_layout Plain Layout
3267 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3270 \begin_layout Plain Layout
3284 \begin_layout Subsection
3288 \begin_layout Standard
3289 Contains type of port #1 (as one line).
3290 Valid values are 'none', 'gamepad', 'multitap' and 'mouse'.
3291 If not present, defaults to 'gamepad'.
3294 \begin_layout Subsection
3298 \begin_layout Standard
3299 Contains type of port #2 (as one line).
3300 Valid values are 'none', 'gamepad', 'multitap', 'mouse', 'superscope',
3301 'justifier' and 'justifiers'.
3302 If not present, defaults to 'none'.
3305 \begin_layout Subsection
3309 \begin_layout Standard
3310 Contains name of the game (as one line).
3313 \begin_layout Subsection
3317 \begin_layout Standard
3318 Contains authors, one per line.
3319 Part before '|' is the full name, part after is the nickname.
3322 \begin_layout Subsection
3326 \begin_layout Standard
3328 \begin_inset Quotes eld
3332 \begin_inset Quotes erd
3336 Used to reject other saves.
3339 \begin_layout Subsection
3340 Member: controlsversion
3343 \begin_layout Standard
3345 \begin_inset Quotes eld
3349 \begin_inset Quotes erd
3353 Used to identify what controls are there.
3356 \begin_layout Subsection
3358 \begin_inset Quotes eld
3362 \begin_inset Quotes erd
3368 \begin_layout Standard
3369 Contains bsnes core version number (as one line).
3372 \begin_layout Subsection
3376 \begin_layout Standard
3377 Contains project ID (as one line).
3378 Used to identify if two movies are part of the same project.
3381 \begin_layout Subsection
3382 Member: {rom,slota,slotb}{,xml}.sha256
3385 \begin_layout Standard
3386 Contains SHA-256 of said ROM or ROM mapping file (as one line).
3387 Absent if corresponding file is absent.
3390 \begin_layout Subsection
3391 Member: moviesram.<name>
3394 \begin_layout Standard
3395 Raw binary startup SRAM of kind <name>.
3396 Only present in savestates and movies starting from SRAM.
3399 \begin_layout Subsection
3403 \begin_layout Standard
3404 Raw binary movie state data.
3405 Only present in savestates.
3408 \begin_layout Standard
3412 \begin_layout Itemize
3413 32 bytes: SHA-256 of project ID.
3416 \begin_layout Itemize
3417 8 bytes: Big-endian current frame.
3420 \begin_layout Itemize
3421 100x4 bytes: Poll counters for each control (bit31 of each is
3422 \begin_inset Quotes eld
3426 \begin_inset Quotes erd
3432 \begin_layout Itemize
3433 8 bytes: Big-endian lag frame count.
3436 \begin_layout Itemize
3437 32 bytes: SHA-256 of past input
3440 \begin_layout Itemize
3441 32 bytes: SHA-256 of previous.
3444 \begin_layout Itemize
3445 (total of 512 bytes)
3448 \begin_layout Subsection
3452 \begin_layout Standard
3453 Raw binary dump of host memory.
3454 Only present in savestates.
3457 \begin_layout Subsection
3461 \begin_layout Standard
3462 The raw binary savestate itself.
3463 Savestate detection uses this file, only present in savestates.
3466 \begin_layout Subsection
3470 \begin_layout Standard
3471 Screenshot of current frame.
3472 Only present in savestates.
3473 First 2 bytes are big-endian width of image, rest are 24-bit RGB image
3475 Height of image is inferred from the width and size of data.
3478 \begin_layout Subsection
3482 \begin_layout Standard
3483 Raw binary SRAM of kind <name> at time of savestate.
3484 Only present in savestates.
3487 \begin_layout Subsection
3491 \begin_layout Standard
3492 The actual input track, one line per subframe (blank lines are skipped).
3495 \begin_layout Itemize
3496 If the first byte of each line is '.', ' ', <tab> or '|', then the line is
3497 part of same frame as previous, otherwise it starts a new frame.
3500 \begin_layout Itemize
3501 First subframe must start a new frame.
3504 \begin_layout Standard
3505 Length of movie in frames is number of lines in input file that start a
3509 \begin_layout Subsection
3513 \begin_layout Standard
3514 Contains textual base-10 rerecord count (as one line; emulator just writes
3515 this, it doesn't read it) + 1.
3518 \begin_layout Subsection
3522 \begin_layout Standard
3523 This member stores set of load IDs.
3524 There is one load ID per rerecord (plus one corresponding to start of project).
3527 \begin_layout Itemize
3528 This member constists of concatenation of records
3531 \begin_layout Itemize
3532 Each record is 2-36 bytes long and can represent 1-16,843,009 consequtive
3536 \begin_layout Itemize
3537 IDs are interpretted as 256-bit big-endian integers with warparound.
3540 \begin_layout Itemize
3541 Initial predicted ID is all zeroes.
3544 \begin_layout Standard
3545 Format of each record is:
3548 \begin_layout Itemize
3549 1 byte: Opcode byte.
3550 Bits 0-4 are prefix length (prefixlen), bits 5-6 are count length (countlen).
3554 \begin_layout Itemize
3555 32-prefixlen bytes of ID.
3558 \begin_layout Itemize
3559 countlen bytes of big-endian count (count).
3562 \begin_layout Standard
3563 Records are processed as follows:
3566 \begin_layout Itemize
3567 To form the first ID encoded by record, take the first prefixlen bytes predicted
3568 ID and append the read ID value to it.
3569 The result is the first ID encoded.
3572 \begin_layout Itemize
3573 If countlen is 0, record encodes 1 ID.
3576 \begin_layout Itemize
3577 If countlen is 1, record encodes 2+count IDs.
3580 \begin_layout Itemize
3581 If countlen is 2, record encodes 258+count IDs.
3584 \begin_layout Itemize
3585 If countlen is 3, record encodes 65794+count IDs.
3588 \begin_layout Itemize
3589 The new predicted ID is the next ID after last one encoded by the record.
3592 \begin_layout Standard
3593 The number of rerecords + 1 is equal to the sum of number of IDs encoded
3597 \begin_layout Subsection
3598 Member: starttime.second
3601 \begin_layout Standard
3602 Movie starting time, second part.
3603 Epoch is Unix epoch.
3604 Default is 1,000,000,000.
3607 \begin_layout Subsection
3608 Member: starttime.subsecond
3611 \begin_layout Standard
3612 Movie starting time, subsecond part.
3613 Unit is 1/3,462,619,485,020 s.
3617 \begin_layout Subsection
3618 Member: savetime.second
3621 \begin_layout Standard
3622 Movie saving time, second part.
3623 Default is starttime.second.
3624 Only present in savestates.
3627 \begin_layout Subsection
3628 Member: savetime.subsecond
3631 \begin_layout Standard
3632 Movie saving time, subsecond part.
3633 Default is starttime.subsecond.
3634 Only present in savestates.
3637 \begin_layout Section
3641 \begin_layout Subsection
3645 \begin_layout Standard
3646 make ui=ui-libsnes profile=accuracy
3649 \begin_layout Subsection
3650 Prerequisite libraries:
3653 \begin_layout Itemize
3657 \begin_layout Itemize
3661 \begin_layout Itemize
3662 SDLmain (Windows/Mac OS X only; Note you may have to extract the object
3666 \begin_layout Itemize
3670 \begin_layout Itemize
3674 \begin_layout Itemize
3675 boost conversion (header only)
3678 \begin_layout Subsection
3679 Compile options to make:
3682 \begin_layout Subsubsection
3686 \begin_layout Standard
3687 Set path to BSNES bsnes directory to <path>.
3690 \begin_layout Subsubsection
3694 \begin_layout Standard
3695 Don't use threads on Linux.
3698 \begin_layout Subsubsection
3702 \begin_layout Standard
3703 Try to use threads even on non-Linux systems.
3706 \begin_layout Subsubsection
3710 \begin_layout Standard
3711 Target C++ compiler to use.
3712 Defaults to g++-4.5.
3715 \begin_layout Standard
3716 Note: If crosscompiling, this has to be crosscompiler.
3719 \begin_layout Subsubsection
3723 \begin_layout Standard
3724 Host C++ compiler to use.
3725 Defaults to the same as CC.
3728 \begin_layout Standard
3729 Note: If crosscompiling, that has to be host compiler (the files produced
3730 will be run in the build process!)
3733 \begin_layout Subsubsection
3737 \begin_layout Standard
3738 Assume BSNES uses compatiblity core instead of accuracy core.
3741 \begin_layout Subsubsection
3745 \begin_layout Standard
3746 Don't compile in Lua support.
3749 \begin_layout Subsubsection
3753 \begin_layout Standard
3754 Disable time() interception.
3755 Prevents recording games using RTC but allows building on some platforms,
3759 \begin_layout Subsubsection
3763 \begin_layout Standard
3764 Set graphics platform.
3765 Currently available choice is
3766 \begin_inset Quotes eld
3770 \begin_inset Quotes erd
3776 \begin_layout Subsubsection
3780 \begin_layout Standard
3782 Currently available choices are
3783 \begin_inset Quotes eld
3787 \begin_inset Quotes erd
3790 (requires SDL graphics),
3791 \begin_inset Quotes eld
3795 \begin_inset Quotes erd
3799 \begin_inset Quotes eld
3803 \begin_inset Quotes erd
3809 \begin_layout Subsubsection
3813 \begin_layout Standard
3814 Set joystick platform.
3815 Currently available choices are
3816 \begin_inset Quotes eld
3820 \begin_inset Quotes erd
3823 (requires SDL graphics) and
3824 \begin_inset Quotes eld
3828 \begin_inset Quotes erd
3834 \begin_layout Subsubsection
3838 \begin_layout Standard
3839 Disable searching for Lua.
3842 \begin_layout Subsubsection
3846 \begin_layout Standard
3847 Disable searching for SDL.
3850 \begin_layout Subsubsection
3854 \begin_layout Standard
3855 Don't link against libdl.
3858 \begin_layout Section
3859 Quick'n'dirty encode guide
3862 \begin_layout Enumerate
3863 Start the emulator and load the movie file.
3866 \begin_layout Enumerate
3867 Set large AVI option 'set-setting avi-large on'
3870 \begin_layout Enumerate
3871 If dumping PAL, set bottom border to 2 'set-setting avi-bottom-border 2'
3874 \begin_layout Enumerate
3875 Enable dumping 'dump-avi 12 tmpdump' (note: Normally 10 and above are
3876 \begin_inset Quotes eld
3879 use only if you know what you are doing.
3880 \begin_inset Quotes erd
3884 In this case, these can be safely used because of how x264 internally works.
3887 \begin_layout Enumerate
3888 Unpause and let it run until you want to end dumping.
3891 \begin_layout Enumerate
3892 Close the emulator (closing the window is the easiest way)
3895 \begin_layout Enumerate
3896 For each tmpdump*.avi file created, on command prompt, do 'x264 --crf 10
3897 -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
3900 \begin_layout Enumerate
3901 Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
3904 \begin_layout Enumerate
3905 Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv + tmpdump_0000001.mkv
3906 + tmpdump_0000002.mkv' (list every tmpdump_<numbers>.mkv, with + in between).
3909 \begin_layout Enumerate
3910 Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'.
3911 Now final.mkv contains quick'n'dirty encode.
3914 \begin_layout Section
3915 Axis configurations for some gamepad types:
3918 \begin_layout Subsection
3922 \begin_layout Standard
3923 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be set to pressure-+.
3926 \begin_layout LyX-Code
3927 set-axis joystick0axis2 pressure-+
3930 \begin_layout LyX-Code
3931 set-axis joystick0axis5 pressure-+
3934 \begin_layout Subsection
3936 \begin_inset Quotes eld
3940 \begin_inset Quotes erd
3946 \begin_layout Standard
3947 Axes 8-19 should be disabled.
3950 \begin_layout LyX-Code
3951 set-axis joystick0axis8 disabled
3954 \begin_layout LyX-Code
3955 set-axis joystick0axis9 disabled
3958 \begin_layout LyX-Code
3959 set-axis joystick0axis10 disabled
3962 \begin_layout LyX-Code
3963 set-axis joystick0axis11 disabled
3966 \begin_layout LyX-Code
3967 set-axis joystick0axis12 disabled
3970 \begin_layout LyX-Code
3971 set-axis joystick0axis13 disabled
3974 \begin_layout LyX-Code
3975 set-axis joystick0axis14 disabled
3978 \begin_layout LyX-Code
3979 set-axis joystick0axis15 disabled
3982 \begin_layout LyX-Code
3983 set-axis joystick0axis16 disabled
3986 \begin_layout LyX-Code
3987 set-axis joystick0axis17 disabled
3990 \begin_layout LyX-Code
3991 set-axis joystick0axis18 disabled
3994 \begin_layout LyX-Code
3995 set-axis joystick0axis19 disabled
3998 \begin_layout Section
4002 \begin_layout Subsection
4003 Problems from BSNES core:
4006 \begin_layout Itemize
4007 The whole pending save stuff.
4010 \begin_layout Itemize
4011 Delay resets are slow.
4014 \begin_layout Itemize
4015 RTC is not emulated in sync-stable manner.
4018 \begin_layout Itemize
4019 Lack of layer hiding.
4022 \begin_layout Itemize
4026 \begin_layout Itemize
4027 Firmwares can't be loaded from ZIP archives.
4030 \begin_layout Itemize
4031 Manual polls can be corrupted if savestate occurs during those.
4034 \begin_layout Subsection
4038 \begin_layout Itemize
4039 Modifiers don't work with pseudo-keys (SDL).
4042 \begin_layout Itemize
4043 Audio for last dumped frame is not itself dumped.
4046 \begin_layout Itemize
4047 Audio in UI is pretty bad in quality.
4050 \begin_layout Itemize
4051 UI itself is 30fps max.
4054 \begin_layout Itemize
4055 AVI compression levels 10-18 are not compatible with AVISynth AVISource.
4058 \begin_layout Itemize
4059 No menus, command based interface (SDL).
4062 \begin_layout Itemize
4063 Long commands don't scroll.
4066 \begin_layout Itemize
4067 The SDL screen drawing is slow.
4070 \begin_layout Section
4074 \begin_layout Subsection
4078 \begin_layout Itemize
4082 \begin_layout Itemize
4083 Fix dumper video corruption with levels 10-18.
4086 \begin_layout Subsection
4090 \begin_layout Itemize
4094 \begin_layout Itemize
4095 Lots of code cleanups
4098 \begin_layout Itemize
4099 Lua interface to settings
4102 \begin_layout Itemize
4103 Allow specifying AVI borders without Lua
4106 \begin_layout Itemize
4107 Fix scaling if vscale > 1 and originx > 0 (left border exists)
4110 \begin_layout Itemize
4111 on_snoop lua callback
4114 \begin_layout Itemize
4115 Faster movie loading and saving.
4118 \begin_layout Subsection
4122 \begin_layout Itemize
4126 \begin_layout Subsection
4130 \begin_layout Itemize
4134 \begin_layout Itemize
4135 Save jukebox functionality.
4138 \begin_layout Subsection
4142 \begin_layout Itemize
4143 Try to fix some nasty failing movie load edge cases
4146 \begin_layout Itemize
4147 Allow specifying scripts to run on command line.
4150 \begin_layout Subsection
4154 \begin_layout Itemize
4155 Major source code reorganization.
4158 \begin_layout Itemize
4159 Backup savestates before overwriting.
4162 \begin_layout Itemize
4163 Don't crash if loading initial state fails.
4166 \begin_layout Subsection
4170 \begin_layout Itemize
4174 \begin_layout Itemize
4175 Fix author name parsing
4178 \begin_layout Itemize
4179 Fix rerecord counting
4182 \begin_layout Itemize
4183 (SDL) Print messages to console if SDL is uninitialized
4186 \begin_layout Itemize
4187 Add movieinfo program
4190 \begin_layout Itemize
4191 Fix loading movies starting from SRAM.
4194 \begin_layout Subsection
4198 \begin_layout Itemize
4199 Add support for unattended dumping
4202 \begin_layout Itemize
4203 Fix compiling for Win32
4206 \begin_layout Itemize
4207 Don't lock up if sound can't be initialized
4210 \begin_layout Itemize
4211 Strip trailing CR from commands
4214 \begin_layout Itemize
4215 Don't try to do dubious things in global ctors (fix crash on startup)
4218 \begin_layout Subsection
4222 \begin_layout Itemize
4223 Small documentation tweaking
4226 \begin_layout Itemize
4230 \begin_layout Itemize
4231 Fix major bug in modifier matching
4234 \begin_layout Subsection
4238 \begin_layout Itemize
4239 Lots of documentation fixes
4242 \begin_layout Itemize
4243 Use dedicated callbacks for event backcomm., not commands.
4246 \begin_layout Itemize
4247 Ensure that the watchdog is not hit when executing delayed reset.
4250 \begin_layout Itemize
4251 Remove errant tab from joystick message.
4254 \begin_layout Subsection
4258 \begin_layout Itemize
4259 Make autofire operate in absolute time, not linear time
4262 \begin_layout Itemize
4263 Reinitialize controls when resuming from loadstate
4266 \begin_layout Itemize
4267 Some more code cleanups
4270 \begin_layout Itemize
4271 If Lua allocator fails, call OOM_panic()
4274 \begin_layout Itemize
4275 Byte/word/dword/qword sized host memory write/read functions.
4278 \begin_layout Itemize
4279 Dump at correct framerate if dumping interlaced NTSC (height=448).
4282 \begin_layout Subsection
4286 \begin_layout Itemize
4287 Actually include the complete source code
4290 \begin_layout Itemize
4294 \begin_layout Subsection
4298 \begin_layout Itemize
4299 Document {save,start}time.{,sub}second.
4302 \begin_layout Itemize
4303 Intercept time() from bsnes core.
4306 \begin_layout Subsection
4310 \begin_layout Itemize
4311 Allow disabling time() interception (allow build on Mac OS X)
4314 \begin_layout Itemize
4315 Use SDLMain on Mac OS X (make SDL not crash)
4318 \begin_layout Itemize
4319 Disable delayed resets (just plain too buggy for now).
4322 \begin_layout Itemize
4326 \begin_layout Itemize
4327 Use 16-bit for graphics/video instead of 32-bit.
4330 \begin_layout Itemize
4331 gui.rectangle/gui.pixel
4334 \begin_layout Itemize
4338 \begin_layout Itemize
4339 New CSCD writer implementation.
4342 \begin_layout Subsection
4346 \begin_layout Itemize
4347 Fix interaction of * and +.
4350 \begin_layout Itemize
4354 \begin_layout Itemize
4355 Use gettimeofday()/usleep(), these seem portable enough.
4358 \begin_layout Itemize
4359 Move joystick axis manipulation to keymapper code.
4362 \begin_layout Itemize
4363 Changes to how read-only works.
4366 \begin_layout Itemize
4367 Refactor controller input code.
4370 \begin_layout Subsection
4374 \begin_layout Itemize
4375 Fix mouseclick scale compensation.
4378 \begin_layout Itemize
4379 Draw area boundaries correctly in SDL code.
4382 \begin_layout Itemize
4386 \begin_layout Itemize
4387 Fix CSCD output (buffer overrun and race condition).
4390 \begin_layout Subsection
4394 \begin_layout Itemize
4395 JMD dumping support.
4398 \begin_layout Itemize
4399 Allow unattended dumping to JMD.
4402 \begin_layout Itemize
4406 \begin_layout Itemize
4407 Switch back to 32-bit colors.
4410 \begin_layout Itemize
4411 Add Lua function gui.color.
4414 \begin_layout Itemize
4415 Use some new C++11 features in GCC 4.6.
4418 \begin_layout Itemize
4419 Be prepared for core frequency changes.
4422 \begin_layout Itemize
4423 Pass colors in one chunk from Lua.