commit f164b81

Add emulator documentation file

 1@@ -0,0 +1,98 @@
 2+
 3+=== Command-line switches ===
 4+
 5+-D
 6+  Use double buffering for the display.
 7+
 8+-F
 9+  Start in full screen mode.
10+
11+-N
12+  Tells the window manager to omit the frame.
13+
14+-Q
15+  Disable the mouse initially (it can still be enabled at run time).
16+
17+-T year.month.day.hours.minutes.seconds.wday.yday.yday.isdst
18+  Use a fixed value for the date/time, by numbers with dots in between. In
19+  this case, it will read the same values from the date/time device each
20+  time it is read. If you put less numbers than expected, then zero will
21+  be used for the remaining values; however, some programs will use these
22+  values to seed a random number generator and will not work correctly if
23+  they are zero.
24+
25+-Y
26+  Enable file system access including writing.
27+
28+-Z
29+  Use UTC instead of local time. (Has no effect in combination with -T.)
30+
31+-d
32+  Enable some debugging features. (Some will work even without this.)
33+
34+-h #
35+  Set default screen height.
36+
37+-i
38+  Hide the system mouse cursor. (The Uxn program might still draw its own
39+  mouse cursor, which most do.)
40+
41+-n
42+  Disable GUI. This switch is required in order to read stdin; without it,
43+  stdin cannot be read (although command-line arguments still work).
44+
45+-p #
46+  Select the palette. Valid palette numbers are 0 to 7, where 7 is the
47+  default setting and means that the running Uxn program can set colours.
48+
49+-q
50+  Disable standard I/O.
51+
52+-t #
53+  Set the frame rate, in milliseconds per frame.
54+
55+-w #
56+  Set default screen width.
57+
58+-y
59+  Enable read-only file system access.
60+
61+-z #
62+  Set zoom level.
63+
64+
65+=== Function keys ===
66+
67+F1
68+  Advance one frame, even if paused.
69+
70+F3
71+  Toggle the mouse mode. When the mouse mode is disabled, the mouse device
72+  does not work; the mouse vector is not called and the mouse coordinates
73+  and button state is not updated.
74+
75+F4
76+  Change which graphics layers are displayed. Either both layers, or only
77+  foreground or only background.
78+
79+F5
80+  Redraw screen. If the right shift key is also pushed, then also sends
81+  some debug output to stderr.
82+
83+F6 / F7
84+  Palette selection.
85+
86+F9
87+  Restart.
88+
89+F10
90+  Quit.
91+
92+PAUSE
93+  Pause/unpause VM.
94+
95+Some programs use shortcut keys with control and letters. This does not
96+work in this program; therefore, END is an alias for the joypad A button
97+(the left control key also corresponds to the joypad A button, but if used
98+together with letter keys, will enter control characters instead).
99+