Refactor TCP dumping
[lsnes.git] / manual.lyx
blob451d6afb6ee5de3d949879685a8fcbe7d680e10f
1 #LyX 2.0 created this file. For more info see http://www.lyx.org/
2 \lyxformat 413
3 \begin_document
4 \begin_header
5 \textclass article
6 \use_default_options true
7 \maintain_unincluded_children false
8 \language finnish
9 \language_package default
10 \inputencoding auto
11 \fontencoding global
12 \font_roman default
13 \font_sans default
14 \font_typewriter default
15 \font_default_family default
16 \use_non_tex_fonts false
17 \font_sc false
18 \font_osf false
19 \font_sf_scale 100
20 \font_tt_scale 100
22 \graphics default
23 \default_output_format default
24 \output_sync 0
25 \bibtex_command default
26 \index_command default
27 \paperfontsize default
28 \use_hyperref false
29 \papersize default
30 \use_geometry false
31 \use_amsmath 1
32 \use_esint 1
33 \use_mhchem 1
34 \use_mathdots 1
35 \cite_engine basic
36 \use_bibtopic false
37 \use_indices false
38 \paperorientation portrait
39 \suppress_date false
40 \use_refstyle 1
41 \index Hakusana
42 \shortcut idx
43 \color #008000
44 \end_index
45 \secnumdepth 3
46 \tocdepth 3
47 \paragraph_separation indent
48 \paragraph_indentation default
49 \quotes_language english
50 \papercolumns 1
51 \papersides 1
52 \paperpagestyle default
53 \tracking_changes false
54 \output_changes false
55 \html_math_output 0
56 \html_css_as_file 0
57 \html_be_strict false
58 \end_header
60 \begin_body
62 \begin_layout Section
63 Introduction
64 \end_layout
66 \begin_layout Standard
67 lsnes is SNES rerecording emulator based on bsnes core.
68 \end_layout
70 \begin_layout Section
71 Dependencies
72 \end_layout
74 \begin_layout Enumerate
75 bsnes libsnes
76 \end_layout
78 \begin_deeper
79 \begin_layout Enumerate
80 v084 or 085
81 \end_layout
83 \begin_layout Enumerate
84 accuracy or compatiblity core.
85 \end_layout
87 \begin_layout Enumerate
88 Patched version (using included 6 patches)
89 \end_layout
91 \end_deeper
92 \begin_layout Enumerate
93 Zlib
94 \end_layout
96 \begin_layout Enumerate
97 boost_iostreams
98 \end_layout
100 \begin_layout Enumerate
101 boost_filesystem
102 \end_layout
104 \begin_layout Enumerate
105 boost_thread
106 \end_layout
108 \begin_layout Enumerate
109 libsdl (SDL only)
110 \end_layout
112 \begin_layout Enumerate
113 sdlmain (SDL only, part of SDL)
114 \end_layout
116 \begin_layout Enumerate
117 boost_conversion (this is header-only library)
118 \end_layout
120 \begin_layout Enumerate
121 libswscale (wxwidgets graphics only)
122 \end_layout
124 \begin_layout Enumerate
125 Portaudio (portaudio sound only)
126 \end_layout
128 \begin_layout Enumerate
129 std::thread and co (for threaded dumper only, not needed if std::thread
130  is available)
131 \end_layout
133 \begin_layout Enumerate
134 Lua (if Lua support is needed).
135 \end_layout
137 \begin_layout Itemize
138 Version 5.1.X or 5.2X.
139 \end_layout
141 \begin_layout Section
142 Building
143 \end_layout
145 \begin_layout Standard
146 Building is via makefile, the following options are available:
147 \end_layout
149 \begin_layout Itemize
150 CROSS_PREFIX=<prefix>
151 \end_layout
153 \begin_deeper
154 \begin_layout Itemize
155 Prefix to apply to commands when building executables / object files for
156  the target architecture.
158 \end_layout
160 \begin_layout Itemize
161 Default is blank.
162 \end_layout
164 \end_deeper
165 \begin_layout Itemize
166 CC=<name>
167 \end_layout
169 \begin_deeper
170 \begin_layout Itemize
171 Name of C++ compiler.
172 \end_layout
174 \begin_layout Itemize
175 CROSS_PREFIX is prepended if compiling for target architecture.
176 \end_layout
178 \begin_layout Itemize
179 This needs to be at least GCC 4.6.
180 \end_layout
182 \begin_layout Itemize
183 Set to 'g++-mp-4.6' if compiling on Mac OS X using GCC 4.6 from Macports.
184 \end_layout
186 \begin_layout Itemize
187 Default is 'g++'.
188 \end_layout
190 \end_deeper
191 \begin_layout Itemize
192 HOSTCC=<name>
193 \end_layout
195 \begin_deeper
196 \begin_layout Itemize
197 Name of host C++ compiler.
198 \end_layout
200 \begin_layout Itemize
201 Default is value of 'CC' option.
202 \end_layout
204 \end_deeper
205 \begin_layout Itemize
206 USER_HOSTCCFLAGS=<flags>:
207 \end_layout
209 \begin_deeper
210 \begin_layout Itemize
211 Compiler flags to pass when compiling/linking for host architecture.
212 \end_layout
214 \begin_layout Itemize
215 Default is blank.
216 \end_layout
218 \end_deeper
219 \begin_layout Itemize
220 USER_CFLAGS=<flags>
221 \end_layout
223 \begin_deeper
224 \begin_layout Itemize
225 Extra flags to pass when compiling for target architecture
226 \end_layout
228 \begin_layout Itemize
229 Default is blank.
230 \end_layout
232 \end_deeper
233 \begin_layout Itemize
234 USER_LDFLAGS=<flags>: 
235 \end_layout
237 \begin_deeper
238 \begin_layout Itemize
239 Extra flags to pass when linking for target architecture.
240 \end_layout
242 \begin_layout Itemize
243 Default is blank.
244 \end_layout
246 \end_deeper
247 \begin_layout Itemize
248 USER_PLATFORM_CFLAGS=<flags>
249 \end_layout
251 \begin_deeper
252 \begin_layout Itemize
253 Extra flags to pass when compiling files using platform-dependent code for
254  target architecture.
255 \end_layout
257 \begin_layout Itemize
258 Default is blank.
259 \end_layout
261 \end_deeper
262 \begin_layout Itemize
263 USER_PLATFORM_LDFLAGS=<flags>
264 \end_layout
266 \begin_deeper
267 \begin_layout Itemize
268 Extra flags to pass when linking files using platform-dependent code for
269  target architecture.
270 \end_layout
272 \begin_layout Itemize
273 Default is blank.
274 \end_layout
276 \end_deeper
277 \begin_layout Itemize
278 FONT_SRC=<file>
279 \end_layout
281 \begin_deeper
282 \begin_layout Itemize
283 Set the font file to use.
284 \end_layout
286 \begin_layout Itemize
287 Currently the valid values are:
288 \end_layout
290 \begin_deeper
291 \begin_layout Itemize
292 cp437.hex: Standard VGA font (256 characters).
293 \end_layout
295 \begin_layout Itemize
296 unifontfull-5.1.20080820.hex: GNU unifont (covers most of Unicode BMP)
297 \end_layout
299 \end_deeper
300 \begin_layout Itemize
301 Default is 'unifontfull-5.1.20080820.hex'
302 \end_layout
304 \end_deeper
305 \begin_layout Itemize
306 LUA=<package>
307 \end_layout
309 \begin_deeper
310 \begin_layout Itemize
311 Package to use for Lua support.
312 \end_layout
314 \begin_layout Itemize
315 Usually valid value is 'lua' or 'lua5.1'.
316 \end_layout
318 \begin_layout Itemize
319 Default is not to build Lua support.
320 \end_layout
322 \end_deeper
323 \begin_layout Itemize
324 THREADS=<value>
325 \end_layout
327 \begin_deeper
328 \begin_layout Itemize
329 Override platform default for dumper threading support.
330 \end_layout
332 \begin_layout Itemize
333 Threading is default on Linux.
334 \end_layout
336 \begin_layout Itemize
337 'YES' tries to use threading (std::thread).
338 \end_layout
340 \begin_layout Itemize
341 'BOOST' tries to use threading (boost::thread).
342 \end_layout
344 \begin_layout Itemize
345 'NO' disables threading.
346 \end_layout
348 \begin_layout Itemize
349 Note: This has absolutely nothing to do with platform threading.
350 \end_layout
352 \end_deeper
353 \begin_layout Itemize
354 BSNES_IS_COMPAT=<anything>
355 \end_layout
357 \begin_deeper
358 \begin_layout Itemize
359 Signals that BSNES core used is compatiblity core, not accuracy core.
360 \end_layout
362 \begin_layout Itemize
363 Default is to assume accuracy core.
364 \end_layout
366 \end_deeper
367 \begin_layout Itemize
368 JOYSTICK=<implementation>
369 \end_layout
371 \begin_deeper
372 \begin_layout Itemize
373 Set joystick implementation.
374  Valid values are:
375 \end_layout
377 \begin_deeper
378 \begin_layout Itemize
379 SDL: Use SDL for joystick (requires SDL graphics)
380 \end_layout
382 \begin_layout Itemize
383 EVDEV: Use EVDEV for joystick (Linux only).
384 \end_layout
386 \begin_layout Itemize
387 DUMMY: Disable joystick support.
388 \end_layout
390 \end_deeper
391 \begin_layout Itemize
392 Default is SDL.
393 \end_layout
395 \end_deeper
396 \begin_layout Itemize
397 SOUND=<implementation>
398 \end_layout
400 \begin_deeper
401 \begin_layout Itemize
402 Set sound implementation.
403  Valid values are:
404 \end_layout
406 \begin_deeper
407 \begin_layout Itemize
408 SDL: Use SDL for sound (requires SDL graphics)
409 \end_layout
411 \begin_layout Itemize
412 PORTAUDIO: Use Portaudio for sound.
413 \end_layout
415 \begin_layout Itemize
416 DUMMY: Disable sound support
417 \end_layout
419 \end_deeper
420 \begin_layout Itemize
421 Default is SDL.
422 \end_layout
424 \end_deeper
425 \begin_layout Itemize
426 GRAPHICS=<implementation>
427 \end_layout
429 \begin_deeper
430 \begin_layout Itemize
431 Set windowing library to use.
432  Valid values are:
433 \end_layout
435 \begin_deeper
436 \begin_layout Itemize
437 SDL: Use SDL for graphics
438 \end_layout
440 \begin_layout Itemize
441 WXWIDGETS: Use wxWidgets for graphics.
442 \end_layout
444 \end_deeper
445 \begin_layout Itemize
446 Default is SDL.
447 \end_layout
449 \end_deeper
450 \begin_layout Section
451 Command line options
452 \end_layout
454 \begin_layout Subsection
455 ROM options
456 \end_layout
458 \begin_layout Standard
459 <kind> in the following can be one of:
460 \end_layout
462 \begin_layout Itemize
463 rom: Cartridge ROM (BIOS for special carts).
464  This is required.
465 \end_layout
467 \begin_layout Itemize
468 bsx: BS-X (non-slotted) Game flash ROM.
469 \end_layout
471 \begin_layout Itemize
472 bsxslotted: BS-X (slotted) Game flash ROM.
473 \end_layout
475 \begin_layout Itemize
476 dmg: DMG game ROM
477 \end_layout
479 \begin_layout Itemize
480 slot-a: Sufami Turbo Slot A ROM
481 \end_layout
483 \begin_layout Itemize
484 slot-b: Sufami Turbo Slot B ROM
485 \end_layout
487 \begin_layout Subsubsection
488 --<kind>=<file> (lsnes/SDL, lsnes-avidump)
489 \end_layout
491 \begin_layout Standard
492 Load <file> as specified ROM (SFC/BS/DMG/ST file format).
493 \end_layout
495 \begin_layout Subsubsection
496 --<kind>-xml=<file> (lsnes/SDL, lsnes-avidump)
497 \end_layout
499 \begin_layout Standard
500 Override hardware detection for ROM, reading the values from <file> (BSNES
501  XML format).
502 \end_layout
504 \begin_layout Subsubsection
505 --ips-<kind>=<file> (lsnes/SDL, lsnes-avidump)
506 \end_layout
508 \begin_layout Standard
509 Apply BPS/IPS patch <file> to ROM <kind>.
510  If specified multiple times, the patches are applied in order.
511 \end_layout
513 \begin_layout Subsubsection
514 --ips-<kind>-xml=<file> (lsnes/SDL, lsnes-avidump)
515 \end_layout
517 \begin_layout Standard
518 Apply BPS/IPS patch <file> to XML of ROM <kind>.
519  If specified multiple times, the patches are applied in order.
520 \end_layout
522 \begin_layout Subsubsection
523 --ips-offset=<offset> (lsnes/SDL, lsnes-avidump)
524 \end_layout
526 \begin_layout Standard
527 Set offset to apply to IPS patches.
528  May be negative.
529  Handy for applying headered IPS patches (use offset of -512 for this).
530  The offset must be 0 for BPS patches.
531 \end_layout
533 \begin_layout Subsubsection
534 --pal
535 \end_layout
537 \begin_layout Standard
538 Force ROM to be considered PAL-only.
539 \end_layout
541 \begin_layout Itemize
542 Only works on SNES and SGB ROMs (not BS-X or Sufami Turbo).
543 \end_layout
545 \begin_layout Itemize
546 Attempting to load NTSC movie file will error out.
547 \end_layout
549 \begin_layout Subsubsection
550 --ntsc
551 \end_layout
553 \begin_layout Standard
554 Force ROM to be considered NTSC-only.
555 \end_layout
557 \begin_layout Itemize
558 Attempting to load PAL movie file will error out.
559 \end_layout
561 \begin_layout Subsection
562 Session options
563 \end_layout
565 \begin_layout Subsubsection
566 <filename> (lsnes/SDL, lsnes-avidump, movieinfo)
567 \end_layout
569 \begin_layout Standard
570 Load <filename> as movie or savestate file.
571  All other session options are ignored.
572 \end_layout
574 \begin_layout Subsubsection
575 --port1=<device> (lsnes/SDL)
576 \end_layout
578 \begin_layout Standard
579 Set type of port1.
580  Valid values are:
581 \end_layout
583 \begin_layout Itemize
584 none: No device connected
585 \end_layout
587 \begin_layout Itemize
588 gamepad: One gamepad (the default)
589 \end_layout
591 \begin_layout Itemize
592 multitap: Four gamepads (warning: makes most games refuse to start)
593 \end_layout
595 \begin_layout Itemize
596 mouse: Mouse.
597 \end_layout
599 \begin_layout Subsubsection
600 --port2=<type> (lsnes/SDL)
601 \end_layout
603 \begin_layout Standard
604 Set type of port2.
605  Valid values are:
606 \end_layout
608 \begin_layout Itemize
609 none: No device connected (the default)
610 \end_layout
612 \begin_layout Itemize
613 gamepad: One gamepad
614 \end_layout
616 \begin_layout Itemize
617 multitap: Four gamepads.
618 \end_layout
620 \begin_layout Itemize
621 mouse: Mouse
622 \end_layout
624 \begin_layout Itemize
625 superscope: Super Scope
626 \end_layout
628 \begin_layout Itemize
629 justifier: One justifier
630 \end_layout
632 \begin_layout Itemize
633 justifiers: Two justifiers
634 \end_layout
636 \begin_layout Subsubsection
637 --gamename=<name> (lsnes/SDL)
638 \end_layout
640 \begin_layout Standard
641 Set the name of game to <name>.
642  Default is blank.
643 \end_layout
645 \begin_layout Subsubsection
646 --author=<name> (lsnes/SDL)
647 \end_layout
649 \begin_layout Standard
650 Add author with full name of <name> (no nickname).
651 \end_layout
653 \begin_layout Subsubsection
654 --author=|<name> (lsnes/SDL)
655 \end_layout
657 \begin_layout Standard
658 Add author with nickname of <name> (no full name).
659 \end_layout
661 \begin_layout Subsubsection
662 --author=<fullname>|<nickname> (lsnes/SDL)
663 \end_layout
665 \begin_layout Standard
666 Add author with full name of <fullname> and nickname of <nickname>.
667 \end_layout
669 \begin_layout Subsubsection
670 --rtc-second=<value> (lsnes/SDL)
671 \end_layout
673 \begin_layout Standard
674 Set RTC second (0 is 1st January 1970 00:00:00Z).
675  Default is 1,000,000,000.
676 \end_layout
678 \begin_layout Subsubsection
679 --rtc-subsecond=<value> (lsnes/SDL)
680 \end_layout
682 \begin_layout Standard
683 Set RTC subsecond.
684  Range is 0-.
685  Unit is CPU cycle.
686  Default is 0.
687 \end_layout
689 \begin_layout Subsection
690 Misc.
691  options:
692 \end_layout
694 \begin_layout Subsubsection
695 --run=<file> (lsnes/SDL)
696 \end_layout
698 \begin_layout Standard
699 After running main RC file, run this file.
700  If multiple are specified, these execute in order specified.
701 \end_layout
703 \begin_layout Subsection
704 dump options (lsnes-dumpavi only)
705 \end_layout
707 \begin_layout Subsubsection
708 --dumper=<dumper>
709 \end_layout
711 \begin_layout Standard
712 Set the dumper to use (required).
713  Use 'list' for listing of known dumpers.
714 \end_layout
716 \begin_layout Subsubsection
717 --mode=<mode>
718 \end_layout
720 \begin_layout Standard
721 Set the mode to use (required for dumpers with multiple modes, forbidden
722  otherwise).
723  Use 'list' for known modes.
724 \end_layout
726 \begin_layout Subsubsection
727 --prefix=<prefix>
728 \end_layout
730 \begin_layout Standard
731 Set dump prefix.
732  Default is 
733 \begin_inset Quotes eld
734 \end_inset
736 avidump
737 \begin_inset Quotes erd
738 \end_inset
741 \end_layout
743 \begin_layout Subsubsection
744 --option=<name>=<value>
745 \end_layout
747 \begin_layout Standard
748 Set option <name> to value <value>.
749 \end_layout
751 \begin_layout Subsubsection
752 --length=<length>
753 \end_layout
755 \begin_layout Standard
756 Set number of frames to dump.
757  Mandatory.
758 \end_layout
760 \begin_layout Subsubsection
761 --lua=<script>
762 \end_layout
764 \begin_layout Standard
765 Run specified lua script (lsnes-dumpavi does not have initialization files).
766 \end_layout
768 \begin_layout Subsubsection
769 --load-library=<library>
770 \end_layout
772 \begin_layout Standard
773 Load the specified shared object / dynamic library / dynamic link library.
774 \end_layout
776 \begin_layout Section
777 Startup file lsnes.rc
778 \end_layout
780 \begin_layout Standard
781 Upon startup, lsnes (lsnes/SDL only) executes file lsnes.rc as commands.
782  This file is located in:
783 \end_layout
785 \begin_layout Itemize
786 Windows: %APPDATA%
787 \backslash
788 lsnes
789 \backslash
790 lsnes.rc (if %APPDATA% exists)
791 \end_layout
793 \begin_layout Itemize
794 Unix: $XDG_CONFIG_HOME/lsnes/lsnes.rc (if $XDG_CONFIG_HOME exists)
795 \end_layout
797 \begin_layout Itemize
798 Unix: $HOME/.config/lsnes/lsnes.rc (if $HOME exists)
799 \end_layout
801 \begin_layout Itemize
802 All: ./lsnes.rc (fallback default).
803 \end_layout
805 \begin_layout Standard
806 If leading directories do not exist, attempt to create them is made.
807 \end_layout
809 \begin_layout Section
810 Internal commands
811 \end_layout
813 \begin_layout Itemize
814 Commands beginning with '*' invoke the corresponding command without alias
815  expansion.
816 \end_layout
818 \begin_layout Itemize
819 If command starts with '+' (after possible '*'), the command is executed
820  as-is when button is pressed, and when button is released, it is executed
821  with '+' replaced by '-'.
822 \end_layout
824 \begin_layout Itemize
825 Commands without '+' execute only on negative edge (release).
826 \end_layout
828 \begin_layout Subsection
829 Settings:
830 \end_layout
832 \begin_layout Standard
833 Settings control various aspects of emulator behaviour.
834 \end_layout
836 \begin_layout Subsubsection
837 set-setting <setting> <value>
838 \end_layout
840 \begin_layout Standard
841 Sets setting <setting> to value <value> (may be empty).
842 \end_layout
844 \begin_layout Subsubsection
845 unset-setting <setting>
846 \end_layout
848 \begin_layout Standard
849 Try to unset setting <setting> (not all settings can be unset).
850 \end_layout
852 \begin_layout Subsubsection
853 get-setting <setting>
854 \end_layout
856 \begin_layout Standard
857 Read value of setting <setting>
858 \end_layout
860 \begin_layout Subsubsection
861 show-settings
862 \end_layout
864 \begin_layout Standard
865 Print names and values of all settings.
866 \end_layout
868 \begin_layout Subsection
869 Keybindings
870 \end_layout
872 \begin_layout Standard
873 Keybindings bind commands or aliases to keys (or pseudo-keys).
875 \end_layout
877 \begin_layout Standard
878 Notes:
879 \end_layout
881 \begin_layout Itemize
882 Do not bind edge active (+/-) commands to keys with modifiers, that won't
883  work right!
884 \end_layout
886 \begin_layout Itemize
887 Names of keys and modifiers are platform-dependent.
888 \end_layout
890 \begin_layout Itemize
891 Be careful before binding pseudo-keys (such as joystick axes, buttons or
892  hats) with modifiers.
893  That may or may not work right.
894 \end_layout
896 \begin_layout Subsubsection
897 bind-key [<mod>/<modmask>] <key> <command>
898 \end_layout
900 \begin_layout Standard
901 Bind <command> to key <key> (activating if modifiers in <modmask> (comma-seperat
902 ed list) are set as <mod> (comma-seperated list).
903 \end_layout
905 \begin_layout Standard
906 The names of keys and modifiers are platform-dependent.
907 \end_layout
909 \begin_layout Subsubsection
910 unbind-key [<mod>/<modmask>] <key>
911 \end_layout
913 \begin_layout Standard
914 Unbind command from <key> (with specified <mod> and <modmask>).
915 \end_layout
917 \begin_layout Subsubsection
918 set-axis <axis> [disabled | axis | axis-inverse | pressure0- | pressure0+
919  | pressure-0 | pressure-+ | pressure+0 | pressure+-] [minus=<val>] [zero=<val>]
920  [plus=<val>] [tolerance=<val>]
921 \end_layout
923 \begin_layout Standard
924 Set axis parameters for axis <axis>.
925 \end_layout
927 \begin_layout Itemize
928 disabled: Disable axis
929 \end_layout
931 \begin_layout Itemize
932 axis: Normal axis
933 \end_layout
935 \begin_layout Itemize
936 axis-inverse: Inverse axis
937 \end_layout
939 \begin_layout Itemize
940 pressure0-: Pressure sensitive.
941  Released at 0, pressed at -.
942 \end_layout
944 \begin_layout Itemize
945 pressure0+: Pressure sensitive.
946  Released at 0, pressed at +.
947 \end_layout
949 \begin_layout Itemize
950 pressure-0: Pressure sensitive.
951  Released at -, pressed at 0.
952 \end_layout
954 \begin_layout Itemize
955 pressure-+: Pressure sensitive.
956  Released at -, pressed at +.
957 \end_layout
959 \begin_layout Itemize
960 pressure+0: Pressure sensitive.
961  Released at +, pressed at 0.
962 \end_layout
964 \begin_layout Itemize
965 pressure+-: Pressure sensitive.
966  Released at +, pressed at -.
967 \end_layout
969 \begin_layout Itemize
970 minus=<val>: Calibration at extreme minus position (-32768-32767)
971 \end_layout
973 \begin_layout Itemize
974 zero=<val>: Calibration at neutral position (-32768-32767)
975 \end_layout
977 \begin_layout Itemize
978 plus=<val>: Calibration at extreme plus position (-32768-32767)
979 \end_layout
981 \begin_layout Itemize
982 tolerance=<value>: Center band tolerance (0<x<1).
983  The smaller the value, the more sensitive the control is.
984 \end_layout
986 \begin_layout Subsubsection
987 show-bindings
988 \end_layout
990 \begin_layout Standard
991 Print all key bindings in effect.
992 \end_layout
994 \begin_layout Subsection
995 Aliases
996 \end_layout
998 \begin_layout Standard
999 Aliases bind command to sequence of commands.
1000  After alias has been defined, it replaces the command it shadows.
1001 \end_layout
1003 \begin_layout Standard
1004 Notes:
1005 \end_layout
1007 \begin_layout Itemize
1008 You can't alias command to itself.
1009 \end_layout
1011 \begin_layout Itemize
1012 Aliases starting with +/- are edge active just like ordinary commands starting
1013  with +/-.
1014 \end_layout
1016 \begin_layout Itemize
1017 One command can be aliased to multiple commands.
1018 \end_layout
1020 \begin_layout Subsubsection
1021 alias-command <command> <expansion>
1022 \end_layout
1024 \begin_layout Standard
1025 Append <expansion> to alias <command>.
1026  If alias does not already exist, it is created.
1027 \end_layout
1029 \begin_layout Subsubsection
1030 unalias-command <command>
1031 \end_layout
1033 \begin_layout Standard
1034 Clear alias expansion for <command>.
1035 \end_layout
1037 \begin_layout Subsubsection
1038 show-aliases
1039 \end_layout
1041 \begin_layout Standard
1042 Print all aliases and their expansions in effect.
1043 \end_layout
1045 \begin_layout Subsection
1046 run-script <script>
1047 \end_layout
1049 \begin_layout Standard
1050 Run <script> as if commands were entered on the command line.
1051 \end_layout
1053 \begin_layout Subsection
1054 Video dumping
1055 \end_layout
1057 \begin_layout Standard
1058 Following commands control video dumping:
1059 \end_layout
1061 \begin_layout Subsubsection
1062 start-dump <dumper> [<mode>] <prefix/filename>
1063 \end_layout
1065 \begin_layout Standard
1066 Start dumping using dumper <dumper>.
1067  If mode is present or not and if prefix or filename is present depends
1068  on the dumper and dumper mode.
1069 \end_layout
1071 \begin_layout Standard
1072 The following dumpers are available:
1073 \end_layout
1075 \begin_layout Itemize
1076 INTERNAL-AVI-CSCD: Internal CSCD in .avi dumper.
1077 \end_layout
1079 \begin_deeper
1080 \begin_layout Itemize
1081 Mode: uncompressed/pcm: Uncompressed video, PCM audio.
1082  Takes prefix.
1083 \end_layout
1085 \begin_layout Itemize
1086 Mode: cscd/pcm: CSCD video, PCM audio.
1087  Takes prefix.
1088 \end_layout
1090 \end_deeper
1091 \begin_layout Itemize
1092 INTERNAL-JMD: Internal .jmd dumper.
1093 \end_layout
1095 \begin_deeper
1096 \begin_layout Itemize
1097 Does not take mode.
1098 \end_layout
1100 \begin_layout Itemize
1101 Takes a filename.
1102 \end_layout
1104 \end_deeper
1105 \begin_layout Itemize
1106 INTERNAL-RAW: Internal RAW dumper.
1107 \end_layout
1109 \begin_deeper
1110 \begin_layout Itemize
1111 Does not take mode.
1112 \end_layout
1114 \begin_layout Itemize
1115 Takes a prefix.
1116 \end_layout
1118 \begin_layout Itemize
1119 Sound is big-endian signed 16-bit, usually at 32040.5Hz.
1120 \end_layout
1122 \begin_layout Itemize
1123 Video is always upscaled to double resolution (512x448 / 512 x 478).
1124 \end_layout
1126 \begin_layout Itemize
1127 Video framerate is usually 322445/6448 fps for PAL and 10738636/178683 fps
1128  for NTSC.
1129 \end_layout
1131 \end_deeper
1132 \begin_layout Itemize
1133 INTERNAL-SDMP: Internal SDMP dumper.
1134 \end_layout
1136 \begin_deeper
1137 \begin_layout Itemize
1138 Mode 'ms': Multi-segment.
1139  Takes prefix.
1140 \end_layout
1142 \begin_layout Itemize
1143 Mode 'ss': Single-segment.
1144  Takes filename.
1145 \end_layout
1147 \end_deeper
1148 \begin_layout Subsubsection
1149 end-dump <dumper>
1150 \end_layout
1152 \begin_layout Standard
1153 End dumping using <dumper>
1154 \end_layout
1156 \begin_layout Subsubsection
1157 show-dumpers [<dumper>]
1158 \end_layout
1160 \begin_layout Standard
1161 Show the list of dumpers or list of modes for <dumper>
1162 \end_layout
1164 \begin_layout Subsection
1165 Memory manipulation
1166 \end_layout
1168 \begin_layout Standard
1169 <address> may be decimal or hexadecimal (prefixed with '0x').
1170  <value> can be hexadecimal (prefixed with '0x'), unsigned or signed (prefixed
1171  with '-') decimal.
1172 \end_layout
1174 \begin_layout Standard
1175 The available element <sizes> are:
1176 \end_layout
1178 \begin_layout Itemize
1179 byte: 1 byte
1180 \end_layout
1182 \begin_layout Itemize
1183 word: 2 bytes
1184 \end_layout
1186 \begin_layout Itemize
1187 dword: 4 bytes
1188 \end_layout
1190 \begin_layout Itemize
1191 qword: 8 bytes
1192 \end_layout
1194 \begin_layout Standard
1195 When reading RAM and ROM, multi-byte reads/writes are big-endian.
1196  When dealing with DSP memory, multi-byte reads/writes are native-endian
1197  (do not use operand sizes exceeding DSP bitness, except dword is OK for
1198  24-bit memory).
1199 \end_layout
1201 \begin_layout Subsubsection
1202 read-<size> <address>
1203 \end_layout
1205 \begin_layout Standard
1206 Read the value of byte in <address>.
1207 \end_layout
1209 \begin_layout Subsubsection
1210 read-s<size> <address>
1211 \end_layout
1213 \begin_layout Standard
1214 Read the value of signed byte in <address>.
1215 \end_layout
1217 \begin_layout Subsubsection
1218 write-<size> <address> <value>
1219 \end_layout
1221 \begin_layout Standard
1222 Write <value> to byte in address <address>.
1223 \end_layout
1225 \begin_layout Subsubsection
1226 search-memory reset
1227 \end_layout
1229 \begin_layout Standard
1230 Reset the memory search
1231 \end_layout
1233 \begin_layout Subsubsection
1234 search-memory count
1235 \end_layout
1237 \begin_layout Standard
1238 Print number of candidates remaining
1239 \end_layout
1241 \begin_layout Subsubsection
1242 search-memory print
1243 \end_layout
1245 \begin_layout Standard
1246 Print all candidates remaining
1247 \end_layout
1249 \begin_layout Subsubsection
1250 search-memory <usflag><sizeflag><op>
1251 \end_layout
1253 \begin_layout Standard
1254 Searches memory for addresses satisfying criteria.
1255 \end_layout
1257 \begin_layout Standard
1258 <usflag> can be:
1259 \end_layout
1261 \begin_layout Itemize
1262 u: unsigned
1263 \end_layout
1265 \begin_layout Itemize
1266 s: signed
1267 \end_layout
1269 \begin_layout Standard
1270 <sizeflag> can be:
1271 \end_layout
1273 \begin_layout Itemize
1274 b: byte
1275 \end_layout
1277 \begin_layout Itemize
1278 w: word
1279 \end_layout
1281 \begin_layout Itemize
1282 d: dword
1283 \end_layout
1285 \begin_layout Itemize
1286 q: qword
1287 \end_layout
1289 \begin_layout Standard
1290 <op> can be:
1291 \end_layout
1293 \begin_layout Itemize
1294 lt: < previous value.
1295 \end_layout
1297 \begin_layout Itemize
1298 le: <= previous value.
1299 \end_layout
1301 \begin_layout Itemize
1302 eq: = previous value.
1303 \end_layout
1305 \begin_layout Itemize
1306 ne: != previous value.
1307 \end_layout
1309 \begin_layout Itemize
1310 ge: >= previous value.
1311 \end_layout
1313 \begin_layout Itemize
1314 gt: > previous value.
1315 \end_layout
1317 \begin_layout Subsubsection
1318 search-memory <sizeflag> <value>
1319 \end_layout
1321 \begin_layout Standard
1322 Searches for addresses that currently have value <value>.
1323  <sizeflag> is as in previous command.
1324 \end_layout
1326 \begin_layout Subsection
1327 Main commands
1328 \end_layout
1330 \begin_layout Standard
1331 These commands are not available in lsnesrc, but are available after ROM
1332  has been loaded.
1333 \end_layout
1335 \begin_layout Subsubsection
1336 quit-emulator [/y]
1337 \end_layout
1339 \begin_layout Standard
1340 Quits the emulator (asking for confirmation).
1341  If /y is given, no confirmation is asked.
1342 \end_layout
1344 \begin_layout Subsubsection
1345 pause-emulator
1346 \end_layout
1348 \begin_layout Standard
1349 Toggle paused/unpaused
1350 \end_layout
1352 \begin_layout Subsubsection
1353 +advance-frame 
1354 \end_layout
1356 \begin_layout Standard
1357 Advance frame.
1358  If the button is still held after configurable timeout expires, game unpauses
1359  for the duration frame advance is held.
1360 \end_layout
1362 \begin_layout Subsubsection
1363 +advance-poll 
1364 \end_layout
1366 \begin_layout Standard
1367 Advance subframe.
1368  If the button is still held after configurable timeout expires, game unpauses
1369  for the duration frame advance is held.
1370 \end_layout
1372 \begin_layout Subsubsection
1373 advance-skiplag 
1374 \end_layout
1376 \begin_layout Standard
1377 Skip to first poll in frame after current.
1378 \end_layout
1380 \begin_layout Subsubsection
1381 reset 
1382 \end_layout
1384 \begin_layout Standard
1385 Reset the SNES after this frame.
1386 \end_layout
1388 \begin_layout Subsubsection
1389 load <filename> 
1390 \end_layout
1392 \begin_layout Standard
1393 Load savestate <filename> in current mode.
1394 \end_layout
1396 \begin_layout Subsubsection
1397 load-state <filename> 
1398 \end_layout
1400 \begin_layout Standard
1401 Load savestate <filename> in readwrite mode.
1402 \end_layout
1404 \begin_layout Subsubsection
1405 load-readonly <filename> 
1406 \end_layout
1408 \begin_layout Standard
1409 Load savestate <filename> in readonly mode.
1410 \end_layout
1412 \begin_layout Subsubsection
1413 load-preserve <filename> 
1414 \end_layout
1416 \begin_layout Standard
1417 Load savestate <filename> in readonly mode, preserving current events.
1418 \end_layout
1420 \begin_layout Subsubsection
1421 load-movie <filename> 
1422 \end_layout
1424 \begin_layout Standard
1425 Load savestate <filename>, ignoring save part in readonly mode.
1426 \end_layout
1428 \begin_layout Subsubsection
1429 save-state <filename> 
1430 \end_layout
1432 \begin_layout Standard
1433 Save system state to <filename> as soon as possible.
1434 \end_layout
1436 \begin_layout Subsubsection
1437 save-movie <filename> 
1438 \end_layout
1440 \begin_layout Standard
1441 Save movie to <filename>.
1442 \end_layout
1444 \begin_layout Subsubsection
1445 set-rwmode 
1446 \end_layout
1448 \begin_layout Standard
1449 Set read-write mode.
1450 \end_layout
1452 \begin_layout Subsubsection
1453 set-romode 
1454 \end_layout
1456 \begin_layout Standard
1457 Set read-only mode
1458 \end_layout
1460 \begin_layout Subsubsection
1461 toggle-rwmode 
1462 \end_layout
1464 \begin_layout Standard
1465 Toggle between read-only and read-write modes.
1466 \end_layout
1468 \begin_layout Subsubsection
1469 set-gamename <name> 
1470 \end_layout
1472 \begin_layout Standard
1473 Set name of the game to <name>
1474 \end_layout
1476 \begin_layout Subsubsection
1477 get-gamename 
1478 \end_layout
1480 \begin_layout Standard
1481 Print the name of the game.
1482 \end_layout
1484 \begin_layout Subsubsection
1485 add-author <author> 
1486 \end_layout
1488 \begin_layout Standard
1489 Adds new author <author>.
1490  If <author> does not contain '|' it is full name.
1491  If it contains '|', '|' splits the full name and nickname.
1492 \end_layout
1494 \begin_layout Subsubsection
1495 edit-author <num> <author> 
1496 \end_layout
1498 \begin_layout Standard
1499 Edit the author in slot <num> (0-based) to be <author> (see add-author for
1500  format)
1501 \end_layout
1503 \begin_layout Subsubsection
1504 remove-author <num> 
1505 \end_layout
1507 \begin_layout Standard
1508 Remove author in slot <num>
1509 \end_layout
1511 \begin_layout Subsubsection
1512 print-authors 
1513 \end_layout
1515 \begin_layout Standard
1516 Print authors.
1517 \end_layout
1519 \begin_layout Subsubsection
1520 test-1, test-2, test-3
1521 \end_layout
1523 \begin_layout Standard
1524 Internal test commands.
1525  Don't use.
1526 \end_layout
1528 \begin_layout Subsubsection
1529 take-screenshot <filename> 
1530 \end_layout
1532 \begin_layout Standard
1533 Save screenshot to <filename>.
1534 \end_layout
1536 \begin_layout Subsubsection
1537 +controller<num><button>
1538 \end_layout
1540 \begin_layout Standard
1541 Press button <button> on controller <num> (1-8).
1542  The following button names are known:
1543 \end_layout
1545 \begin_layout Itemize
1546 left
1547 \end_layout
1549 \begin_layout Itemize
1550 right
1551 \end_layout
1553 \begin_layout Itemize
1555 \end_layout
1557 \begin_layout Itemize
1558 down
1559 \end_layout
1561 \begin_layout Itemize
1563 \end_layout
1565 \begin_layout Itemize
1567 \end_layout
1569 \begin_layout Itemize
1571 \end_layout
1573 \begin_layout Itemize
1575 \end_layout
1577 \begin_layout Itemize
1579 \end_layout
1581 \begin_layout Itemize
1583 \end_layout
1585 \begin_layout Itemize
1586 select
1587 \end_layout
1589 \begin_layout Itemize
1590 start
1591 \end_layout
1593 \begin_layout Itemize
1594 trigger
1595 \end_layout
1597 \begin_layout Itemize
1598 cursor
1599 \end_layout
1601 \begin_layout Itemize
1602 pause
1603 \end_layout
1605 \begin_layout Itemize
1606 turbo
1607 \end_layout
1609 \begin_layout Subsubsection
1610 controllerh<num><button>
1611 \end_layout
1613 \begin_layout Standard
1614 Hold/unhold button <button> on controller <num> (1-8).
1615  See +controller for button names.
1616 \end_layout
1618 \begin_layout Subsubsection
1619 autofire (<pattern>|-)...
1620 \end_layout
1622 \begin_layout Standard
1623 Set autofire pattern.
1624  Each parameter is comma-separated list of button names (in form of 1start,
1625  1A, 2B, etc..) to hold on that frame.
1626  After reaching the end of pattern, the pattern restarts from the beginning.
1627 \end_layout
1629 \begin_layout Subsubsection
1630 repaint
1631 \end_layout
1633 \begin_layout Standard
1634 Force a repaint.
1635 \end_layout
1637 \begin_layout Subsection
1638 Save jukebox 
1639 \end_layout
1641 \begin_layout Subsubsection
1642 cycle-jukebox-backward
1643 \end_layout
1645 \begin_layout Standard
1646 Cycle save jukebox backwards.
1647 \end_layout
1649 \begin_layout Subsubsection
1650 cycle-jukebox-forward
1651 \end_layout
1653 \begin_layout Standard
1654 Cycle save jukebox forwards
1655 \end_layout
1657 \begin_layout Subsubsection
1658 add-jukebox-save <filename>
1659 \end_layout
1661 \begin_layout Standard
1662 Add <filename> to jukebox saves.
1663 \end_layout
1665 \begin_layout Subsubsection
1666 load-jukebox
1667 \end_layout
1669 \begin_layout Standard
1670 Do load from jukebox (current mode).
1671 \end_layout
1673 \begin_layout Subsubsection
1674 save-jukebox
1675 \end_layout
1677 \begin_layout Standard
1678 Do state save to jukebox.
1679 \end_layout
1681 \begin_layout Subsection
1682 Lua 
1683 \end_layout
1685 \begin_layout Standard
1686 Only available if lua support is compiled in.
1687 \end_layout
1689 \begin_layout Subsubsection
1690 evaluate-lua <luacode>
1691 \end_layout
1693 \begin_layout Standard
1694 Run Lua code <luacode> using built-in Lua interpretter.
1695 \end_layout
1697 \begin_layout Subsubsection
1698 run-lua <script>
1699 \end_layout
1701 \begin_layout Standard
1702 Run specified lua file using built-in Lua interpretter.
1703 \end_layout
1705 \begin_layout Subsection
1706 Memory watch
1707 \end_layout
1709 \begin_layout Subsubsection
1710 add-watch <name> <expression>
1711 \end_layout
1713 \begin_layout Standard
1714 Adds new watch (or modifies old one).
1715 \end_layout
1717 \begin_layout Subsubsection
1718 remove-watch <name>
1719 \end_layout
1721 \begin_layout Standard
1722 Remove a watch.
1723 \end_layout
1725 \begin_layout Subsection
1726 Sound 
1727 \end_layout
1729 \begin_layout Subsubsection
1730 enable-sound <on/off> 
1731 \end_layout
1733 \begin_layout Standard
1734 Enable/Disable sound.
1735 \end_layout
1737 \begin_layout Subsubsection
1738 set-sound-device <device> 
1739 \end_layout
1741 \begin_layout Standard
1742 Set sound device to <device>
1743 \end_layout
1745 \begin_layout Subsubsection
1746 show-sound-status 
1747 \end_layout
1749 \begin_layout Standard
1750 Show status of sound system.
1751 \end_layout
1753 \begin_layout Subsubsection
1754 show-sound-devices
1755 \end_layout
1757 \begin_layout Standard
1758 Show all available devices.
1759 \end_layout
1761 \begin_layout Subsubsection
1762 set-volume <multiplier>
1763 \end_layout
1765 \begin_layout Standard
1766 Set the volume multiplier to <multiplier>.
1767  1 is normal volume, and higher numbers are louder.
1768 \end_layout
1770 \begin_layout Subsubsection
1771 set-volume <multiplier>%
1772 \end_layout
1774 \begin_layout Standard
1775 Set the volume multiplier to <multiplier> percent.
1776  100 is normal volume, and higher numbers are louder.
1777 \end_layout
1779 \begin_layout Subsubsection
1780 set-volume <multiplier>dB
1781 \end_layout
1783 \begin_layout Standard
1784 Set the volume multiplier to <multiplier> dB.
1785  0 is normal volume, and higher numbers are louder.
1786  The value may be negative.
1787 \end_layout
1789 \begin_layout Subsection
1790 SDL Platform commands 
1791 \end_layout
1793 \begin_layout Standard
1794 The following are valid on SDL platform.
1795 \end_layout
1797 \begin_layout Subsubsection
1798 identify-key
1799 \end_layout
1801 \begin_layout Standard
1802 Asks to press a key and then identifies that (pseudo-)key.
1803 \end_layout
1805 \begin_layout Subsubsection
1806 toggle-console 
1807 \end_layout
1809 \begin_layout Standard
1810 Toggle between windowed/fullscreen console.
1811 \end_layout
1813 \begin_layout Subsubsection
1814 scroll-fullup 
1815 \end_layout
1817 \begin_layout Standard
1818 Scroll messages window as far back as it goes.
1819 \end_layout
1821 \begin_layout Subsubsection
1822 scroll-fulldown 
1823 \end_layout
1825 \begin_layout Standard
1826 Scroll messages window as far forward as it goes.
1827 \end_layout
1829 \begin_layout Subsubsection
1830 scroll-up 
1831 \end_layout
1833 \begin_layout Standard
1834 Scroll messages window back one screenful.
1835 \end_layout
1837 \begin_layout Subsubsection
1838 scroll-down 
1839 \end_layout
1841 \begin_layout Standard
1842 Scroll messages window forward one screenful.
1843 \end_layout
1845 \begin_layout Section
1846 Settings
1847 \end_layout
1849 \begin_layout Subsection
1850 Core settings
1851 \end_layout
1853 \begin_layout Subsubsection
1854 firmwarepath
1855 \end_layout
1857 \begin_layout Standard
1858 Set where bsnes looks for firmware files.
1859  Default is 
1860 \begin_inset Quotes eld
1861 \end_inset
1864 \begin_inset Quotes erd
1865 \end_inset
1868 \end_layout
1870 \begin_layout Subsubsection
1871 targetfps
1872 \end_layout
1874 \begin_layout Standard
1875 Set the target fps.
1876  Numeric, range is 0.001 to 
1877 \begin_inset Quotes eld
1878 \end_inset
1880 infinite
1881 \begin_inset Quotes erd
1882 \end_inset
1885  Default is native framerate.
1886 \end_layout
1888 \begin_layout Subsubsection
1889 savecompression
1890 \end_layout
1892 \begin_layout Standard
1893 Set save compression level (integer 0-9).
1894  Default is 7 (0 is no compression).
1895 \end_layout
1897 \begin_layout Subsubsection
1898 advance-timeout
1899 \end_layout
1901 \begin_layout Standard
1902 Set the frame advance timeout in milliseconds.
1903  Numeric integer, range is 0-999999999.
1904  Default is 500.
1905 \end_layout
1907 \begin_layout Subsection
1908 AVI dumper settings
1909 \end_layout
1911 \begin_layout Subsubsection
1912 avi-large
1913 \end_layout
1915 \begin_layout Standard
1916 AVI dumper: Always dump at 512x448 or 512x478 regardless of what the console
1917  outputs.
1918 \end_layout
1920 \begin_layout Subsubsection
1921 avi-left-border
1922 \end_layout
1924 \begin_layout Standard
1925 AVI dumper: Set the default left border thickness (unless lua overrides)
1926  for dumps.
1927  Range 0-8191.
1928  Default is 0.
1929 \end_layout
1931 \begin_layout Subsubsection
1932 avi-right-border
1933 \end_layout
1935 \begin_layout Standard
1936 AVI dumper: Set the default right border thickness (unless lua overrides)
1937  for dumps.
1938  Range 0-8191.
1939  Default is 0.
1940 \end_layout
1942 \begin_layout Subsubsection
1943 avi-top-border
1944 \end_layout
1946 \begin_layout Standard
1947 AVI dumper: Set the default top border thickness (unless lua overrides)
1948  for dumps.
1949  Range 0-8191.
1950  Default is 0.
1951 \end_layout
1953 \begin_layout Subsubsection
1954 avi-bottom-border
1955 \end_layout
1957 \begin_layout Standard
1958 AVI dumper: Set the default bottom border thickness (unless lua overrides)
1959  for dumps.
1960  Range 0-8191.
1961  Default is 0.
1962 \end_layout
1964 \begin_layout Subsubsection
1965 avi-maxframes
1966 \end_layout
1968 \begin_layout Standard
1969 AVI dumper: Maximum number of frames per dump segment (0 => unlimited).
1970  Range 0-999999999.
1971  Default is 0.
1972 \end_layout
1974 \begin_layout Subsubsection
1975 avi-compresison
1976 \end_layout
1978 \begin_layout Standard
1979 AVI dumper: Compression level (0-18).
1980 \end_layout
1982 \begin_layout Itemize
1983 Compression levels 10 and above are not compatible with stock CSCD codec.
1984 \end_layout
1986 \begin_layout Itemize
1987 Recomended level is 7.
1988 \end_layout
1990 \begin_layout Subsubsection
1991 avi-soundrate
1992 \end_layout
1994 \begin_layout Standard
1995 AVI dumper: Set method of determining the sound rate.
1996 \end_layout
1998 \begin_layout Itemize
1999 0: Pick nearest of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48, 64, 88.2, 96,
2000  128, 176.4 and 192 kHz.
2001 \end_layout
2003 \begin_layout Itemize
2004 1: Round down to nearest integer.
2005 \end_layout
2007 \begin_layout Itemize
2008 2: Round up to nearest ingeter.
2009 \end_layout
2011 \begin_layout Subsection
2012 JMD options
2013 \end_layout
2015 \begin_layout Subsubsection
2016 jmd-copression
2017 \end_layout
2019 \begin_layout Standard
2020 JMD dumper: Compression level (0-9).
2021 \end_layout
2023 \begin_layout Subsection
2024 SDL platform settings
2025 \end_layout
2027 \begin_layout Subsubsection
2028 autorepeat-first-delay
2029 \end_layout
2031 \begin_layout Standard
2032 Sets the delay for first character in typematic autorepeat.
2033 \end_layout
2035 \begin_layout Subsubsection
2036 autorepeat-subsequent-delay
2037 \end_layout
2039 \begin_layout Standard
2040 Sets the delay for subsequent characters in typematic autorepeat.
2041 \end_layout
2043 \begin_layout Section
2044 Lua functions
2045 \end_layout
2047 \begin_layout Subsection
2048 Core (in main table)
2049 \end_layout
2051 \begin_layout Subsubsection
2052 print
2053 \end_layout
2055 \begin_layout Standard
2056 Print line to message console.
2057 \end_layout
2059 \begin_layout Subsubsection
2060 exec(string command)
2061 \end_layout
2063 \begin_layout Standard
2064 Run command as it was entered on the command line
2065 \end_layout
2067 \begin_layout Subsubsection
2068 utime()
2069 \end_layout
2071 \begin_layout Standard
2072 Returns two values.
2073  First is time since some epoch in seconds, the second is microseconds mod
2074  10^6 since that epoch.
2075 \end_layout
2077 \begin_layout Subsubsection
2078 emulator_ready()
2079 \end_layout
2081 \begin_layout Standard
2082 Returns true if emulator has finished booting, false if not (on_startup()
2083  will be issued later).
2084 \end_layout
2086 \begin_layout Subsubsection
2087 set_idle_timeout(number timeout)
2088 \end_layout
2090 \begin_layout Standard
2091 Set number of microseconds to block idle for.
2092  After this timeout has expired, on_idle() will be called once.
2093 \end_layout
2095 \begin_layout Subsubsection
2096 set_timer_timeout(number timeout)
2097 \end_layout
2099 \begin_layout Standard
2100 Set number of microseconds to block timer for.
2101  After this timeout has expired, on_timer() will be called once.
2102 \end_layout
2104 \begin_layout Subsection
2105 Table bit:
2106 \end_layout
2108 \begin_layout Standard
2109 Bitwise logical functions and related.
2110 \end_layout
2112 \begin_layout Subsubsection
2113 bit.none(number...) / bit.bnot(number...)
2114 \end_layout
2116 \begin_layout Standard
2117 48-bit bitwise NOT / NONE function (set bits that are set in none of the
2118  arguments).
2119 \end_layout
2121 \begin_layout Subsubsection
2122 bit.any(number...) / bit.bor(number...)
2123 \end_layout
2125 \begin_layout Standard
2126 48-bit bitwise OR / ANY function (set bits that are set in any of the arguments).
2127 \end_layout
2129 \begin_layout Subsubsection
2130 bit.all(number...) / bit.band(number...)
2131 \end_layout
2133 \begin_layout Standard
2134 48-bit bitwise AND / ALL function (set bits that are set in all of the arguments
2136 \end_layout
2138 \begin_layout Subsubsection
2139 bit.parity(number...) / bit.bxor(number...)
2140 \end_layout
2142 \begin_layout Standard
2143 48-bit bitwise XOR / PARITY function (set bits that are set in odd number
2144  of the arguments).
2145 \end_layout
2147 \begin_layout Subsubsection
2148 bit.lrotate(number base[, number amount[, number bits]])
2149 \end_layout
2151 \begin_layout Standard
2152 Rotate bits-bit (max 48, default 48) number left by amount (default 1) places.
2153 \end_layout
2155 \begin_layout Subsubsection
2156 bit.rrotate(number base[, number amount[, number bits]])
2157 \end_layout
2159 \begin_layout Standard
2160 Rotate bits-bit (max 48, default 48) number right by amount (default 1)
2161  places.
2162 \end_layout
2164 \begin_layout Subsubsection
2165 bit.lshift(number base[, number amount[, number bits]])
2166 \end_layout
2168 \begin_layout Standard
2169 Shift bits-bit (max 48, default 48) number left by amount (default 1) places.
2170  The new bits are filled with zeroes.
2171 \end_layout
2173 \begin_layout Subsubsection
2174 bit.lrshift(number base[, number amount[, number bits]])
2175 \end_layout
2177 \begin_layout Standard
2178 Shift bits-bit (max 48, default 48) number logically right by amount (default
2179  1) places.
2180  The new bits are filled with zeroes.
2181 \end_layout
2183 \begin_layout Subsubsection
2184 bit.arshift(number base[, number amount[, number bits]])
2185 \end_layout
2187 \begin_layout Standard
2188 Shift bits-bit (max 48, default 48) number arithmetically right by amount
2189  (default 1) places.
2190  The new bits are shifted in with copy of the high bit.
2191 \end_layout
2193 \begin_layout Subsubsection
2194 bit.extract(number base[, number bit0[, number bit1,...]])
2195 \end_layout
2197 \begin_layout Standard
2198 Returns number that has bit0-th bit as bit 0, bit1-th bit as 1 and so on.
2199 \end_layout
2201 \begin_layout Standard
2202 Notes: 
2203 \end_layout
2205 \begin_layout Itemize
2206 Bit numbers up to 51 should work reliably (then things start falling apart
2207  due to double precision issues).
2208 \end_layout
2210 \begin_layout Itemize
2211 There are two special bit positions, true and false, standing for always
2212  set bit and always clear bit.
2213 \end_layout
2215 \begin_layout Subsubsection
2216 bit.value([number bit1[, number bit2,...]])
2217 \end_layout
2219 \begin_layout Standard
2220 Returns bitwise OR of 1 left shifted by bit1 places, 1 left shifted by bit2
2221  places and so on.
2222  As special value, nil argument is no-op.
2223 \end_layout
2225 \begin_layout Subsection
2226 Table gui:
2227 \end_layout
2229 \begin_layout Standard
2230 Most of these functions can only be called in on_paint and on_video callbacks.
2231  Exceptions are noted.
2232 \end_layout
2234 \begin_layout Standard
2235 Colors are 32-bit.
2236  Bits 0-7 are the blue component, bits 8-15 are the green component, bits
2237  16-23 are the red component, bits 24-31 are alpha component (0 is fully
2238  opaque, 255 is almost transparent).
2239  -1 is the fully transparent color.
2240  Alpha values greater than 127 do work.
2241 \end_layout
2243 \begin_layout Standard
2244 Origin of coordinates is at top left corner of game display area.
2245  Left and top gaps correspond to negative coordinates.
2246 \end_layout
2248 \begin_layout Subsubsection
2249 gui.resolution()
2250 \end_layout
2252 \begin_layout Standard
2253 Returns 2-tuple (hresolution, vresolution).
2254 \end_layout
2256 \begin_layout Subsubsection
2257 gui.<class>_gap(number gap)
2258 \end_layout
2260 \begin_layout Standard
2261 Set the <class> (left, right, top, bottom) gap to specified value (max gap
2262  is 8191).
2263 \end_layout
2265 \begin_layout Subsubsection
2266 gui.text(number x, number y, string text[, number fgc[, number bgc]])
2267 \end_layout
2269 \begin_layout Standard
2270 Draw specified text on the GUI (each character cell is 8 or 16 wide and
2271  16 high).
2272  Parameters:
2273 \end_layout
2275 \begin_layout Itemize
2276 x: X-coordinate to start the drawing from (and x-coordinate at begining
2277  of the lines).
2278 \end_layout
2280 \begin_layout Itemize
2281 y: Y-coordinate to start the drawing from.
2282 \end_layout
2284 \begin_layout Itemize
2285 text: The text to draw.
2286 \end_layout
2288 \begin_layout Itemize
2289 fgc: Text color (default is 0xFFFFFF (white))
2290 \end_layout
2292 \begin_layout Itemize
2293 bgc: Background color (default is -1 (transparent))
2294 \end_layout
2296 \begin_layout Subsubsection
2297 gui.textH(number x, number y, string text[, number fgc[, number bgc]])
2298 \end_layout
2300 \begin_layout Standard
2301 Like gui.text, but draw using double-width.
2302 \end_layout
2304 \begin_layout Subsubsection
2305 gui.textV(number x, number y, string text[, number fgc[, number bgc]])
2306 \end_layout
2308 \begin_layout Standard
2309 Like gui.text, but draw using double-height.
2310 \end_layout
2312 \begin_layout Subsubsection
2313 gui.textHV(number x, number y, string text[, number fgc[, number bgc]])
2314 \end_layout
2316 \begin_layout Standard
2317 Like gui.text, but draw using double-width/double-height.
2318 \end_layout
2320 \begin_layout Subsubsection
2321 gui.rectangle(number x, number y, number width, number height[, number thickness[
2322 , number outline[, number fill]]])
2323 \end_layout
2325 \begin_layout Standard
2326 Draw rectangle on the GUI.
2327  Parameters:
2328 \end_layout
2330 \begin_layout Itemize
2331 x: X-coordinate of left edge.
2332 \end_layout
2334 \begin_layout Itemize
2335 y: Y-coordinate of upper edge.
2336 \end_layout
2338 \begin_layout Itemize
2339 width: Width of rectangle.
2340 \end_layout
2342 \begin_layout Itemize
2343 height: Height of rectangle.
2344 \end_layout
2346 \begin_layout Itemize
2347 thickness: Thickness of outline (default is 1).
2348 \end_layout
2350 \begin_layout Itemize
2351 outline: Color of outline (default is 0xFFFFFF (white))
2352 \end_layout
2354 \begin_layout Itemize
2355 fill: Color of fil (default is -1 (transparent))
2356 \end_layout
2358 \begin_layout Subsubsection
2359 gui.pixel(number x, number y[, number color])
2360 \end_layout
2362 \begin_layout Standard
2363 Draw one pixel on the GUI.
2364  Parameters:
2365 \end_layout
2367 \begin_layout Itemize
2368 x: X-coordinate of the pixel
2369 \end_layout
2371 \begin_layout Itemize
2372 y: Y-coordinate of the pixel
2373 \end_layout
2375 \begin_layout Itemize
2376 color: Color of the pixel (default is 0xFFFFFF (white))
2377 \end_layout
2379 \begin_layout Subsubsection
2380 gui.crosshair(number x, number y[, number length[, number color]])
2381 \end_layout
2383 \begin_layout Standard
2384 Draw a crosshair.
2385  Parameters:
2386 \end_layout
2388 \begin_layout Itemize
2389 x: X-coordinate of the crosshair
2390 \end_layout
2392 \begin_layout Itemize
2393 y: Y-coordinate of the crosshair
2394 \end_layout
2396 \begin_layout Itemize
2397 length: Length of the crosshair lines (default 10).
2398 \end_layout
2400 \begin_layout Itemize
2401 color: Color of the crosshair (default is 0xFFFFFF (white))
2402 \end_layout
2404 \begin_layout Subsubsection
2405 gui.line(number x1, number y1, number x2, number y2[, number color])
2406 \end_layout
2408 \begin_layout Standard
2409 Draw a thin line.
2410  Parameters:
2411 \end_layout
2413 \begin_layout Itemize
2414 x1: X-coordinate of one end.
2415 \end_layout
2417 \begin_layout Itemize
2418 y1: Y-coordinate of one end.
2419 \end_layout
2421 \begin_layout Itemize
2422 x2: X-coordinate of the other end.
2423 \end_layout
2425 \begin_layout Itemize
2426 y2: Y-coordinate of the other end.
2427 \end_layout
2429 \begin_layout Itemize
2430 color: Color of the line (default is 0xFFFFFF (white)).
2431 \end_layout
2433 \begin_layout Subsubsection
2434 gui.circle(number x, number y, number r[, number thick[, number border[,
2435  number fil]]])
2436 \end_layout
2438 \begin_layout Standard
2439 Draw a circle.
2440  Parameters.
2441 \end_layout
2443 \begin_layout Itemize
2444 x: X-coordinate of the center
2445 \end_layout
2447 \begin_layout Itemize
2448 y: Y-coordinate of the center
2449 \end_layout
2451 \begin_layout Itemize
2452 r: The radius of the circle
2453 \end_layout
2455 \begin_layout Itemize
2456 thick: Border thickness
2457 \end_layout
2459 \begin_layout Itemize
2460 border: Border color (default is 0xFFFFFF (white))
2461 \end_layout
2463 \begin_layout Itemize
2464 fill: Fill color (default is -1 (transparent)).
2465 \end_layout
2467 \begin_layout Subsubsection
2468 gui.bitmap_draw(number x, number y, bitmap bitmap, palette palette)
2469 \end_layout
2471 \begin_layout Standard
2472 Draw a bitmap on screen with specified palette.
2473  Parameters:
2474 \end_layout
2476 \begin_layout Itemize
2477 x: X-coordinate of left edge.
2478 \end_layout
2480 \begin_layout Itemize
2481 y: Y-coordinate of top edge.
2482 \end_layout
2484 \begin_layout Itemize
2485 bitmap: The bitmap to draw
2486 \end_layout
2488 \begin_layout Itemize
2489 palette: The palette to draw the bitmap using.
2490 \end_layout
2492 \begin_layout Subsubsection
2493 gui.bitmap_draw(number x, number y, dbitmap bitmap)
2494 \end_layout
2496 \begin_layout Standard
2497 Draw a bitmap on screen.
2498  Parameters:
2499 \end_layout
2501 \begin_layout Itemize
2502 x: X-coordinate of left edge.
2503 \end_layout
2505 \begin_layout Itemize
2506 y: Y-coordinate of top edge.
2507 \end_layout
2509 \begin_layout Itemize
2510 bitmap: The bitmap to draw
2511 \end_layout
2513 \begin_layout Subsubsection
2514 gui.palette_new()
2515 \end_layout
2517 \begin_layout Standard
2518 Returns a new palette (initially all transparent).
2519  Can be used anywhere.
2520 \end_layout
2522 \begin_layout Subsubsection
2523 gui.bitmap_new(number w, number h, boolean direct[, bool icolor])
2524 \end_layout
2526 \begin_layout Standard
2527 Returns a new bitmap/dbitmap.
2528  Can be used anywhere.
2529  Parameters:
2530 \end_layout
2532 \begin_layout Itemize
2533 w: The width of new bitmap
2534 \end_layout
2536 \begin_layout Itemize
2537 h: The height of new bitmap
2538 \end_layout
2540 \begin_layout Itemize
2541 direct: If true, the returned bitmap is dbitmap, otherwise bitmap.
2542 \end_layout
2544 \begin_layout Itemize
2545 icolor: Initital fill color (defaults to 0 on BITMAP, -1 on DBITMAP)
2546 \end_layout
2548 \begin_layout Subsubsection
2549 gui.bitmap_load(string file)
2550 \end_layout
2552 \begin_layout Standard
2553 Returns loaded bitmap/dbitmap (if bitmap, the second return value is palette
2554  for bitmap).
2555  Can be used anywhere.
2556  Parameters:
2557 \end_layout
2559 \begin_layout Itemize
2560 file: The name of file to load.
2561 \end_layout
2563 \begin_layout Subsubsection
2564 gui.palette_set(palette palette, number index, number color)
2565 \end_layout
2567 \begin_layout Standard
2568 Sets color in palette.
2569  Can be used anywhere.
2570  Parameters:
2571 \end_layout
2573 \begin_layout Itemize
2574 palette: The palette to manipulate
2575 \end_layout
2577 \begin_layout Itemize
2578 index: Index of color (0-65535).
2579 \end_layout
2581 \begin_layout Itemize
2582 color: The color value.
2583 \end_layout
2585 \begin_layout Subsubsection
2586 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y, number color)
2587 \end_layout
2589 \begin_layout Standard
2590 Sets specified pixel in bitmap.
2591  Can be used anywhere.
2592  Parameters:
2593 \end_layout
2595 \begin_layout Itemize
2596 bitmap: The bitmap to manipulate
2597 \end_layout
2599 \begin_layout Itemize
2600 x: The x-coordinate of the pixel.
2601 \end_layout
2603 \begin_layout Itemize
2604 y: The y-coordinate of the pixel.
2605 \end_layout
2607 \begin_layout Itemize
2608 color: If bitmap is a bitmap, color index (0-65535).
2609  Otherwise color value.
2610 \end_layout
2612 \begin_layout Subsubsection
2613 gui.bitmap_size(bitmap/dbitmap bitmap)
2614 \end_layout
2616 \begin_layout Standard
2617 Get size of bitmap.
2618  Can be used anywhere.
2619  Parameters:
2620 \end_layout
2622 \begin_layout Itemize
2623 bitmap: The bitmap to query.
2624 \end_layout
2626 \begin_layout Standard
2627 The first return is the width, the second is the height.
2628 \end_layout
2630 \begin_layout Subsubsection
2631 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy, bitmap/dbitmap
2632  src, number sx, number sy, number w, number h[, number ck])
2633 \end_layout
2635 \begin_layout Standard
2636 Blit a part of bitmap to another.
2637  Can be used anywhere.
2638  Parameters:
2639 \end_layout
2641 \begin_layout Itemize
2642 dest: Destination to blit to.
2643 \end_layout
2645 \begin_layout Itemize
2646 dx: left edge of target
2647 \end_layout
2649 \begin_layout Itemize
2650 dy: Top edge of target
2651 \end_layout
2653 \begin_layout Itemize
2654 src: The source to blit from.
2655  Must be of the same type as destination.
2656 \end_layout
2658 \begin_layout Itemize
2659 sx: left edge of source
2660 \end_layout
2662 \begin_layout Itemize
2663 sy: Top edge of source
2664 \end_layout
2666 \begin_layout Itemize
2667 w: Width of region
2668 \end_layout
2670 \begin_layout Itemize
2671 h: Height of region.
2672 \end_layout
2674 \begin_layout Itemize
2675 ck: Color key.
2676  Pixels of this color are not blitted.
2677 \end_layout
2679 \begin_deeper
2680 \begin_layout Itemize
2681 If bitmaps are bitmaps, this is color index of colorkey.
2682  Values outside range 0-65535 cause no key to be used as colorkey.
2683 \end_layout
2685 \begin_layout Itemize
2686 If bitmaps are dbitmaps, this color value of colorkey.
2687 \end_layout
2689 \begin_layout Itemize
2690 May be absent or nil for no colorkey blit.
2691 \end_layout
2693 \end_deeper
2694 \begin_layout Subsubsection
2695 gui.repaint()
2696 \end_layout
2698 \begin_layout Standard
2699 Request on_repaint() to happen as soon as possible.
2700  Can be used anywhere.
2701 \end_layout
2703 \begin_layout Subsubsection
2704 gui.subframe_update(boolean on)
2705 \end_layout
2707 \begin_layout Standard
2708 Request subframe updates (calling on_paint() on subframes) to happen (on=true)
2709  or not happen (on=false).
2710  Can be used anywhere.
2711 \end_layout
2713 \begin_layout Subsubsection
2714 gui.screenshot(string filename)
2715 \end_layout
2717 \begin_layout Standard
2718 Write PNG screenshot of the current frame (no drawings) to specified file.
2719  Can be used anywhere.
2720 \end_layout
2722 \begin_layout Subsubsection
2723 gui.color(number r, number g, number b[, number a])
2724 \end_layout
2726 \begin_layout Standard
2727 Returns color (in notation Lua scripts use) corresponding to color (r,g,b),
2728  each component in scale 0-255.
2729  If a is specified, that is alpha (0 is fully transparent, 256(sic) is fully
2730  opaque).
2731  The default alpha is 256.
2732 \end_layout
2734 \begin_layout Subsubsection
2735 gui.status(string name, string value)
2736 \end_layout
2738 \begin_layout Standard
2739 Set status field 
2740 \begin_inset Quotes eld
2741 \end_inset
2743 L[<name>]
2744 \begin_inset Quotes erd
2745 \end_inset
2747  to <value> in status area.
2748  Can be used anywhere.
2749 \end_layout
2751 \begin_layout Subsubsection
2752 gui.rainbow(number step, number steps[, number color])
2753 \end_layout
2755 \begin_layout Standard
2756 Perform hue rotation of color <color> (default bright red), by <step> steps.
2757  The number of steps per full rotation is given by absolute value of <steps>.
2758 \end_layout
2760 \begin_layout Standard
2761 If <steps> is negative, the rotation will be counterclockwise.
2762 \end_layout
2764 \begin_layout Subsection
2765 table input
2766 \end_layout
2768 \begin_layout Standard
2769 Input handling.
2770  Only available in on_input callback.
2771 \end_layout
2773 \begin_layout Subsubsection
2774 input.get(number controller, number index)
2775 \end_layout
2777 \begin_layout Standard
2778 Read the specified index (0-11) from specified controller (0-7).
2779  Notes:
2780 \end_layout
2782 \begin_layout Itemize
2783 Uses physical controller numbering.
2784  Gamepad in port 2 is controller 4, not 1!
2785 \end_layout
2787 \begin_layout Subsubsection
2788 input.set(number controller, number index, number value)
2789 \end_layout
2791 \begin_layout Standard
2792 Write the specified index (0-11) from specified controller (0-7), storing
2793  value.
2794  Notes:
2795 \end_layout
2797 \begin_layout Itemize
2798 Uses physical controller numbering.
2799  Gamepad in port 2 is controller 4, not 1!
2800 \end_layout
2802 \begin_layout Subsubsection
2803 input.geta(number controller)
2804 \end_layout
2806 \begin_layout Standard
2807 Get input state for entiere controller.
2808  Returns 13 return values.
2809 \end_layout
2811 \begin_layout Itemize
2812 1st return value: Bitmask: bit i is set if i:th index is nonzero
2813 \end_layout
2815 \begin_layout Itemize
2816 2nd-13th return value: value of i:th index.
2817 \end_layout
2819 \begin_layout Subsubsection
2820 input.seta(number controller, number bitmask, number args...)
2821 \end_layout
2823 \begin_layout Standard
2824 Set state for entiere controller.
2825  args is up to 12 values for indices (overriding values in bitmask if specified).
2826 \end_layout
2828 \begin_layout Subsubsection
2829 input.controllertype(number controller)
2830 \end_layout
2832 \begin_layout Standard
2833 Get the type of controller as string.
2834  Valid values are:
2835 \end_layout
2837 \begin_layout Itemize
2838 gamepad
2839 \end_layout
2841 \begin_layout Itemize
2842 mouse
2843 \end_layout
2845 \begin_layout Itemize
2846 justifier
2847 \end_layout
2849 \begin_layout Itemize
2850 superscope
2851 \end_layout
2853 \begin_layout Subsubsection
2854 input.reset([number cycles])
2855 \end_layout
2857 \begin_layout Standard
2858 Execute reset.
2859  If cycles is greater than zero, do delayed reset.
2860  0 (or no value) causes immediate reset.
2861 \end_layout
2863 \begin_layout Itemize
2864 Only available with subframe flag false.
2865 \end_layout
2867 \begin_layout Subsubsection
2868 input.raw()
2869 \end_layout
2871 \begin_layout Standard
2872 Returns table of tables of all available keys and axes.
2873  The first table is indexed by key name (platform-dependent!), and the inner
2874  table has the following fields:
2875 \end_layout
2877 \begin_layout Itemize
2878 last_rawval: Last reported raw value for control.
2879 \end_layout
2881 \begin_layout Itemize
2882 ktype: Type of key (disabled, key, mouse, axis, axis-inverse, hat, pressure-m0,
2883  pressure-mp, pressure-0m, pressure-0p, pressure-pm, pressure-p0).
2884 \end_layout
2886 \begin_layout Itemize
2887 cal_left: Minimum calibration value.
2888  Only meaningful with axis and pressure types.
2889 \end_layout
2891 \begin_layout Itemize
2892 cal_center: Center calibration value.
2893  Only meaningful with axis and pressure types.
2894 \end_layout
2896 \begin_layout Itemize
2897 cal_right: Maximum calibration value.
2898  Only meaningful with axis and pressure types.
2899 \end_layout
2901 \begin_layout Itemize
2902 cal_tolerance: Dead zone tolerance.
2903  Only meaningful with axis and pressure types.
2904 \end_layout
2906 \begin_layout Subsubsection
2907 input.keyhook(key, state)
2908 \end_layout
2910 \begin_layout Standard
2911 Requests that keyhook events to be sent for key (state=true) or not sent
2912  (state=false).
2913 \end_layout
2915 \begin_layout Subsection
2916 Table hostmemory
2917 \end_layout
2919 \begin_layout Standard
2920 Host memory handling (extra memory saved to savestates).
2921  Host memory starts empty.
2922 \end_layout
2924 \begin_layout Subsubsection
2925 hostmemory.read(number address)
2926 \end_layout
2928 \begin_layout Standard
2929 Reads hostmemory slot address.
2930  Slot numbers out of range return false instead of numeric.
2931 \end_layout
2933 \begin_layout Subsubsection
2934 hostmemory.write(number address, number value)
2935 \end_layout
2937 \begin_layout Standard
2938 Writes hostmemory slot with 0-255.
2939  Slot numbers out of range cause extension of host memory slot space.
2940 \end_layout
2942 \begin_layout Subsubsection
2943 hostmemory.readbyte(number address)
2944 \end_layout
2946 \begin_layout Standard
2947 Read unsigned byte (1 element) from given address.
2948  Slots out of range return false.
2949 \end_layout
2951 \begin_layout Subsubsection
2952 hostmemory.writebyte(number address, number value)
2953 \end_layout
2955 \begin_layout Standard
2956 Write unsigned byte (1 element) to given slot.
2957  Slot numbers out of range cause extension.
2958 \end_layout
2960 \begin_layout Subsubsection
2961 hostmemory.readsbyte(number address)
2962 \end_layout
2964 \begin_layout Standard
2965 Read signed byte (1 element) from given address.
2966  Slots out of range return false.
2967 \end_layout
2969 \begin_layout Subsubsection
2970 hostmemory.writesbyte(number address, number value)
2971 \end_layout
2973 \begin_layout Standard
2974 Write signed byte (1 element) to given slot.
2975  Slot numbers out of range cause extension.
2976 \end_layout
2978 \begin_layout Subsubsection
2979 hostmemory.readword(number address)
2980 \end_layout
2982 \begin_layout Standard
2983 Read unsigned word (2 elements) from given address.
2984  Slots out of range return false.
2985 \end_layout
2987 \begin_layout Subsubsection
2988 hostmemory.writeword(number address, number value)
2989 \end_layout
2991 \begin_layout Standard
2992 Write unsigned word (2 elements) to given slot.
2993  Slot numbers out of range cause extension.
2994 \end_layout
2996 \begin_layout Subsubsection
2997 hostmemory.readsword(number address)
2998 \end_layout
3000 \begin_layout Standard
3001 Read signed word (2 elements) from given address.
3002  Slots out of range return false.
3003 \end_layout
3005 \begin_layout Subsubsection
3006 hostmemory.writesword(number address, number value)
3007 \end_layout
3009 \begin_layout Standard
3010 Write signed word (2 elements) to given slot.
3011  Slot numbers out of range cause extension.
3012 \end_layout
3014 \begin_layout Subsubsection
3015 hostmemory.readdword(number address)
3016 \end_layout
3018 \begin_layout Standard
3019 Read unsigned doubleword (4 elements) from given address.
3020  Slots out of range return false.
3021 \end_layout
3023 \begin_layout Subsubsection
3024 hostmemory.writedword(number address, number value)
3025 \end_layout
3027 \begin_layout Standard
3028 Write unsigned doubleword (4 elements) to given slot.
3029  Slot numbers out of range cause extension.
3030 \end_layout
3032 \begin_layout Subsubsection
3033 hostmemory.readsdword(number address)
3034 \end_layout
3036 \begin_layout Standard
3037 Read signed doubleword (4 elements) from given address.
3038  Slots out of range return false.
3039 \end_layout
3041 \begin_layout Subsubsection
3042 hostmemory.writesdword(number address, number value)
3043 \end_layout
3045 \begin_layout Standard
3046 Write signed doubleword (4 elements) to given slot.
3047  Slot numbers out of range cause extension.
3048 \end_layout
3050 \begin_layout Subsubsection
3051 hostmemory.readqword(number address)
3052 \end_layout
3054 \begin_layout Standard
3055 Read unsigned quadword (8 elements) from given address.
3056  Slots out of range return false.
3057 \end_layout
3059 \begin_layout Subsubsection
3060 hostmemory.writeqword(number address, number value)
3061 \end_layout
3063 \begin_layout Standard
3064 Write unsigned quadword (4 elements) to given slot.
3065  Slot numbers out of range cause extension.
3066 \end_layout
3068 \begin_layout Subsubsection
3069 hostmemory.readsqword(number address)
3070 \end_layout
3072 \begin_layout Standard
3073 Read signed quadword (8 elements) from given address.
3074  Slots out of range return false.
3075 \end_layout
3077 \begin_layout Subsubsection
3078 hostmemory.writesqword(number address, number value)
3079 \end_layout
3081 \begin_layout Standard
3082 Write signed quadword (8 elements) to given slot.
3083  Slot numbers out of range cause extension.
3084 \end_layout
3086 \begin_layout Subsection
3087 Table movie
3088 \end_layout
3090 \begin_layout Standard
3091 Movie handling
3092 \end_layout
3094 \begin_layout Subsubsection
3095 movie.currentframe()
3096 \end_layout
3098 \begin_layout Standard
3099 Return number of current frame.
3100 \end_layout
3102 \begin_layout Subsubsection
3103 movie.framecount()
3104 \end_layout
3106 \begin_layout Standard
3107 Return number of frames in movie.
3108 \end_layout
3110 \begin_layout Subsubsection
3111 movie.readonly()
3112 \end_layout
3114 \begin_layout Standard
3115 Return true if in readonly mode, false if in readwrite.
3116 \end_layout
3118 \begin_layout Subsubsection
3119 movie.set_readwrite()
3120 \end_layout
3122 \begin_layout Standard
3123 Set readwrite mode (does not cause on_readwrite callback).
3124 \end_layout
3126 \begin_layout Subsubsection
3127 movie.frame_subframes(number frame)
3128 \end_layout
3130 \begin_layout Standard
3131 Count number of subframes in specified frame (frame numbers are 1-based)
3132  and return that.
3133 \end_layout
3135 \begin_layout Subsubsection
3136 movie.read_subframe(number frame, number subframe)
3137 \end_layout
3139 \begin_layout Standard
3140 Read specifed subframe in specified frame and return data as array (100
3141  elements, numbered 0-99 currently).
3142 \end_layout
3144 \begin_layout Subsection
3145 Table settings
3146 \end_layout
3148 \begin_layout Standard
3149 Routines for settings manipulation
3150 \end_layout
3152 \begin_layout Subsubsection
3153 settings.get(string name)
3154 \end_layout
3156 \begin_layout Standard
3157 Get value of setting.
3158  If setting is blank, returns false.
3159  If setting value can't be obtained, returns (nil, error message).
3160 \end_layout
3162 \begin_layout Subsubsection
3163 settings.set(string name, string value)
3164 \end_layout
3166 \begin_layout Standard
3167 Set value of setting.
3168  If setting can't be set, returns (nil, error message).
3169 \end_layout
3171 \begin_layout Subsubsection
3172 settings.is_set(string name)
3173 \end_layout
3175 \begin_layout Standard
3176 Returns if setting is set.
3177  If setting does not exist, returns (nil, error message).
3178 \end_layout
3180 \begin_layout Subsubsection
3181 settings.blank(string name)
3182 \end_layout
3184 \begin_layout Standard
3185 Blanks a setting and returns true.
3186  If setting can't be blanked, returns (nil, error message).
3187 \end_layout
3189 \begin_layout Subsection
3190 Table memory
3191 \end_layout
3193 \begin_layout Standard
3194 Contains various functions for managing memory
3195 \end_layout
3197 \begin_layout Subsubsection
3198 memory.vma_count()
3199 \end_layout
3201 \begin_layout Standard
3202 Returns the number of VMAs
3203 \end_layout
3205 \begin_layout Subsubsection
3206 memory.read_vma(number index)
3207 \end_layout
3209 \begin_layout Standard
3210 Reads the specified VMA (indices start from zero).
3211  Trying to read invalid VMA gives nil.
3212  The read VMA is table with the following fields:
3213 \end_layout
3215 \begin_layout Itemize
3216 region_name (string): The readable name of the VMA
3217 \end_layout
3219 \begin_layout Itemize
3220 baseaddr (number): Base address of the VMA
3221 \end_layout
3223 \begin_layout Itemize
3224 lastaddr (number): Last address in the VMA.
3225 \end_layout
3227 \begin_layout Itemize
3228 size (number): The size of VMA in bytes.
3229 \end_layout
3231 \begin_layout Itemize
3232 readonly (boolean): True of the VMA corresponds to ROM.
3233 \end_layout
3235 \begin_layout Itemize
3236 native_endian (boolean): True if the VMA has native endian as opposed to
3237  little endian.
3238 \end_layout
3240 \begin_layout Subsubsection
3241 memory.find_vma(number address)
3242 \end_layout
3244 \begin_layout Standard
3245 Finds the VMA containing specified address.
3246  Returns table in the same format as read_vma or nil if not found.
3247 \end_layout
3249 \begin_layout Subsubsection
3250 memory.readbyte(number address)
3251 \end_layout
3253 \begin_layout Standard
3254 Reads the specified address as unsigned byte and returns the result.
3255 \end_layout
3257 \begin_layout Subsubsection
3258 memory.readsbyte(number address)
3259 \end_layout
3261 \begin_layout Standard
3262 Reads the specified address as signed byte and returns the result.
3263 \end_layout
3265 \begin_layout Subsubsection
3266 memory.writebyte(number address, number value)
3267 \end_layout
3269 \begin_layout Standard
3270 Writes the specified value (negative values undergo 2's complement) to specified
3271  address (as a byte).
3272 \end_layout
3274 \begin_layout Subsubsection
3275 memory.readword(number address)
3276 \end_layout
3278 \begin_layout Standard
3279 Reads the specified address as unsigned word and returns the result.
3280 \end_layout
3282 \begin_layout Subsubsection
3283 memory.readsword(number address)
3284 \end_layout
3286 \begin_layout Standard
3287 Reads the specified address as signed word and returns the result.
3288 \end_layout
3290 \begin_layout Subsubsection
3291 memory.writeword(number address, number value)
3292 \end_layout
3294 \begin_layout Standard
3295 Writes the specified value (negative values undergo 2's complement) to specified
3296  address (as a word).
3297 \end_layout
3299 \begin_layout Subsubsection
3300 memory.readdword(number address)
3301 \end_layout
3303 \begin_layout Standard
3304 Reads the specified address as unsigned doubleword and returns the result.
3305 \end_layout
3307 \begin_layout Subsubsection
3308 memory.readsdword(number address)
3309 \end_layout
3311 \begin_layout Standard
3312 Reads the specified address as signed doubleword and returns the result.
3313 \end_layout
3315 \begin_layout Subsubsection
3316 memory.writedword(number address, number value)
3317 \end_layout
3319 \begin_layout Standard
3320 Writes the specified value (negative values undergo 2's complement) to specified
3321  address (as a doubleword).
3322 \end_layout
3324 \begin_layout Subsubsection
3325 memory.readqword(number address)
3326 \end_layout
3328 \begin_layout Standard
3329 Reads the specified address as unsigned quadword and returns the result.
3330 \end_layout
3332 \begin_layout Subsubsection
3333 memory.readsqword(number address)
3334 \end_layout
3336 \begin_layout Standard
3337 Reads the specified address as signed quadword and returns the result.
3338 \end_layout
3340 \begin_layout Subsubsection
3341 memory.writeqword(number address, number value)
3342 \end_layout
3344 \begin_layout Standard
3345 Writes the specified value (negative values undergo 2's complement) to specified
3346  address (as a quadword).
3347 \end_layout
3349 \begin_layout Subsection
3350 Table _SYSTEM
3351 \end_layout
3353 \begin_layout Standard
3354 Contains copy of global variables from time of Lua initialization.
3355  Non-writeable.
3356 \end_layout
3358 \begin_layout Subsection
3359 Callbacks
3360 \end_layout
3362 \begin_layout Standard
3363 Various callbacks to Lua that can occur.
3364 \end_layout
3366 \begin_layout Subsubsection
3367 Callback: on_paint(bool not_synth)
3368 \end_layout
3370 \begin_layout Standard
3371 Called when screen is being painted.
3372  Any gui.* calls requiring graphic context draw on the screen.
3373 \end_layout
3375 \begin_layout Standard
3376 not_synth is true if this hook is being called in response to received frame,
3377  false otherwise.
3378 \end_layout
3380 \begin_layout Subsubsection
3381 Callback: on_video()
3382 \end_layout
3384 \begin_layout Standard
3385 Called when video dump frame is being painted.
3386  Any gui.* calls requiring graphic context draw on the video.
3387 \end_layout
3389 \begin_layout Subsubsection
3390 Callback: on_frame_emulated()
3391 \end_layout
3393 \begin_layout Standard
3394 Called when emulating frame has completed and on_paint()/on_video() calls
3395  are about to be issued.
3396 \end_layout
3398 \begin_layout Subsubsection
3399 Callback: on_frame()
3400 \end_layout
3402 \begin_layout Standard
3403 Called on each starting whole frame.
3404 \end_layout
3406 \begin_layout Subsubsection
3407 Callback: on_startup()
3408 \end_layout
3410 \begin_layout Standard
3411 Called when the emulator is starting (lsnes.rc and --run files has been run).
3412 \end_layout
3414 \begin_layout Subsubsection
3415 Callback: on_rewind()
3416 \end_layout
3418 \begin_layout Standard
3419 Called when rewind movie to beginning has completed.
3420 \end_layout
3422 \begin_layout Subsubsection
3423 Callback: on_pre_load(string name)
3424 \end_layout
3426 \begin_layout Standard
3427 Called just before savestate/movie load occurs (note: loads are always delayed,
3428  so this occurs even when load was initiated by lua).
3429 \end_layout
3431 \begin_layout Subsubsection
3432 Callback: on_err_load(string name)
3433 \end_layout
3435 \begin_layout Standard
3436 Called if loadstate goes wrong.
3437 \end_layout
3439 \begin_layout Subsubsection
3440 Callback: on_post_load(string name, boolean was_savestate)
3441 \end_layout
3443 \begin_layout Standard
3444 Called on successful loadstate.
3445  was_savestate gives if this was a savestate or a movie.
3446 \end_layout
3448 \begin_layout Subsubsection
3449 Callback: on_pre_save(string name, boolean is_savestate)
3450 \end_layout
3452 \begin_layout Standard
3453 Called just before savestate save occurs (note: movie saves are synchronous
3454  and won't trigger these callbacks if called from Lua).
3455 \end_layout
3457 \begin_layout Subsubsection
3458 Callback: on_err_save(string name)
3459 \end_layout
3461 \begin_layout Standard
3462 Called if savestate goes wrong.
3463 \end_layout
3465 \begin_layout Subsubsection
3466 Callback: on_post_save(string name, boolean is_savestate)
3467 \end_layout
3469 \begin_layout Standard
3470 Called on successful savaestate.
3471  is_savestate gives if this was a savestate or a movie.
3472 \end_layout
3474 \begin_layout Subsubsection
3475 Callback: on_quit()
3476 \end_layout
3478 \begin_layout Standard
3479 Called when emulator is shutting down.
3480 \end_layout
3482 \begin_layout Subsubsection
3483 Callback: on_input(boolean subframe)
3484 \end_layout
3486 \begin_layout Standard
3487 Called when emulator is just sending input to bsnes core.
3488  Warning: This is called even in readonly mode, but the results are ignored.
3489 \end_layout
3491 \begin_layout Subsubsection
3492 Callback: on_reset()
3493 \end_layout
3495 \begin_layout Standard
3496 Called when SNES is reset.
3497 \end_layout
3499 \begin_layout Subsubsection
3500 Callback: on_readwrite()
3501 \end_layout
3503 \begin_layout Standard
3504 Called when moving into readwrite mode as result of 
3505 \begin_inset Quotes eld
3506 \end_inset
3508 set-rwmode
3509 \begin_inset Quotes erd
3510 \end_inset
3512  command (note: moving to rwmode by Lua won't trigger this, as per recursive
3513  entry protection).
3514 \end_layout
3516 \begin_layout Subsubsection
3517 Callback: on_snoop(number port, number controller, number index, number
3518  value)
3519 \end_layout
3521 \begin_layout Standard
3522 Called each time bsnes asks for input.
3523  The value is the final value to be sent to bsnes core (readonly mode, autohold
3524  and autofire have been taken into account).
3525  Might be useful when translating movies to format suitable for console
3526  verification.
3527  Note: There is no way to modify the value to be sent.
3528 \end_layout
3530 \begin_layout Subsubsection
3531 Callback: on_keyhook(string keyname, table state)
3532 \end_layout
3534 \begin_layout Standard
3535 Sent when key that has keyhook events requested changes state.
3536  Keyname is name of the key (group) and state is the state (same kind as
3537  table values in input.raw).
3538 \end_layout
3540 \begin_layout Subsubsection
3541 Callback: on_idle()
3542 \end_layout
3544 \begin_layout Standard
3545 Called when requested by set_idle_timeout(), the timeout has expired and
3546  emulator is waiting.
3547 \end_layout
3549 \begin_layout Subsubsection
3550 Callback: on_timer()
3551 \end_layout
3553 \begin_layout Standard
3554 Called when requested by set_idle_timeout() and the timeout has expired
3555  (regardless if emulator is waiting).
3556 \end_layout
3558 \begin_layout Section
3559 Memory watch expression syntax
3560 \end_layout
3562 \begin_layout Standard
3563 Memory watch expressions are in RPN (Reverse Polish Notation).
3564  At the end of expression, the top entry on stack is taken as the final
3565  result.
3566 \end_layout
3568 \begin_layout Standard
3569 Notations:
3570 \end_layout
3572 \begin_layout Itemize
3573 Evaluation order is strictly left to right.
3574 \end_layout
3576 \begin_layout Itemize
3577 a is the entry on top of stack
3578 \end_layout
3580 \begin_layout Itemize
3581 b is the entry immediately below top of stack
3582 \end_layout
3584 \begin_layout Itemize
3585 ; separates values to be pushed (no intermediate pop).
3586 \end_layout
3588 \begin_layout Itemize
3589 After end of element, all used stack slots are popped and all results are
3590  pushed.
3591 \end_layout
3593 \begin_layout Itemize
3594 When pushing multiple values, the pushes occur in order shown.
3595 \end_layout
3597 \begin_layout Standard
3598 The following operators are available:
3599 \end_layout
3601 \begin_layout Itemize
3602 + : a + b
3603 \end_layout
3605 \begin_layout Itemize
3606 - : a - b
3607 \end_layout
3609 \begin_layout Itemize
3610 * : a * b
3611 \end_layout
3613 \begin_layout Itemize
3614 / : a / b
3615 \end_layout
3617 \begin_layout Itemize
3618 % : a % b
3619 \end_layout
3621 \begin_layout Itemize
3622 a : atan(a)
3623 \end_layout
3625 \begin_layout Itemize
3626 b : read_signed_byte(a)
3627 \end_layout
3629 \begin_layout Itemize
3630 c : cos(a)
3631 \end_layout
3633 \begin_layout Itemize
3634 d : read_signed_dword(a)
3635 \end_layout
3637 \begin_layout Itemize
3638 i : quotent(a / b)
3639 \end_layout
3641 \begin_layout Itemize
3642 p :
3643 \begin_inset Formula $\pi$
3644 \end_inset
3647 \end_layout
3649 \begin_layout Itemize
3650 q : read_signed_qword(a)
3651 \end_layout
3653 \begin_layout Itemize
3654 r : sqrt(a)
3655 \end_layout
3657 \begin_layout Itemize
3658 s : sin(a)
3659 \end_layout
3661 \begin_layout Itemize
3662 t : tan(a)
3663 \end_layout
3665 \begin_layout Itemize
3666 u : a; a
3667 \end_layout
3669 \begin_layout Itemize
3670 w : read_signed_word(a)
3671 \end_layout
3673 \begin_layout Itemize
3674 A : atan2(a, b)
3675 \end_layout
3677 \begin_layout Itemize
3678 B : read_unsigned_byte(a)
3679 \end_layout
3681 \begin_layout Itemize
3682 C<number>z : Push number <number> to stack.
3683 \end_layout
3685 \begin_layout Itemize
3686 D : read_unsigned_dword(a)
3687 \end_layout
3689 \begin_layout Itemize
3690 C0x<number>z : Push number <number> (hexadecimal) to stack.
3691 \end_layout
3693 \begin_layout Itemize
3694 Q : read_unsigned_qword(a)
3695 \end_layout
3697 \begin_layout Itemize
3698 R<digit> : round a to <digit> digits.
3699 \end_layout
3701 \begin_layout Itemize
3702 W : read_unsigned_word(a)
3703 \end_layout
3705 \begin_layout Subsection
3706 Example:
3707 \end_layout
3709 \begin_layout Standard
3710 C0x007e0878zWC0x007e002czW-
3711 \end_layout
3713 \begin_layout Enumerate
3714 Push value 0x7e0878 on top of stack (C0x007e0878z).
3715 \end_layout
3717 \begin_layout Enumerate
3718 Pop the value on top of stack (0x7e0878), read word value at that address
3719  and push the result,call it x1 (W).
3720 \end_layout
3722 \begin_layout Enumerate
3723 Push value 0x7e002c on top of stack (C0x007e002cz).
3724 \end_layout
3726 \begin_layout Enumerate
3727 Pop the value on top of stack (0x7e002c), read word value at that address
3728  and push the result,call it x2 (W).
3729 \end_layout
3731 \begin_layout Enumerate
3732 Pop the two top numbers on stack, x1 and x2, substract x1 from x2 and push
3733  x2 - x1 (-).
3734 \end_layout
3736 \begin_layout Enumerate
3737 Since the expression ends, the final memory watch result is the top one
3738  on stack, which is x2 - x1.
3739 \end_layout
3741 \begin_layout Section
3742 Modifier and key names:
3743 \end_layout
3745 \begin_layout Subsection
3746 SDL Platform
3747 \end_layout
3749 \begin_layout Subsubsection
3750 Modifier names
3751 \end_layout
3753 \begin_layout Standard
3754 Following modifier names are known:
3755 \end_layout
3757 \begin_layout Itemize
3758 ctrl, lctrl, rctrl: Control keys
3759 \end_layout
3761 \begin_layout Itemize
3762 alt, lalt, ralt: ALT keys.
3763 \end_layout
3765 \begin_layout Itemize
3766 shift, lshift, rshift: Shift keys.
3767 \end_layout
3769 \begin_layout Itemize
3770 meta, lmeta, rmeta: Meta keys.
3771 \end_layout
3773 \begin_layout Itemize
3774 num, caps: Numlock/Capslock (these are sticky!)
3775 \end_layout
3777 \begin_layout Itemize
3778 mode: Mode select.
3779 \end_layout
3781 \begin_layout Subsubsection
3782 Key names
3783 \end_layout
3785 \begin_layout Standard
3786 Following key names are known:
3787 \end_layout
3789 \begin_layout Itemize
3790 backspace, tab, clear, return, pause, escape, space, exclaim, quotedbl,
3791  hash, dollar, ampersand, quote, leftparen, rightparen, asterisk, plus,
3792  comma, minus, period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon,
3793  less, equals, greater, question, at, leftbracket, backslash, rightbracket,
3794  caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n,
3795  o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0, world_1, world_2,
3796  world_3, world_4, world_5, world_6, world_7, world_8, world_9, world_10,
3797  world_11, world_12, world_13, world_14, world_15, world_16, world_17, world_18,
3798  world_19, world_20, world_21, world_22, world_23, world_24, world_25, world_26,
3799  world_27, world_28, world_29, world_30, world_31, world_32, world_33, world_34,
3800  world_35, world_36, world_37, world_38, world_39, world_40, world_41, world_42,
3801  world_43, world_44, world_45, world_46, world_47, world_48, world_49, world_50,
3802  world_51, world_52, world_53, world_54, world_55, world_56, world_57, world_58,
3803  world_59, world_60, world_61, world_62, world_63, world_64, world_65, world_66,
3804  world_67, world_68, world_69, world_70, world_71, world_72, world_73, world_74,
3805  world_75, world_76, world_77, world_78, world_79, world_80, world_81, world_82,
3806  world_83, world_84, world_85, world_86, world_87, world_88, world_89, world_90,
3807  world_91, world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3, kp4,
3808  kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide, kp_multiply, kp_minus, kp_plus,
3809  kp_enter, kp_equals, up, down, right, left, insert, home, end, pageup,
3810  pagedown, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14,
3811  f15, numlock, capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt,
3812  lalt, rmeta, lmeta, lsuper, rsuper, mode, compose, help, print, sysreq,
3813  break, menu, power, euro, undo
3814 \end_layout
3816 \begin_layout Itemize
3817 Names of form 'key<n>' where <n> is 0-255 are interpretted as key having
3818  hardware-dependent scan code of <n> (useful to bind those keys that don't
3819  have symbolic names).
3820 \end_layout
3822 \begin_layout Subsubsection
3823 Joystick pseudo-keys:
3824 \end_layout
3826 \begin_layout Itemize
3827 joystick<num>button<button>: Joystick <num> (0-based) button <button> (0-based).
3828 \end_layout
3830 \begin_layout Itemize
3831 joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat> (0-based) up.
3832 \end_layout
3834 \begin_layout Itemize
3835 joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat> (0-based) left.
3836 \end_layout
3838 \begin_layout Itemize
3839 joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat> (0-based) down.
3840 \end_layout
3842 \begin_layout Itemize
3843 joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat> (0-based) right.
3844 \end_layout
3846 \begin_layout Itemize
3847 joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis> negative
3848  position (axis modes axis and axis_inverse).
3849 \end_layout
3851 \begin_layout Itemize
3852 joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis> positive
3853  position (axis modes axis and axis_inverse).
3854 \end_layout
3856 \begin_layout Itemize
3857 joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis> pressure (axis
3858  modes pressure_*).
3859 \end_layout
3861 \begin_layout Subsubsection
3862 Special buttons:
3863 \end_layout
3865 \begin_layout Itemize
3866 Escape: Enter/Exit Command mode, cancel modal dialogs.
3867 \end_layout
3869 \begin_layout Itemize
3870 Return (also KPEnter): Execute command, ok modal dialog.
3871 \end_layout
3873 \begin_layout Itemize
3874 Pgup/Up (also KP8/9 if no num lock; command mode): Previous command in command
3875  history
3876 \end_layout
3878 \begin_layout Itemize
3879 Pgdn/Down(also KP2/3 if no num lock; command mode): Next command in command
3880  history
3881 \end_layout
3883 \begin_layout Itemize
3884 Home (also KP7 if no num lock; command mode): Beginning of command.
3885 \end_layout
3887 \begin_layout Itemize
3888 End (also KP1 if no num lock; command mode): End of command.
3889 \end_layout
3891 \begin_layout Itemize
3892 Left (also KP4 if no num lock; command mode): Move cursor left.
3893 \end_layout
3895 \begin_layout Itemize
3896 Right (also KP6 if no num lock; command mode): Move cursor right.
3897 \end_layout
3899 \begin_layout Itemize
3900 Delete (also KP.
3901  if no num lock; command mode): Delete character to right of cursor.
3902 \end_layout
3904 \begin_layout Itemize
3905 Insert (also KP0 if no num lock; command mode): Toggle between insert /
3906  overwrite modes.
3907 \end_layout
3909 \begin_layout Itemize
3910 Backspace (command mode): Delete character to left of cursor.
3911 \end_layout
3913 \begin_layout Itemize
3914 LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump corrupted!).
3915 \end_layout
3917 \begin_layout Subsection
3918 wxWidgets platform
3919 \end_layout
3921 \begin_layout Subsubsection
3922 Modifier names:
3923 \end_layout
3925 \begin_layout Standard
3926 Following modifier names are known:
3927 \end_layout
3929 \begin_layout Itemize
3931 \end_layout
3933 \begin_layout Itemize
3934 ctrl
3935 \end_layout
3937 \begin_layout Itemize
3938 shift 
3939 \end_layout
3941 \begin_layout Itemize
3942 meta
3943 \end_layout
3945 \begin_layout Itemize
3946 cmd (Mac OS X only)
3947 \end_layout
3949 \begin_layout Subsubsection
3950 Key names:
3951 \end_layout
3953 \begin_layout Standard
3954 Following key names are known:
3955 \end_layout
3957 \begin_layout Itemize
3958 back, tab, return, escape, space, exclaim, quotedbl, hash, dollar, percent,
3959  ampersand, quote, leftparen, rightparen, asterisk, plus, comma, minus,
3960  period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
3961  greater, question, at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3962  q, r, s, t, u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
3963  underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3964  q, r, s, t, u, v, w, x, y, z, leftcurly, pipe, rightcurly, tilde, delete,
3965  start, lbutton, rbutton, cancel, mbutton, clear, shift, alt, control, menu,
3966  pause, capital, end, home, lefT, up, right, down, select, print, execute,
3967  snapshot, insert, help, numpad0, numpad1, numpad2, numpad3, numpad4, numpad5,
3968  numpad6, numpad7, numpad8, numpad9, multiply, add, separator, subtract,
3969  decimal, divide, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13,
3970  f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, numlock, scroll,
3971  pageup, pagedown, numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
3972  numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up, numpad_right,
3973  numpad_down, numpad_pageup, numpad_pagedown, numpad_end, numpad_begin,
3974  numpad_insert, numpad_delete, numpad_equal, numpad_multiply, numpad_add,
3975  numpad_separator, numpad_subtract, numpad_decimal, numpad_divide, windows_left,
3976  windows_right, windows_menu, command, special1, special2, special3, special4,
3977  special5, special6, special7, special8, special9, special10, special11,
3978  special12, special13, special14, special15, special16, special17, special18,
3979  special19, special20
3980 \end_layout
3982 \begin_layout Section
3983 Movie file format
3984 \end_layout
3986 \begin_layout Standard
3987 Movie file is .zip archive in itself, normal ZIP archive tools work on it
3988  (note: If you recompress it, do not use compression methods other than
3989  store and deflate and especially do not use encryption of any kind).
3990 \end_layout
3992 \begin_layout Subsection
3993 Detecting clean start/SRAM/Savestate
3994 \end_layout
3996 \begin_layout Itemize
3997 If file has member 
3998 \begin_inset Quotes eld
3999 \end_inset
4001 savestate
4002 \begin_inset Quotes erd
4003 \end_inset
4005  it is savestate, otherwise:
4006 \end_layout
4008 \begin_layout Itemize
4009 If file has members with names starting 
4010 \begin_inset Quotes eld
4011 \end_inset
4013 moviesram.
4014 \begin_inset Quotes erd
4015 \end_inset
4017  it is movie starting from SRAM, otherwise:
4018 \end_layout
4020 \begin_layout Itemize
4021 It is movie starting from clear state.
4022 \end_layout
4024 \begin_layout Subsection
4025 Member: gametype
4026 \end_layout
4028 \begin_layout Standard
4029 Type of game ROM and region (as one line).
4030  Valid values are:
4031 \end_layout
4033 \begin_layout Standard
4034 \begin_inset Tabular
4035 <lyxtabular version="3" rows="8" columns="3">
4036 <features tabularvalignment="middle">
4037 <column alignment="center" valignment="top" width="0">
4038 <column alignment="center" valignment="top" width="0">
4039 <column alignment="center" valignment="top" width="0">
4040 <row>
4041 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4042 \begin_inset Text
4044 \begin_layout Plain Layout
4045 Value
4046 \end_layout
4048 \end_inset
4049 </cell>
4050 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4051 \begin_inset Text
4053 \begin_layout Plain Layout
4054 System
4055 \end_layout
4057 \end_inset
4058 </cell>
4059 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4060 \begin_inset Text
4062 \begin_layout Plain Layout
4063 Region
4064 \end_layout
4066 \end_inset
4067 </cell>
4068 </row>
4069 <row>
4070 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4071 \begin_inset Text
4073 \begin_layout Plain Layout
4074 snes_pal
4075 \end_layout
4077 \end_inset
4078 </cell>
4079 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4080 \begin_inset Text
4082 \begin_layout Plain Layout
4083 Super NES
4084 \end_layout
4086 \end_inset
4087 </cell>
4088 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4089 \begin_inset Text
4091 \begin_layout Plain Layout
4093 \end_layout
4095 \end_inset
4096 </cell>
4097 </row>
4098 <row>
4099 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4100 \begin_inset Text
4102 \begin_layout Plain Layout
4103 sgb_pal
4104 \end_layout
4106 \end_inset
4107 </cell>
4108 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4109 \begin_inset Text
4111 \begin_layout Plain Layout
4112 Super Game Boy
4113 \end_layout
4115 \end_inset
4116 </cell>
4117 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4118 \begin_inset Text
4120 \begin_layout Plain Layout
4122 \end_layout
4124 \end_inset
4125 </cell>
4126 </row>
4127 <row>
4128 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4129 \begin_inset Text
4131 \begin_layout Plain Layout
4132 snes_ntsc
4133 \end_layout
4135 \end_inset
4136 </cell>
4137 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4138 \begin_inset Text
4140 \begin_layout Plain Layout
4141 Super NES
4142 \end_layout
4144 \end_inset
4145 </cell>
4146 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4147 \begin_inset Text
4149 \begin_layout Plain Layout
4150 NTSC
4151 \end_layout
4153 \end_inset
4154 </cell>
4155 </row>
4156 <row>
4157 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4158 \begin_inset Text
4160 \begin_layout Plain Layout
4161 sgb_ntsc
4162 \end_layout
4164 \end_inset
4165 </cell>
4166 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4167 \begin_inset Text
4169 \begin_layout Plain Layout
4170 Super Game Boy
4171 \end_layout
4173 \end_inset
4174 </cell>
4175 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4176 \begin_inset Text
4178 \begin_layout Plain Layout
4179 NTSC
4180 \end_layout
4182 \end_inset
4183 </cell>
4184 </row>
4185 <row>
4186 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4187 \begin_inset Text
4189 \begin_layout Plain Layout
4191 \end_layout
4193 \end_inset
4194 </cell>
4195 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4196 \begin_inset Text
4198 \begin_layout Plain Layout
4199 BS-X (non-slotted)
4200 \end_layout
4202 \end_inset
4203 </cell>
4204 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4205 \begin_inset Text
4207 \begin_layout Plain Layout
4208 NTSC
4209 \end_layout
4211 \end_inset
4212 </cell>
4213 </row>
4214 <row>
4215 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4216 \begin_inset Text
4218 \begin_layout Plain Layout
4219 bsxslotted
4220 \end_layout
4222 \end_inset
4223 </cell>
4224 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4225 \begin_inset Text
4227 \begin_layout Plain Layout
4228 BS-X (slotted)
4229 \end_layout
4231 \end_inset
4232 </cell>
4233 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4234 \begin_inset Text
4236 \begin_layout Plain Layout
4237 NTSC
4238 \end_layout
4240 \end_inset
4241 </cell>
4242 </row>
4243 <row>
4244 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4245 \begin_inset Text
4247 \begin_layout Plain Layout
4248 sufamiturbo
4249 \end_layout
4251 \end_inset
4252 </cell>
4253 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4254 \begin_inset Text
4256 \begin_layout Plain Layout
4257 Sufami Turbo
4258 \end_layout
4260 \end_inset
4261 </cell>
4262 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4263 \begin_inset Text
4265 \begin_layout Plain Layout
4266 NTSC
4267 \end_layout
4269 \end_inset
4270 </cell>
4271 </row>
4272 </lyxtabular>
4274 \end_inset
4277 \end_layout
4279 \begin_layout Standard
4280 Frame rates are:
4281 \end_layout
4283 \begin_layout Standard
4284 \begin_inset Tabular
4285 <lyxtabular version="3" rows="3" columns="2">
4286 <features tabularvalignment="middle">
4287 <column alignment="center" valignment="top" width="0">
4288 <column alignment="center" valignment="top" width="0">
4289 <row>
4290 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4291 \begin_inset Text
4293 \begin_layout Plain Layout
4294 Region
4295 \end_layout
4297 \end_inset
4298 </cell>
4299 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4300 \begin_inset Text
4302 \begin_layout Plain Layout
4303 Framerate (fps)
4304 \end_layout
4306 \end_inset
4307 </cell>
4308 </row>
4309 <row>
4310 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4311 \begin_inset Text
4313 \begin_layout Plain Layout
4315 \end_layout
4317 \end_inset
4318 </cell>
4319 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4320 \begin_inset Text
4322 \begin_layout Plain Layout
4323 322445/6448
4324 \end_layout
4326 \end_inset
4327 </cell>
4328 </row>
4329 <row>
4330 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4331 \begin_inset Text
4333 \begin_layout Plain Layout
4334 NTSC
4335 \end_layout
4337 \end_inset
4338 </cell>
4339 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4340 \begin_inset Text
4342 \begin_layout Plain Layout
4343 10738636/178683
4344 \end_layout
4346 \end_inset
4347 </cell>
4348 </row>
4349 </lyxtabular>
4351 \end_inset
4354 \end_layout
4356 \begin_layout Subsection
4357 Member: port1
4358 \end_layout
4360 \begin_layout Standard
4361 Contains type of port #1 (as one line).
4362  Valid values are 'none', 'gamepad', 'multitap' and 'mouse'.
4363  If not present, defaults to 'gamepad'.
4364 \end_layout
4366 \begin_layout Subsection
4367 Member: port2
4368 \end_layout
4370 \begin_layout Standard
4371 Contains type of port #2 (as one line).
4372  Valid values are 'none', 'gamepad', 'multitap', 'mouse', 'superscope',
4373  'justifier' and 'justifiers'.
4374  If not present, defaults to 'none'.
4375 \end_layout
4377 \begin_layout Subsection
4378 Member: gamename
4379 \end_layout
4381 \begin_layout Standard
4382 Contains name of the game (as one line).
4383 \end_layout
4385 \begin_layout Subsection
4386 Member: authors
4387 \end_layout
4389 \begin_layout Standard
4390 Contains authors, one per line.
4391  Part before '|' is the full name, part after is the nickname.
4392 \end_layout
4394 \begin_layout Subsection
4395 Member: systemid
4396 \end_layout
4398 \begin_layout Standard
4399 Always 
4400 \begin_inset Quotes eld
4401 \end_inset
4403 lsnes-rr1
4404 \begin_inset Quotes erd
4405 \end_inset
4407  (one line).
4408  Used to reject other saves.
4409 \end_layout
4411 \begin_layout Subsection
4412 Member: controlsversion
4413 \end_layout
4415 \begin_layout Standard
4416 Always 
4417 \begin_inset Quotes eld
4418 \end_inset
4421 \begin_inset Quotes erd
4422 \end_inset
4424  (one line).
4425  Used to identify what controls are there.
4426 \end_layout
4428 \begin_layout Subsection
4429 Member: 
4430 \begin_inset Quotes eld
4431 \end_inset
4433 coreversion
4434 \begin_inset Quotes erd
4435 \end_inset
4438 \end_layout
4440 \begin_layout Standard
4441 Contains bsnes core version number (as one line).
4442 \end_layout
4444 \begin_layout Subsection
4445 Member: projectid
4446 \end_layout
4448 \begin_layout Standard
4449 Contains project ID (as one line).
4450  Used to identify if two movies are part of the same project.
4451 \end_layout
4453 \begin_layout Subsection
4454 Member: {rom,slota,slotb}{,xml}.sha256
4455 \end_layout
4457 \begin_layout Standard
4458 Contains SHA-256 of said ROM or ROM mapping file (as one line).
4459  Absent if corresponding file is absent.
4460 \end_layout
4462 \begin_layout Subsection
4463 Member: moviesram.<name>
4464 \end_layout
4466 \begin_layout Standard
4467 Raw binary startup SRAM of kind <name>.
4468  Only present in savestates and movies starting from SRAM.
4469 \end_layout
4471 \begin_layout Subsection
4472 Member: saveframe
4473 \end_layout
4475 \begin_layout Standard
4476 Contains frame number (as one line) of frame movie was saved on.
4477  Only present in savestates.
4478 \end_layout
4480 \begin_layout Subsection
4481 Member: lagcounter
4482 \end_layout
4484 \begin_layout Standard
4485 Current value of lag counter (as one line).
4486  Only present in savestates.
4487 \end_layout
4489 \begin_layout Subsection
4490 Member: pollcounters
4491 \end_layout
4493 \begin_layout Standard
4494 Contains poll counters (currently 100 of them), one per line.
4495  Each line is raw poll count if DRDY is set for it.
4496  Otherwise it is negative poll count minus one.
4497  Only present in savestates.
4498 \end_layout
4500 \begin_layout Subsection
4501 Member: hostmemory
4502 \end_layout
4504 \begin_layout Standard
4505 Raw binary dump of host memory.
4506  Only present in savestates.
4507 \end_layout
4509 \begin_layout Subsection
4510 Member: savestate
4511 \end_layout
4513 \begin_layout Standard
4514 The raw binary savestate itself.
4515  Savestate detection uses this file, only present in savestates.
4516 \end_layout
4518 \begin_layout Subsection
4519 Member: screenshot
4520 \end_layout
4522 \begin_layout Standard
4523 Screenshot of current frame.
4524  Only present in savestates.
4525  First 2 bytes are big-endian width of image, rest are 24-bit RGB image
4526  data.
4527  Height of image is inferred from the width and size of data.
4528 \end_layout
4530 \begin_layout Subsection
4531 Member: sram.<name>
4532 \end_layout
4534 \begin_layout Standard
4535 Raw binary SRAM of kind <name> at time of savestate.
4536  Only present in savestates.
4537 \end_layout
4539 \begin_layout Subsection
4540 Member: input
4541 \end_layout
4543 \begin_layout Standard
4544 The actual input track, one line per subframe (blank lines are skipped).
4545 \end_layout
4547 \begin_layout Itemize
4548 If the first byte of each line is '.', ' ', <tab> or '|', then the line is
4549  part of same frame as previous, otherwise it starts a new frame.
4550 \end_layout
4552 \begin_layout Itemize
4553 First subframe must start a new frame.
4554 \end_layout
4556 \begin_layout Standard
4557 Length of movie in frames is number of lines in input file that start a
4558  new frame.
4559 \end_layout
4561 \begin_layout Subsection
4562 Member: rerecords
4563 \end_layout
4565 \begin_layout Standard
4566 Contains textual base-10 rerecord count (as one line; emulator just writes
4567  this, it doesn't read it) + 1.
4568 \end_layout
4570 \begin_layout Subsection
4571 Member: rrdata
4572 \end_layout
4574 \begin_layout Standard
4575 This member stores set of load IDs.
4576  There is one load ID per rerecord (plus one corresponding to start of project).
4577 \end_layout
4579 \begin_layout Itemize
4580 This member constists of concatenation of records
4581 \end_layout
4583 \begin_layout Itemize
4584 Each record is 2-36 bytes long and can represent 1-16,843,009 consequtive
4585  IDs.
4586 \end_layout
4588 \begin_layout Itemize
4589 IDs are interpretted as 256-bit big-endian integers with warparound.
4590 \end_layout
4592 \begin_layout Itemize
4593 Initial predicted ID is all zeroes.
4594 \end_layout
4596 \begin_layout Standard
4597 Format of each record is:
4598 \end_layout
4600 \begin_layout Itemize
4601 1 byte: Opcode byte.
4602  Bits 0-4 are prefix length (prefixlen), bits 5-6 are count length (countlen).
4603  Bit 7 is unused.
4604 \end_layout
4606 \begin_layout Itemize
4607 32-prefixlen bytes of ID.
4608 \end_layout
4610 \begin_layout Itemize
4611 countlen bytes of big-endian count (count).
4612 \end_layout
4614 \begin_layout Standard
4615 Records are processed as follows:
4616 \end_layout
4618 \begin_layout Itemize
4619 To form the first ID encoded by record, take the first prefixlen bytes predicted
4620  ID and append the read ID value to it.
4621  The result is the first ID encoded.
4622 \end_layout
4624 \begin_layout Itemize
4625 If countlen is 0, record encodes 1 ID.
4626 \end_layout
4628 \begin_layout Itemize
4629 If countlen is 1, record encodes 2+count IDs.
4630 \end_layout
4632 \begin_layout Itemize
4633 If countlen is 2, record encodes 258+count IDs.
4634 \end_layout
4636 \begin_layout Itemize
4637 If countlen is 3, record encodes 65794+count IDs.
4638 \end_layout
4640 \begin_layout Itemize
4641 The new predicted ID is the next ID after last one encoded by the record.
4642 \end_layout
4644 \begin_layout Standard
4645 The number of rerecords + 1 is equal to the sum of number of IDs encoded
4646  by all records.
4647 \end_layout
4649 \begin_layout Subsection
4650 Member: starttime.second
4651 \end_layout
4653 \begin_layout Standard
4654 Movie starting time, second part.
4655  Epoch is Unix epoch.
4656  Default is 1,000,000,000.
4657 \end_layout
4659 \begin_layout Subsection
4660 Member: starttime.subsecond
4661 \end_layout
4663 \begin_layout Standard
4664 Movie starting time, subsecond part.
4665  Unit is CPU clocks.
4666  Default is 0.
4667 \end_layout
4669 \begin_layout Subsection
4670 Member: savetime.second
4671 \end_layout
4673 \begin_layout Standard
4674 Movie saving time, second part.
4675  Default is starttime.second.
4676  Only present in savestates.
4677 \end_layout
4679 \begin_layout Subsection
4680 Member: savetime.subsecond
4681 \end_layout
4683 \begin_layout Standard
4684 Movie saving time, subsecond part.
4685  Default is starttime.subsecond.
4686  Only present in savestates.
4687 \end_layout
4689 \begin_layout Section
4690 Quick'n'dirty encode guide
4691 \end_layout
4693 \begin_layout Enumerate
4694 Start the emulator and load the movie file.
4695 \end_layout
4697 \begin_layout Enumerate
4698 Set large AVI option 'set-setting avi-large on'
4699 \end_layout
4701 \begin_layout Enumerate
4702 Enable dumping 'dump-avi tmpdump' 
4703 \end_layout
4705 \begin_layout Enumerate
4706 Unpause and let it run until you want to end dumping.
4707 \end_layout
4709 \begin_layout Enumerate
4710 Close the emulator (closing the window is the easiest way).
4711  Or use 'end-avi'.
4712 \end_layout
4714 \begin_layout Enumerate
4715 For each tmpdump*.avi file created, on command prompt, do 'x264 --crf 10
4716  -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
4717 \end_layout
4719 \begin_layout Enumerate
4720 Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
4721 \end_layout
4723 \begin_layout Enumerate
4724 Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv + tmpdump_0000001.mkv
4725  + tmpdump_0000002.mkv' (list every tmpdump_<numbers>.mkv, with + in between).
4726 \end_layout
4728 \begin_layout Enumerate
4729 Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'.
4730  Now final.mkv contains quick'n'dirty encode.
4731 \end_layout
4733 \begin_layout Section
4734 Axis configurations for some gamepad types:
4735 \end_layout
4737 \begin_layout Subsection
4738 XBox360 controller:
4739 \end_layout
4741 \begin_layout Standard
4742 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be set to pressure-+.
4743 \end_layout
4745 \begin_layout LyX-Code
4746 set-axis joystick0axis2 pressure-+
4747 \end_layout
4749 \begin_layout LyX-Code
4750 set-axis joystick0axis5 pressure-+
4751 \end_layout
4753 \begin_layout Itemize
4754 This is needed for SDL only.
4755  EVDEV sets those types correctly.
4756 \end_layout
4758 \begin_layout Subsection
4759 PS3 
4760 \begin_inset Quotes eld
4761 \end_inset
4763 sixaxis
4764 \begin_inset Quotes erd
4765 \end_inset
4767  controller:
4768 \end_layout
4770 \begin_layout Standard
4771 Axes 8-19 should be disabled.
4772 \end_layout
4774 \begin_layout LyX-Code
4775 set-axis joystick0axis8 disabled
4776 \end_layout
4778 \begin_layout LyX-Code
4779 set-axis joystick0axis9 disabled
4780 \end_layout
4782 \begin_layout LyX-Code
4783 set-axis joystick0axis10 disabled
4784 \end_layout
4786 \begin_layout LyX-Code
4787 set-axis joystick0axis11 disabled
4788 \end_layout
4790 \begin_layout LyX-Code
4791 set-axis joystick0axis12 disabled
4792 \end_layout
4794 \begin_layout LyX-Code
4795 set-axis joystick0axis13 disabled
4796 \end_layout
4798 \begin_layout LyX-Code
4799 set-axis joystick0axis14 disabled
4800 \end_layout
4802 \begin_layout LyX-Code
4803 set-axis joystick0axis15 disabled
4804 \end_layout
4806 \begin_layout LyX-Code
4807 set-axis joystick0axis16 disabled
4808 \end_layout
4810 \begin_layout LyX-Code
4811 set-axis joystick0axis17 disabled
4812 \end_layout
4814 \begin_layout LyX-Code
4815 set-axis joystick0axis18 disabled
4816 \end_layout
4818 \begin_layout LyX-Code
4819 set-axis joystick0axis19 disabled
4820 \end_layout
4822 \begin_layout Section
4823 Errata:
4824 \end_layout
4826 \begin_layout Subsection
4827 Problems from BSNES core:
4828 \end_layout
4830 \begin_layout Itemize
4831 The whole pending save stuff.
4832 \end_layout
4834 \begin_layout Itemize
4835 Lack of layer hiding.
4836 \end_layout
4838 \begin_layout Itemize
4839 It is slow (especially accuracy).
4840 \end_layout
4842 \begin_layout Itemize
4843 Firmwares can't be loaded from ZIP archives.
4844 \end_layout
4846 \begin_layout Subsection
4847 Other problems:
4848 \end_layout
4850 \begin_layout Itemize
4851 Modifiers don't work with pseudo-keys (SDL, EVDEV).
4852 \end_layout
4854 \begin_layout Itemize
4855 Audio for last dumped frame is not itself dumped.
4856 \end_layout
4858 \begin_layout Itemize
4859 Audio in UI is pretty bad in quality if game doesn't run at full speed.
4860 \end_layout
4862 \begin_layout Itemize
4863 AVI compression levels 10-18 are not compatible with AVISynth AVISource.
4864 \end_layout
4866 \begin_layout Itemize
4867 No menus, command based interface (SDL).
4868 \end_layout
4870 \begin_layout Itemize
4871 Long commands don't scroll.
4872 \end_layout
4874 \begin_layout Itemize
4875 Wxwidgets UI is still buggy.
4876 \end_layout
4878 \begin_layout Section
4879 Changelog:
4880 \end_layout
4882 \begin_layout Subsection
4883 rr0-beta1
4884 \end_layout
4886 \begin_layout Itemize
4887 Fix -Wall warnings
4888 \end_layout
4890 \begin_layout Itemize
4891 Fix dumper video corruption with levels 10-18.
4892 \end_layout
4894 \begin_layout Subsection
4895 rr0-beta2
4896 \end_layout
4898 \begin_layout Itemize
4899 Autofire
4900 \end_layout
4902 \begin_layout Itemize
4903 Lots of code cleanups
4904 \end_layout
4906 \begin_layout Itemize
4907 Lua interface to settings
4908 \end_layout
4910 \begin_layout Itemize
4911 Allow specifying AVI borders without Lua
4912 \end_layout
4914 \begin_layout Itemize
4915 Fix scaling if vscale > 1 and originx > 0 (left border exists)
4916 \end_layout
4918 \begin_layout Itemize
4919 on_snoop lua callback
4920 \end_layout
4922 \begin_layout Itemize
4923 Faster movie loading and saving.
4924 \end_layout
4926 \begin_layout Subsection
4927 rr0-beta3
4928 \end_layout
4930 \begin_layout Itemize
4931 Joystick support
4932 \end_layout
4934 \begin_layout Subsection
4935 rr0-beta4
4936 \end_layout
4938 \begin_layout Itemize
4939 Fix multi-buttons
4940 \end_layout
4942 \begin_layout Itemize
4943 Save jukebox functionality.
4944 \end_layout
4946 \begin_layout Subsection
4947 rr0-beta5
4948 \end_layout
4950 \begin_layout Itemize
4951 Try to fix some nasty failing movie load edge cases
4952 \end_layout
4954 \begin_layout Itemize
4955 Allow specifying scripts to run on command line.
4956 \end_layout
4958 \begin_layout Subsection
4959 rr0-beta6
4960 \end_layout
4962 \begin_layout Itemize
4963 Major source code reorganization.
4964 \end_layout
4966 \begin_layout Itemize
4967 Backup savestates before overwriting.
4968 \end_layout
4970 \begin_layout Itemize
4971 Don't crash if loading initial state fails.
4972 \end_layout
4974 \begin_layout Subsection
4975 rr0-beta7
4976 \end_layout
4978 \begin_layout Itemize
4979 Fix firmware lookup
4980 \end_layout
4982 \begin_layout Itemize
4983 Fix author name parsing
4984 \end_layout
4986 \begin_layout Itemize
4987 Fix rerecord counting
4988 \end_layout
4990 \begin_layout Itemize
4991 (SDL) Print messages to console if SDL is uninitialized
4992 \end_layout
4994 \begin_layout Itemize
4995 Add movieinfo program
4996 \end_layout
4998 \begin_layout Itemize
4999 Fix loading movies starting from SRAM.
5000 \end_layout
5002 \begin_layout Subsection
5003 rr0-beta8
5004 \end_layout
5006 \begin_layout Itemize
5007 Add support for unattended dumping
5008 \end_layout
5010 \begin_layout Itemize
5011 Fix compiling for Win32
5012 \end_layout
5014 \begin_layout Itemize
5015 Don't lock up if sound can't be initialized
5016 \end_layout
5018 \begin_layout Itemize
5019 Strip trailing CR from commands
5020 \end_layout
5022 \begin_layout Itemize
5023 Don't try to do dubious things in global ctors (fix crash on startup)
5024 \end_layout
5026 \begin_layout Subsection
5027 rr0-beta9
5028 \end_layout
5030 \begin_layout Itemize
5031 Small documentation tweaking
5032 \end_layout
5034 \begin_layout Itemize
5035 Fix make clean
5036 \end_layout
5038 \begin_layout Itemize
5039 Fix major bug in modifier matching
5040 \end_layout
5042 \begin_layout Subsection
5043 rr0-beta10
5044 \end_layout
5046 \begin_layout Itemize
5047 Lots of documentation fixes
5048 \end_layout
5050 \begin_layout Itemize
5051 Use dedicated callbacks for event backcomm., not commands.
5052 \end_layout
5054 \begin_layout Itemize
5055 Ensure that the watchdog is not hit when executing delayed reset.
5056 \end_layout
5058 \begin_layout Itemize
5059 Remove errant tab from joystick message.
5060 \end_layout
5062 \begin_layout Subsection
5063 rr0-beta11
5064 \end_layout
5066 \begin_layout Itemize
5067 Make autofire operate in absolute time, not linear time
5068 \end_layout
5070 \begin_layout Itemize
5071 Reinitialize controls when resuming from loadstate
5072 \end_layout
5074 \begin_layout Itemize
5075 Some more code cleanups
5076 \end_layout
5078 \begin_layout Itemize
5079 If Lua allocator fails, call OOM_panic()
5080 \end_layout
5082 \begin_layout Itemize
5083 Byte/word/dword/qword sized host memory write/read functions.
5084 \end_layout
5086 \begin_layout Itemize
5087 Dump at correct framerate if dumping interlaced NTSC (height=448).
5088 \end_layout
5090 \begin_layout Subsection
5091 rr0-beta12
5092 \end_layout
5094 \begin_layout Itemize
5095 Actually include the complete source code
5096 \end_layout
5098 \begin_layout Itemize
5099 Keep track of RTC
5100 \end_layout
5102 \begin_layout Subsection
5103 rr0-beta13
5104 \end_layout
5106 \begin_layout Itemize
5107 Document {save,start}time.{,sub}second.
5108 \end_layout
5110 \begin_layout Itemize
5111 Intercept time() from bsnes core.
5112 \end_layout
5114 \begin_layout Subsection
5115 rr0-beta14
5116 \end_layout
5118 \begin_layout Itemize
5119 Allow disabling time() interception (allow build on Mac OS X)
5120 \end_layout
5122 \begin_layout Itemize
5123 Use SDLMain on Mac OS X (make SDL not crash)
5124 \end_layout
5126 \begin_layout Itemize
5127 Disable delayed resets (just plain too buggy for now).
5128 \end_layout
5130 \begin_layout Itemize
5131 Code cleanups
5132 \end_layout
5134 \begin_layout Itemize
5135 Use 16-bit for graphics/video instead of 32-bit.
5136 \end_layout
5138 \begin_layout Itemize
5139 gui.rectangle/gui.pixel
5140 \end_layout
5142 \begin_layout Itemize
5143 gui.crosshair
5144 \end_layout
5146 \begin_layout Itemize
5147 New CSCD writer implementation.
5148 \end_layout
5150 \begin_layout Subsection
5151 rr0-beta15
5152 \end_layout
5154 \begin_layout Itemize
5155 Fix interaction of * and +.
5156 \end_layout
5158 \begin_layout Itemize
5159 Manual improvements
5160 \end_layout
5162 \begin_layout Itemize
5163 Use gettimeofday()/usleep(), these seem portable enough.
5164 \end_layout
5166 \begin_layout Itemize
5167 Move joystick axis manipulation to keymapper code.
5168 \end_layout
5170 \begin_layout Itemize
5171 Changes to how read-only works.
5172 \end_layout
5174 \begin_layout Itemize
5175 Refactor controller input code.
5176 \end_layout
5178 \begin_layout Subsection
5179 rr0-beta16
5180 \end_layout
5182 \begin_layout Itemize
5183 Fix mouseclick scale compensation.
5184 \end_layout
5186 \begin_layout Itemize
5187 Draw area boundaries correctly in SDL code.
5188 \end_layout
5190 \begin_layout Itemize
5191 gui.screenshot.
5192 \end_layout
5194 \begin_layout Itemize
5195 Fix CSCD output (buffer overrun and race condition).
5196 \end_layout
5198 \begin_layout Subsection
5199 rr0-beta17
5200 \end_layout
5202 \begin_layout Itemize
5203 JMD dumping support.
5204 \end_layout
5206 \begin_layout Itemize
5207 Allow unattended dumping to JMD.
5208 \end_layout
5210 \begin_layout Itemize
5211 Move to BSNES v083.
5212 \end_layout
5214 \begin_layout Itemize
5215 Switch back to 32-bit colors.
5216 \end_layout
5218 \begin_layout Itemize
5219 Add Lua function gui.color.
5220 \end_layout
5222 \begin_layout Itemize
5223 Use some new C++11 features in GCC 4.6.
5224 \end_layout
5226 \begin_layout Itemize
5227 Be prepared for core frequency changes.
5228 \end_layout
5230 \begin_layout Itemize
5231 Pass colors in one chunk from Lua.
5232 \end_layout
5234 \begin_layout Subsection
5235 rr0-beta18
5236 \end_layout
5238 \begin_layout Itemize
5239 New lua functions gui.line(), gui.status() and gui.circle(), memory.vma_count(),
5240  memory.read_vma() and memory.find_vma().
5241 \end_layout
5243 \begin_layout Itemize
5244 Numerious documentation fixups
5245 \end_layout
5247 \begin_layout Itemize
5248 RTC time format changed
5249 \end_layout
5251 \begin_layout Itemize
5252 Reformat flags display
5253 \end_layout
5255 \begin_layout Itemize
5256 Allow lua package name to be overridden
5257 \end_layout
5259 \begin_layout Itemize
5260 SDUMP (high-quality dumping).
5261 \end_layout
5263 \begin_layout Itemize
5264 Split platform support to plugins.
5265 \end_layout
5267 \begin_layout Itemize
5268 Make all sound plugins support basic sound commands
5269 \end_layout
5271 \begin_layout Itemize
5272 Support portaudio for sound.
5273 \end_layout
5275 \begin_layout Itemize
5276 Allow disable Lua/SDL searching.
5277 \end_layout
5279 \begin_layout Itemize
5280 Upconvert colors when copying lcscreen to screen.
5281 \end_layout
5283 \begin_layout Itemize
5284 Reorganize source tree.
5285 \end_layout
5287 \begin_layout Itemize
5288 Evdev joystick support.
5289 \end_layout
5291 \begin_layout Itemize
5292 Refactor more code into generic window code.
5293 \end_layout
5295 \begin_layout Subsection
5296 rr0-beta19
5297 \end_layout
5299 \begin_layout Itemize
5300 Refactor message handling.
5301 \end_layout
5303 \begin_layout Itemize
5304 Rework makefile
5305 \end_layout
5307 \begin_layout Itemize
5308 Documentation fixes
5309 \end_layout
5311 \begin_layout Itemize
5312 Finish pending saves before load/quit.
5313 \end_layout
5315 \begin_layout Itemize
5316 Wxwidgets graphics plugin.
5317 \end_layout
5319 \begin_layout Subsection
5320 rr0-beta20
5321 \end_layout
5323 \begin_layout Itemize
5324 Get rid of win32-crap.[ch]pp.
5325 \end_layout
5327 \begin_layout Itemize
5328 Move files around a lot.
5329 \end_layout
5331 \begin_layout Itemize
5332 Get rid of need for host C++ compiler.
5333 \end_layout
5335 \begin_layout Itemize
5336 Bsnes v084 core.
5337 \end_layout
5339 \begin_layout Itemize
5340 Refactor inter-component communication.
5341 \end_layout
5343 \begin_layout Itemize
5344 Fix zero luma.
5345 \end_layout
5347 \begin_layout Itemize
5348 Fix crash on multiline aliases.
5349 \end_layout
5351 \begin_layout Itemize
5352 Load/Save settings in wxwidgets gui.
5353 \end_layout
5355 \begin_layout Subsection
5356 rr0-beta21
5357 \end_layout
5359 \begin_layout Itemize
5360 Patch problems in bsnes core
5361 \end_layout
5363 \begin_layout Itemize
5364 SNES is little-endian, not big-endian!
5365 \end_layout
5367 \begin_layout Itemize
5368 Fix memory corruption in lcscreen::load()
5369 \end_layout
5371 \begin_layout Subsection
5372 rr0-beta22
5373 \end_layout
5375 \begin_layout Itemize
5376 Fix interpretting repeat counts in rrdata loading.
5377 \end_layout
5379 \begin_layout Itemize
5380 New lua callback: on_frame()
5381 \end_layout
5383 \begin_layout Itemize
5384 Remove calls to runtosave() that aren't supposed to be there
5385 \end_layout
5387 \begin_layout Itemize
5388 Lua function: movie.read_rtc()
5389 \end_layout
5391 \begin_layout Itemize
5392 Ignore src/fonts/font.cpp
5393 \end_layout
5395 \begin_layout Itemize
5396 Fix more bsnes core problems
5397 \end_layout
5399 \begin_layout Itemize
5400 Control bsnes random seeding
5401 \end_layout
5403 \begin_layout Itemize
5404 Pause-on-end
5405 \end_layout
5407 \begin_layout Itemize
5408 Some bsnes core debugging features (state dump and state hash)
5409 \end_layout
5411 \begin_layout Itemize
5412 Fix titlebar version number (no, the last version wasn't 'lsnes-0-beta21',
5413  it was 'lsnes rr0-beta21').
5414 \end_layout
5416 \begin_layout Subsection
5417 rr0-beta23
5418 \end_layout
5420 \begin_layout Itemize
5421 Fix memory corruption due to macro/field mixup
5422 \end_layout
5424 \begin_layout Itemize
5425 search-memory update
5426 \end_layout
5428 \begin_layout Itemize
5429 Allow direct-mapped framebuffer
5430 \end_layout
5432 \begin_layout Itemize
5433 SDL: Use SDL_ANYFORMAT if possible
5434 \end_layout
5436 \begin_layout Itemize
5437 SDMP2SOX: 2s delay modes.
5438 \end_layout
5440 \begin_layout Itemize
5441 Wxwidgets: Cleanups
5442 \end_layout
5444 \begin_layout Itemize
5445 Use sed -E, not sed -r.
5446  Fixes building on Mac OS X.
5447 \end_layout
5449 \begin_layout Itemize
5450 Wxwidgets: Save jukebox on exit
5451 \end_layout
5453 \begin_layout Itemize
5454 Fix RTC if using load-movie on savestate.
5455 \end_layout
5457 \begin_layout Itemize
5458 Fix crash related to full console mode.
5459 \end_layout
5461 \begin_layout Subsection
5462 rr0-beta24
5463 \end_layout
5465 \begin_layout Itemize
5466 Wxwidgets: Allow bringing application to foreground on Mac OS X.
5467 \end_layout
5469 \begin_layout Itemize
5470 Wxwidgets: Allow compiling on Mac OS X.
5471 \end_layout
5473 \begin_layout Itemize
5474 Use movie compare instead of movie hashing (faster save/load).
5475 \end_layout
5477 \begin_layout Itemize
5478 Lua: _SYSTEM table.
5479 \end_layout
5481 \begin_layout Subsection
5482 rr0-beta25
5483 \end_layout
5485 \begin_layout Itemize
5486 sdmp2sox: Pad soundtrack if using -l or -L.
5487 \end_layout
5489 \begin_layout Itemize
5490 sdmp2sox: Fix NTSC overscan.
5491 \end_layout
5493 \begin_layout Itemize
5494 sdmp2sox: Add AR correction mode.
5495 \end_layout
5497 \begin_layout Itemize
5498 call lua_close() when exiting.
5499 \end_layout
5501 \begin_layout Itemize
5502 Fix zip_writer bug causing warnings from info-zip and error from advzip.
5503 \end_layout
5505 \begin_layout Subsection
5506 rr0-beta26
5507 \end_layout
5509 \begin_layout Itemize
5510 Fix IPS patching code (use bsnes core IPS patcher).
5511 \end_layout
5513 \begin_layout Itemize
5514 Implement BPS patching (using bsnes core IPS patcher).
5515 \end_layout
5517 \begin_layout Itemize
5518 Add feature to load headered ROMs.
5519 \end_layout
5521 \begin_layout Subsection
5522 rr0-beta27
5523 \end_layout
5525 \begin_layout Itemize
5526 Show command names when showing keybindings
5527 \end_layout
5529 \begin_layout Subsection
5531 \end_layout
5533 \begin_layout Itemize
5534 Fix pause-on-end to be actually controllable
5535 \end_layout
5537 \begin_layout Itemize
5538 SDL: Poll all events in queue, not just first one (fixes slowness in command
5539  typing)
5540 \end_layout
5542 \begin_layout Itemize
5543 Wxwidgets: Fix ROM loading.
5544 \end_layout
5546 \begin_layout Subsection
5547 rr1-beta0
5548 \end_layout
5550 \begin_layout Itemize
5551 Lua: Add gui.textH, gui.textV, gui.textHV
5552 \end_layout
5554 \begin_layout Itemize
5555 Fix text colors on SDL on Mac OS X
5556 \end_layout
5558 \begin_layout Itemize
5559 Mode 'F' for finished in readonly mode.
5560 \end_layout
5562 \begin_layout Itemize
5563 Fix some WS errors.
5564 \end_layout
5566 \begin_layout Itemize
5567 Reliably pause after skip poll
5568 \end_layout
5570 \begin_layout Itemize
5571 Split UI and core into their own threads
5572 \end_layout
5574 \begin_layout Subsection
5575 rr1-beta1
5576 \end_layout
5578 \begin_layout Itemize
5579 Remove leftover dummy SRAM slot
5580 \end_layout
5582 \begin_layout Itemize
5583 Fix controller numbers.
5584 \end_layout
5586 \begin_layout Subsection
5587 rr1-beta2
5588 \end_layout
5590 \begin_layout Itemize
5591 Fix lsnes-dumpavi after interface change.
5592 \end_layout
5594 \begin_layout Itemize
5595 Also give BSNES patches for v085.
5596 \end_layout
5598 \begin_layout Itemize
5599 Pack movie data in memory.
5600 \end_layout
5602 \begin_layout Subsection
5603 rr1-beta3
5604 \end_layout
5606 \begin_layout Itemize
5607 Fix framecount/length given when loading movies.
5608 \end_layout
5610 \begin_layout Itemize
5611 Controller command memory leak fixes.
5612 \end_layout
5614 \begin_layout Itemize
5615 Don't leak palette if freeing screen object.
5616 \end_layout
5618 \begin_layout Subsection
5619 rr1-beta4
5620 \end_layout
5622 \begin_layout Itemize
5623 Detect revisions.
5624 \end_layout
5626 \begin_layout Itemize
5627 Wxwidgets: Allow controlling dumper from the menu.
5628 \end_layout
5630 \begin_layout Subsection
5631 rr1-beta5
5632 \end_layout
5634 \begin_layout Itemize
5635 Rewrite parts of manual
5636 \end_layout
5638 \begin_layout Itemize
5639 Lua: Make it work with Lua 5.2.
5640 \end_layout
5642 \begin_layout Subsection
5643 rr1-beta6
5644 \end_layout
5646 \begin_layout Itemize
5647 Win32: Fix compile errors.
5648 \end_layout
5650 \begin_layout Subsection
5651 rr1-beta7
5652 \end_layout
5654 \begin_layout Itemize
5655 Refactor controller input code.
5656 \end_layout
5658 \begin_layout Itemize
5659 Fix crash when using command line on SDL / Mac OS X.
5660 \end_layout
5662 \begin_layout Subsection
5663 rr1-beta8
5664 \end_layout
5666 \begin_layout Itemize
5667 Delete core/coroutine (obsolete)
5668 \end_layout
5670 \begin_layout Itemize
5671 Lag input display by one frame.
5672 \end_layout
5674 \begin_layout Itemize
5675 Rewind movie to beginning function.
5676 \end_layout
5678 \begin_layout Itemize
5679 Fix wrong frame number reported to Lua when repainting after loadstate
5680 \end_layout
5682 \begin_layout Itemize
5683 Support UI editing of jukebox
5684 \end_layout
5686 \begin_layout Itemize
5687 Wxwidgets: Save settings on exit.
5688 \end_layout
5690 \begin_layout Itemize
5691 Support ${project} for filenames
5692 \end_layout
5694 \begin_layout Itemize
5695 SDL: Fix command history
5696 \end_layout
5698 \begin_layout Subsection
5699 rr1-beta9
5700 \end_layout
5702 \begin_layout Itemize
5703 Fix some order-of-global-ctor bugs.
5704 \end_layout
5706 \begin_layout Subsection
5707 rr1-beta10
5708 \end_layout
5710 \begin_layout Itemize
5711 Fix crashes when quitting on Win32.
5712 \end_layout
5714 \begin_layout Subsection
5715 rr1-beta11
5716 \end_layout
5718 \begin_layout Itemize
5719 EVDEV: Queue keypresses from joystick, don't send directly
5720 \end_layout
5722 \begin_layout Itemize
5723 Wxwidgets: Load-Preserve that actually works.
5724 \end_layout
5726 \begin_layout Subsection
5727 rr1-beta12
5728 \end_layout
5730 \begin_layout Itemize
5731 Wxwidgets: GUI for memory search.
5732 \end_layout
5734 \begin_layout Itemize
5735 Warn about using synchronous queue in UI callback.
5736 \end_layout
5738 \begin_layout Subsection
5739 rr1-beta13
5740 \end_layout
5742 \begin_layout Itemize
5743 Remember last saved file for each ROM
5744 \end_layout
5746 \begin_layout Itemize
5747 Support MT dumping via boost.
5748 \end_layout
5750 \begin_layout Itemize
5751 Lua: input.raw
5752 \end_layout
5754 \begin_layout Itemize
5755 Lua: input.keyhook
5756 \end_layout
5758 \begin_layout Itemize
5759 Make mouse be ordinary input instead of special-casing
5760 \end_layout
5762 \begin_layout Itemize
5763 SDL: Don't screw up commands with NUL codepoints.
5764 \end_layout
5766 \begin_layout Subsection
5767 rr1-beta14
5768 \end_layout
5770 \begin_layout Itemize
5771 Merge status panel and main window
5772 \end_layout
5774 \begin_layout Itemize
5775 True movie slot support (the rest of it)
5776 \end_layout
5778 \begin_layout Itemize
5779 SDL: Fix compilation error
5780 \end_layout
5782 \begin_layout Itemize
5783 Elminate cross calls in dump menu code.
5784 \end_layout
5786 \begin_layout Subsection
5787 rr1-beta15
5788 \end_layout
5790 \begin_layout Itemize
5791 Cancel pending saves command
5792 \end_layout
5794 \begin_layout Itemize
5795 Wxwidgets: Code refactoring
5796 \end_layout
5798 \begin_layout Itemize
5799 Wxwidgets: Fix system -> reset
5800 \end_layout
5802 \begin_layout Itemize
5803 Wxwidgets: Read watch expressions in the right thread
5804 \end_layout
5806 \begin_layout Subsection
5807 rr1-beta16
5808 \end_layout
5810 \begin_layout Itemize
5811 Wxwidgets: Don't prompt for member when running Lua script (Lua doesn't
5812  support that).
5813 \end_layout
5815 \begin_layout Itemize
5816 Wxwidgets: 128 -> 1024 Autohold slots (in case more are needed).
5817 \end_layout
5819 \begin_layout Itemize
5820 Don't append trailing '-' to prefix when saving movie.
5821 \end_layout
5823 \begin_layout Itemize
5824 Fix ROM/savestate handling (don't let user mismatch ROM and savestates).
5825 \end_layout
5827 \begin_layout Subsection
5829 \end_layout
5831 \begin_layout Itemize
5832 Document memory watch syntax.
5833 \end_layout
5835 \begin_layout Subsection
5836 rr1-delta1
5837 \end_layout
5839 \begin_layout Itemize
5840 Fix unattended dumping (lsnes-dumpavi)
5841 \end_layout
5843 \begin_layout Itemize
5844 Support RAW dumping
5845 \end_layout
5847 \begin_layout Itemize
5848 Use adv_dumper instead of the old interface in lsnes-dumpavi (changes syntax)
5849 \end_layout
5851 \begin_layout Itemize
5852 Add option to control sample rate preturbation in AVI dumper
5853 \end_layout
5855 \begin_layout Subsection
5856 rr1-delta2
5857 \end_layout
5859 \begin_layout Itemize
5860 Wxwidgets: Fix dumper submodes
5861 \end_layout
5863 \begin_layout Itemize
5864 Set core controller types before loadstate
5865 \end_layout
5867 \begin_layout Subsection
5868 rr1-delta2epsilon1
5869 \end_layout
5871 \begin_layout Itemize
5872 Fix compiling with bsnes v086.
5873 \end_layout
5875 \begin_layout Subsection
5876 rr1-delta3
5877 \end_layout
5879 \begin_layout Itemize
5880 Don't prompt before quitting
5881 \end_layout
5883 \begin_layout Itemize
5884 Start unpaused, preserve pause/unpause over load.
5885 \end_layout
5887 \begin_layout Itemize
5888 Try to autodetect if ROM is headered.
5889 \end_layout
5891 \begin_layout Itemize
5892 Wxwidgets: Only bring up ROM patching screen if specifically requested.
5893 \end_layout
5895 \begin_layout Itemize
5896 Allow configuring some hotkeys.
5897 \end_layout
5899 \begin_layout Subsection
5900 rr1-delta4
5901 \end_layout
5903 \begin_layout Itemize
5904 Lots of code cleanups
5905 \end_layout
5907 \begin_layout Itemize
5908 Fix JMD compression (JMD dumping was broken)
5909 \end_layout
5911 \begin_layout Itemize
5912 Don't crash if Lua C function throws an exception.
5913 \end_layout
5915 \begin_layout Itemize
5916 Support bitmap drawing in Lua.
5917 \end_layout
5919 \begin_layout Itemize
5920 Fix bsnes v085/v086 patches.
5921 \end_layout
5923 \begin_layout Itemize
5924 Improve stability on win32.
5925 \end_layout
5927 \begin_layout Subsection
5928 rr1-delta4epsilon1
5929 \end_layout
5931 \begin_layout Itemize
5932 Don't corrupt movie if movie length is integer multiple of frames per page.
5933 \end_layout
5935 \begin_layout Subsection
5936 rr1-delta5
5937 \end_layout
5939 \begin_layout Itemize
5940 New Lua hooks: on_rewind, on_frame_emulated, on_idle, on_timer
5941 \end_layout
5943 \begin_layout Itemize
5944 New Lua functions: emulator_ready(), utime(), set_idle_timeout(), set_timer_time
5945 out(), bit.extract(), bit.value(), input.geta(), input.seta() and input.controllertyp
5947 \end_layout
5949 \begin_layout Itemize
5950 Wxwidgets: Fix internal focus lost (hotkeys stop working)
5951 \end_layout
5953 \begin_layout Itemize
5954 Wxwidgets: Fix broken modifiers
5955 \end_layout
5957 \begin_layout Itemize
5958 on_paint has parameter now.
5959 \end_layout
5961 \begin_layout Itemize
5962 Optional initital fill for bitmaps
5963 \end_layout
5965 \begin_layout Itemize
5966 Fix palette changing.
5967 \end_layout
5969 \begin_layout Itemize
5970 Optimize rendering a bit.
5971 \end_layout
5973 \begin_layout Itemize
5974 Bsnes v087 support.
5975 \end_layout
5977 \begin_layout Subsection
5978 rr1-delta5epsilon1
5979 \end_layout
5981 \begin_layout Itemize
5982 Movieinfo: Fix display of port #2 type.
5983 \end_layout
5985 \begin_layout Itemize
5986 Call on_input() after loadstate.
5987 \end_layout
5989 \begin_layout Subsection
5990 rr1-delta5epsilon2
5991 \end_layout
5993 \begin_layout Itemize
5994 Fix writing port2 data to movie.
5995 \end_layout
5997 \begin_layout Itemize
5998 Fix SRAM handling with Bsnes v087.
5999 \end_layout
6001 \end_body
6002 \end_document