aboutsummaryrefslogtreecommitdiff
path: root/games/colem/colem.pod
blob: b2c0fb43c8c3ac351916e6084bfc138df6481a24 (plain)
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
# pod source for colem man page. convert with:
# pod2man --stderr -s6 -r3.8 -cSlackBuilds.org colem.pod > colem.6

=pod

=head1 NAME

colem - Emulator for ColecoVision and Coleco Adam consoles

=head1 SYNOPSIS

colem [-option1 [-option2...]] [filename]

=head1 DESCRIPTION

ColEm is a portable emulator of the old ColecoVision videogame console. It should run most ColecoVision games and supports Coleco's SuperAction controllers with spin wheels.

You can always get the latest ColEm binaries, source code, and support files from
http://fms.komkon.org/ColEm/

=head1 OPTIONS

[filename]
Name of the file to load as a cartridge [default: CART.ROM]

This program will transparently uncompress singular GZIPped files.

=over 4

=item -verbose <level>

Select debugging messages [bitmask, default: 5]

=over 4

=item Z<>0

Silent

=item Z<>1

Startup messages

=item Z<>2

VDP

=item Z<>4

Illegal Z80 ops

=item Z<>16

Sound

=back

=item -pal, -ntsc

Video system to use [default: -ntsc]

=item -skip <percent>

Percentage of frames to skip [default: 25]

=item -help 

Print this help page

=item -home <dirname>

Set directory with system ROM files [default: see FILES, below]

=item -adam, -cv

Run in Adam/ColecoVision mode [default: -cv]

=item -allspr

Show all sprites [off]

=item -autoa, -noautoa

Autofire/No autofire for FIRE-R button [default: -noautoa]

=item -autob, -noautob

Autofire/No autofire for FIRE-L button [default: -noautob]

=item -spin1x, -spin1y

Mouse X/Y position as SuperAction spinner 1 [default: off]

=item -spin2x, -spin2y

Mouse X/Y position as SuperAction spinner 2 [default: off]

=item -drums, -nodrums

Hit/Don't hit MIDI drums on noise [default: -nodrums]

=item -logsnd <filename>

Write soundtrack to a MIDI file [default: LOG.MID]

=item -palette <number>

Use given color palette [default: 0]

=over 4

=item Z<>0

Scaled VDP colors

=item Z<>1

Original VDP colors

=item Z<>2

Faded NTSC colors

=back

=item -sound [<quality>]

Sound emulation quality [default: 22050]

=item -nosound

Don't emulate sound [default: emulate sound]

=item -trap <address>

Trap execution when PC reaches address [default: FFFFh]

=item -sync <frequency>

Sync screen updates to <frequency> [default: 60]

=item -nosync

Do not sync screen updates [default: -nosync]

=item -soft

Scale display with 2xSaI [default: off]

=item -eagle

Scale display with EAGLE [default: off]

=item -epx

Scale display with EPX [default: off]

=item -scale2x

Scale display with Scale2X [default: off]

=item -cmy

Simulate CMY pixel raster [default: off]

=item -rgb

Simulate RGB pixel raster [default: off]

=item -mono

Simulate monochrome CRT [default: off]

=item -sepia

Simulate sepia CRT [default: off]

=item -green

Simulate green CRT [default: off]

=item -amber

Simulate amber CRT [default: off]

=item -saver, -nosaver

Save/don't save CPU when inactive [default: -saver]

=item -shm, -noshm

Use/don't use MIT SHM extensions for X [default: -shm]

=item -scale <factor>

Scale window by <factor> [default: 2]

=back

=head1 KEYBOARD BINDINGS

[ALT] Hold to switch to the second controller

=over 4

=item [SPACE]

FIRE-R button (also: [SHIFT],A,S,D,F,G,H,J,K,L)

=item [CONTROL]

FIRE-L button (also: Z,X,C,V,B,N,M)

=item [Q] 

SuperAction PURPLE button (also: E,T,U,O)

=item [W] 

SuperAction BLUE button (also: R,Y,I,P)

=item [0]-[9]

Digit buttons

=item [-] 

[*] button

=item [=] 

[#] button

=item [PGUP]

Fast-forward emulation (also: [F9])

=item [ESC]

Quit emulation (also: [F12])

=item [F1] 

Go into the built-in debugger

=item [F2] 

Turn soundtrack log on/off

=item [F3] 

Toggle FIRE-R autofire on/off

=item [F4] 

Toggle FIRE-L autofire on/off

=item [F5] 

Invoke configuration menu

=item [F6] 

Load emulation state

=item [F7] 

Save emulation state

=item [F8] 

Turn scanline simulation on/off

=item [ALT]+[F8]

Toggle screen softening on/off

=item [F9] 

Fast-forward emulation (also: [PGUP])

=item [F11]

Reset hardware

=item [F12]

Quit emulation (also: [ESC])

=item [ALT]+[PGUP]

Increase audio volume

=item [ALT]+[PGDOWN]

Decrease audio volume

=back

=head1 FILES

=over 4

=item coleco.rom

ColecoVision BIOS ROM image (8192 bytes). This is the only ROM required for playing ColecoVision games.

=item writer.rom

SmartWriter ROM (32768 bytes), only required for emulating the Coleco ADAM system.

=item eos.rom

Extended OS ROM (8192 bytes), only required for emulating the Coleco ADAM system.

=back

The above ROM images may be named in all-lowercase or all-uppercase, and are searched for in:

1. The directory specified by -home, or the current directory if -home not given.

2. /usr/share/colem/

3. ~/.colem/

The coleco.rom file will occasionally be found on websites with the names "os7.rom" or "ColecoVision BIOS (1982).col". Its md5sum is one of:

 2c66f5911e5b42b8ebe113403548eee7 (original version)
 00fd13b66d39c69706aa48eb84a78411 (hacked version, different font)
 47f7180592a00b9631c97a12ff0fdd3c (hacked version, no title screen delay)

ColEm works with any of the above ROM images.

=head1 AUTHOR

ColEm is by Marat Fayzullin, (C)FMS 1994-2016

This man page is by B. Watson, for the SlackBuilds.org project (but may be used by anyone for any
purpose).