-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmanual.lyx
2930 lines (2269 loc) · 54 KB
/
manual.lyx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#LyX 2.1 created this file. For more info see http://www.lyx.org/
\lyxformat 474
\begin_document
\begin_header
\textclass article
\use_default_options true
\maintain_unincluded_children false
\language finnish
\language_package default
\inputencoding auto
\fontencoding global
\font_roman default
\font_sans default
\font_typewriter default
\font_math auto
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
\graphics default
\default_output_format default
\output_sync 0
\bibtex_command default
\index_command default
\paperfontsize default
\use_hyperref false
\papersize default
\use_geometry false
\use_package amsmath 1
\use_package amssymb 1
\use_package cancel 1
\use_package esint 1
\use_package mathdots 1
\use_package mathtools 1
\use_package mhchem 1
\use_package stackrel 1
\use_package stmaryrd 1
\use_package undertilde 1
\cite_engine basic
\cite_engine_type default
\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
\justification true
\use_refstyle 1
\index Hakusana
\shortcut idx
\color #008000
\end_index
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\paragraph_indentation default
\quotes_language english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict false
\end_header
\begin_body
\begin_layout Section
Introduction
\end_layout
\begin_layout Standard
lsnes is SNES rerecording emulator based on bsnes core.
\end_layout
\begin_layout Section
Dependencies
\end_layout
\begin_layout Enumerate
bsnes libsnes (for bsnes SNES core)
\end_layout
\begin_deeper
\begin_layout Enumerate
v084-v087 (v084 or v085 for delayreset support)
\end_layout
\begin_layout Enumerate
accuracy or compatiblity core with debugger enabled.
\end_layout
\begin_layout Enumerate
Patched version (using included 7 patches)
\end_layout
\end_deeper
\begin_layout Enumerate
gambatte (for gambatte core)
\end_layout
\begin_deeper
\begin_layout Enumerate
SVN r320, r358 or r364
\end_layout
\begin_layout Enumerate
Patched with included patches
\end_layout
\end_deeper
\begin_layout Enumerate
Zlib
\end_layout
\begin_layout Enumerate
boost_iostreams
\end_layout
\begin_layout Enumerate
boost_filesystem
\end_layout
\begin_layout Enumerate
boost_thread (if native std::thread is not available)
\end_layout
\begin_layout Enumerate
libsdl (SDL only)
\end_layout
\begin_layout Enumerate
sdlmain (SDL only, part of SDL)
\end_layout
\begin_layout Enumerate
boost_conversion (this is header-only library)
\end_layout
\begin_layout Enumerate
libswscale (wxwidgets graphics only)
\end_layout
\begin_layout Enumerate
Portaudio (portaudio sound only)
\end_layout
\begin_layout Enumerate
libao (libao sound only)
\end_layout
\begin_layout Enumerate
Lua version 5.1.X or 5.2.X
\end_layout
\begin_layout Enumerate
G++ 4.6 or 4.7
\end_layout
\begin_layout Enumerate
libopus (optional, for commentary track tool)
\end_layout
\begin_layout Section
Building
\end_layout
\begin_layout Itemize
Copy bsnes sources (the bsnes subdirectory) to subdirectory 'bsnes' (for
bsnes core).
\end_layout
\begin_layout Itemize
Copy gambatte sources to subdirectory 'gambatte' (for gambatte core).
\end_layout
\begin_layout Itemize
Patch the bsnes sources with included patches (directory 'bsnes-patches/<version
>', bsnes core)
\end_layout
\begin_layout Itemize
Patch the gambatte sources with included patches (directory 'gambatte-patches/<v
ersion>', gambatte core)
\end_layout
\begin_layout Itemize
Edit options.build (or copy of that file)
\end_layout
\begin_layout Itemize
Run make (passing 'OPTIONS=<filename>' if using something else than options.build
).
\end_layout
\begin_layout Section
Command line options
\end_layout
\begin_layout Subsection
Wxwidgets options
\end_layout
\begin_layout Subsubsection
--rom=<file>
\end_layout
\begin_layout Standard
Load <file> as ROM.
\end_layout
\begin_layout Subsubsection
<file>
\end_layout
\begin_layout Standard
Load <file> as ROM.
\end_layout
\begin_layout Subsubsection
--load=<file>
\end_layout
\begin_layout Standard
Load <file> as movie or savestate file on startup.
\end_layout
\begin_layout Subsubsection
--settings
\end_layout
\begin_layout Standard
Instead of starting the emulator, only display the settings.
\end_layout
\begin_layout Subsubsection
--pluginmanager
\end_layout
\begin_layout Standard
Instead of starting the emulator, display the plugin manager (useful to
disable some plugin that causes emulator to crash on startup)
\end_layout
\begin_layout Subsubsection
--lua=<file>
\end_layout
\begin_layout Standard
Run this Lua file on startup
\end_layout
\begin_layout Subsection
dump options (lsnes-dumpavi only)
\end_layout
\begin_layout Subsubsection
--rom=<file>
\end_layout
\begin_layout Standard
Load <file> as ROM.
Required.
\end_layout
\begin_layout Subsubsection
<filename>
\end_layout
\begin_layout Standard
Load <filename> as movie or savestate file on startup.
Required.
\end_layout
\begin_layout Subsubsection
--dumper=<dumper>
\end_layout
\begin_layout Standard
Set the dumper to use (required).
Use 'list' for listing of known dumpers.
\end_layout
\begin_layout Subsubsection
--firmware-path=<path>
\end_layout
\begin_layout Standard
Set path to look for firmware.
\end_layout
\begin_layout Subsubsection
--mode=<mode>
\end_layout
\begin_layout Standard
Set the mode to use (required for dumpers with multiple modes, forbidden
otherwise).
Use 'list' for known modes.
\end_layout
\begin_layout Subsubsection
--prefix=<prefix>
\end_layout
\begin_layout Standard
Set dump prefix.
Default is
\begin_inset Quotes eld
\end_inset
avidump
\begin_inset Quotes erd
\end_inset
.
\end_layout
\begin_layout Subsubsection
--option=<name>=<value>
\end_layout
\begin_layout Standard
Set option <name> to value <value>.
\end_layout
\begin_layout Subsubsection
--length=<length>
\end_layout
\begin_layout Standard
Set number of frames to dump.
Mandatory, unless --overdump-length is specified.
\end_layout
\begin_layout Subsubsection
--overdump-length=<length>
\end_layout
\begin_layout Standard
Set number of frames to dump after movie end.
Mutually exclusive with --length.
\end_layout
\begin_layout Subsubsection
--lua=<script>
\end_layout
\begin_layout Standard
Run specified lua script (lsnes-dumpavi does not have initialization files).
\end_layout
\begin_layout Subsubsection
--load-library=<library>
\end_layout
\begin_layout Standard
Load the specified shared object / dynamic library / dynamic link library.
\end_layout
\begin_layout Subsection
lsnes settings directory
\end_layout
\begin_layout Standard
The lsnes settings directory is (in order of decreasing perference):
\end_layout
\begin_layout Itemize
Windows: %APPDATA%
\backslash
lsnes (if %APPDATA% exists)
\end_layout
\begin_layout Itemize
Unix: $XDG_CONFIG_HOME/lsnes (if $XDG_CONFIG_HOME exists)
\end_layout
\begin_layout Itemize
Unix: $HOME/.config/lsnes (if $HOME exists)
\end_layout
\begin_layout Itemize
All: .
(fallback default).
\end_layout
\begin_layout Standard
If leading directories do not exist, attempt to create them is made.
\end_layout
\begin_layout Section
Internal commands
\end_layout
\begin_layout Itemize
Commands beginning with '*' invoke the corresponding command without alias
expansion.
\end_layout
\begin_layout Itemize
If command starts with '+' (after possible '*'), the command is executed
as-is when button is pressed, and when button is released, it is executed
with '+' replaced by '-'.
\end_layout
\begin_layout Itemize
Commands without '+' execute only on negative edge (release).
\end_layout
\begin_layout Subsection
run-script <script>
\end_layout
\begin_layout Standard
Run <script> as if commands were entered on the command line.
\end_layout
\begin_layout Subsection
Memory manipulation
\end_layout
\begin_layout Itemize
<address> can be one of:
\end_layout
\begin_deeper
\begin_layout Itemize
Decimal number
\end_layout
\begin_layout Itemize
Hexadecimal number (prefixed with 0x)
\end_layout
\begin_layout Itemize
<memarea>+<hexoffset> (no 0x prefix for offset).
\end_layout
\end_deeper
\begin_layout Standard
<value> can be hexadecimal (prefixed with '0x'), unsigned or signed (prefixed
with '-') decimal.
\end_layout
\begin_layout Standard
The available element <sizes> are:
\end_layout
\begin_layout Itemize
byte: 1 byte
\end_layout
\begin_layout Itemize
word: 2 bytes
\end_layout
\begin_layout Itemize
hword: 3 bytes
\end_layout
\begin_layout Itemize
dword: 4 bytes
\end_layout
\begin_layout Itemize
qword: 8 bytes
\end_layout
\begin_layout Itemize
float: 4 bytes (floating-point)
\end_layout
\begin_layout Itemize
double: 8 bytes (floating-point)
\end_layout
\begin_layout Standard
When reading RAM and ROM, multi-byte reads/writes are big-endian.
When dealing with DSP memory, multi-byte reads/writes are native-endian
(do not use operand sizes exceeding DSP bitness, except dword is OK for
24-bit memory).
\end_layout
\begin_layout Subsubsection
read-<size> <address>
\end_layout
\begin_layout Standard
Read the value of byte in <address>.
\end_layout
\begin_layout Subsubsection
read-s<size> <address>
\end_layout
\begin_layout Standard
Read the value of signed byte in <address>.
\end_layout
\begin_layout Subsubsection
write-<size> <address> <value>
\end_layout
\begin_layout Standard
Write <value> to byte in address <address>.
\end_layout
\begin_layout Subsection
Main commands
\end_layout
\begin_layout Standard
These commands are not available in lsnesrc, but are available after ROM
has been loaded.
\end_layout
\begin_layout Subsubsection
quit-emulator
\end_layout
\begin_layout Standard
Quits the emulator.
\end_layout
\begin_layout Subsubsection
pause-emulator
\end_layout
\begin_layout Standard
Toggle paused/unpaused
\end_layout
\begin_layout Subsubsection
+advance-frame
\end_layout
\begin_layout Standard
Advance frame.
If the button is still held after configurable timeout expires, game unpauses
for the duration frame advance is held.
\end_layout
\begin_layout Subsubsection
+advance-poll
\end_layout
\begin_layout Standard
Advance subframe.
If the button is still held after configurable timeout expires, game unpauses
for the duration frame advance is held.
\end_layout
\begin_layout Subsubsection
advance-skiplag
\end_layout
\begin_layout Standard
Skip to first poll in frame after current.
\end_layout
\begin_layout Subsubsection
reset
\end_layout
\begin_layout Standard
Reset the SNES after this frame.
\end_layout
\begin_layout Subsubsection
load <filename>
\end_layout
\begin_layout Standard
Load savestate <filename> in current mode.
\end_layout
\begin_layout Subsubsection
load-state <filename>
\end_layout
\begin_layout Standard
Load savestate <filename> in readwrite mode.
\end_layout
\begin_layout Subsubsection
load-readonly <filename>
\end_layout
\begin_layout Standard
Load savestate <filename> in readonly mode.
\end_layout
\begin_layout Subsubsection
load-preserve <filename>
\end_layout
\begin_layout Standard
Load savestate <filename> in readonly mode, preserving current events.
\end_layout
\begin_layout Subsubsection
load-movie <filename>
\end_layout
\begin_layout Standard
Load savestate <filename>, ignoring save part in readonly mode.
\end_layout
\begin_layout Subsubsection
save-state <filename>
\end_layout
\begin_layout Standard
Save system state to <filename> as soon as possible.
\end_layout
\begin_layout Subsubsection
save-movie <filename>
\end_layout
\begin_layout Standard
Save movie to <filename>.
\end_layout
\begin_layout Subsubsection
set-rwmode
\end_layout
\begin_layout Standard
Set recording mode.
\end_layout
\begin_layout Subsubsection
set-romode
\end_layout
\begin_layout Standard
Set playback mode
\end_layout
\begin_layout Subsubsection
toggle-rwmode
\end_layout
\begin_layout Standard
Toggle between playback and recording modes.
\end_layout
\begin_layout Subsubsection
test-1, test-2, test-3
\end_layout
\begin_layout Standard
Internal test commands.
Don't use.
\end_layout
\begin_layout Subsubsection
take-screenshot <filename>
\end_layout
\begin_layout Standard
Save screenshot to <filename>.
\end_layout
\begin_layout Subsubsection
+controller <class>-<#>-<button>
\end_layout
\begin_layout Standard
Press button <button> on controller <num> of class <class>.
\end_layout
\begin_layout Itemize
Class 'gamepad': A, B, X, Y, L, R, select, start, up, down, left, right,
ext0, ext1, ext2, ext3
\end_layout
\begin_layout Itemize
Class 'mouse': L, R
\end_layout
\begin_layout Itemize
Class 'superscope': trigger, cursor, turbo, pause
\end_layout
\begin_layout Itemize
Class 'justifier': trigger, start
\end_layout
\begin_layout Itemize
Class 'gb': A, B, select, start, up, down, left, right
\end_layout
\begin_layout Subsubsection
hold-controller <class>-<#>-<button>
\end_layout
\begin_layout Standard
Hold/unhold button <button> on controller <num> of class <class>.
\end_layout
\begin_layout Subsubsection
type-controller <class>-<#>-<button>
\end_layout
\begin_layout Standard
Hold/unhold button <button> on controller <num> of class <class> for the
next frame.
See +controller for button names.
\end_layout
\begin_layout Standard
Cauntion: Does not work properly if outside frame advance.
\end_layout
\begin_layout Subsubsection
+autofire-controller <class>-<#>-<button> [[<duty>] <cyclelen>]
\end_layout
\begin_layout Standard
Start autofire.
If duty is not specified, defaults to 1.
If <cyclelen> is not specified, defaults to 2.
\end_layout
\begin_layout Subsubsection
-autofire-controller <class>-<#>-<button> [[<duty>] <cyclelen>]
\end_layout
\begin_layout Standard
End autofire.
\end_layout
\begin_layout Subsubsection
autofire-controller <class>-<#>-<button> [[<duty>] <cyclelen>]
\end_layout
\begin_layout Standard
Toggle autofire.
If autofire is turned on, specified cycle is used.
\end_layout
\begin_layout Subsubsection
designate-position <class>-<#>-analog<n>
\end_layout
\begin_layout Standard
Designate position for analog pair.
<n> is only there if there are multiple axis pairs.
\end_layout
\begin_layout Subsubsection
repaint
\end_layout
\begin_layout Standard
Force a repaint.
\end_layout
\begin_layout Subsubsection
toggle-pause-on-end
\end_layout
\begin_layout Standard
Toggle pause on end flag.
\end_layout
\begin_layout Subsubsection
set-pause-on-end
\end_layout
\begin_layout Standard
Set pause on end flag.
\end_layout
\begin_layout Subsubsection
clear-pause-on-end
\end_layout
\begin_layout Standard
Clear pause on end flag.
\end_layout
\begin_layout Subsubsection
action <action> [<parameters>]
\end_layout
\begin_layout Standard
Run specified core action.
\end_layout
\begin_layout Subsection
Save jukebox
\end_layout
\begin_layout Subsubsection
cycle-jukebox-backward
\end_layout
\begin_layout Standard
Cycle save jukebox backwards.
\end_layout
\begin_layout Subsubsection
cycle-jukebox-forward
\end_layout
\begin_layout Standard
Cycle save jukebox forwards
\end_layout
\begin_layout Subsubsection
set-jukebox-slot <slot>
\end_layout
\begin_layout Standard
Set current jukebox slot
\end_layout
\begin_layout Subsubsection
load-jukebox
\end_layout
\begin_layout Standard
Do load from jukebox (current mode).
\end_layout
\begin_layout Subsubsection
save-jukebox
\end_layout
\begin_layout Standard
Do state save to jukebox.
\end_layout
\begin_layout Subsection
Slot branches
\end_layout
\begin_layout Subsubsection
list-branches
\end_layout
\begin_layout Standard
List all branches
\end_layout
\begin_layout Subsubsection
create-branch <pid> <name>
\end_layout
\begin_layout Standard
Create a new branch, with <pid> as parent and <name> as name.
\end_layout
\begin_layout Subsubsection
rename-branch <id> <name>
\end_layout
\begin_layout Standard
Rename branch <id> to <name>.
\end_layout
\begin_layout Subsubsection
reparent-branch <id> <pid>
\end_layout
\begin_layout Standard
Set parent of branch <id> to <pid>.
\end_layout
\begin_layout Subsubsection
set-branch <id>
\end_layout
\begin_layout Standard
Set current branch to <id>.
\end_layout
\begin_layout Subsubsection
delete-branch <id>
\end_layout
\begin_layout Standard
Delete branch <id>.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Subsection
Lua
\end_layout
\begin_layout Subsubsection
evaluate-lua <luacode>
\end_layout
\begin_layout Standard
Run Lua code <luacode> using built-in Lua interpretter.
\end_layout
\begin_layout Subsubsection
L <luacode>
\end_layout
\begin_layout Standard
Synonym for evaluate-lua.
\end_layout
\begin_layout Subsubsection
run-lua <script>
\end_layout
\begin_layout Standard
Run specified lua file using built-in Lua interpretter.
\end_layout
\begin_layout Subsubsection
reset-lua
\end_layout
\begin_layout Standard
Clear the Lua VM state and restore to factory defaults.
\end_layout
\begin_layout Subsection
Sound
\end_layout
\begin_layout Subsubsection
enable-sound <on/off>
\end_layout
\begin_layout Standard
Enable/Disable sound.
\end_layout
\begin_layout Subsection
Misc.
\end_layout
\begin_layout Subsubsection
load-rom <file>
\end_layout
\begin_layout Standard
Loads ROM (format autodetected) from <file>.
\end_layout
\begin_layout Subsubsection
reload-rom
\end_layout
\begin_layout Standard
Reloads the main ROM image from.
\end_layout
\begin_layout Subsubsection
+tangent
\end_layout
\begin_layout Standard
Tangent for recording voice for commentary track.
While pressed, record a stream.
\end_layout
\begin_layout Subsubsection
advance-subframe-timeout
\end_layout
\begin_layout Standard
Subframe advance timeout in milliseconds.
Default is 100.
\end_layout
\begin_layout Subsubsection
set-speed <speed>
\end_layout
\begin_layout Standard
Set the speed multiplier.
<speed> may be positive number (1 is normal speed) or
\begin_inset Quotes eld
\end_inset
turbo
\begin_inset Quotes erd
\end_inset
for turbo.
\end_layout
\begin_layout Section