]> git.lizzy.rs Git - plan9front.git/blob - sys/man/1/nintendo
c1b6b29f59f42c34d0eb29071d57dde062769523
[plan9front.git] / sys / man / 1 / nintendo
1 .TH NINTENDO 1
2 .SH NAME
3 gb, gba, nes, snes \- emulators
4 .SH SYNOPSIS
5 .B games/gb
6 [
7 .B -acd
8 ]
9 [
10 .B -C
11 .I ...
12 ] [
13 .B -x
14 .I scale
15 ]
16 .I romfile
17 .br
18 .B games/gba
19 [
20 .B -a
21 ] [
22 .B -b
23 .I biosfile
24 ] [
25 .B -s
26 .I savetype
27 ] [
28 .B -x
29 .I scale
30 ]
31 .I romfile
32 .br
33 .B games/nes
34 [
35 .B -aos
36 ] [
37 .B -x
38 .I scale
39 ]
40 .I romfile
41 .br
42 .B games/snes
43 [
44 .B -ahms
45 ] [
46 .B -x
47 .I scale
48 ]
49 .I romfile
50 .SH DESCRIPTION
51 .I Gb,
52 .I gba,
53 .I nes
54 and
55 .I snes
56 are emulators for the Nintendo Game Boy and Game Boy Color (GB and GBC), Nintendo Game Boy Advance (GBA), Nintendo Entertainment System (NES), and Super Nintendo Entertainment System (SNES).
57 They execute the romfile given as an argument.
58 The \fBz\fR, \fBx\fR, \fBa\fR, \fBs\fR, \fBq\fR, \fBw, \fRreturn and shift keys correspond to B, A, Y, X, L1, L2, Start and Select, respectively.
59 Other keys:
60 .TP
61 F1
62 Pause the emulator. If already paused it will step one video frame.
63 .TP
64 F5
65 Save the current state in \fBgb.save\fR / \fBgba.save\fR / \fBnes.save\fR / \fBsnes.save\fR.
66 .TP
67 F6
68 Load the current state from \fBgb.save\fR / \fBgba.save\fR / \fBnes.save\fR / \fBsnes.save\fR.
69 .TP
70 F12
71 Toggle the emulator's speedometer.  It shows in the upper left,
72 off-viewport corner, the ratio between the expected and observed time it
73 took to draw 60 frames.
74 .TP
75 t
76 Toggle tracing of the emulator.
77 .TP
78 `
79 It uncaps the 60fps frame rate and lets emulation go as fast as possible.
80 .TP
81 Esc
82 Pause the emulator.
83 .TP
84 Del
85 Exit the emulator.
86 .PP
87 Command line options:
88 .TP
89 .B -a
90 Enable audio output.
91 .TP
92 .B -x
93 Scale the screen to a given factor regardless of the window's size.
94 .PP
95 .B gb
96 options:
97 .TP
98 .B -c
99 Run GBC roms in GBC mode and DMG (GB) roms in GBC's DMG compatibility mode.
100 .TP
101 .B -d
102 Run GB roms in DMG mode. GBC-only roms will not run in this mode; others will run only in black & white.
103 .TP
104 .BI -C nnnnnn,nnnnnn,nnnnnn,nnnnnn
105 Select a color palette. Has no effect on roms in color mode. The syntax is of the form -C ffffff,aaaaaa,555555,000000 (using HTML style rrggbb notation).
106 .PP
107 .B gba
108 options:
109 .TP
110 .B -b
111 Location of the GBA BIOS file (required to operate the emulator). Default is \fB/sys/games/lib/gbabios.bin\fR.
112 .TP
113 .B -s
114 Save format used by the original game. Valid formats are: eeprom4, eeprom64, sram256, flash512, flash1024. The number corresponds to the size, in kilobits, of the save file. By default, the emulator attempts to automatically detect the save format, but does not always succeed.
115 .PP
116 .B nes
117 options:
118 .TP
119 .B -o
120 Hide the top and bottom eight pixels (overscan area), like a real television would.
121 .TP
122 .B -s
123 Save contents of battery backed SRAM (used by some games for savegames) as a file (\fIgb\fR and \fIsnes\fR automatically detect if this is needed).
124 .PP
125 .B snes
126 options:
127 .TP
128 .B -h
129 Override HiROM/LoROM detection:
130 .B -h
131 sets LoROM,
132 .B -hh
133 sets HiROM.
134 .TP
135 .B -m
136 Enable mouse emulation using system mouse. Mouse button 1 (left button) engages the SNES left mouse button. Mouse button 3 (right button) engages the SNES right mouse button. Holding down mouse button 2 (middle button) disengages the SNES mouse entirely so that the Plan 9 cursor offset can be adjusted to align with the SNES cursor.
137 .SH SOURCE
138 .B /sys/src/games/gb
139 .br
140 .B /sys/src/games/gba
141 .br
142 .B /sys/src/games/nes
143 .br
144 .B /sys/src/games/snes
145 .SH BUGS
146 You bet!
147 .br
148 SRAM saving on the NES only functions when the
149 .B -s
150 option is used.
151 .br
152 The SNES horizontal hires mode is supported only with
153 .B -2
154 scaling.
155 .br
156 All emulators assume a North American (i.e. NTSC) system. PAL games (and in some cases Japanese games) are not supported.
157 .SH HISTORY
158 .I Gb
159 first appeared in 9front (April, 2012).
160 .br
161 .I Gba
162 first appeared in 9front (September, 2014).
163 .br
164 .I Nes
165 first appeared in 9front (February, 2014).
166 .br
167 .I Snes
168 first appeared in 9front (March, 2014).