]> git.lizzy.rs Git - plan9front.git/blob - sys/man/1/nintendo
merge
[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 -acdT
8 ]
9 [
10 .B -C
11 .I ...
12 ]
13 .I romfile
14 .br
15 .B games/gba
16 [
17 .B -aT
18 ] [
19 .B -b
20 .I biosfile
21 ] [
22 .B -s
23 .I savetype
24 ]
25 .I romfile
26 .br
27 .B games/nes
28 [
29 .B -aos
30 ]
31 .I romfile
32 .br
33 .B games/snes
34 [
35 .B -ahmsT
36 ]
37 .I romfile
38 .SH DESCRIPTION
39 .I Gb,
40 .I gba,
41 .I nes
42 and
43 .I snes
44 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).
45 They execute the romfile given as an argument.
46 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.
47 Other keys:
48 .TP
49 F5
50 Save the current state in \fBgb.save\fR / \fBgba.save\fR / \fBnes.save\fR / \fBsnes.save\fR.
51 .TP
52 F6
53 Load the current state from \fBgb.save\fR / \fBgba.save\fR / \fBnes.save\fR / \fBsnes.save\fR.
54 .TP
55 Esc
56 Pause the emulator.
57 .TP
58 Del
59 Exit the emulator.
60 .PP
61 Command line options:
62 .TP
63 .B -a
64 Enable audio output.
65 .PP
66 .B gb
67 options:
68 .TP
69 .B -c
70 Run GBC roms in GBC mode and DMG (GB) roms in GBC's DMG compatibility mode.
71 .TP
72 .B -d
73 Run GB roms in DMG mode. GBC-only roms will not run in this mode; others will run only in black & white.
74 .TP
75 .BI -C nnnnnn,nnnnnn,nnnnnn,nnnnnn
76 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).
77 .PP
78 .B gba
79 options:
80 .TP
81 .B -b
82 Location of the GBA BIOS file (required to operate the emulator). Default is \fB/sys/games/lib/gbabios.bin\fR.
83 .TP
84 .B -s
85 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.
86 .PP
87 .B nes
88 options:
89 .TP
90 .B -o
91 Hide the top and bottom eight pixels (overscan area), like a real television would.
92 .TP
93 .B -s
94 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).
95 .PP
96 .B snes
97 options:
98 .TP
99 .B -h
100 Override HiROM/LoROM detection:
101 .B -h
102 sets LoROM,
103 .B -hh
104 sets HiROM.
105 .TP
106 .B -m
107 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.
108 .SH SOURCE
109 .B /sys/src/games/gb
110 .br
111 .B /sys/src/games/gba
112 .br
113 .B /sys/src/games/nes
114 .br
115 .B /sys/src/games/snes
116 .SH BUGS
117 You bet!
118 .br
119 SRAM saving on the NES only functions when the
120 .B -s
121 option is used.
122 .br
123 The SNES horizontal hires mode is supported only with
124 .B -2
125 scaling.
126 .br
127 All emulators assume a North American (i.e. NTSC) system. PAL games (and in some cases Japanese games) are not supported.
128 .SH HISTORY
129 .I Gb
130 first appeared in 9front (April, 2012).
131 .br
132 .I Gba
133 first appeared in 9front (September, 2014).
134 .br
135 .I Nes
136 first appeared in 9front (February, 2014).
137 .br
138 .I Snes
139 first appeared in 9front (March, 2014).