Add new lua hooks
[lsnes.git] / manual.lyx
blob4b9b903e79e4a884a829a1c2cdeda637cbba3d86
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 Section
769 Startup file lsnes.rc
770 \end_layout
772 \begin_layout Standard
773 Upon startup, lsnes (lsnes/SDL only) executes file lsnes.rc as commands.
774  This file is located in:
775 \end_layout
777 \begin_layout Itemize
778 Windows: %APPDATA%
779 \backslash
780 lsnes
781 \backslash
782 lsnes.rc (if %APPDATA% exists)
783 \end_layout
785 \begin_layout Itemize
786 Unix: $XDG_CONFIG_HOME/lsnes/lsnes.rc (if $XDG_CONFIG_HOME exists)
787 \end_layout
789 \begin_layout Itemize
790 Unix: $HOME/.config/lsnes/lsnes.rc (if $HOME exists)
791 \end_layout
793 \begin_layout Itemize
794 All: ./lsnes.rc (fallback default).
795 \end_layout
797 \begin_layout Standard
798 If leading directories do not exist, attempt to create them is made.
799 \end_layout
801 \begin_layout Section
802 Internal commands
803 \end_layout
805 \begin_layout Itemize
806 Commands beginning with '*' invoke the corresponding command without alias
807  expansion.
808 \end_layout
810 \begin_layout Itemize
811 If command starts with '+' (after possible '*'), the command is executed
812  as-is when button is pressed, and when button is released, it is executed
813  with '+' replaced by '-'.
814 \end_layout
816 \begin_layout Itemize
817 Commands without '+' execute only on negative edge (release).
818 \end_layout
820 \begin_layout Subsection
821 Settings:
822 \end_layout
824 \begin_layout Standard
825 Settings control various aspects of emulator behaviour.
826 \end_layout
828 \begin_layout Subsubsection
829 set-setting <setting> <value>
830 \end_layout
832 \begin_layout Standard
833 Sets setting <setting> to value <value> (may be empty).
834 \end_layout
836 \begin_layout Subsubsection
837 unset-setting <setting>
838 \end_layout
840 \begin_layout Standard
841 Try to unset setting <setting> (not all settings can be unset).
842 \end_layout
844 \begin_layout Subsubsection
845 get-setting <setting>
846 \end_layout
848 \begin_layout Standard
849 Read value of setting <setting>
850 \end_layout
852 \begin_layout Subsubsection
853 show-settings
854 \end_layout
856 \begin_layout Standard
857 Print names and values of all settings.
858 \end_layout
860 \begin_layout Subsection
861 Keybindings
862 \end_layout
864 \begin_layout Standard
865 Keybindings bind commands or aliases to keys (or pseudo-keys).
867 \end_layout
869 \begin_layout Standard
870 Notes:
871 \end_layout
873 \begin_layout Itemize
874 Do not bind edge active (+/-) commands to keys with modifiers, that won't
875  work right!
876 \end_layout
878 \begin_layout Itemize
879 Names of keys and modifiers are platform-dependent.
880 \end_layout
882 \begin_layout Itemize
883 Be careful before binding pseudo-keys (such as joystick axes, buttons or
884  hats) with modifiers.
885  That may or may not work right.
886 \end_layout
888 \begin_layout Subsubsection
889 bind-key [<mod>/<modmask>] <key> <command>
890 \end_layout
892 \begin_layout Standard
893 Bind <command> to key <key> (activating if modifiers in <modmask> (comma-seperat
894 ed list) are set as <mod> (comma-seperated list).
895 \end_layout
897 \begin_layout Standard
898 The names of keys and modifiers are platform-dependent.
899 \end_layout
901 \begin_layout Subsubsection
902 unbind-key [<mod>/<modmask>] <key>
903 \end_layout
905 \begin_layout Standard
906 Unbind command from <key> (with specified <mod> and <modmask>).
907 \end_layout
909 \begin_layout Subsubsection
910 set-axis <axis> [disabled | axis | axis-inverse | pressure0- | pressure0+
911  | pressure-0 | pressure-+ | pressure+0 | pressure+-] [minus=<val>] [zero=<val>]
912  [plus=<val>] [tolerance=<val>]
913 \end_layout
915 \begin_layout Standard
916 Set axis parameters for axis <axis>.
917 \end_layout
919 \begin_layout Itemize
920 disabled: Disable axis
921 \end_layout
923 \begin_layout Itemize
924 axis: Normal axis
925 \end_layout
927 \begin_layout Itemize
928 axis-inverse: Inverse axis
929 \end_layout
931 \begin_layout Itemize
932 pressure0-: Pressure sensitive.
933  Released at 0, pressed at -.
934 \end_layout
936 \begin_layout Itemize
937 pressure0+: Pressure sensitive.
938  Released at 0, pressed at +.
939 \end_layout
941 \begin_layout Itemize
942 pressure-0: Pressure sensitive.
943  Released at -, pressed at 0.
944 \end_layout
946 \begin_layout Itemize
947 pressure-+: Pressure sensitive.
948  Released at -, pressed at +.
949 \end_layout
951 \begin_layout Itemize
952 pressure+0: Pressure sensitive.
953  Released at +, pressed at 0.
954 \end_layout
956 \begin_layout Itemize
957 pressure+-: Pressure sensitive.
958  Released at +, pressed at -.
959 \end_layout
961 \begin_layout Itemize
962 minus=<val>: Calibration at extreme minus position (-32768-32767)
963 \end_layout
965 \begin_layout Itemize
966 zero=<val>: Calibration at neutral position (-32768-32767)
967 \end_layout
969 \begin_layout Itemize
970 plus=<val>: Calibration at extreme plus position (-32768-32767)
971 \end_layout
973 \begin_layout Itemize
974 tolerance=<value>: Center band tolerance (0<x<1).
975  The smaller the value, the more sensitive the control is.
976 \end_layout
978 \begin_layout Subsubsection
979 show-bindings
980 \end_layout
982 \begin_layout Standard
983 Print all key bindings in effect.
984 \end_layout
986 \begin_layout Subsection
987 Aliases
988 \end_layout
990 \begin_layout Standard
991 Aliases bind command to sequence of commands.
992  After alias has been defined, it replaces the command it shadows.
993 \end_layout
995 \begin_layout Standard
996 Notes:
997 \end_layout
999 \begin_layout Itemize
1000 You can't alias command to itself.
1001 \end_layout
1003 \begin_layout Itemize
1004 Aliases starting with +/- are edge active just like ordinary commands starting
1005  with +/-.
1006 \end_layout
1008 \begin_layout Itemize
1009 One command can be aliased to multiple commands.
1010 \end_layout
1012 \begin_layout Subsubsection
1013 alias-command <command> <expansion>
1014 \end_layout
1016 \begin_layout Standard
1017 Append <expansion> to alias <command>.
1018  If alias does not already exist, it is created.
1019 \end_layout
1021 \begin_layout Subsubsection
1022 unalias-command <command>
1023 \end_layout
1025 \begin_layout Standard
1026 Clear alias expansion for <command>.
1027 \end_layout
1029 \begin_layout Subsubsection
1030 show-aliases
1031 \end_layout
1033 \begin_layout Standard
1034 Print all aliases and their expansions in effect.
1035 \end_layout
1037 \begin_layout Subsection
1038 run-script <script>
1039 \end_layout
1041 \begin_layout Standard
1042 Run <script> as if commands were entered on the command line.
1043 \end_layout
1045 \begin_layout Subsection
1046 Video dumping
1047 \end_layout
1049 \begin_layout Standard
1050 Following commands control video dumping:
1051 \end_layout
1053 \begin_layout Subsubsection
1054 dump-avi <prefix>
1055 \end_layout
1057 \begin_layout Standard
1058 Dump AVI video to prefix <prefix> Notes:
1059 \end_layout
1061 \begin_layout Itemize
1062 The codec is Camstudio Codec in gzip mode.
1063 \end_layout
1065 \begin_layout Itemize
1066 Encoder and muxer are internal, available on all platforms.
1067 \end_layout
1069 \begin_layout Itemize
1070 Audio enable/disable and framerate has no effect.
1071 \end_layout
1073 \begin_layout Itemize
1074 The audio dumped to .avi is low-quality version.
1075  The high-quality version is dumped to .sox file.
1076 \end_layout
1078 \begin_layout Subsubsection
1079 end-avi
1080 \end_layout
1082 \begin_layout Standard
1083 End current AVI video dump (closing the emulator also closes the dump).
1084 \end_layout
1086 \begin_layout Subsubsection
1087 dump-jmd <file>
1088 \end_layout
1090 \begin_layout Standard
1091 Dump JMD video to file <file>.
1092 \end_layout
1094 \begin_layout Subsubsection
1095 end-jmd
1096 \end_layout
1098 \begin_layout Standard
1099 End the current JMD dump in progress.
1100 \end_layout
1102 \begin_layout Subsubsection
1103 dump-sdmp <prefix>
1104 \end_layout
1106 \begin_layout Standard
1107 Dump SDMP to <prefix>, splitting at 2GB.
1108 \end_layout
1110 \begin_layout Subsubsection
1111 dump-sdmp-ss <file>
1112 \end_layout
1114 \begin_layout Standard
1115 Dump SDMP to <file>, no splitting
1116 \end_layout
1118 \begin_layout Subsubsection
1119 end-sdmp
1120 \end_layout
1122 \begin_layout Standard
1123 End the current SDMP dump in progress.
1124 \end_layout
1126 \begin_layout Subsubsection
1127 dump-raw <prefix>
1128 \end_layout
1130 \begin_layout Standard
1131 Dump raw audio (to <prefix>.audio, at 32040.5Hz) and video (to <prefix>.video>,
1132  at nominal framerate and 512x448 / 512x478 size).
1133 \end_layout
1135 \begin_layout Subsubsection
1136 end-raw
1137 \end_layout
1139 \begin_layout Standard
1140 End the current RAW dump in progress.
1141 \end_layout
1143 \begin_layout Subsection
1144 Memory manipulation
1145 \end_layout
1147 \begin_layout Standard
1148 <address> may be decimal or hexadecimal (prefixed with '0x').
1149  <value> can be hexadecimal (prefixed with '0x'), unsigned or signed (prefixed
1150  with '-') decimal.
1151 \end_layout
1153 \begin_layout Standard
1154 The available element <sizes> are:
1155 \end_layout
1157 \begin_layout Itemize
1158 byte: 1 byte
1159 \end_layout
1161 \begin_layout Itemize
1162 word: 2 bytes
1163 \end_layout
1165 \begin_layout Itemize
1166 dword: 4 bytes
1167 \end_layout
1169 \begin_layout Itemize
1170 qword: 8 bytes
1171 \end_layout
1173 \begin_layout Standard
1174 When reading RAM and ROM, multi-byte reads/writes are big-endian.
1175  When dealing with DSP memory, multi-byte reads/writes are native-endian
1176  (do not use operand sizes exceeding DSP bitness, except dword is OK for
1177  24-bit memory).
1178 \end_layout
1180 \begin_layout Subsubsection
1181 read-<size> <address>
1182 \end_layout
1184 \begin_layout Standard
1185 Read the value of byte in <address>.
1186 \end_layout
1188 \begin_layout Subsubsection
1189 read-s<size> <address>
1190 \end_layout
1192 \begin_layout Standard
1193 Read the value of signed byte in <address>.
1194 \end_layout
1196 \begin_layout Subsubsection
1197 write-<size> <address> <value>
1198 \end_layout
1200 \begin_layout Standard
1201 Write <value> to byte in address <address>.
1202 \end_layout
1204 \begin_layout Subsubsection
1205 search-memory reset
1206 \end_layout
1208 \begin_layout Standard
1209 Reset the memory search
1210 \end_layout
1212 \begin_layout Subsubsection
1213 search-memory count
1214 \end_layout
1216 \begin_layout Standard
1217 Print number of candidates remaining
1218 \end_layout
1220 \begin_layout Subsubsection
1221 search-memory print
1222 \end_layout
1224 \begin_layout Standard
1225 Print all candidates remaining
1226 \end_layout
1228 \begin_layout Subsubsection
1229 search-memory <usflag><sizeflag><op>
1230 \end_layout
1232 \begin_layout Standard
1233 Searches memory for addresses satisfying criteria.
1234 \end_layout
1236 \begin_layout Standard
1237 <usflag> can be:
1238 \end_layout
1240 \begin_layout Itemize
1241 u: unsigned
1242 \end_layout
1244 \begin_layout Itemize
1245 s: signed
1246 \end_layout
1248 \begin_layout Standard
1249 <sizeflag> can be:
1250 \end_layout
1252 \begin_layout Itemize
1253 b: byte
1254 \end_layout
1256 \begin_layout Itemize
1257 w: word
1258 \end_layout
1260 \begin_layout Itemize
1261 d: dword
1262 \end_layout
1264 \begin_layout Itemize
1265 q: qword
1266 \end_layout
1268 \begin_layout Standard
1269 <op> can be:
1270 \end_layout
1272 \begin_layout Itemize
1273 lt: < previous value.
1274 \end_layout
1276 \begin_layout Itemize
1277 le: <= previous value.
1278 \end_layout
1280 \begin_layout Itemize
1281 eq: = previous value.
1282 \end_layout
1284 \begin_layout Itemize
1285 ne: != previous value.
1286 \end_layout
1288 \begin_layout Itemize
1289 ge: >= previous value.
1290 \end_layout
1292 \begin_layout Itemize
1293 gt: > previous value.
1294 \end_layout
1296 \begin_layout Subsubsection
1297 search-memory <sizeflag> <value>
1298 \end_layout
1300 \begin_layout Standard
1301 Searches for addresses that currently have value <value>.
1302  <sizeflag> is as in previous command.
1303 \end_layout
1305 \begin_layout Subsection
1306 Main commands
1307 \end_layout
1309 \begin_layout Standard
1310 These commands are not available in lsnesrc, but are available after ROM
1311  has been loaded.
1312 \end_layout
1314 \begin_layout Subsubsection
1315 quit-emulator [/y]
1316 \end_layout
1318 \begin_layout Standard
1319 Quits the emulator (asking for confirmation).
1320  If /y is given, no confirmation is asked.
1321 \end_layout
1323 \begin_layout Subsubsection
1324 pause-emulator
1325 \end_layout
1327 \begin_layout Standard
1328 Toggle paused/unpaused
1329 \end_layout
1331 \begin_layout Subsubsection
1332 +advance-frame 
1333 \end_layout
1335 \begin_layout Standard
1336 Advance frame.
1337  If the button is still held after configurable timeout expires, game unpauses
1338  for the duration frame advance is held.
1339 \end_layout
1341 \begin_layout Subsubsection
1342 +advance-poll 
1343 \end_layout
1345 \begin_layout Standard
1346 Advance subframe.
1347  If the button is still held after configurable timeout expires, game unpauses
1348  for the duration frame advance is held.
1349 \end_layout
1351 \begin_layout Subsubsection
1352 advance-skiplag 
1353 \end_layout
1355 \begin_layout Standard
1356 Skip to first poll in frame after current.
1357 \end_layout
1359 \begin_layout Subsubsection
1360 reset 
1361 \end_layout
1363 \begin_layout Standard
1364 Reset the SNES after this frame.
1365 \end_layout
1367 \begin_layout Subsubsection
1368 load <filename> 
1369 \end_layout
1371 \begin_layout Standard
1372 Load savestate <filename> in current mode.
1373 \end_layout
1375 \begin_layout Subsubsection
1376 load-state <filename> 
1377 \end_layout
1379 \begin_layout Standard
1380 Load savestate <filename> in readwrite mode.
1381 \end_layout
1383 \begin_layout Subsubsection
1384 load-readonly <filename> 
1385 \end_layout
1387 \begin_layout Standard
1388 Load savestate <filename> in readonly mode.
1389 \end_layout
1391 \begin_layout Subsubsection
1392 load-preserve <filename> 
1393 \end_layout
1395 \begin_layout Standard
1396 Load savestate <filename> in readonly mode, preserving current events.
1397 \end_layout
1399 \begin_layout Subsubsection
1400 load-movie <filename> 
1401 \end_layout
1403 \begin_layout Standard
1404 Load savestate <filename>, ignoring save part in readonly mode.
1405 \end_layout
1407 \begin_layout Subsubsection
1408 save-state <filename> 
1409 \end_layout
1411 \begin_layout Standard
1412 Save system state to <filename> as soon as possible.
1413 \end_layout
1415 \begin_layout Subsubsection
1416 save-movie <filename> 
1417 \end_layout
1419 \begin_layout Standard
1420 Save movie to <filename>.
1421 \end_layout
1423 \begin_layout Subsubsection
1424 set-rwmode 
1425 \end_layout
1427 \begin_layout Standard
1428 Set read-write mode.
1429 \end_layout
1431 \begin_layout Subsubsection
1432 set-romode 
1433 \end_layout
1435 \begin_layout Standard
1436 Set read-only mode
1437 \end_layout
1439 \begin_layout Subsubsection
1440 toggle-rwmode 
1441 \end_layout
1443 \begin_layout Standard
1444 Toggle between read-only and read-write modes.
1445 \end_layout
1447 \begin_layout Subsubsection
1448 set-gamename <name> 
1449 \end_layout
1451 \begin_layout Standard
1452 Set name of the game to <name>
1453 \end_layout
1455 \begin_layout Subsubsection
1456 get-gamename 
1457 \end_layout
1459 \begin_layout Standard
1460 Print the name of the game.
1461 \end_layout
1463 \begin_layout Subsubsection
1464 add-author <author> 
1465 \end_layout
1467 \begin_layout Standard
1468 Adds new author <author>.
1469  If <author> does not contain '|' it is full name.
1470  If it contains '|', '|' splits the full name and nickname.
1471 \end_layout
1473 \begin_layout Subsubsection
1474 edit-author <num> <author> 
1475 \end_layout
1477 \begin_layout Standard
1478 Edit the author in slot <num> (0-based) to be <author> (see add-author for
1479  format)
1480 \end_layout
1482 \begin_layout Subsubsection
1483 remove-author <num> 
1484 \end_layout
1486 \begin_layout Standard
1487 Remove author in slot <num>
1488 \end_layout
1490 \begin_layout Subsubsection
1491 print-authors 
1492 \end_layout
1494 \begin_layout Standard
1495 Print authors.
1496 \end_layout
1498 \begin_layout Subsubsection
1499 test-1, test-2, test-3
1500 \end_layout
1502 \begin_layout Standard
1503 Internal test commands.
1504  Don't use.
1505 \end_layout
1507 \begin_layout Subsubsection
1508 take-screenshot <filename> 
1509 \end_layout
1511 \begin_layout Standard
1512 Save screenshot to <filename>.
1513 \end_layout
1515 \begin_layout Subsubsection
1516 +controller<num><button>
1517 \end_layout
1519 \begin_layout Standard
1520 Press button <button> on controller <num> (1-8).
1521  The following button names are known:
1522 \end_layout
1524 \begin_layout Itemize
1525 left
1526 \end_layout
1528 \begin_layout Itemize
1529 right
1530 \end_layout
1532 \begin_layout Itemize
1534 \end_layout
1536 \begin_layout Itemize
1537 down
1538 \end_layout
1540 \begin_layout Itemize
1542 \end_layout
1544 \begin_layout Itemize
1546 \end_layout
1548 \begin_layout Itemize
1550 \end_layout
1552 \begin_layout Itemize
1554 \end_layout
1556 \begin_layout Itemize
1558 \end_layout
1560 \begin_layout Itemize
1562 \end_layout
1564 \begin_layout Itemize
1565 select
1566 \end_layout
1568 \begin_layout Itemize
1569 start
1570 \end_layout
1572 \begin_layout Itemize
1573 trigger
1574 \end_layout
1576 \begin_layout Itemize
1577 cursor
1578 \end_layout
1580 \begin_layout Itemize
1581 pause
1582 \end_layout
1584 \begin_layout Itemize
1585 turbo
1586 \end_layout
1588 \begin_layout Subsubsection
1589 controllerh<num><button>
1590 \end_layout
1592 \begin_layout Standard
1593 Hold/unhold button <button> on controller <num> (1-8).
1594  See +controller for button names.
1595 \end_layout
1597 \begin_layout Subsubsection
1598 autofire (<pattern>|-)...
1599 \end_layout
1601 \begin_layout Standard
1602 Set autofire pattern.
1603  Each parameter is comma-separated list of button names (in form of 1start,
1604  1A, 2B, etc..) to hold on that frame.
1605  After reaching the end of pattern, the pattern restarts from the beginning.
1606 \end_layout
1608 \begin_layout Subsubsection
1609 repaint
1610 \end_layout
1612 \begin_layout Standard
1613 Force a repaint.
1614 \end_layout
1616 \begin_layout Subsection
1617 Save jukebox 
1618 \end_layout
1620 \begin_layout Subsubsection
1621 cycle-jukebox-backward
1622 \end_layout
1624 \begin_layout Standard
1625 Cycle save jukebox backwards.
1626 \end_layout
1628 \begin_layout Subsubsection
1629 cycle-jukebox-forward
1630 \end_layout
1632 \begin_layout Standard
1633 Cycle save jukebox forwards
1634 \end_layout
1636 \begin_layout Subsubsection
1637 add-jukebox-save <filename>
1638 \end_layout
1640 \begin_layout Standard
1641 Add <filename> to jukebox saves.
1642 \end_layout
1644 \begin_layout Subsubsection
1645 load-jukebox
1646 \end_layout
1648 \begin_layout Standard
1649 Do load from jukebox (current mode).
1650 \end_layout
1652 \begin_layout Subsubsection
1653 save-jukebox
1654 \end_layout
1656 \begin_layout Standard
1657 Do state save to jukebox.
1658 \end_layout
1660 \begin_layout Subsection
1661 Lua 
1662 \end_layout
1664 \begin_layout Standard
1665 Only available if lua support is compiled in.
1666 \end_layout
1668 \begin_layout Subsubsection
1669 evaluate-lua <luacode>
1670 \end_layout
1672 \begin_layout Standard
1673 Run Lua code <luacode> using built-in Lua interpretter.
1674 \end_layout
1676 \begin_layout Subsubsection
1677 run-lua <script>
1678 \end_layout
1680 \begin_layout Standard
1681 Run specified lua file using built-in Lua interpretter.
1682 \end_layout
1684 \begin_layout Subsection
1685 Memory watch
1686 \end_layout
1688 \begin_layout Subsubsection
1689 add-watch <name> <expression>
1690 \end_layout
1692 \begin_layout Standard
1693 Adds new watch (or modifies old one).
1694 \end_layout
1696 \begin_layout Subsubsection
1697 remove-watch <name>
1698 \end_layout
1700 \begin_layout Standard
1701 Remove a watch.
1702 \end_layout
1704 \begin_layout Subsection
1705 Sound 
1706 \end_layout
1708 \begin_layout Subsubsection
1709 enable-sound <on/off> 
1710 \end_layout
1712 \begin_layout Standard
1713 Enable/Disable sound.
1714 \end_layout
1716 \begin_layout Subsubsection
1717 set-sound-device <device> 
1718 \end_layout
1720 \begin_layout Standard
1721 Set sound device to <device>
1722 \end_layout
1724 \begin_layout Subsubsection
1725 show-sound-status 
1726 \end_layout
1728 \begin_layout Standard
1729 Show status of sound system.
1730 \end_layout
1732 \begin_layout Subsubsection
1733 show-sound-devices
1734 \end_layout
1736 \begin_layout Standard
1737 Show all available devices.
1738 \end_layout
1740 \begin_layout Subsection
1741 SDL Platform commands 
1742 \end_layout
1744 \begin_layout Standard
1745 The following are valid on SDL platform.
1746 \end_layout
1748 \begin_layout Subsubsection
1749 identify-key
1750 \end_layout
1752 \begin_layout Standard
1753 Asks to press a key and then identifies that (pseudo-)key.
1754 \end_layout
1756 \begin_layout Subsubsection
1757 toggle-console 
1758 \end_layout
1760 \begin_layout Standard
1761 Toggle between windowed/fullscreen console.
1762 \end_layout
1764 \begin_layout Subsubsection
1765 scroll-fullup 
1766 \end_layout
1768 \begin_layout Standard
1769 Scroll messages window as far back as it goes.
1770 \end_layout
1772 \begin_layout Subsubsection
1773 scroll-fulldown 
1774 \end_layout
1776 \begin_layout Standard
1777 Scroll messages window as far forward as it goes.
1778 \end_layout
1780 \begin_layout Subsubsection
1781 scroll-up 
1782 \end_layout
1784 \begin_layout Standard
1785 Scroll messages window back one screenful.
1786 \end_layout
1788 \begin_layout Subsubsection
1789 scroll-down 
1790 \end_layout
1792 \begin_layout Standard
1793 Scroll messages window forward one screenful.
1794 \end_layout
1796 \begin_layout Section
1797 Settings
1798 \end_layout
1800 \begin_layout Subsection
1801 Core settings
1802 \end_layout
1804 \begin_layout Subsubsection
1805 firmwarepath
1806 \end_layout
1808 \begin_layout Standard
1809 Set where bsnes looks for firmware files.
1810  Default is 
1811 \begin_inset Quotes eld
1812 \end_inset
1815 \begin_inset Quotes erd
1816 \end_inset
1819 \end_layout
1821 \begin_layout Subsubsection
1822 targetfps
1823 \end_layout
1825 \begin_layout Standard
1826 Set the target fps.
1827  Numeric, range is 0.001 to 
1828 \begin_inset Quotes eld
1829 \end_inset
1831 infinite
1832 \begin_inset Quotes erd
1833 \end_inset
1836  Default is native framerate.
1837 \end_layout
1839 \begin_layout Subsubsection
1840 savecompression
1841 \end_layout
1843 \begin_layout Standard
1844 Set save compression level (integer 0-9).
1845  Default is 7 (0 is no compression).
1846 \end_layout
1848 \begin_layout Subsubsection
1849 advance-timeout
1850 \end_layout
1852 \begin_layout Standard
1853 Set the frame advance timeout in milliseconds.
1854  Numeric integer, range is 0-999999999.
1855  Default is 500.
1856 \end_layout
1858 \begin_layout Subsection
1859 AVI dumper settings
1860 \end_layout
1862 \begin_layout Subsubsection
1863 avi-large
1864 \end_layout
1866 \begin_layout Standard
1867 AVI dumper: Always dump at 512x448 or 512x478 regardless of what the console
1868  outputs.
1869 \end_layout
1871 \begin_layout Subsubsection
1872 avi-left-border
1873 \end_layout
1875 \begin_layout Standard
1876 AVI dumper: Set the default left border thickness (unless lua overrides)
1877  for dumps.
1878  Range 0-8191.
1879  Default is 0.
1880 \end_layout
1882 \begin_layout Subsubsection
1883 avi-right-border
1884 \end_layout
1886 \begin_layout Standard
1887 AVI dumper: Set the default right border thickness (unless lua overrides)
1888  for dumps.
1889  Range 0-8191.
1890  Default is 0.
1891 \end_layout
1893 \begin_layout Subsubsection
1894 avi-top-border
1895 \end_layout
1897 \begin_layout Standard
1898 AVI dumper: Set the default top border thickness (unless lua overrides)
1899  for dumps.
1900  Range 0-8191.
1901  Default is 0.
1902 \end_layout
1904 \begin_layout Subsubsection
1905 avi-bottom-border
1906 \end_layout
1908 \begin_layout Standard
1909 AVI dumper: Set the default bottom border thickness (unless lua overrides)
1910  for dumps.
1911  Range 0-8191.
1912  Default is 0.
1913 \end_layout
1915 \begin_layout Subsubsection
1916 avi-maxframes
1917 \end_layout
1919 \begin_layout Standard
1920 AVI dumper: Maximum number of frames per dump segment (0 => unlimited).
1921  Range 0-999999999.
1922  Default is 0.
1923 \end_layout
1925 \begin_layout Subsubsection
1926 avi-compresison
1927 \end_layout
1929 \begin_layout Standard
1930 AVI dumper: Compression level (0-18).
1931 \end_layout
1933 \begin_layout Itemize
1934 Compression levels 10 and above are not compatible with stock CSCD codec.
1935 \end_layout
1937 \begin_layout Itemize
1938 Recomended level is 7.
1939 \end_layout
1941 \begin_layout Subsubsection
1942 avi-soundrate
1943 \end_layout
1945 \begin_layout Standard
1946 AVI dumper: Set method of determining the sound rate.
1947 \end_layout
1949 \begin_layout Itemize
1950 0: Pick nearest of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, 48, 64, 88.2, 96,
1951  128, 176.4 and 192 kHz.
1952 \end_layout
1954 \begin_layout Itemize
1955 1: Round down to nearest integer.
1956 \end_layout
1958 \begin_layout Itemize
1959 2: Round up to nearest ingeter.
1960 \end_layout
1962 \begin_layout Subsection
1963 JMD options
1964 \end_layout
1966 \begin_layout Subsubsection
1967 jmd-copression
1968 \end_layout
1970 \begin_layout Standard
1971 JMD dumper: Compression level (0-9).
1972 \end_layout
1974 \begin_layout Subsection
1975 SDL platform settings
1976 \end_layout
1978 \begin_layout Subsubsection
1979 autorepeat-first-delay
1980 \end_layout
1982 \begin_layout Standard
1983 Sets the delay for first character in typematic autorepeat.
1984 \end_layout
1986 \begin_layout Subsubsection
1987 autorepeat-subsequent-delay
1988 \end_layout
1990 \begin_layout Standard
1991 Sets the delay for subsequent characters in typematic autorepeat.
1992 \end_layout
1994 \begin_layout Section
1995 Lua functions
1996 \end_layout
1998 \begin_layout Subsection
1999 Core (in main table)
2000 \end_layout
2002 \begin_layout Subsubsection
2003 print
2004 \end_layout
2006 \begin_layout Standard
2007 Print line to message console.
2008 \end_layout
2010 \begin_layout Subsubsection
2011 exec(string command)
2012 \end_layout
2014 \begin_layout Standard
2015 Run command as it was entered on the command line
2016 \end_layout
2018 \begin_layout Subsection
2019 Table bit:
2020 \end_layout
2022 \begin_layout Standard
2023 Bitwise logical functions and related.
2024 \end_layout
2026 \begin_layout Subsubsection
2027 bit.none(number...) / bit.bnot(number...)
2028 \end_layout
2030 \begin_layout Standard
2031 48-bit bitwise NOT / NONE function (set bits that are set in none of the
2032  arguments).
2033 \end_layout
2035 \begin_layout Subsubsection
2036 bit.any(number...) / bit.bor(number...)
2037 \end_layout
2039 \begin_layout Standard
2040 48-bit bitwise OR / ANY function (set bits that are set in any of the arguments).
2041 \end_layout
2043 \begin_layout Subsubsection
2044 bit.all(number...) / bit.band(number...)
2045 \end_layout
2047 \begin_layout Standard
2048 48-bit bitwise AND / ALL function (set bits that are set in all of the arguments
2050 \end_layout
2052 \begin_layout Subsubsection
2053 bit.parity(number...) / bit.bxor(number...)
2054 \end_layout
2056 \begin_layout Standard
2057 48-bit bitwise XOR / PARITY function (set bits that are set in odd number
2058  of the arguments).
2059 \end_layout
2061 \begin_layout Subsubsection
2062 bit.lrotate(number base[, number amount[, number bits]])
2063 \end_layout
2065 \begin_layout Standard
2066 Rotate bits-bit (max 48, default 48) number left by amount (default 1) places.
2067 \end_layout
2069 \begin_layout Subsubsection
2070 bit.rrotate(number base[, number amount[, number bits]])
2071 \end_layout
2073 \begin_layout Standard
2074 Rotate bits-bit (max 48, default 48) number right by amount (default 1)
2075  places.
2076 \end_layout
2078 \begin_layout Subsubsection
2079 bit.lshift(number base[, number amount[, number bits]])
2080 \end_layout
2082 \begin_layout Standard
2083 Shift bits-bit (max 48, default 48) number left by amount (default 1) places.
2084  The new bits are filled with zeroes.
2085 \end_layout
2087 \begin_layout Subsubsection
2088 bit.lrshift(number base[, number amount[, number bits]])
2089 \end_layout
2091 \begin_layout Standard
2092 Shift bits-bit (max 48, default 48) number logically right by amount (default
2093  1) places.
2094  The new bits are filled with zeroes.
2095 \end_layout
2097 \begin_layout Subsubsection
2098 bit.arshift(number base[, number amount[, number bits]])
2099 \end_layout
2101 \begin_layout Standard
2102 Shift bits-bit (max 48, default 48) number arithmetically right by amount
2103  (default 1) places.
2104  The new bits are shifted in with copy of the high bit.
2105 \end_layout
2107 \begin_layout Subsection
2108 Table gui:
2109 \end_layout
2111 \begin_layout Standard
2112 Most of these functions can only be called in on_paint and on_video callbacks.
2113  Exceptions are noted.
2114 \end_layout
2116 \begin_layout Standard
2117 Colors are 32-bit.
2118  Bits 0-7 are the blue component, bits 8-15 are the green component, bits
2119  16-23 are the red component, bits 24-31 are alpha component (0 is fully
2120  opaque, 255 is almost transparent).
2121  -1 is the fully transparent color.
2122  Alpha values greater than 127 do work.
2123 \end_layout
2125 \begin_layout Standard
2126 Origin of coordinates is at top left corner of game display area.
2127  Left and top gaps correspond to negative coordinates.
2128 \end_layout
2130 \begin_layout Subsubsection
2131 gui.resolution()
2132 \end_layout
2134 \begin_layout Standard
2135 Returns 2-tuple (hresolution, vresolution).
2136 \end_layout
2138 \begin_layout Subsubsection
2139 gui.<class>_gap(number gap)
2140 \end_layout
2142 \begin_layout Standard
2143 Set the <class> (left, right, top, bottom) gap to specified value (max gap
2144  is 8191).
2145 \end_layout
2147 \begin_layout Subsubsection
2148 gui.text(number x, number y, string text[, number fgc[, number bgc]])
2149 \end_layout
2151 \begin_layout Standard
2152 Draw specified text on the GUI (each character cell is 8 or 16 wide and
2153  16 high).
2154  Parameters:
2155 \end_layout
2157 \begin_layout Itemize
2158 x: X-coordinate to start the drawing from (and x-coordinate at begining
2159  of the lines).
2160 \end_layout
2162 \begin_layout Itemize
2163 y: Y-coordinate to start the drawing from.
2164 \end_layout
2166 \begin_layout Itemize
2167 text: The text to draw.
2168 \end_layout
2170 \begin_layout Itemize
2171 fgc: Text color (default is 0xFFFFFF (white))
2172 \end_layout
2174 \begin_layout Itemize
2175 bgc: Background color (default is -1 (transparent))
2176 \end_layout
2178 \begin_layout Subsubsection
2179 gui.textH(number x, number y, string text[, number fgc[, number bgc]])
2180 \end_layout
2182 \begin_layout Standard
2183 Like gui.text, but draw using double-width.
2184 \end_layout
2186 \begin_layout Subsubsection
2187 gui.textV(number x, number y, string text[, number fgc[, number bgc]])
2188 \end_layout
2190 \begin_layout Standard
2191 Like gui.text, but draw using double-height.
2192 \end_layout
2194 \begin_layout Subsubsection
2195 gui.textHV(number x, number y, string text[, number fgc[, number bgc]])
2196 \end_layout
2198 \begin_layout Standard
2199 Like gui.text, but draw using double-width/double-height.
2200 \end_layout
2202 \begin_layout Subsubsection
2203 gui.rectangle(number x, number y, number width, number height[, number thickness[
2204 , number outline[, number fill]]])
2205 \end_layout
2207 \begin_layout Standard
2208 Draw rectangle on the GUI.
2209  Parameters:
2210 \end_layout
2212 \begin_layout Itemize
2213 x: X-coordinate of left edge.
2214 \end_layout
2216 \begin_layout Itemize
2217 y: Y-coordinate of upper edge.
2218 \end_layout
2220 \begin_layout Itemize
2221 width: Width of rectangle.
2222 \end_layout
2224 \begin_layout Itemize
2225 height: Height of rectangle.
2226 \end_layout
2228 \begin_layout Itemize
2229 thickness: Thickness of outline (default is 1).
2230 \end_layout
2232 \begin_layout Itemize
2233 outline: Color of outline (default is 0xFFFFFF (white))
2234 \end_layout
2236 \begin_layout Itemize
2237 fill: Color of fil (default is -1 (transparent))
2238 \end_layout
2240 \begin_layout Subsubsection
2241 gui.pixel(number x, number y[, number color])
2242 \end_layout
2244 \begin_layout Standard
2245 Draw one pixel on the GUI.
2246  Parameters:
2247 \end_layout
2249 \begin_layout Itemize
2250 x: X-coordinate of the pixel
2251 \end_layout
2253 \begin_layout Itemize
2254 y: Y-coordinate of the pixel
2255 \end_layout
2257 \begin_layout Itemize
2258 color: Color of the pixel (default is 0xFFFFFF (white))
2259 \end_layout
2261 \begin_layout Subsubsection
2262 gui.crosshair(number x, number y[, number length[, number color]])
2263 \end_layout
2265 \begin_layout Standard
2266 Draw a crosshair.
2267  Parameters:
2268 \end_layout
2270 \begin_layout Itemize
2271 x: X-coordinate of the crosshair
2272 \end_layout
2274 \begin_layout Itemize
2275 y: Y-coordinate of the crosshair
2276 \end_layout
2278 \begin_layout Itemize
2279 length: Length of the crosshair lines (default 10).
2280 \end_layout
2282 \begin_layout Itemize
2283 color: Color of the crosshair (default is 0xFFFFFF (white))
2284 \end_layout
2286 \begin_layout Subsubsection
2287 gui.line(number x1, number y1, number x2, number y2[, number color])
2288 \end_layout
2290 \begin_layout Standard
2291 Draw a thin line.
2292  Parameters:
2293 \end_layout
2295 \begin_layout Itemize
2296 x1: X-coordinate of one end.
2297 \end_layout
2299 \begin_layout Itemize
2300 y1: Y-coordinate of one end.
2301 \end_layout
2303 \begin_layout Itemize
2304 x2: X-coordinate of the other end.
2305 \end_layout
2307 \begin_layout Itemize
2308 y2: Y-coordinate of the other end.
2309 \end_layout
2311 \begin_layout Itemize
2312 color: Color of the line (default is 0xFFFFFF (white)).
2313 \end_layout
2315 \begin_layout Subsubsection
2316 gui.circle(number x, number y, number r[, number thick[, number border[,
2317  number fil]]])
2318 \end_layout
2320 \begin_layout Standard
2321 Draw a circle.
2322  Parameters.
2323 \end_layout
2325 \begin_layout Itemize
2326 x: X-coordinate of the center
2327 \end_layout
2329 \begin_layout Itemize
2330 y: Y-coordinate of the center
2331 \end_layout
2333 \begin_layout Itemize
2334 r: The radius of the circle
2335 \end_layout
2337 \begin_layout Itemize
2338 thick: Border thickness
2339 \end_layout
2341 \begin_layout Itemize
2342 border: Border color (default is 0xFFFFFF (white))
2343 \end_layout
2345 \begin_layout Itemize
2346 fill: Fill color (default is -1 (transparent)).
2347 \end_layout
2349 \begin_layout Subsubsection
2350 gui.bitmap_draw(number x, number y, bitmap bitmap, palette palette)
2351 \end_layout
2353 \begin_layout Standard
2354 Draw a bitmap on screen with specified palette.
2355  Parameters:
2356 \end_layout
2358 \begin_layout Itemize
2359 x: X-coordinate of left edge.
2360 \end_layout
2362 \begin_layout Itemize
2363 y: Y-coordinate of top edge.
2364 \end_layout
2366 \begin_layout Itemize
2367 bitmap: The bitmap to draw
2368 \end_layout
2370 \begin_layout Itemize
2371 palette: The palette to draw the bitmap using.
2372 \end_layout
2374 \begin_layout Subsubsection
2375 gui.bitmap_draw(number x, number y, dbitmap bitmap)
2376 \end_layout
2378 \begin_layout Standard
2379 Draw a bitmap on screen.
2380  Parameters:
2381 \end_layout
2383 \begin_layout Itemize
2384 x: X-coordinate of left edge.
2385 \end_layout
2387 \begin_layout Itemize
2388 y: Y-coordinate of top edge.
2389 \end_layout
2391 \begin_layout Itemize
2392 bitmap: The bitmap to draw
2393 \end_layout
2395 \begin_layout Subsubsection
2396 gui.palette_new()
2397 \end_layout
2399 \begin_layout Standard
2400 Returns a new palette (initially all transparent).
2401  Can be used anywhere.
2402 \end_layout
2404 \begin_layout Subsubsection
2405 gui.bitmap_new(number w, number h, boolean direct)
2406 \end_layout
2408 \begin_layout Standard
2409 Returns a new bitmap/dbitmap.
2410  Can be used anywhere.
2411  Parameters:
2412 \end_layout
2414 \begin_layout Itemize
2415 w: The width of new bitmap
2416 \end_layout
2418 \begin_layout Itemize
2419 h: The height of new bitmap
2420 \end_layout
2422 \begin_layout Itemize
2423 direct: If true, the returned bitmap is dbitmap, otherwise bitmap.
2424 \end_layout
2426 \begin_layout Subsubsection
2427 gui.bitmap_load(string file)
2428 \end_layout
2430 \begin_layout Standard
2431 Returns loaded bitmap/dbitmap (if bitmap, the second return value is palette
2432  for bitmap).
2433  Can be used anywhere.
2434  Parameters:
2435 \end_layout
2437 \begin_layout Itemize
2438 file: The name of file to load.
2439 \end_layout
2441 \begin_layout Subsubsection
2442 gui.palette_set(palette palette, number index, number color)
2443 \end_layout
2445 \begin_layout Standard
2446 Sets color in palette.
2447  Can be used anywhere.
2448  Parameters:
2449 \end_layout
2451 \begin_layout Itemize
2452 palette: The palette to manipulate
2453 \end_layout
2455 \begin_layout Itemize
2456 index: Index of color (0-65535).
2457 \end_layout
2459 \begin_layout Itemize
2460 color: The color value.
2461 \end_layout
2463 \begin_layout Subsubsection
2464 gui.bitmap_pset(bitmap/dbitmap bitmap, number x, number y, number color)
2465 \end_layout
2467 \begin_layout Standard
2468 Sets specified pixel in bitmap.
2469  Can be used anywhere.
2470  Parameters:
2471 \end_layout
2473 \begin_layout Itemize
2474 bitmap: The bitmap to manipulate
2475 \end_layout
2477 \begin_layout Itemize
2478 x: The x-coordinate of the pixel.
2479 \end_layout
2481 \begin_layout Itemize
2482 y: The y-coordinate of the pixel.
2483 \end_layout
2485 \begin_layout Itemize
2486 color: If bitmap is a bitmap, color index (0-65535).
2487  Otherwise color value.
2488 \end_layout
2490 \begin_layout Subsubsection
2491 gui.bitmap_size(bitmap/dbitmap bitmap)
2492 \end_layout
2494 \begin_layout Standard
2495 Get size of bitmap.
2496  Can be used anywhere.
2497  Parameters:
2498 \end_layout
2500 \begin_layout Itemize
2501 bitmap: The bitmap to query.
2502 \end_layout
2504 \begin_layout Standard
2505 The first return is the width, the second is the height.
2506 \end_layout
2508 \begin_layout Subsubsection
2509 gui.bitmap_blit(bitmap/dbitmap dest, number dx, number dy, bitmap/dbitmap
2510  src, number sx, number sy, number w, number h[, number ck])
2511 \end_layout
2513 \begin_layout Standard
2514 Blit a part of bitmap to another.
2515  Can be used anywhere.
2516  Parameters:
2517 \end_layout
2519 \begin_layout Itemize
2520 dest: Destination to blit to.
2521 \end_layout
2523 \begin_layout Itemize
2524 dx: left edge of target
2525 \end_layout
2527 \begin_layout Itemize
2528 dy: Top edge of target
2529 \end_layout
2531 \begin_layout Itemize
2532 src: The source to blit from.
2533  Must be of the same type as destination.
2534 \end_layout
2536 \begin_layout Itemize
2537 sx: left edge of source
2538 \end_layout
2540 \begin_layout Itemize
2541 sy: Top edge of source
2542 \end_layout
2544 \begin_layout Itemize
2545 w: Width of region
2546 \end_layout
2548 \begin_layout Itemize
2549 h: Height of region.
2550 \end_layout
2552 \begin_layout Itemize
2553 ck: Color key.
2554  Pixels of this color are not blitted.
2555 \end_layout
2557 \begin_deeper
2558 \begin_layout Itemize
2559 If bitmaps are bitmaps, this is color index of colorkey.
2560  Values outside range 0-65535 cause no key to be used as colorkey.
2561 \end_layout
2563 \begin_layout Itemize
2564 If bitmaps are dbitmaps, this color value of colorkey.
2565 \end_layout
2567 \begin_layout Itemize
2568 May be absent or nil for no colorkey blit.
2569 \end_layout
2571 \end_deeper
2572 \begin_layout Subsubsection
2573 gui.repaint()
2574 \end_layout
2576 \begin_layout Standard
2577 Request on_repaint() to happen as soon as possible.
2578  Can be used anywhere.
2579 \end_layout
2581 \begin_layout Subsubsection
2582 gui.subframe_update(boolean on)
2583 \end_layout
2585 \begin_layout Standard
2586 Request subframe updates (calling on_paint() on subframes) to happen (on=true)
2587  or not happen (on=false).
2588  Can be used anywhere.
2589 \end_layout
2591 \begin_layout Subsubsection
2592 gui.screenshot(string filename)
2593 \end_layout
2595 \begin_layout Standard
2596 Write PNG screenshot of the current frame (no drawings) to specified file.
2597  Can be used anywhere.
2598 \end_layout
2600 \begin_layout Subsubsection
2601 gui.color(number r, number g, number b[, number a])
2602 \end_layout
2604 \begin_layout Standard
2605 Returns color (in notation Lua scripts use) corresponding to color (r,g,b),
2606  each component in scale 0-255.
2607  If a is specified, that is alpha (0 is fully transparent, 256(sic) is fully
2608  opaque).
2609  The default alpha is 256.
2610 \end_layout
2612 \begin_layout Subsubsection
2613 gui.status(string name, string value)
2614 \end_layout
2616 \begin_layout Standard
2617 Set status field 
2618 \begin_inset Quotes eld
2619 \end_inset
2621 L[<name>]
2622 \begin_inset Quotes erd
2623 \end_inset
2625  to <value> in status area.
2626  Can be used anywhere.
2627 \end_layout
2629 \begin_layout Subsection
2630 table input
2631 \end_layout
2633 \begin_layout Standard
2634 Input handling.
2635  Only available in on_input callback.
2636 \end_layout
2638 \begin_layout Subsubsection
2639 input.get(number controller, number index)
2640 \end_layout
2642 \begin_layout Standard
2643 Read the specified index (0-11) from specified controller (0-7).
2644  Notes:
2645 \end_layout
2647 \begin_layout Itemize
2648 Uses physical controller numbering.
2649  Gamepad in port 2 is controller 4, not 1!
2650 \end_layout
2652 \begin_layout Subsubsection
2653 input.set(number controller, number index, number value)
2654 \end_layout
2656 \begin_layout Standard
2657 Write the specified index (0-11) from specified controller (0-7), storing
2658  value.
2659  Notes:
2660 \end_layout
2662 \begin_layout Itemize
2663 Uses physical controller numbering.
2664  Gamepad in port 2 is controller 4, not 1!
2665 \end_layout
2667 \begin_layout Subsubsection
2668 input.reset([number cycles])
2669 \end_layout
2671 \begin_layout Standard
2672 Execute reset.
2673  If cycles is greater than zero, do delayed reset.
2674  0 (or no value) causes immediate reset.
2675 \end_layout
2677 \begin_layout Itemize
2678 Only available with subframe flag false.
2679 \end_layout
2681 \begin_layout Subsubsection
2682 input.raw()
2683 \end_layout
2685 \begin_layout Standard
2686 Returns table of tables of all available keys and axes.
2687  The first table is indexed by key name (platform-dependent!), and the inner
2688  table has the following fields:
2689 \end_layout
2691 \begin_layout Itemize
2692 last_rawval: Last reported raw value for control.
2693 \end_layout
2695 \begin_layout Itemize
2696 ktype: Type of key (disabled, key, mouse, axis, axis-inverse, hat, pressure-m0,
2697  pressure-mp, pressure-0m, pressure-0p, pressure-pm, pressure-p0).
2698 \end_layout
2700 \begin_layout Itemize
2701 cal_left: Minimum calibration value.
2702  Only meaningful with axis and pressure types.
2703 \end_layout
2705 \begin_layout Itemize
2706 cal_center: Center calibration value.
2707  Only meaningful with axis and pressure types.
2708 \end_layout
2710 \begin_layout Itemize
2711 cal_right: Maximum calibration value.
2712  Only meaningful with axis and pressure types.
2713 \end_layout
2715 \begin_layout Itemize
2716 cal_tolerance: Dead zone tolerance.
2717  Only meaningful with axis and pressure types.
2718 \end_layout
2720 \begin_layout Subsubsection
2721 input.keyhook(key, state)
2722 \end_layout
2724 \begin_layout Standard
2725 Requests that keyhook events to be sent for key (state=true) or not sent
2726  (state=false).
2727 \end_layout
2729 \begin_layout Subsection
2730 Table hostmemory
2731 \end_layout
2733 \begin_layout Standard
2734 Host memory handling (extra memory saved to savestates).
2735  Host memory starts empty.
2736 \end_layout
2738 \begin_layout Subsubsection
2739 hostmemory.read(number address)
2740 \end_layout
2742 \begin_layout Standard
2743 Reads hostmemory slot address.
2744  Slot numbers out of range return false instead of numeric.
2745 \end_layout
2747 \begin_layout Subsubsection
2748 hostmemory.write(number address, number value)
2749 \end_layout
2751 \begin_layout Standard
2752 Writes hostmemory slot with 0-255.
2753  Slot numbers out of range cause extension of host memory slot space.
2754 \end_layout
2756 \begin_layout Subsubsection
2757 hostmemory.readbyte(number address)
2758 \end_layout
2760 \begin_layout Standard
2761 Read unsigned byte (1 element) from given address.
2762  Slots out of range return false.
2763 \end_layout
2765 \begin_layout Subsubsection
2766 hostmemory.writebyte(number address, number value)
2767 \end_layout
2769 \begin_layout Standard
2770 Write unsigned byte (1 element) to given slot.
2771  Slot numbers out of range cause extension.
2772 \end_layout
2774 \begin_layout Subsubsection
2775 hostmemory.readsbyte(number address)
2776 \end_layout
2778 \begin_layout Standard
2779 Read signed byte (1 element) from given address.
2780  Slots out of range return false.
2781 \end_layout
2783 \begin_layout Subsubsection
2784 hostmemory.writesbyte(number address, number value)
2785 \end_layout
2787 \begin_layout Standard
2788 Write signed byte (1 element) to given slot.
2789  Slot numbers out of range cause extension.
2790 \end_layout
2792 \begin_layout Subsubsection
2793 hostmemory.readword(number address)
2794 \end_layout
2796 \begin_layout Standard
2797 Read unsigned word (2 elements) from given address.
2798  Slots out of range return false.
2799 \end_layout
2801 \begin_layout Subsubsection
2802 hostmemory.writeword(number address, number value)
2803 \end_layout
2805 \begin_layout Standard
2806 Write unsigned word (2 elements) to given slot.
2807  Slot numbers out of range cause extension.
2808 \end_layout
2810 \begin_layout Subsubsection
2811 hostmemory.readsword(number address)
2812 \end_layout
2814 \begin_layout Standard
2815 Read signed word (2 elements) from given address.
2816  Slots out of range return false.
2817 \end_layout
2819 \begin_layout Subsubsection
2820 hostmemory.writesword(number address, number value)
2821 \end_layout
2823 \begin_layout Standard
2824 Write signed word (2 elements) to given slot.
2825  Slot numbers out of range cause extension.
2826 \end_layout
2828 \begin_layout Subsubsection
2829 hostmemory.readdword(number address)
2830 \end_layout
2832 \begin_layout Standard
2833 Read unsigned doubleword (4 elements) from given address.
2834  Slots out of range return false.
2835 \end_layout
2837 \begin_layout Subsubsection
2838 hostmemory.writedword(number address, number value)
2839 \end_layout
2841 \begin_layout Standard
2842 Write unsigned doubleword (4 elements) to given slot.
2843  Slot numbers out of range cause extension.
2844 \end_layout
2846 \begin_layout Subsubsection
2847 hostmemory.readsdword(number address)
2848 \end_layout
2850 \begin_layout Standard
2851 Read signed doubleword (4 elements) from given address.
2852  Slots out of range return false.
2853 \end_layout
2855 \begin_layout Subsubsection
2856 hostmemory.writesdword(number address, number value)
2857 \end_layout
2859 \begin_layout Standard
2860 Write signed doubleword (4 elements) to given slot.
2861  Slot numbers out of range cause extension.
2862 \end_layout
2864 \begin_layout Subsubsection
2865 hostmemory.readqword(number address)
2866 \end_layout
2868 \begin_layout Standard
2869 Read unsigned quadword (8 elements) from given address.
2870  Slots out of range return false.
2871 \end_layout
2873 \begin_layout Subsubsection
2874 hostmemory.writeqword(number address, number value)
2875 \end_layout
2877 \begin_layout Standard
2878 Write unsigned quadword (4 elements) to given slot.
2879  Slot numbers out of range cause extension.
2880 \end_layout
2882 \begin_layout Subsubsection
2883 hostmemory.readsqword(number address)
2884 \end_layout
2886 \begin_layout Standard
2887 Read signed quadword (8 elements) from given address.
2888  Slots out of range return false.
2889 \end_layout
2891 \begin_layout Subsubsection
2892 hostmemory.writesqword(number address, number value)
2893 \end_layout
2895 \begin_layout Standard
2896 Write signed quadword (8 elements) to given slot.
2897  Slot numbers out of range cause extension.
2898 \end_layout
2900 \begin_layout Subsection
2901 Table movie
2902 \end_layout
2904 \begin_layout Standard
2905 Movie handling
2906 \end_layout
2908 \begin_layout Subsubsection
2909 movie.currentframe()
2910 \end_layout
2912 \begin_layout Standard
2913 Return number of current frame.
2914 \end_layout
2916 \begin_layout Subsubsection
2917 movie.framecount()
2918 \end_layout
2920 \begin_layout Standard
2921 Return number of frames in movie.
2922 \end_layout
2924 \begin_layout Subsubsection
2925 movie.readonly()
2926 \end_layout
2928 \begin_layout Standard
2929 Return true if in readonly mode, false if in readwrite.
2930 \end_layout
2932 \begin_layout Subsubsection
2933 movie.set_readwrite()
2934 \end_layout
2936 \begin_layout Standard
2937 Set readwrite mode (does not cause on_readwrite callback).
2938 \end_layout
2940 \begin_layout Subsubsection
2941 movie.frame_subframes(number frame)
2942 \end_layout
2944 \begin_layout Standard
2945 Count number of subframes in specified frame (frame numbers are 1-based)
2946  and return that.
2947 \end_layout
2949 \begin_layout Subsubsection
2950 movie.read_subframe(number frame, number subframe)
2951 \end_layout
2953 \begin_layout Standard
2954 Read specifed subframe in specified frame and return data as array (100
2955  elements, numbered 0-99 currently).
2956 \end_layout
2958 \begin_layout Subsection
2959 Table settings
2960 \end_layout
2962 \begin_layout Standard
2963 Routines for settings manipulation
2964 \end_layout
2966 \begin_layout Subsubsection
2967 settings.get(string name)
2968 \end_layout
2970 \begin_layout Standard
2971 Get value of setting.
2972  If setting is blank, returns false.
2973  If setting value can't be obtained, returns (nil, error message).
2974 \end_layout
2976 \begin_layout Subsubsection
2977 settings.set(string name, string value)
2978 \end_layout
2980 \begin_layout Standard
2981 Set value of setting.
2982  If setting can't be set, returns (nil, error message).
2983 \end_layout
2985 \begin_layout Subsubsection
2986 settings.is_set(string name)
2987 \end_layout
2989 \begin_layout Standard
2990 Returns if setting is set.
2991  If setting does not exist, returns (nil, error message).
2992 \end_layout
2994 \begin_layout Subsubsection
2995 settings.blank(string name)
2996 \end_layout
2998 \begin_layout Standard
2999 Blanks a setting and returns true.
3000  If setting can't be blanked, returns (nil, error message).
3001 \end_layout
3003 \begin_layout Subsection
3004 Table memory
3005 \end_layout
3007 \begin_layout Standard
3008 Contains various functions for managing memory
3009 \end_layout
3011 \begin_layout Subsubsection
3012 memory.vma_count()
3013 \end_layout
3015 \begin_layout Standard
3016 Returns the number of VMAs
3017 \end_layout
3019 \begin_layout Subsubsection
3020 memory.read_vma(number index)
3021 \end_layout
3023 \begin_layout Standard
3024 Reads the specified VMA (indices start from zero).
3025  Trying to read invalid VMA gives nil.
3026  The read VMA is table with the following fields:
3027 \end_layout
3029 \begin_layout Itemize
3030 region_name (string): The readable name of the VMA
3031 \end_layout
3033 \begin_layout Itemize
3034 baseaddr (number): Base address of the VMA
3035 \end_layout
3037 \begin_layout Itemize
3038 lastaddr (number): Last address in the VMA.
3039 \end_layout
3041 \begin_layout Itemize
3042 size (number): The size of VMA in bytes.
3043 \end_layout
3045 \begin_layout Itemize
3046 readonly (boolean): True of the VMA corresponds to ROM.
3047 \end_layout
3049 \begin_layout Itemize
3050 native_endian (boolean): True if the VMA has native endian as opposed to
3051  little endian.
3052 \end_layout
3054 \begin_layout Subsubsection
3055 memory.find_vma(number address)
3056 \end_layout
3058 \begin_layout Standard
3059 Finds the VMA containing specified address.
3060  Returns table in the same format as read_vma or nil if not found.
3061 \end_layout
3063 \begin_layout Subsubsection
3064 memory.readbyte(number address)
3065 \end_layout
3067 \begin_layout Standard
3068 Reads the specified address as unsigned byte and returns the result.
3069 \end_layout
3071 \begin_layout Subsubsection
3072 memory.readsbyte(number address)
3073 \end_layout
3075 \begin_layout Standard
3076 Reads the specified address as signed byte and returns the result.
3077 \end_layout
3079 \begin_layout Subsubsection
3080 memory.writebyte(number address, number value)
3081 \end_layout
3083 \begin_layout Standard
3084 Writes the specified value (negative values undergo 2's complement) to specified
3085  address (as a byte).
3086 \end_layout
3088 \begin_layout Subsubsection
3089 memory.readword(number address)
3090 \end_layout
3092 \begin_layout Standard
3093 Reads the specified address as unsigned word and returns the result.
3094 \end_layout
3096 \begin_layout Subsubsection
3097 memory.readsword(number address)
3098 \end_layout
3100 \begin_layout Standard
3101 Reads the specified address as signed word and returns the result.
3102 \end_layout
3104 \begin_layout Subsubsection
3105 memory.writeword(number address, number value)
3106 \end_layout
3108 \begin_layout Standard
3109 Writes the specified value (negative values undergo 2's complement) to specified
3110  address (as a word).
3111 \end_layout
3113 \begin_layout Subsubsection
3114 memory.readdword(number address)
3115 \end_layout
3117 \begin_layout Standard
3118 Reads the specified address as unsigned doubleword and returns the result.
3119 \end_layout
3121 \begin_layout Subsubsection
3122 memory.readsdword(number address)
3123 \end_layout
3125 \begin_layout Standard
3126 Reads the specified address as signed doubleword and returns the result.
3127 \end_layout
3129 \begin_layout Subsubsection
3130 memory.writedword(number address, number value)
3131 \end_layout
3133 \begin_layout Standard
3134 Writes the specified value (negative values undergo 2's complement) to specified
3135  address (as a doubleword).
3136 \end_layout
3138 \begin_layout Subsubsection
3139 memory.readqword(number address)
3140 \end_layout
3142 \begin_layout Standard
3143 Reads the specified address as unsigned quadword and returns the result.
3144 \end_layout
3146 \begin_layout Subsubsection
3147 memory.readsqword(number address)
3148 \end_layout
3150 \begin_layout Standard
3151 Reads the specified address as signed quadword and returns the result.
3152 \end_layout
3154 \begin_layout Subsubsection
3155 memory.writeqword(number address, number value)
3156 \end_layout
3158 \begin_layout Standard
3159 Writes the specified value (negative values undergo 2's complement) to specified
3160  address (as a quadword).
3161 \end_layout
3163 \begin_layout Subsection
3164 Table _SYSTEM
3165 \end_layout
3167 \begin_layout Standard
3168 Contains copy of global variables from time of Lua initialization.
3169  Non-writeable.
3170 \end_layout
3172 \begin_layout Subsection
3173 Callbacks
3174 \end_layout
3176 \begin_layout Standard
3177 Various callbacks to Lua that can occur.
3178 \end_layout
3180 \begin_layout Subsubsection
3181 Callback: on_paint()
3182 \end_layout
3184 \begin_layout Standard
3185 Called when screen is being painted.
3186  Any gui.* calls requiring graphic context draw on the screen.
3187 \end_layout
3189 \begin_layout Subsubsection
3190 Callback: on_video()
3191 \end_layout
3193 \begin_layout Standard
3194 Called when video dump frame is being painted.
3195  Any gui.* calls requiring graphic context draw on the video.
3196 \end_layout
3198 \begin_layout Subsubsection
3199 Callback: on_frame()
3200 \end_layout
3202 \begin_layout Standard
3203 Called on each starting whole frame.
3204 \end_layout
3206 \begin_layout Subsubsection
3207 Callback: on_startup()
3208 \end_layout
3210 \begin_layout Standard
3211 Called when the emulator is starting (lsnes.rc and --run files has been run).
3212 \end_layout
3214 \begin_layout Subsubsection
3215 Callback: on_pre_load(string name)
3216 \end_layout
3218 \begin_layout Standard
3219 Called just before savestate/movie load occurs (note: loads are always delayed,
3220  so this occurs even when load was initiated by lua).
3221 \end_layout
3223 \begin_layout Subsubsection
3224 Callback: on_err_load(string name)
3225 \end_layout
3227 \begin_layout Standard
3228 Called if loadstate goes wrong.
3229 \end_layout
3231 \begin_layout Subsubsection
3232 Callback: on_post_load(string name, boolean was_savestate)
3233 \end_layout
3235 \begin_layout Standard
3236 Called on successful loadstate.
3237  was_savestate gives if this was a savestate or a movie.
3238 \end_layout
3240 \begin_layout Subsubsection
3241 Callback: on_pre_save(string name, boolean is_savestate)
3242 \end_layout
3244 \begin_layout Standard
3245 Called just before savestate save occurs (note: movie saves are synchronous
3246  and won't trigger these callbacks if called from Lua).
3247 \end_layout
3249 \begin_layout Subsubsection
3250 Callback: on_err_save(string name)
3251 \end_layout
3253 \begin_layout Standard
3254 Called if savestate goes wrong.
3255 \end_layout
3257 \begin_layout Subsubsection
3258 Callback: on_post_save(string name, boolean is_savestate)
3259 \end_layout
3261 \begin_layout Standard
3262 Called on successful savaestate.
3263  is_savestate gives if this was a savestate or a movie.
3264 \end_layout
3266 \begin_layout Subsubsection
3267 Callback: on_quit()
3268 \end_layout
3270 \begin_layout Standard
3271 Called when emulator is shutting down.
3272 \end_layout
3274 \begin_layout Subsubsection
3275 Callback: on_input(boolean subframe)
3276 \end_layout
3278 \begin_layout Standard
3279 Called when emulator is just sending input to bsnes core.
3280  Warning: This is called even in readonly mode, but the results are ignored.
3281 \end_layout
3283 \begin_layout Subsubsection
3284 Callback: on_reset()
3285 \end_layout
3287 \begin_layout Standard
3288 Called when SNES is reset.
3289 \end_layout
3291 \begin_layout Subsubsection
3292 Callback: on_readwrite()
3293 \end_layout
3295 \begin_layout Standard
3296 Called when moving into readwrite mode as result of 
3297 \begin_inset Quotes eld
3298 \end_inset
3300 set-rwmode
3301 \begin_inset Quotes erd
3302 \end_inset
3304  command (note: moving to rwmode by Lua won't trigger this, as per recursive
3305  entry protection).
3306 \end_layout
3308 \begin_layout Subsubsection
3309 Callback: on_snoop(number port, number controller, number index, number
3310  value)
3311 \end_layout
3313 \begin_layout Standard
3314 Called each time bsnes asks for input.
3315  The value is the final value to be sent to bsnes core (readonly mode, autohold
3316  and autofire have been taken into account).
3317  Might be useful when translating movies to format suitable for console
3318  verification.
3319  Note: There is no way to modify the value to be sent.
3320 \end_layout
3322 \begin_layout Subsubsection
3323 Callback: on_keyhook(string keyname, table state)
3324 \end_layout
3326 \begin_layout Standard
3327 Sent when key that has keyhook events requested changes state.
3328  Keyname is name of the key (group) and state is the state (same kind as
3329  table values in input.raw).
3330 \end_layout
3332 \begin_layout Section
3333 Memory watch expression syntax
3334 \end_layout
3336 \begin_layout Standard
3337 Memory watch expressions are in RPN (Reverse Polish Notation).
3338  At the end of expression, the top entry on stack is taken as the final
3339  result.
3340 \end_layout
3342 \begin_layout Standard
3343 Notations:
3344 \end_layout
3346 \begin_layout Itemize
3347 Evaluation order is strictly left to right.
3348 \end_layout
3350 \begin_layout Itemize
3351 a is the entry on top of stack
3352 \end_layout
3354 \begin_layout Itemize
3355 b is the entry immediately below top of stack
3356 \end_layout
3358 \begin_layout Itemize
3359 ; separates values to be pushed (no intermediate pop).
3360 \end_layout
3362 \begin_layout Itemize
3363 After end of element, all used stack slots are popped and all results are
3364  pushed.
3365 \end_layout
3367 \begin_layout Itemize
3368 When pushing multiple values, the pushes occur in order shown.
3369 \end_layout
3371 \begin_layout Standard
3372 The following operators are available:
3373 \end_layout
3375 \begin_layout Itemize
3376 + : a + b
3377 \end_layout
3379 \begin_layout Itemize
3380 - : a - b
3381 \end_layout
3383 \begin_layout Itemize
3384 * : a * b
3385 \end_layout
3387 \begin_layout Itemize
3388 / : a / b
3389 \end_layout
3391 \begin_layout Itemize
3392 % : a % b
3393 \end_layout
3395 \begin_layout Itemize
3396 a : atan(a)
3397 \end_layout
3399 \begin_layout Itemize
3400 b : read_signed_byte(a)
3401 \end_layout
3403 \begin_layout Itemize
3404 c : cos(a)
3405 \end_layout
3407 \begin_layout Itemize
3408 d : read_signed_dword(a)
3409 \end_layout
3411 \begin_layout Itemize
3412 i : quotent(a / b)
3413 \end_layout
3415 \begin_layout Itemize
3416 p :
3417 \begin_inset Formula $\pi$
3418 \end_inset
3421 \end_layout
3423 \begin_layout Itemize
3424 q : read_signed_qword(a)
3425 \end_layout
3427 \begin_layout Itemize
3428 r : sqrt(a)
3429 \end_layout
3431 \begin_layout Itemize
3432 s : sin(a)
3433 \end_layout
3435 \begin_layout Itemize
3436 t : tan(a)
3437 \end_layout
3439 \begin_layout Itemize
3440 u : a; a
3441 \end_layout
3443 \begin_layout Itemize
3444 w : read_signed_word(a)
3445 \end_layout
3447 \begin_layout Itemize
3448 A : atan2(a, b)
3449 \end_layout
3451 \begin_layout Itemize
3452 B : read_unsigned_byte(a)
3453 \end_layout
3455 \begin_layout Itemize
3456 C<number>z : Push number <number> to stack.
3457 \end_layout
3459 \begin_layout Itemize
3460 D : read_unsigned_dword(a)
3461 \end_layout
3463 \begin_layout Itemize
3464 C0x<number>z : Push number <number> (hexadecimal) to stack.
3465 \end_layout
3467 \begin_layout Itemize
3468 Q : read_unsigned_qword(a)
3469 \end_layout
3471 \begin_layout Itemize
3472 R<digit> : round a to <digit> digits.
3473 \end_layout
3475 \begin_layout Itemize
3476 W : read_unsigned_word(a)
3477 \end_layout
3479 \begin_layout Subsection
3480 Example:
3481 \end_layout
3483 \begin_layout Standard
3484 C0x007e0878zWC0x007e002czW-
3485 \end_layout
3487 \begin_layout Enumerate
3488 Push value 0x7e0878 on top of stack (C0x007e0878z).
3489 \end_layout
3491 \begin_layout Enumerate
3492 Pop the value on top of stack (0x7e0878), read word value at that address
3493  and push the result,call it x1 (W).
3494 \end_layout
3496 \begin_layout Enumerate
3497 Push value 0x7e002c on top of stack (C0x007e002cz).
3498 \end_layout
3500 \begin_layout Enumerate
3501 Pop the value on top of stack (0x7e002c), read word value at that address
3502  and push the result,call it x2 (W).
3503 \end_layout
3505 \begin_layout Enumerate
3506 Pop the two top numbers on stack, x1 and x2, substract x1 from x2 and push
3507  x2 - x1 (-).
3508 \end_layout
3510 \begin_layout Enumerate
3511 Since the expression ends, the final memory watch result is the top one
3512  on stack, which is x2 - x1.
3513 \end_layout
3515 \begin_layout Section
3516 Modifier and key names:
3517 \end_layout
3519 \begin_layout Subsection
3520 SDL Platform
3521 \end_layout
3523 \begin_layout Subsubsection
3524 Modifier names
3525 \end_layout
3527 \begin_layout Standard
3528 Following modifier names are known:
3529 \end_layout
3531 \begin_layout Itemize
3532 ctrl, lctrl, rctrl: Control keys
3533 \end_layout
3535 \begin_layout Itemize
3536 alt, lalt, ralt: ALT keys.
3537 \end_layout
3539 \begin_layout Itemize
3540 shift, lshift, rshift: Shift keys.
3541 \end_layout
3543 \begin_layout Itemize
3544 meta, lmeta, rmeta: Meta keys.
3545 \end_layout
3547 \begin_layout Itemize
3548 num, caps: Numlock/Capslock (these are sticky!)
3549 \end_layout
3551 \begin_layout Itemize
3552 mode: Mode select.
3553 \end_layout
3555 \begin_layout Subsubsection
3556 Key names
3557 \end_layout
3559 \begin_layout Standard
3560 Following key names are known:
3561 \end_layout
3563 \begin_layout Itemize
3564 backspace, tab, clear, return, pause, escape, space, exclaim, quotedbl,
3565  hash, dollar, ampersand, quote, leftparen, rightparen, asterisk, plus,
3566  comma, minus, period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon,
3567  less, equals, greater, question, at, leftbracket, backslash, rightbracket,
3568  caret, underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n,
3569  o, p, q, r, s, t, u, v, w, x, y, z, delete, world_0, world_1, world_2,
3570  world_3, world_4, world_5, world_6, world_7, world_8, world_9, world_10,
3571  world_11, world_12, world_13, world_14, world_15, world_16, world_17, world_18,
3572  world_19, world_20, world_21, world_22, world_23, world_24, world_25, world_26,
3573  world_27, world_28, world_29, world_30, world_31, world_32, world_33, world_34,
3574  world_35, world_36, world_37, world_38, world_39, world_40, world_41, world_42,
3575  world_43, world_44, world_45, world_46, world_47, world_48, world_49, world_50,
3576  world_51, world_52, world_53, world_54, world_55, world_56, world_57, world_58,
3577  world_59, world_60, world_61, world_62, world_63, world_64, world_65, world_66,
3578  world_67, world_68, world_69, world_70, world_71, world_72, world_73, world_74,
3579  world_75, world_76, world_77, world_78, world_79, world_80, world_81, world_82,
3580  world_83, world_84, world_85, world_86, world_87, world_88, world_89, world_90,
3581  world_91, world_92, world_93, world_94, world_95, kp0, kp1, kp2, kp3, kp4,
3582  kp5, kp6, kp7, kp8, kp9, kp_period, kp_divide, kp_multiply, kp_minus, kp_plus,
3583  kp_enter, kp_equals, up, down, right, left, insert, home, end, pageup,
3584  pagedown, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14,
3585  f15, numlock, capslock, scrollock, rshift, lshift, rctrl, lctrl, ralt,
3586  lalt, rmeta, lmeta, lsuper, rsuper, mode, compose, help, print, sysreq,
3587  break, menu, power, euro, undo
3588 \end_layout
3590 \begin_layout Itemize
3591 Names of form 'key<n>' where <n> is 0-255 are interpretted as key having
3592  hardware-dependent scan code of <n> (useful to bind those keys that don't
3593  have symbolic names).
3594 \end_layout
3596 \begin_layout Subsubsection
3597 Joystick pseudo-keys:
3598 \end_layout
3600 \begin_layout Itemize
3601 joystick<num>button<button>: Joystick <num> (0-based) button <button> (0-based).
3602 \end_layout
3604 \begin_layout Itemize
3605 joystick<num>hat<hat>n: Joystick <num> (0-based) hat <hat> (0-based) up.
3606 \end_layout
3608 \begin_layout Itemize
3609 joystick<num>hat<hat>w: Joystick <num> (0-based) hat <hat> (0-based) left.
3610 \end_layout
3612 \begin_layout Itemize
3613 joystick<num>hat<hat>s: Joystick <num> (0-based) hat <hat> (0-based) down.
3614 \end_layout
3616 \begin_layout Itemize
3617 joystick<num>hat<hat>e: Joystick <num> (0-based) hat <hat> (0-based) right.
3618 \end_layout
3620 \begin_layout Itemize
3621 joystick<num>axis<axis>-: Joystick <num> (0-based) axis <axis> negative
3622  position (axis modes axis and axis_inverse).
3623 \end_layout
3625 \begin_layout Itemize
3626 joystick<num>axis<axis>+: Joystick <num> (0-based) axis <axis> positive
3627  position (axis modes axis and axis_inverse).
3628 \end_layout
3630 \begin_layout Itemize
3631 joystick<num>axis<axis>: Joystick <num> (0-based) axis <axis> pressure (axis
3632  modes pressure_*).
3633 \end_layout
3635 \begin_layout Subsubsection
3636 Special buttons:
3637 \end_layout
3639 \begin_layout Itemize
3640 Escape: Enter/Exit Command mode, cancel modal dialogs.
3641 \end_layout
3643 \begin_layout Itemize
3644 Return (also KPEnter): Execute command, ok modal dialog.
3645 \end_layout
3647 \begin_layout Itemize
3648 Pgup/Up (also KP8/9 if no num lock; command mode): Previous command in command
3649  history
3650 \end_layout
3652 \begin_layout Itemize
3653 Pgdn/Down(also KP2/3 if no num lock; command mode): Next command in command
3654  history
3655 \end_layout
3657 \begin_layout Itemize
3658 Home (also KP7 if no num lock; command mode): Beginning of command.
3659 \end_layout
3661 \begin_layout Itemize
3662 End (also KP1 if no num lock; command mode): End of command.
3663 \end_layout
3665 \begin_layout Itemize
3666 Left (also KP4 if no num lock; command mode): Move cursor left.
3667 \end_layout
3669 \begin_layout Itemize
3670 Right (also KP6 if no num lock; command mode): Move cursor right.
3671 \end_layout
3673 \begin_layout Itemize
3674 Delete (also KP.
3675  if no num lock; command mode): Delete character to right of cursor.
3676 \end_layout
3678 \begin_layout Itemize
3679 Insert (also KP0 if no num lock; command mode): Toggle between insert /
3680  overwrite modes.
3681 \end_layout
3683 \begin_layout Itemize
3684 Backspace (command mode): Delete character to left of cursor.
3685 \end_layout
3687 \begin_layout Itemize
3688 LCTRL+LALT+ESCAPE: Ungraceful shutdown (leaves dump corrupted!).
3689 \end_layout
3691 \begin_layout Subsection
3692 wxWidgets platform
3693 \end_layout
3695 \begin_layout Subsubsection
3696 Modifier names:
3697 \end_layout
3699 \begin_layout Standard
3700 Following modifier names are known:
3701 \end_layout
3703 \begin_layout Itemize
3705 \end_layout
3707 \begin_layout Itemize
3708 ctrl
3709 \end_layout
3711 \begin_layout Itemize
3712 shift 
3713 \end_layout
3715 \begin_layout Itemize
3716 meta
3717 \end_layout
3719 \begin_layout Itemize
3720 cmd (Mac OS X only)
3721 \end_layout
3723 \begin_layout Subsubsection
3724 Key names:
3725 \end_layout
3727 \begin_layout Standard
3728 Following key names are known:
3729 \end_layout
3731 \begin_layout Itemize
3732 back, tab, return, escape, space, exclaim, quotedbl, hash, dollar, percent,
3733  ampersand, quote, leftparen, rightparen, asterisk, plus, comma, minus,
3734  period, slash, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, colon, semicolon, less, equals,
3735  greater, question, at, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3736  q, r, s, t, u, v, w, x, y, z, leftbracket, backslash, rightbracket, caret,
3737  underscore, backquote, a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p,
3738  q, r, s, t, u, v, w, x, y, z, leftcurly, pipe, rightcurly, tilde, delete,
3739  start, lbutton, rbutton, cancel, mbutton, clear, shift, alt, control, menu,
3740  pause, capital, end, home, lefT, up, right, down, select, print, execute,
3741  snapshot, insert, help, numpad0, numpad1, numpad2, numpad3, numpad4, numpad5,
3742  numpad6, numpad7, numpad8, numpad9, multiply, add, separator, subtract,
3743  decimal, divide, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13,
3744  f14, f15, f16, f17, f18, f19, f20, f21, f22, f23, f24, numlock, scroll,
3745  pageup, pagedown, numpad_space, numpad_tab, numpad_enter, numpad_f1, numpad_f2,
3746  numpad_f3, numpad_f4, numpad_home, numpad_left, numpad_up, numpad_right,
3747  numpad_down, numpad_pageup, numpad_pagedown, numpad_end, numpad_begin,
3748  numpad_insert, numpad_delete, numpad_equal, numpad_multiply, numpad_add,
3749  numpad_separator, numpad_subtract, numpad_decimal, numpad_divide, windows_left,
3750  windows_right, windows_menu, command, special1, special2, special3, special4,
3751  special5, special6, special7, special8, special9, special10, special11,
3752  special12, special13, special14, special15, special16, special17, special18,
3753  special19, special20
3754 \end_layout
3756 \begin_layout Section
3757 Movie file format
3758 \end_layout
3760 \begin_layout Standard
3761 Movie file is .zip archive in itself, normal ZIP archive tools work on it
3762  (note: If you recompress it, do not use compression methods other than
3763  store and deflate and especially do not use encryption of any kind).
3764 \end_layout
3766 \begin_layout Subsection
3767 Detecting clean start/SRAM/Savestate
3768 \end_layout
3770 \begin_layout Itemize
3771 If file has member 
3772 \begin_inset Quotes eld
3773 \end_inset
3775 savestate
3776 \begin_inset Quotes erd
3777 \end_inset
3779  it is savestate, otherwise:
3780 \end_layout
3782 \begin_layout Itemize
3783 If file has members with names starting 
3784 \begin_inset Quotes eld
3785 \end_inset
3787 moviesram.
3788 \begin_inset Quotes erd
3789 \end_inset
3791  it is movie starting from SRAM, otherwise:
3792 \end_layout
3794 \begin_layout Itemize
3795 It is movie starting from clear state.
3796 \end_layout
3798 \begin_layout Subsection
3799 Member: gametype
3800 \end_layout
3802 \begin_layout Standard
3803 Type of game ROM and region (as one line).
3804  Valid values are:
3805 \end_layout
3807 \begin_layout Standard
3808 \begin_inset Tabular
3809 <lyxtabular version="3" rows="8" columns="3">
3810 <features tabularvalignment="middle">
3811 <column alignment="center" valignment="top" width="0">
3812 <column alignment="center" valignment="top" width="0">
3813 <column alignment="center" valignment="top" width="0">
3814 <row>
3815 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3816 \begin_inset Text
3818 \begin_layout Plain Layout
3819 Value
3820 \end_layout
3822 \end_inset
3823 </cell>
3824 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3825 \begin_inset Text
3827 \begin_layout Plain Layout
3828 System
3829 \end_layout
3831 \end_inset
3832 </cell>
3833 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
3834 \begin_inset Text
3836 \begin_layout Plain Layout
3837 Region
3838 \end_layout
3840 \end_inset
3841 </cell>
3842 </row>
3843 <row>
3844 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3845 \begin_inset Text
3847 \begin_layout Plain Layout
3848 snes_pal
3849 \end_layout
3851 \end_inset
3852 </cell>
3853 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3854 \begin_inset Text
3856 \begin_layout Plain Layout
3857 Super NES
3858 \end_layout
3860 \end_inset
3861 </cell>
3862 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3863 \begin_inset Text
3865 \begin_layout Plain Layout
3867 \end_layout
3869 \end_inset
3870 </cell>
3871 </row>
3872 <row>
3873 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3874 \begin_inset Text
3876 \begin_layout Plain Layout
3877 sgb_pal
3878 \end_layout
3880 \end_inset
3881 </cell>
3882 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3883 \begin_inset Text
3885 \begin_layout Plain Layout
3886 Super Game Boy
3887 \end_layout
3889 \end_inset
3890 </cell>
3891 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3892 \begin_inset Text
3894 \begin_layout Plain Layout
3896 \end_layout
3898 \end_inset
3899 </cell>
3900 </row>
3901 <row>
3902 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3903 \begin_inset Text
3905 \begin_layout Plain Layout
3906 snes_ntsc
3907 \end_layout
3909 \end_inset
3910 </cell>
3911 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3912 \begin_inset Text
3914 \begin_layout Plain Layout
3915 Super NES
3916 \end_layout
3918 \end_inset
3919 </cell>
3920 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3921 \begin_inset Text
3923 \begin_layout Plain Layout
3924 NTSC
3925 \end_layout
3927 \end_inset
3928 </cell>
3929 </row>
3930 <row>
3931 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3932 \begin_inset Text
3934 \begin_layout Plain Layout
3935 sgb_ntsc
3936 \end_layout
3938 \end_inset
3939 </cell>
3940 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3941 \begin_inset Text
3943 \begin_layout Plain Layout
3944 Super Game Boy
3945 \end_layout
3947 \end_inset
3948 </cell>
3949 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3950 \begin_inset Text
3952 \begin_layout Plain Layout
3953 NTSC
3954 \end_layout
3956 \end_inset
3957 </cell>
3958 </row>
3959 <row>
3960 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3961 \begin_inset Text
3963 \begin_layout Plain Layout
3965 \end_layout
3967 \end_inset
3968 </cell>
3969 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3970 \begin_inset Text
3972 \begin_layout Plain Layout
3973 BS-X (non-slotted)
3974 \end_layout
3976 \end_inset
3977 </cell>
3978 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
3979 \begin_inset Text
3981 \begin_layout Plain Layout
3982 NTSC
3983 \end_layout
3985 \end_inset
3986 </cell>
3987 </row>
3988 <row>
3989 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3990 \begin_inset Text
3992 \begin_layout Plain Layout
3993 bsxslotted
3994 \end_layout
3996 \end_inset
3997 </cell>
3998 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
3999 \begin_inset Text
4001 \begin_layout Plain Layout
4002 BS-X (slotted)
4003 \end_layout
4005 \end_inset
4006 </cell>
4007 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4008 \begin_inset Text
4010 \begin_layout Plain Layout
4011 NTSC
4012 \end_layout
4014 \end_inset
4015 </cell>
4016 </row>
4017 <row>
4018 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4019 \begin_inset Text
4021 \begin_layout Plain Layout
4022 sufamiturbo
4023 \end_layout
4025 \end_inset
4026 </cell>
4027 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4028 \begin_inset Text
4030 \begin_layout Plain Layout
4031 Sufami Turbo
4032 \end_layout
4034 \end_inset
4035 </cell>
4036 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4037 \begin_inset Text
4039 \begin_layout Plain Layout
4040 NTSC
4041 \end_layout
4043 \end_inset
4044 </cell>
4045 </row>
4046 </lyxtabular>
4048 \end_inset
4051 \end_layout
4053 \begin_layout Standard
4054 Frame rates are:
4055 \end_layout
4057 \begin_layout Standard
4058 \begin_inset Tabular
4059 <lyxtabular version="3" rows="3" columns="2">
4060 <features tabularvalignment="middle">
4061 <column alignment="center" valignment="top" width="0">
4062 <column alignment="center" valignment="top" width="0">
4063 <row>
4064 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4065 \begin_inset Text
4067 \begin_layout Plain Layout
4068 Region
4069 \end_layout
4071 \end_inset
4072 </cell>
4073 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4074 \begin_inset Text
4076 \begin_layout Plain Layout
4077 Framerate (fps)
4078 \end_layout
4080 \end_inset
4081 </cell>
4082 </row>
4083 <row>
4084 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4085 \begin_inset Text
4087 \begin_layout Plain Layout
4089 \end_layout
4091 \end_inset
4092 </cell>
4093 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4094 \begin_inset Text
4096 \begin_layout Plain Layout
4097 322445/6448
4098 \end_layout
4100 \end_inset
4101 </cell>
4102 </row>
4103 <row>
4104 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4105 \begin_inset Text
4107 \begin_layout Plain Layout
4108 NTSC
4109 \end_layout
4111 \end_inset
4112 </cell>
4113 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4114 \begin_inset Text
4116 \begin_layout Plain Layout
4117 10738636/178683
4118 \end_layout
4120 \end_inset
4121 </cell>
4122 </row>
4123 </lyxtabular>
4125 \end_inset
4128 \end_layout
4130 \begin_layout Subsection
4131 Member: port1
4132 \end_layout
4134 \begin_layout Standard
4135 Contains type of port #1 (as one line).
4136  Valid values are 'none', 'gamepad', 'multitap' and 'mouse'.
4137  If not present, defaults to 'gamepad'.
4138 \end_layout
4140 \begin_layout Subsection
4141 Member: port2
4142 \end_layout
4144 \begin_layout Standard
4145 Contains type of port #2 (as one line).
4146  Valid values are 'none', 'gamepad', 'multitap', 'mouse', 'superscope',
4147  'justifier' and 'justifiers'.
4148  If not present, defaults to 'none'.
4149 \end_layout
4151 \begin_layout Subsection
4152 Member: gamename
4153 \end_layout
4155 \begin_layout Standard
4156 Contains name of the game (as one line).
4157 \end_layout
4159 \begin_layout Subsection
4160 Member: authors
4161 \end_layout
4163 \begin_layout Standard
4164 Contains authors, one per line.
4165  Part before '|' is the full name, part after is the nickname.
4166 \end_layout
4168 \begin_layout Subsection
4169 Member: systemid
4170 \end_layout
4172 \begin_layout Standard
4173 Always 
4174 \begin_inset Quotes eld
4175 \end_inset
4177 lsnes-rr1
4178 \begin_inset Quotes erd
4179 \end_inset
4181  (one line).
4182  Used to reject other saves.
4183 \end_layout
4185 \begin_layout Subsection
4186 Member: controlsversion
4187 \end_layout
4189 \begin_layout Standard
4190 Always 
4191 \begin_inset Quotes eld
4192 \end_inset
4195 \begin_inset Quotes erd
4196 \end_inset
4198  (one line).
4199  Used to identify what controls are there.
4200 \end_layout
4202 \begin_layout Subsection
4203 Member: 
4204 \begin_inset Quotes eld
4205 \end_inset
4207 coreversion
4208 \begin_inset Quotes erd
4209 \end_inset
4212 \end_layout
4214 \begin_layout Standard
4215 Contains bsnes core version number (as one line).
4216 \end_layout
4218 \begin_layout Subsection
4219 Member: projectid
4220 \end_layout
4222 \begin_layout Standard
4223 Contains project ID (as one line).
4224  Used to identify if two movies are part of the same project.
4225 \end_layout
4227 \begin_layout Subsection
4228 Member: {rom,slota,slotb}{,xml}.sha256
4229 \end_layout
4231 \begin_layout Standard
4232 Contains SHA-256 of said ROM or ROM mapping file (as one line).
4233  Absent if corresponding file is absent.
4234 \end_layout
4236 \begin_layout Subsection
4237 Member: moviesram.<name>
4238 \end_layout
4240 \begin_layout Standard
4241 Raw binary startup SRAM of kind <name>.
4242  Only present in savestates and movies starting from SRAM.
4243 \end_layout
4245 \begin_layout Subsection
4246 Member: saveframe
4247 \end_layout
4249 \begin_layout Standard
4250 Contains frame number (as one line) of frame movie was saved on.
4251  Only present in savestates.
4252 \end_layout
4254 \begin_layout Subsection
4255 Member: lagcounter
4256 \end_layout
4258 \begin_layout Standard
4259 Current value of lag counter (as one line).
4260  Only present in savestates.
4261 \end_layout
4263 \begin_layout Subsection
4264 Member: pollcounters
4265 \end_layout
4267 \begin_layout Standard
4268 Contains poll counters (currently 100 of them), one per line.
4269  Each line is raw poll count if DRDY is set for it.
4270  Otherwise it is negative poll count minus one.
4271  Only present in savestates.
4272 \end_layout
4274 \begin_layout Subsection
4275 Member: hostmemory
4276 \end_layout
4278 \begin_layout Standard
4279 Raw binary dump of host memory.
4280  Only present in savestates.
4281 \end_layout
4283 \begin_layout Subsection
4284 Member: savestate
4285 \end_layout
4287 \begin_layout Standard
4288 The raw binary savestate itself.
4289  Savestate detection uses this file, only present in savestates.
4290 \end_layout
4292 \begin_layout Subsection
4293 Member: screenshot
4294 \end_layout
4296 \begin_layout Standard
4297 Screenshot of current frame.
4298  Only present in savestates.
4299  First 2 bytes are big-endian width of image, rest are 24-bit RGB image
4300  data.
4301  Height of image is inferred from the width and size of data.
4302 \end_layout
4304 \begin_layout Subsection
4305 Member: sram.<name>
4306 \end_layout
4308 \begin_layout Standard
4309 Raw binary SRAM of kind <name> at time of savestate.
4310  Only present in savestates.
4311 \end_layout
4313 \begin_layout Subsection
4314 Member: input
4315 \end_layout
4317 \begin_layout Standard
4318 The actual input track, one line per subframe (blank lines are skipped).
4319 \end_layout
4321 \begin_layout Itemize
4322 If the first byte of each line is '.', ' ', <tab> or '|', then the line is
4323  part of same frame as previous, otherwise it starts a new frame.
4324 \end_layout
4326 \begin_layout Itemize
4327 First subframe must start a new frame.
4328 \end_layout
4330 \begin_layout Standard
4331 Length of movie in frames is number of lines in input file that start a
4332  new frame.
4333 \end_layout
4335 \begin_layout Subsection
4336 Member: rerecords
4337 \end_layout
4339 \begin_layout Standard
4340 Contains textual base-10 rerecord count (as one line; emulator just writes
4341  this, it doesn't read it) + 1.
4342 \end_layout
4344 \begin_layout Subsection
4345 Member: rrdata
4346 \end_layout
4348 \begin_layout Standard
4349 This member stores set of load IDs.
4350  There is one load ID per rerecord (plus one corresponding to start of project).
4351 \end_layout
4353 \begin_layout Itemize
4354 This member constists of concatenation of records
4355 \end_layout
4357 \begin_layout Itemize
4358 Each record is 2-36 bytes long and can represent 1-16,843,009 consequtive
4359  IDs.
4360 \end_layout
4362 \begin_layout Itemize
4363 IDs are interpretted as 256-bit big-endian integers with warparound.
4364 \end_layout
4366 \begin_layout Itemize
4367 Initial predicted ID is all zeroes.
4368 \end_layout
4370 \begin_layout Standard
4371 Format of each record is:
4372 \end_layout
4374 \begin_layout Itemize
4375 1 byte: Opcode byte.
4376  Bits 0-4 are prefix length (prefixlen), bits 5-6 are count length (countlen).
4377  Bit 7 is unused.
4378 \end_layout
4380 \begin_layout Itemize
4381 32-prefixlen bytes of ID.
4382 \end_layout
4384 \begin_layout Itemize
4385 countlen bytes of big-endian count (count).
4386 \end_layout
4388 \begin_layout Standard
4389 Records are processed as follows:
4390 \end_layout
4392 \begin_layout Itemize
4393 To form the first ID encoded by record, take the first prefixlen bytes predicted
4394  ID and append the read ID value to it.
4395  The result is the first ID encoded.
4396 \end_layout
4398 \begin_layout Itemize
4399 If countlen is 0, record encodes 1 ID.
4400 \end_layout
4402 \begin_layout Itemize
4403 If countlen is 1, record encodes 2+count IDs.
4404 \end_layout
4406 \begin_layout Itemize
4407 If countlen is 2, record encodes 258+count IDs.
4408 \end_layout
4410 \begin_layout Itemize
4411 If countlen is 3, record encodes 65794+count IDs.
4412 \end_layout
4414 \begin_layout Itemize
4415 The new predicted ID is the next ID after last one encoded by the record.
4416 \end_layout
4418 \begin_layout Standard
4419 The number of rerecords + 1 is equal to the sum of number of IDs encoded
4420  by all records.
4421 \end_layout
4423 \begin_layout Subsection
4424 Member: starttime.second
4425 \end_layout
4427 \begin_layout Standard
4428 Movie starting time, second part.
4429  Epoch is Unix epoch.
4430  Default is 1,000,000,000.
4431 \end_layout
4433 \begin_layout Subsection
4434 Member: starttime.subsecond
4435 \end_layout
4437 \begin_layout Standard
4438 Movie starting time, subsecond part.
4439  Unit is CPU clocks.
4440  Default is 0.
4441 \end_layout
4443 \begin_layout Subsection
4444 Member: savetime.second
4445 \end_layout
4447 \begin_layout Standard
4448 Movie saving time, second part.
4449  Default is starttime.second.
4450  Only present in savestates.
4451 \end_layout
4453 \begin_layout Subsection
4454 Member: savetime.subsecond
4455 \end_layout
4457 \begin_layout Standard
4458 Movie saving time, subsecond part.
4459  Default is starttime.subsecond.
4460  Only present in savestates.
4461 \end_layout
4463 \begin_layout Section
4464 Quick'n'dirty encode guide
4465 \end_layout
4467 \begin_layout Enumerate
4468 Start the emulator and load the movie file.
4469 \end_layout
4471 \begin_layout Enumerate
4472 Set large AVI option 'set-setting avi-large on'
4473 \end_layout
4475 \begin_layout Enumerate
4476 Enable dumping 'dump-avi tmpdump' 
4477 \end_layout
4479 \begin_layout Enumerate
4480 Unpause and let it run until you want to end dumping.
4481 \end_layout
4483 \begin_layout Enumerate
4484 Close the emulator (closing the window is the easiest way).
4485  Or use 'end-avi'.
4486 \end_layout
4488 \begin_layout Enumerate
4489 For each tmpdump*.avi file created, on command prompt, do 'x264 --crf 10
4490  -o tmpdump_<numbers>.mkv tmpdump_<numbers>.avi'.
4491 \end_layout
4493 \begin_layout Enumerate
4494 Do 'sox tmpdump.sox tmpdump.ogg rate -v 32000'
4495 \end_layout
4497 \begin_layout Enumerate
4498 Do 'mkvmerge -o tmpdump_video.mkv tmpdump_0000000.mkv + tmpdump_0000001.mkv
4499  + tmpdump_0000002.mkv' (list every tmpdump_<numbers>.mkv, with + in between).
4500 \end_layout
4502 \begin_layout Enumerate
4503 Do 'mkvmerge -o final.mkv tmpdump_video.mkv tmpdump.ogg'.
4504  Now final.mkv contains quick'n'dirty encode.
4505 \end_layout
4507 \begin_layout Section
4508 Axis configurations for some gamepad types:
4509 \end_layout
4511 \begin_layout Subsection
4512 XBox360 controller:
4513 \end_layout
4515 \begin_layout Standard
4516 Axes 2 and 5 (joystick<n>axis2 and joystick<n>axis5) should be set to pressure-+.
4517 \end_layout
4519 \begin_layout LyX-Code
4520 set-axis joystick0axis2 pressure-+
4521 \end_layout
4523 \begin_layout LyX-Code
4524 set-axis joystick0axis5 pressure-+
4525 \end_layout
4527 \begin_layout Itemize
4528 This is needed for SDL only.
4529  EVDEV sets those types correctly.
4530 \end_layout
4532 \begin_layout Subsection
4533 PS3 
4534 \begin_inset Quotes eld
4535 \end_inset
4537 sixaxis
4538 \begin_inset Quotes erd
4539 \end_inset
4541  controller:
4542 \end_layout
4544 \begin_layout Standard
4545 Axes 8-19 should be disabled.
4546 \end_layout
4548 \begin_layout LyX-Code
4549 set-axis joystick0axis8 disabled
4550 \end_layout
4552 \begin_layout LyX-Code
4553 set-axis joystick0axis9 disabled
4554 \end_layout
4556 \begin_layout LyX-Code
4557 set-axis joystick0axis10 disabled
4558 \end_layout
4560 \begin_layout LyX-Code
4561 set-axis joystick0axis11 disabled
4562 \end_layout
4564 \begin_layout LyX-Code
4565 set-axis joystick0axis12 disabled
4566 \end_layout
4568 \begin_layout LyX-Code
4569 set-axis joystick0axis13 disabled
4570 \end_layout
4572 \begin_layout LyX-Code
4573 set-axis joystick0axis14 disabled
4574 \end_layout
4576 \begin_layout LyX-Code
4577 set-axis joystick0axis15 disabled
4578 \end_layout
4580 \begin_layout LyX-Code
4581 set-axis joystick0axis16 disabled
4582 \end_layout
4584 \begin_layout LyX-Code
4585 set-axis joystick0axis17 disabled
4586 \end_layout
4588 \begin_layout LyX-Code
4589 set-axis joystick0axis18 disabled
4590 \end_layout
4592 \begin_layout LyX-Code
4593 set-axis joystick0axis19 disabled
4594 \end_layout
4596 \begin_layout Section
4597 Errata:
4598 \end_layout
4600 \begin_layout Subsection
4601 Problems from BSNES core:
4602 \end_layout
4604 \begin_layout Itemize
4605 The whole pending save stuff.
4606 \end_layout
4608 \begin_layout Itemize
4609 Lack of layer hiding.
4610 \end_layout
4612 \begin_layout Itemize
4613 It is slow (especially accuracy).
4614 \end_layout
4616 \begin_layout Itemize
4617 Firmwares can't be loaded from ZIP archives.
4618 \end_layout
4620 \begin_layout Subsection
4621 Other problems:
4622 \end_layout
4624 \begin_layout Itemize
4625 Modifiers don't work with pseudo-keys (SDL, EVDEV).
4626 \end_layout
4628 \begin_layout Itemize
4629 Audio for last dumped frame is not itself dumped.
4630 \end_layout
4632 \begin_layout Itemize
4633 Audio in UI is pretty bad in quality if game doesn't run at full speed.
4634 \end_layout
4636 \begin_layout Itemize
4637 AVI compression levels 10-18 are not compatible with AVISynth AVISource.
4638 \end_layout
4640 \begin_layout Itemize
4641 No menus, command based interface (SDL).
4642 \end_layout
4644 \begin_layout Itemize
4645 Long commands don't scroll.
4646 \end_layout
4648 \begin_layout Itemize
4649 Wxwidgets UI is still buggy.
4650 \end_layout
4652 \begin_layout Section
4653 Changelog:
4654 \end_layout
4656 \begin_layout Subsection
4657 rr0-beta1
4658 \end_layout
4660 \begin_layout Itemize
4661 Fix -Wall warnings
4662 \end_layout
4664 \begin_layout Itemize
4665 Fix dumper video corruption with levels 10-18.
4666 \end_layout
4668 \begin_layout Subsection
4669 rr0-beta2
4670 \end_layout
4672 \begin_layout Itemize
4673 Autofire
4674 \end_layout
4676 \begin_layout Itemize
4677 Lots of code cleanups
4678 \end_layout
4680 \begin_layout Itemize
4681 Lua interface to settings
4682 \end_layout
4684 \begin_layout Itemize
4685 Allow specifying AVI borders without Lua
4686 \end_layout
4688 \begin_layout Itemize
4689 Fix scaling if vscale > 1 and originx > 0 (left border exists)
4690 \end_layout
4692 \begin_layout Itemize
4693 on_snoop lua callback
4694 \end_layout
4696 \begin_layout Itemize
4697 Faster movie loading and saving.
4698 \end_layout
4700 \begin_layout Subsection
4701 rr0-beta3
4702 \end_layout
4704 \begin_layout Itemize
4705 Joystick support
4706 \end_layout
4708 \begin_layout Subsection
4709 rr0-beta4
4710 \end_layout
4712 \begin_layout Itemize
4713 Fix multi-buttons
4714 \end_layout
4716 \begin_layout Itemize
4717 Save jukebox functionality.
4718 \end_layout
4720 \begin_layout Subsection
4721 rr0-beta5
4722 \end_layout
4724 \begin_layout Itemize
4725 Try to fix some nasty failing movie load edge cases
4726 \end_layout
4728 \begin_layout Itemize
4729 Allow specifying scripts to run on command line.
4730 \end_layout
4732 \begin_layout Subsection
4733 rr0-beta6
4734 \end_layout
4736 \begin_layout Itemize
4737 Major source code reorganization.
4738 \end_layout
4740 \begin_layout Itemize
4741 Backup savestates before overwriting.
4742 \end_layout
4744 \begin_layout Itemize
4745 Don't crash if loading initial state fails.
4746 \end_layout
4748 \begin_layout Subsection
4749 rr0-beta7
4750 \end_layout
4752 \begin_layout Itemize
4753 Fix firmware lookup
4754 \end_layout
4756 \begin_layout Itemize
4757 Fix author name parsing
4758 \end_layout
4760 \begin_layout Itemize
4761 Fix rerecord counting
4762 \end_layout
4764 \begin_layout Itemize
4765 (SDL) Print messages to console if SDL is uninitialized
4766 \end_layout
4768 \begin_layout Itemize
4769 Add movieinfo program
4770 \end_layout
4772 \begin_layout Itemize
4773 Fix loading movies starting from SRAM.
4774 \end_layout
4776 \begin_layout Subsection
4777 rr0-beta8
4778 \end_layout
4780 \begin_layout Itemize
4781 Add support for unattended dumping
4782 \end_layout
4784 \begin_layout Itemize
4785 Fix compiling for Win32
4786 \end_layout
4788 \begin_layout Itemize
4789 Don't lock up if sound can't be initialized
4790 \end_layout
4792 \begin_layout Itemize
4793 Strip trailing CR from commands
4794 \end_layout
4796 \begin_layout Itemize
4797 Don't try to do dubious things in global ctors (fix crash on startup)
4798 \end_layout
4800 \begin_layout Subsection
4801 rr0-beta9
4802 \end_layout
4804 \begin_layout Itemize
4805 Small documentation tweaking
4806 \end_layout
4808 \begin_layout Itemize
4809 Fix make clean
4810 \end_layout
4812 \begin_layout Itemize
4813 Fix major bug in modifier matching
4814 \end_layout
4816 \begin_layout Subsection
4817 rr0-beta10
4818 \end_layout
4820 \begin_layout Itemize
4821 Lots of documentation fixes
4822 \end_layout
4824 \begin_layout Itemize
4825 Use dedicated callbacks for event backcomm., not commands.
4826 \end_layout
4828 \begin_layout Itemize
4829 Ensure that the watchdog is not hit when executing delayed reset.
4830 \end_layout
4832 \begin_layout Itemize
4833 Remove errant tab from joystick message.
4834 \end_layout
4836 \begin_layout Subsection
4837 rr0-beta11
4838 \end_layout
4840 \begin_layout Itemize
4841 Make autofire operate in absolute time, not linear time
4842 \end_layout
4844 \begin_layout Itemize
4845 Reinitialize controls when resuming from loadstate
4846 \end_layout
4848 \begin_layout Itemize
4849 Some more code cleanups
4850 \end_layout
4852 \begin_layout Itemize
4853 If Lua allocator fails, call OOM_panic()
4854 \end_layout
4856 \begin_layout Itemize
4857 Byte/word/dword/qword sized host memory write/read functions.
4858 \end_layout
4860 \begin_layout Itemize
4861 Dump at correct framerate if dumping interlaced NTSC (height=448).
4862 \end_layout
4864 \begin_layout Subsection
4865 rr0-beta12
4866 \end_layout
4868 \begin_layout Itemize
4869 Actually include the complete source code
4870 \end_layout
4872 \begin_layout Itemize
4873 Keep track of RTC
4874 \end_layout
4876 \begin_layout Subsection
4877 rr0-beta13
4878 \end_layout
4880 \begin_layout Itemize
4881 Document {save,start}time.{,sub}second.
4882 \end_layout
4884 \begin_layout Itemize
4885 Intercept time() from bsnes core.
4886 \end_layout
4888 \begin_layout Subsection
4889 rr0-beta14
4890 \end_layout
4892 \begin_layout Itemize
4893 Allow disabling time() interception (allow build on Mac OS X)
4894 \end_layout
4896 \begin_layout Itemize
4897 Use SDLMain on Mac OS X (make SDL not crash)
4898 \end_layout
4900 \begin_layout Itemize
4901 Disable delayed resets (just plain too buggy for now).
4902 \end_layout
4904 \begin_layout Itemize
4905 Code cleanups
4906 \end_layout
4908 \begin_layout Itemize
4909 Use 16-bit for graphics/video instead of 32-bit.
4910 \end_layout
4912 \begin_layout Itemize
4913 gui.rectangle/gui.pixel
4914 \end_layout
4916 \begin_layout Itemize
4917 gui.crosshair
4918 \end_layout
4920 \begin_layout Itemize
4921 New CSCD writer implementation.
4922 \end_layout
4924 \begin_layout Subsection
4925 rr0-beta15
4926 \end_layout
4928 \begin_layout Itemize
4929 Fix interaction of * and +.
4930 \end_layout
4932 \begin_layout Itemize
4933 Manual improvements
4934 \end_layout
4936 \begin_layout Itemize
4937 Use gettimeofday()/usleep(), these seem portable enough.
4938 \end_layout
4940 \begin_layout Itemize
4941 Move joystick axis manipulation to keymapper code.
4942 \end_layout
4944 \begin_layout Itemize
4945 Changes to how read-only works.
4946 \end_layout
4948 \begin_layout Itemize
4949 Refactor controller input code.
4950 \end_layout
4952 \begin_layout Subsection
4953 rr0-beta16
4954 \end_layout
4956 \begin_layout Itemize
4957 Fix mouseclick scale compensation.
4958 \end_layout
4960 \begin_layout Itemize
4961 Draw area boundaries correctly in SDL code.
4962 \end_layout
4964 \begin_layout Itemize
4965 gui.screenshot.
4966 \end_layout
4968 \begin_layout Itemize
4969 Fix CSCD output (buffer overrun and race condition).
4970 \end_layout
4972 \begin_layout Subsection
4973 rr0-beta17
4974 \end_layout
4976 \begin_layout Itemize
4977 JMD dumping support.
4978 \end_layout
4980 \begin_layout Itemize
4981 Allow unattended dumping to JMD.
4982 \end_layout
4984 \begin_layout Itemize
4985 Move to BSNES v083.
4986 \end_layout
4988 \begin_layout Itemize
4989 Switch back to 32-bit colors.
4990 \end_layout
4992 \begin_layout Itemize
4993 Add Lua function gui.color.
4994 \end_layout
4996 \begin_layout Itemize
4997 Use some new C++11 features in GCC 4.6.
4998 \end_layout
5000 \begin_layout Itemize
5001 Be prepared for core frequency changes.
5002 \end_layout
5004 \begin_layout Itemize
5005 Pass colors in one chunk from Lua.
5006 \end_layout
5008 \begin_layout Subsection
5009 rr0-beta18
5010 \end_layout
5012 \begin_layout Itemize
5013 New lua functions gui.line(), gui.status() and gui.circle(), memory.vma_count(),
5014  memory.read_vma() and memory.find_vma().
5015 \end_layout
5017 \begin_layout Itemize
5018 Numerious documentation fixups
5019 \end_layout
5021 \begin_layout Itemize
5022 RTC time format changed
5023 \end_layout
5025 \begin_layout Itemize
5026 Reformat flags display
5027 \end_layout
5029 \begin_layout Itemize
5030 Allow lua package name to be overridden
5031 \end_layout
5033 \begin_layout Itemize
5034 SDUMP (high-quality dumping).
5035 \end_layout
5037 \begin_layout Itemize
5038 Split platform support to plugins.
5039 \end_layout
5041 \begin_layout Itemize
5042 Make all sound plugins support basic sound commands
5043 \end_layout
5045 \begin_layout Itemize
5046 Support portaudio for sound.
5047 \end_layout
5049 \begin_layout Itemize
5050 Allow disable Lua/SDL searching.
5051 \end_layout
5053 \begin_layout Itemize
5054 Upconvert colors when copying lcscreen to screen.
5055 \end_layout
5057 \begin_layout Itemize
5058 Reorganize source tree.
5059 \end_layout
5061 \begin_layout Itemize
5062 Evdev joystick support.
5063 \end_layout
5065 \begin_layout Itemize
5066 Refactor more code into generic window code.
5067 \end_layout
5069 \begin_layout Subsection
5070 rr0-beta19
5071 \end_layout
5073 \begin_layout Itemize
5074 Refactor message handling.
5075 \end_layout
5077 \begin_layout Itemize
5078 Rework makefile
5079 \end_layout
5081 \begin_layout Itemize
5082 Documentation fixes
5083 \end_layout
5085 \begin_layout Itemize
5086 Finish pending saves before load/quit.
5087 \end_layout
5089 \begin_layout Itemize
5090 Wxwidgets graphics plugin.
5091 \end_layout
5093 \begin_layout Subsection
5094 rr0-beta20
5095 \end_layout
5097 \begin_layout Itemize
5098 Get rid of win32-crap.[ch]pp.
5099 \end_layout
5101 \begin_layout Itemize
5102 Move files around a lot.
5103 \end_layout
5105 \begin_layout Itemize
5106 Get rid of need for host C++ compiler.
5107 \end_layout
5109 \begin_layout Itemize
5110 Bsnes v084 core.
5111 \end_layout
5113 \begin_layout Itemize
5114 Refactor inter-component communication.
5115 \end_layout
5117 \begin_layout Itemize
5118 Fix zero luma.
5119 \end_layout
5121 \begin_layout Itemize
5122 Fix crash on multiline aliases.
5123 \end_layout
5125 \begin_layout Itemize
5126 Load/Save settings in wxwidgets gui.
5127 \end_layout
5129 \begin_layout Subsection
5130 rr0-beta21
5131 \end_layout
5133 \begin_layout Itemize
5134 Patch problems in bsnes core
5135 \end_layout
5137 \begin_layout Itemize
5138 SNES is little-endian, not big-endian!
5139 \end_layout
5141 \begin_layout Itemize
5142 Fix memory corruption in lcscreen::load()
5143 \end_layout
5145 \begin_layout Subsection
5146 rr0-beta22
5147 \end_layout
5149 \begin_layout Itemize
5150 Fix interpretting repeat counts in rrdata loading.
5151 \end_layout
5153 \begin_layout Itemize
5154 New lua callback: on_frame()
5155 \end_layout
5157 \begin_layout Itemize
5158 Remove calls to runtosave() that aren't supposed to be there
5159 \end_layout
5161 \begin_layout Itemize
5162 Lua function: movie.read_rtc()
5163 \end_layout
5165 \begin_layout Itemize
5166 Ignore src/fonts/font.cpp
5167 \end_layout
5169 \begin_layout Itemize
5170 Fix more bsnes core problems
5171 \end_layout
5173 \begin_layout Itemize
5174 Control bsnes random seeding
5175 \end_layout
5177 \begin_layout Itemize
5178 Pause-on-end
5179 \end_layout
5181 \begin_layout Itemize
5182 Some bsnes core debugging features (state dump and state hash)
5183 \end_layout
5185 \begin_layout Itemize
5186 Fix titlebar version number (no, the last version wasn't 'lsnes-0-beta21',
5187  it was 'lsnes rr0-beta21').
5188 \end_layout
5190 \begin_layout Subsection
5191 rr0-beta23
5192 \end_layout
5194 \begin_layout Itemize
5195 Fix memory corruption due to macro/field mixup
5196 \end_layout
5198 \begin_layout Itemize
5199 search-memory update
5200 \end_layout
5202 \begin_layout Itemize
5203 Allow direct-mapped framebuffer
5204 \end_layout
5206 \begin_layout Itemize
5207 SDL: Use SDL_ANYFORMAT if possible
5208 \end_layout
5210 \begin_layout Itemize
5211 SDMP2SOX: 2s delay modes.
5212 \end_layout
5214 \begin_layout Itemize
5215 Wxwidgets: Cleanups
5216 \end_layout
5218 \begin_layout Itemize
5219 Use sed -E, not sed -r.
5220  Fixes building on Mac OS X.
5221 \end_layout
5223 \begin_layout Itemize
5224 Wxwidgets: Save jukebox on exit
5225 \end_layout
5227 \begin_layout Itemize
5228 Fix RTC if using load-movie on savestate.
5229 \end_layout
5231 \begin_layout Itemize
5232 Fix crash related to full console mode.
5233 \end_layout
5235 \begin_layout Subsection
5236 rr0-beta24
5237 \end_layout
5239 \begin_layout Itemize
5240 Wxwidgets: Allow bringing application to foreground on Mac OS X.
5241 \end_layout
5243 \begin_layout Itemize
5244 Wxwidgets: Allow compiling on Mac OS X.
5245 \end_layout
5247 \begin_layout Itemize
5248 Use movie compare instead of movie hashing (faster save/load).
5249 \end_layout
5251 \begin_layout Itemize
5252 Lua: _SYSTEM table.
5253 \end_layout
5255 \begin_layout Subsection
5256 rr0-beta25
5257 \end_layout
5259 \begin_layout Itemize
5260 sdmp2sox: Pad soundtrack if using -l or -L.
5261 \end_layout
5263 \begin_layout Itemize
5264 sdmp2sox: Fix NTSC overscan.
5265 \end_layout
5267 \begin_layout Itemize
5268 sdmp2sox: Add AR correction mode.
5269 \end_layout
5271 \begin_layout Itemize
5272 call lua_close() when exiting.
5273 \end_layout
5275 \begin_layout Itemize
5276 Fix zip_writer bug causing warnings from info-zip and error from advzip.
5277 \end_layout
5279 \begin_layout Subsection
5280 rr0-beta26
5281 \end_layout
5283 \begin_layout Itemize
5284 Fix IPS patching code (use bsnes core IPS patcher).
5285 \end_layout
5287 \begin_layout Itemize
5288 Implement BPS patching (using bsnes core IPS patcher).
5289 \end_layout
5291 \begin_layout Itemize
5292 Add feature to load headered ROMs.
5293 \end_layout
5295 \begin_layout Subsection
5296 rr0-beta27
5297 \end_layout
5299 \begin_layout Itemize
5300 Show command names when showing keybindings
5301 \end_layout
5303 \begin_layout Subsection
5305 \end_layout
5307 \begin_layout Itemize
5308 Fix pause-on-end to be actually controllable
5309 \end_layout
5311 \begin_layout Itemize
5312 SDL: Poll all events in queue, not just first one (fixes slowness in command
5313  typing)
5314 \end_layout
5316 \begin_layout Itemize
5317 Wxwidgets: Fix ROM loading.
5318 \end_layout
5320 \begin_layout Subsection
5321 rr1-beta0
5322 \end_layout
5324 \begin_layout Itemize
5325 Lua: Add gui.textH, gui.textV, gui.textHV
5326 \end_layout
5328 \begin_layout Itemize
5329 Fix text colors on SDL on Mac OS X
5330 \end_layout
5332 \begin_layout Itemize
5333 Mode 'F' for finished in readonly mode.
5334 \end_layout
5336 \begin_layout Itemize
5337 Fix some WS errors.
5338 \end_layout
5340 \begin_layout Itemize
5341 Reliably pause after skip poll
5342 \end_layout
5344 \begin_layout Itemize
5345 Split UI and core into their own threads
5346 \end_layout
5348 \begin_layout Subsection
5349 rr1-beta1
5350 \end_layout
5352 \begin_layout Itemize
5353 Remove leftover dummy SRAM slot
5354 \end_layout
5356 \begin_layout Itemize
5357 Fix controller numbers.
5358 \end_layout
5360 \begin_layout Subsection
5361 rr1-beta2
5362 \end_layout
5364 \begin_layout Itemize
5365 Fix lsnes-dumpavi after interface change.
5366 \end_layout
5368 \begin_layout Itemize
5369 Also give BSNES patches for v085.
5370 \end_layout
5372 \begin_layout Itemize
5373 Pack movie data in memory.
5374 \end_layout
5376 \begin_layout Subsection
5377 rr1-beta3
5378 \end_layout
5380 \begin_layout Itemize
5381 Fix framecount/length given when loading movies.
5382 \end_layout
5384 \begin_layout Itemize
5385 Controller command memory leak fixes.
5386 \end_layout
5388 \begin_layout Itemize
5389 Don't leak palette if freeing screen object.
5390 \end_layout
5392 \begin_layout Subsection
5393 rr1-beta4
5394 \end_layout
5396 \begin_layout Itemize
5397 Detect revisions.
5398 \end_layout
5400 \begin_layout Itemize
5401 Wxwidgets: Allow controlling dumper from the menu.
5402 \end_layout
5404 \begin_layout Subsection
5405 rr1-beta5
5406 \end_layout
5408 \begin_layout Itemize
5409 Rewrite parts of manual
5410 \end_layout
5412 \begin_layout Itemize
5413 Lua: Make it work with Lua 5.2.
5414 \end_layout
5416 \begin_layout Subsection
5417 rr1-beta6
5418 \end_layout
5420 \begin_layout Itemize
5421 Win32: Fix compile errors.
5422 \end_layout
5424 \begin_layout Subsection
5425 rr1-beta7
5426 \end_layout
5428 \begin_layout Itemize
5429 Refactor controller input code.
5430 \end_layout
5432 \begin_layout Itemize
5433 Fix crash when using command line on SDL / Mac OS X.
5434 \end_layout
5436 \begin_layout Subsection
5437 rr1-beta8
5438 \end_layout
5440 \begin_layout Itemize
5441 Delete core/coroutine (obsolete)
5442 \end_layout
5444 \begin_layout Itemize
5445 Lag input display by one frame.
5446 \end_layout
5448 \begin_layout Itemize
5449 Rewind movie to beginning function.
5450 \end_layout
5452 \begin_layout Itemize
5453 Fix wrong frame number reported to Lua when repainting after loadstate
5454 \end_layout
5456 \begin_layout Itemize
5457 Support UI editing of jukebox
5458 \end_layout
5460 \begin_layout Itemize
5461 Wxwidgets: Save settings on exit.
5462 \end_layout
5464 \begin_layout Itemize
5465 Support ${project} for filenames
5466 \end_layout
5468 \begin_layout Itemize
5469 SDL: Fix command history
5470 \end_layout
5472 \begin_layout Subsection
5473 rr1-beta9
5474 \end_layout
5476 \begin_layout Itemize
5477 Fix some order-of-global-ctor bugs.
5478 \end_layout
5480 \begin_layout Subsection
5481 rr1-beta10
5482 \end_layout
5484 \begin_layout Itemize
5485 Fix crashes when quitting on Win32.
5486 \end_layout
5488 \begin_layout Subsection
5489 rr1-beta11
5490 \end_layout
5492 \begin_layout Itemize
5493 EVDEV: Queue keypresses from joystick, don't send directly
5494 \end_layout
5496 \begin_layout Itemize
5497 Wxwidgets: Load-Preserve that actually works.
5498 \end_layout
5500 \begin_layout Subsection
5501 rr1-beta12
5502 \end_layout
5504 \begin_layout Itemize
5505 Wxwidgets: GUI for memory search.
5506 \end_layout
5508 \begin_layout Itemize
5509 Warn about using synchronous queue in UI callback.
5510 \end_layout
5512 \begin_layout Subsection
5513 rr1-beta13
5514 \end_layout
5516 \begin_layout Itemize
5517 Remember last saved file for each ROM
5518 \end_layout
5520 \begin_layout Itemize
5521 Support MT dumping via boost.
5522 \end_layout
5524 \begin_layout Itemize
5525 Lua: input.raw
5526 \end_layout
5528 \begin_layout Itemize
5529 Lua: input.keyhook
5530 \end_layout
5532 \begin_layout Itemize
5533 Make mouse be ordinary input instead of special-casing
5534 \end_layout
5536 \begin_layout Itemize
5537 SDL: Don't screw up commands with NUL codepoints.
5538 \end_layout
5540 \begin_layout Subsection
5541 rr1-beta14
5542 \end_layout
5544 \begin_layout Itemize
5545 Merge status panel and main window
5546 \end_layout
5548 \begin_layout Itemize
5549 True movie slot support (the rest of it)
5550 \end_layout
5552 \begin_layout Itemize
5553 SDL: Fix compilation error
5554 \end_layout
5556 \begin_layout Itemize
5557 Elminate cross calls in dump menu code.
5558 \end_layout
5560 \begin_layout Subsection
5561 rr1-beta15
5562 \end_layout
5564 \begin_layout Itemize
5565 Cancel pending saves command
5566 \end_layout
5568 \begin_layout Itemize
5569 Wxwidgets: Code refactoring
5570 \end_layout
5572 \begin_layout Itemize
5573 Wxwidgets: Fix system -> reset
5574 \end_layout
5576 \begin_layout Itemize
5577 Wxwidgets: Read watch expressions in the right thread
5578 \end_layout
5580 \begin_layout Subsection
5581 rr1-beta16
5582 \end_layout
5584 \begin_layout Itemize
5585 Wxwidgets: Don't prompt for member when running Lua script (Lua doesn't
5586  support that).
5587 \end_layout
5589 \begin_layout Itemize
5590 Wxwidgets: 128 -> 1024 Autohold slots (in case more are needed).
5591 \end_layout
5593 \begin_layout Itemize
5594 Don't append trailing '-' to prefix when saving movie.
5595 \end_layout
5597 \begin_layout Itemize
5598 Fix ROM/savestate handling (don't let user mismatch ROM and savestates).
5599 \end_layout
5601 \begin_layout Subsection
5603 \end_layout
5605 \begin_layout Itemize
5606 Document memory watch syntax.
5607 \end_layout
5609 \begin_layout Subsection
5610 rr1-delta1
5611 \end_layout
5613 \begin_layout Itemize
5614 Fix unattended dumping (lsnes-dumpavi)
5615 \end_layout
5617 \begin_layout Itemize
5618 Support RAW dumping
5619 \end_layout
5621 \begin_layout Itemize
5622 Use adv_dumper instead of the old interface in lsnes-dumpavi (changes syntax)
5623 \end_layout
5625 \begin_layout Itemize
5626 Add option to control sample rate preturbation in AVI dumper
5627 \end_layout
5629 \begin_layout Subsection
5630 rr1-delta2
5631 \end_layout
5633 \begin_layout Itemize
5634 Wxwidgets: Fix dumper submodes
5635 \end_layout
5637 \begin_layout Itemize
5638 Set core controller types before loadstate
5639 \end_layout
5641 \begin_layout Subsection
5642 rr1-delta2epsilon1
5643 \end_layout
5645 \begin_layout Itemize
5646 Fix compiling with bsnes v086.
5647 \end_layout
5649 \begin_layout Subsection
5650 rr1-delta3
5651 \end_layout
5653 \begin_layout Itemize
5654 Don't prompt before quitting
5655 \end_layout
5657 \begin_layout Itemize
5658 Start unpaused, preserve pause/unpause over load.
5659 \end_layout
5661 \begin_layout Itemize
5662 Try to autodetect if ROM is headered.
5663 \end_layout
5665 \begin_layout Itemize
5666 Wxwidgets: Only bring up ROM patching screen if specifically requested.
5667 \end_layout
5669 \begin_layout Itemize
5670 Allow configuring some hotkeys.
5671 \end_layout
5673 \begin_layout Subsection
5674 rr1-delta4
5675 \end_layout
5677 \begin_layout Itemize
5678 Lots of code cleanups
5679 \end_layout
5681 \begin_layout Itemize
5682 Fix JMD compression (JMD dumping was broken)
5683 \end_layout
5685 \begin_layout Itemize
5686 Don't crash if Lua C function throws an exception.
5687 \end_layout
5689 \begin_layout Itemize
5690 Support bitmap drawing in Lua.
5691 \end_layout
5693 \begin_layout Itemize
5694 Fix bsnes v085/v086 patches.
5695 \end_layout
5697 \begin_layout Itemize
5698 Improve stability on win32.
5699 \end_layout
5701 \begin_layout Subsection
5702 rr1-delta4epsilon1
5703 \end_layout
5705 \begin_layout Itemize
5706 Don't corrupt movie if movie length is integer multiple of frames per page.
5707 \end_layout
5709 \end_body
5710 \end_document