![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to manual.html CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [HATARI the Atari ST Emulator] / hatari / doc|
Return to manual.html CVS log | Up to [HATARI the Atari ST Emulator] / hatari / doc |
1.1 root 1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2: <html>
3: <head>
4: <title>Hatari User's Manual</title>
5: <meta name="description" content="User's manual for the Atari ST emulator Hatari">
6: <meta name="author" content="Matthias Arndt <[email protected]>">
7: <meta name="keywords" content="hatari, documentation, manual, linux">
8: <meta name="resource-type" content="document">
9: <meta name="distribution" content="global">
10: <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15">
1.1.1.2 ! root 11: <meta name="Generator" content="Quanta Plus 3.2.1 SuSE Linux 9.1">
1.1 root 12: <meta http-equiv="Content-Style-Type" content="text/css">
13: <style type="text/css">
14: <!--
1.1.1.2 ! root 15: body { background-color:#FFFFFF;
! 16: color:#000000;
! 17: margin-left:10px;
! 18: margin-right:10px;
! 19: font-family:Verdana,Arial,Helvetica,sans-serif; font-size:12pt;
! 20: }
1.1 root 21:
22: h1 { font-size:28pt; }
23: h2 { font-size:22pt; border-bottom:solid thin black;}
24: h3 { font-size:16pt; }
25: h4 { font-size:13pt; }
26:
27: td { font-family:Verdana,Arial,Helvetica,sans-serif; font-size:12pt; }
28:
29: a:link { color:#000099; background-color:#ffffff; text-decoration:none; }
30: a:visited { color:#cc0000; background-color:#ffffff; text-decoration:none;}
31: a:hover { color:#000099; background-color:#ffffff; text-decoration:none; font-weight:bold; }
32: a:active { color:#993399; background-color:#ffffff; text-decoration:none; font-weight:bold; }
33:
34: *.commandline { font-family:Fixed,Courier,monospace; font-size:10pt; }
1.1.1.2 ! root 35: *.file { color: #000088;}
! 36: *.button { color: #468E64;}
1.1 root 37: *.key { color:#550000; font-family:Fixed,Courier,monospace; font-size:10pt; }
38: *.backdropped { background-color:#ffffee; }
39: *.image {border-width:2px; border-style:solid; border-color:#eeeeff; padding:1cm; text-align:justify; }
40:
41: -->
42: </style>
43:
44: </head>
45: <body bgcolor="#ffffff" text="#000000" link="#000099" vlink="#cc0000" alink="#993399">
46: <h1 align="center">Hatari User's Manual</h1>
1.1.1.2 ! root 47: <p align="center">
! 48: <strong>project initiator and main developer of Hatari: Thomas Huth <<a href="mailto:[email protected]">[email protected]</a>></strong><br>
! 49: <strong>manual by Matthias Arndt <<a href="mailto:[email protected]">[email protected]</a>></strong>
! 50: </p>
! 51: <p align="center">
! 52: <strong>Hatari on the WWW: <A href="http://hatari.sourceforge.net/" target="_blank">http://hatari.sourceforge.net/</A> </strong>
! 53: </p>
1.1 root 54: <br>
55:
56: <h2>Introduction</h2>
57:
58: <h3>General description</h3>
59: <p>Hatari is an Atari ST emulator for Linux, FreeBSD, BeOS and other
60: Systems which are supported by the SDL library. See Appendix B
1.1.1.2 ! root 61: for details on emulation in general.</p>
1.1 root 62: <p>Hatari is based on two main sources: </p>
63:
64: <ul>
65: <li>The WinSTon sourcecode written by Paul Bates. You can get it
66: from: <a href="http://www.sourceforge.net/projects/winston/">http://www.sourceforge.net/projects/winston/</a> </li>
67: <li>The UAE's CPU core, you can download UAE
1.1.1.2 ! root 68: at: <a href="http://www.freiburg.linux.de/~uae/">http://www.freiburg.linux.de/~uae/</a> </li>
1.1 root 69: </ul>
70: <p>
71: Hatari started as an adaption of the free WinSTon source code to Linux.
72: (WinSTon is a ST emulator for Windows). But since WinSTon's CPU core was
73: written in i86 assembler, it was not possible to use it for Hatari as
74: Hatari is intended to be platform independent. So the UAE's CPU core was
75: used for Hatari instead, because this CPU core has been written in
76: portable C and also has some nice features like 68040 and FPU support.
77: </p>
78:
79: <h3>Features</h3>
80: <ul>
1.1.1.2 ! root 81: <li>complete m68k emulation via UAE's CPU core</li>
! 82: <li>support for EmuTOS, TOS 1.00, 1.02, 1.04, 2.05 and 2.06</li>
! 83: <li>ST RAM size variable (512k, 1MB, 2MB and 4MB possible)</li>
! 84: <li>most of the ST specific hardware</li>
1.1 root 85: <li>ST Shifter with ST-High, ST-Medium and ST-Low resolutions,
1.1.1.2 ! root 86: overscan effects for lower border and partially in the upper, left and right border too</li>
! 87: <li>512 colour ST palette</li>
! 88: <li>Blitter chip emulation</li>
! 89: <li>PSG YM2149 emulation (soundchip) including STFM samples</li>
! 90: <li>Printer emulation on GEMDOS and Hardware level (print to file)</li>
! 91: <li>experimental support for RS232</li>
! 92: <li>extremely experimental MIDI support</li>
1.1 root 93: <li>Mega ST real time clock</li>
94: <li>many (but not all) raster effects </li>
95: <li>IKBD emulation (keyboard, mouse and joystick) with custom keyboard mapping</li>
96: <li>joystick emulation via cursor keys and joystick emulation via a
1.1.1.2 ! root 97: connected PC joystick</li>
! 98: <li>FDC emulation using floppy disk images in standard formats (*.ST, *.MSA
! 99: and *.DIM)</li>
! 100: <li>support for zipped disk images (both PkZip and Gzip)</li>
! 101: <li>partial ACSI emulation for harddisk support</li>
! 102: <li>GEMDOS interface driver to mount a directory as a harddrive</li>
! 103: <li>experimental support for memory snapshots</li>
! 104: <li>driver for extended VDI resolutions</li>
! 105: <li>recording of sound as .WAV and .YM files</li>
! 106: <li>screenshots in .BMP format</li>
! 107: <li>animation capturing</li>
1.1 root 108: <li>interlaced rendering of ST-Low and ST-Medium resolutions </li>
109: <li>scaling of ST-Low and ST-Medium to 800x600 resolution </li>
110: </ul>
111: <p>
112: At the time of this writing there is neither a complete MMU emulation
113: nor support for STE specific features.
114: </p>
115:
116: <h3>System requirements</h3>
117: <p> Hatari currently has the following system requirements: </p>
118: <ul>
119: <li>a fast PC (>200MHz) </li>
120: <li>some sort of Unix (preferable <a href="http://www.linux.org/">GNU/Linux</a>) </li>
121: <li>the SDL library (<a href="http://www.libsdl.org/">http://www.libsdl.org/</a>)</li>
122: <li>the zLib (<a href="http://www.gzip.org/zlib/">http://www.gzip.org/zlib/</a>) for support of gzipped disk images</li>
123: </ul>
124: Hatari has been succesfully tested on the following machines:
125: <p> </p>
126: <ul>
1.1.1.2 ! root 127: <li>Linux/i86 with Kernel 2.6.6, AMD Athlon 600MHz</li>
! 128: <li>Linux/i86 with Kernel 2.4.x, AMD Athlon 600MHz </li>
1.1 root 129: <li>Linux/i86 with Kernel 2.2.18, Pentium MMX 200MHz </li>
1.1.1.2 ! root 130: <li>Linux/PPC with Kernel 2.4.x </li>
! 131: <li>BeOS/i86 </li>
1.1 root 132: <li>Apple PowerMac with Mac OS X </li>
133: <li>NetBSD 1.6 </li>
1.1.1.2 ! root 134: <li>FreeBSD 4.1 on an i486 computer, FreeBSD 4.8 on a Pentium 4 and FreeBSD 5.1 </li>
! 135: <li>OpenBSD 3.5 </li>
! 136: <li>Since version 0.40, Hatari now also works on machines with a Sparc CPU </li>
! 137: <li>Zaurus SL-C760 PDA </li>
1.1 root 138: </ul>
139:
140: <h2>Compiling and running</h2>
141:
142: <h3>Compiling Hatari</h3>
143: <p> First, you need the SDL library, you can get it at:
144: <a href="http://www.libsdl.org/">http://www.libsdl.org/</a>. Most distributions already ship a suitable version.
145: Make sure to install the appropriate header files as well often called "libsdl-dev" or the like.
146: </p>
147: <p> Second, you need the zLib compression library. You can get it from <a href="http://www.gzip.org/zlib/">http://www.gzip.org/zlib/</a>
148: but the version shipped with your distribution will be sufficient in most cases. Make sure to have the header files
149: for it installed as well.
150: </p>
151:
152: <p>
153: Of course, you need the GNU C compiler and (GNU) Make, too!
154: </p>
155:
1.1.1.2 ! root 156: <p> Change to the hatari/ directory and adapt the configuration file
! 157: <span class="file">Makefile.cnf</span> to suite your system.
! 158: Alternatively, you can use the supplied configure script to auto-detect
! 159: all parameters (type "./configure --help" to see the options of the script).
! 160: Then compile Hatari by typing <span class="commandline">make</span>. If all
! 161: works fine, you'll get the executable <span class="commandline">hatari</span> in the src/ subdirectory.
! 162: </p>
1.1 root 163:
164: <h3>Installation of a TOS ROM</h3>
165: <p> Then you'll have to copy a TOS ROM to the data directory (the data directory is specified
1.1.1.2 ! root 166: in the configuration file Makefile.cnf) and rename it to <span class="commandline">tos.img</span>, or use the
1.1 root 167: <span class="commandline">--tos</span> command line option to tell Hatari where to find a TOS ROM.
168: Hatari needs a TOS ROM image because this contains the operating system
169: of the emulated Atari. Sorry, it is not possible to ship an image with
170: the Hatari package since these images are still copyrighted. But you can
171: easily create an image with a real ST and one of those various
172: ROM-image programs for the ST. Or search the internet, but don't ask the Hatari team
173: where to find one.
174: </p>
175: <p> Another solution is EmuTOS, which is an open-source
176: TOS clone. You can find EmuTOS at: <a href="http://emutos.sourceforge.net/">http://emutos.sourceforge.net/</a>. It's
177: not the best solution for playing games or running other old software
1.1.1.2 ! root 178: due to compatibility issues, but it's free and officially compatible with Hatari! </p>
1.1 root 179: <p>If you do not specify a TOS image on the commandline nor can Hatari
180: find a suitable TOS image in the default dir, you'll get the chance to
181: select a TOS image file from the GUI. </p>
182:
183: <h3>Installation of the binary</h3>
1.1.1.2 ! root 184: <p> Type <span class="commandline">make install</span> as root to do a systemwide installation. In this case it is recommended
! 185: to set the DATADIR variable in Makefile.cnf to a proper value. <tt>/usr/local/share/hatari</tt> is a good value in that case.</p>
! 186: <p>The Hatari executable should now be in your PATH and accessible from anywhere.</p>
! 187:
1.1 root 188: <p> When you finally have got a TOS image, try starting Hatari with the
189: option <span class="commandline">--help</span> to find out more about its command line parameters. </p>
190:
191: <h3>Running Hatari for the first time</h3>
192: <p> Now type <span class="commandline">hatari</span> to run the emulator for the first time. If all goes
193: well, you should now be presented with a window showing you the familiar
194: little green desktop of the Atari ST. Press <span class="key">F12</span> to turn on the GUI to
195: configure Hatari to suit your needs, press <span class="key">F11</span> to toggle windowed and fullscreen mode. </p>
196:
197: <h2>Command line options</h2>
198: <p> Hatari ofcourse understands several command line options. </p>
199: <p> Type <span class="commandline">hatari --help</span> to list them all. </p>
200: <p> The command line options in detail are as follows (in brackets the
201: long version): </p>
202:
203: <table cellpadding="3" border="1">
204: <tbody>
205: <tr class="backdropped">
206: <td align="center">Option</td>
207: <td align="center">Purpose</td>
208: </tr>
209: <tr>
210: <td align="center">-h (--help)</td>
211: <td align="center">prints command line options and terminates</td>
212: </tr>
213: <tr>
214: <td align="center">-v (--version)</td>
215: <td align="center">prints version information and terminates</td>
216: </tr>
217: <tr>
218: <td align="center">-m (--mono)</td>
219: <td align="center">starts the emulated Atari ST in monochrome
220: resolution</td>
221: </tr>
222: <tr>
223: <td align="center">-f (--fullscreen)</td>
224: <td align="center">tries to use a fullscreen mode</td>
225: </tr>
226: <tr>
227: <td align="center">-j (--joystick)</td>
228: <td align="center">activates joystick emulation via cursor keys</td>
229: </tr>
230: <tr>
231: <td align="center">--nosound</td>
232: <td align="center">disables sound (makes emulation faster)</td>
233: </tr>
234: <tr>
235: <td align="center">--frameskip</td>
236: <td align="center">drops every second frame (accelerates
237: emulation)</td>
238: </tr>
239: <tr>
240: <td align="center">-D (--debug)</td>
241: <td align="center">activates the simple builtin debugger</td>
242: </tr>
243: <tr>
1.1.1.2 ! root 244: <TD align="center">--slowfdc</TD>
! 245: <td align="center">slows down FDC emulation (needed to make some games and demos work)</td>
! 246: </tr>
! 247: <tr>
1.1 root 248: <td align="center">-d <dir> (--harddrive <dir>)</td>
249: <td align="center">emulates <dir> as a hard disk</td>
250: </tr>
251: <tr>
252: <td align="center">--hdimage <imagefile></td>
253: <td align="center">emulate hard disk with an image file</td>
254: </tr>
255: <tr>
256: <td align="center">--tos <imagefile></td>
257: <td align="center">specify TOS ROM image to use</td>
258: </tr>
259: <tr>
260: <td align="center">--memsize x</td>
261: <td align="center">set amount of emulated RAM<br>
262: x=0 for 512K, x=1,x=2 or x=4 for 1,2 or 4 MB</td>
263: </tr>
264: <tr>
265: <td align="center">--cpulevel x</td>
266: <td align="center">specify CPU (680x0) to use (TOS 2.06 only!!)</td>
267: </tr>
268: <tr>
269: <td align="center">--compatible</td>
270: <td align="center">use a more compatible but slower 68000 CPU mode</td>
271: </tr>
272: <tr>
273: <td align="center">--blitter</td>
274: <td align="center">enable blitter emulation</td>
275: </tr>
276: <tr>
277: <td align="center">--vdi</td>
278: <td align="center">use extended VDI resolution</td>
279: </tr>
1.1.1.2 ! root 280: <tr>
! 281: <td align="center">--printer</td>
! 282: <td align="center">enable experimental printer support</td>
! 283: </tr>
! 284: <tr>
! 285: <td align="center">--midi <filename></td>
! 286: <td align="center">enable experimental MIDI output to the mentioned file</td>
! 287: </tr>
! 288: <tr>
! 289: <td align="center">--rs232 <filename></td>
! 290: <td align="center">enable experimental RS232 communication via the mentioned file</td>
! 291: </tr>
! 292: <tr>
! 293: <td align="center">-c <filename> (--configfile)</td>
! 294: <td align="center">Use the mentioned file as configuration file instead of ~/.hatari.cfg</td>
! 295: </tr>
1.1 root 296: </tbody>
297: </table>
298:
299: <h2>Using the emulated system</h2>
300: <p> Once you've started Hatari succesfully, you can use the emulator as
301: an allmost complete Atari ST computer system. </p>
302:
303: <h3>The GUI</h3>
304:
305: <h4>General usage</h4>
306: <p>Press <span class="key">F12</span> to enter the GUI. Navigate it with the mouse.
307: The GUI is rather self explanatory.</p>
1.1.1.2 ! root 308: <p>Click <span class="button">Okay</span> to go back to the emulated ST. All checked options will be applied.</p>
! 309: <p>Check the <span class="button">Reset ST</span> option if you want the emulated ST to perform a soft reset. This should be equal to pressing the reset button on your ST.
! 310: </p>
! 311: <p>Click <span class="button">Quit</span> to terminate Hatari and return to the host OS.</p>
! 312: <p>Click <span class="button">Cancel</span> to abandon any changes made.</p>
1.1 root 313:
314: <h4>The System Dialog</h4>
315: <p>Check the CPU type to use here, enable prefetch mode and if the Blitter should be active.</p>
316: <p>For best Atari ST compatibility choose plain 68000 here.</p>
1.1.1.2 ! root 317: <p>The Timer-D patch changes the Timer-D initialization from TOS. TOS uses Timer-D as a baudrate generator for RS232.
! 318: The TOS default slows the emulation down so the patch gives you a faster emulation.
! 319: </p>
! 320: <p>You can disable the Timer-D patch if games or demos require the original TOS setting.</p>
! 321: <p><em>NOTE:</em> These parameters are very sensitive to the emulated ST and it is strongly recommended to
1.1 root 322: reset the emulated ST after changing these options.</p>
323:
1.1.1.2 ! root 324: <h4>The Discs Dialog</h4>
! 325: <p>Use the upper dialog to choose which floppy disks should be emulated in the disk drives.</p>
1.1 root 326: <p>You can use most standard Atari ST disk image files. See the chapter "Floppy disk images"
327: for details.</p>
1.1.1.2 ! root 328: <p>Click on the button <span class="button">Browse</span> next to the A: and B: option to go to the fileselector.
! 329: You may select and browse zipped disk images as well.</p>
! 330: <p>Click on <span class="button">Eject</span> to eject a disk image from the emulated drive. The emulated ST will act as if had no floppy disk in its drive.</p>
1.1 root 331: <p>You can specify a default directory where Hatari will start to browse the filesystem.</p>
332: <p>Check the "Auto insert B" option if you want Hatari to be smart and insert the second disk
333: of a two disk game automatically. This option will insert the second disk in drive B and some
334: games may not be able to find the disks there. In that rare case you will need to insert the
335: second disk manually when prompted.</p>
1.1.1.2 ! root 336: <p>
! 337: <em>NOTE:</em> This option does not always work properly.
! 338: </p>
! 339:
! 340: <p>If you need to create a new blank disk image, click on <span class="button">Create disk image</span>.
! 341: Parameters for the new image can be set in the following dialog. Click on <span class="create">create</span> to create the image or on <span class="button">back</span> to get back to the
! 342: disk dialog.
! 343: </p>
! 344: <p>
! 345: After clicking <span class="button">create</span>, a fileselector appears. You can browse the filesystem now. Select the target directory, click beside File:
! 346: and type in a name for the new disk image. The name should terminate with .st or .msa.
! 347: </p>
! 348: <p>Hatari can currently create plain .ST and .MSA disk images exclusively.</p>
! 349:
! 350: <p>Use the lower dialog to change the harddisk settings.</p>
1.1 root 351: <p>You can select a harddrive image for harddrive emulation via image file here or you may select
352: a directory of your local filesystem to be emulated as the ST's harddrive.</p>
353: <p>Check "Boot from HD" if you want Hatari to execute the AUTO folder on the harddrive.
354: This option is checked by default if you specify a harddrive image or a directory via the command line.</p>
355:
356: <h4>The Memory Dialog</h4>
357: <p>You can select the amount of RAM for the emulated ST here.</p>
358: <p><em>Note:</em> This option is critical and you are strongly advised to reset the emulated ST
359: when changing this option.</p>
1.1.1.2 ! root 360: <p>Here you will find the options to save memory snapshots as well.</p>
! 361: <p>Click on <span class="button">Save</span> to save a memory snapshot to file. You can select a new filename here.</p>
! 362: <p>Click on <span class="button">Restore</span> to restore a memory snapshot from a file. Use the fileselector to select the snapshot to be restored.</p>
! 363: <p><em>NOTE:</em> Memory snapshots should be considered <span style="color:red;">EXPERIMENTAL</span> and the Hatari team strongly advises you not to rely on them yet!</p>
1.1 root 364:
365: <h4>The TOS/GEM Dialog</h4>
1.1.1.2 ! root 366: <p>Here you can select the TOS image to use. Click on <span class="button">Browse</span> to select it via the fileselector.</p>
1.1 root 367: <p>In the GEM setup you can select a larger resolution for GEM conformant apps. Select resolution
368: and colour depth. Almost all games and demos will not work in one of these resolutions.</p>
369: <p><em>Note:</em> These options are critical and you are strongly advised to reset the emulated ST
370: when changing one of these option.</p>
371:
372: <h4>The Joystick Dialog</h4>
373: <p>Here you can select which joystick you want to emulate via the cursor keys.</p>
374: <p>Joystick 1 is the normal ST joystick port and 99.9% of all ST games use this port, Joystick 0
375: emulates a joystick plugged into the ST mouse port allowing you to play 2 player games.</p>
376: <p>If no joystick is checked here, joystick emulation is done via a connected PC joystick.</p>
377: <p>See the chapter "Emulated Joystick" for details.</p>
378:
379: <h4>The Screen Dialog</h4>
380: <p>Here you control the video output of the emulated ST.</p>
381: <p>Check "Fullscreen" to run Hatari fullscreen, default is windowed.</p>
382: <p>Check "Interlace" if you wish to have that old TV feeling in Hatari. Every second line will be black.
383: This will only work in ST-MEDIUM or ST-LOW in scaled up resolutions.</p>
384: <p>Check "Frame Skip" to speed Hatari up if emulation is too slow. This will only draw every second ST frame
385: instead of the default of drawing every ST frame. Uncheck if you have a fast PC.</p>
386: <p>Check "Use Borders" if you wish to have the borders around the ST screen.</p>
387: <p>"Force 8Bpp" will force SDL to use an 8bit video mode. You don't need this for modern video cards.</p>
388: <p>You can select which sort of monitor to use. Check "Color" for games and demos. If you check "Mono" here,
389: Hatari will emulate the good old SM124 and will not allow you to switch to color modes from the running ST.
390: This toggle acts like a monitor switch with a color and monochrome monitor connected.</p>
391: <p>"ST-Low mode" will control if Hatari renders ST-LOW to a 320x200 or 640x400 PC display (with borders turned off) or 384x267 or 768x534.
392: Basically select this to toggle between a small or a large window.</p>
1.1.1.2 ! root 393: <p>Click <span class="button">Capture Screen</span> to create a screenshot in .BMP format to the current working directory or click <span class="button">Record Animation</span> to record a sequence of single screenshots.
1.1 root 394: </p>
395:
396: <h4>The Keyboard Dialog</h4>
397: <p>Here you can select the keyboard mapping to use.</p>
398: <p>Two different mappings called "Symbolic" and "Scancode" are predefined.</p>
399: <p>You can also load a custom keymapping file here if you wish. Please note that selecting to use a custom keyboard mapping will
400: use the "symbolic" mapping for all keys not defined by your map file. See the supplied example mapfile on how to build your
401: own keyboard mapping.</p>
402:
403: <h4>The Sound Dialog</h4>
1.1.1.2 ! root 404: <p>Here you can control the sound subsystem.</p>
1.1 root 405: <p>Check if you want emulated sound at all. Emulation is faster if sound emulation is turned off.</p>
406: <p>3 frequencies from low to high quality are available. Experiment a little bit to find out which fits best for your setup.
407: Medium quality will work ok in most cases.</p>
408: <p>You can select to record a piece of sound here. Check which format to use and click the button. It is a toggle button so
409: you will need to return to the GUI to switch sound recording off again.</p>
410:
1.1.1.2 ! root 411: <h4>The Devices Dialog</h4>
! 412: <p>Check here if you want to enable experimental printer support. See the chapter "Emulated printer" for details.</p>
! 413: <p>As Hatari currently only supports printing to file, click on <span class="button">Select</span> to select the file to print to. You can enter a new filename as well.</p>
! 414: <p><em>NOTE:</em> As the printer emulation is not perfect yet, activated printer support may interfere with the emulated sound.
! 415: This is due to the fact that the Atari ST uses some general I/O ports of the soundchip for the printer port. The Hatari team suggests to
! 416: disable printing while using games and demos.
! 417: </p>
! 418: <p>Check the second checkmark if you want to enable experimental RS232 support. The RS232 device is configured according to the settings of the emulated RS232 of the Atari ST. This means Hatari will automatically use baudrate and handshaking as configured for the emulated ST.</p>
! 419: <p>Select a suitable device file for input and output. Click on <span class="button">Browse</span> to select.
! 420: A good choice is /dev/ttyS0 or /dev/ttyS1.
! 421: </p>
! 422: <p>You can enable MIDI as well. This currently work for outputting MIDI data only. A good choice is /dev/midi00.</p>
! 423: <p>Click on <span class="button">Browse</span> to select a suitable MIDI device file for output.</p>
! 424: <p>Your sound driver must support MIDI to make this work.</p>
! 425:
! 426: <p><em>NOTE:</em> RS232 and MIDI emulation are very experimental, too.
! 427: Don't enable them unless you really need them!
! 428: </p>
1.1 root 429:
430: <h3>Keyboard shortcuts</h3>
431: <p> While the emulator is running, you can activate or toggle various
432: features via the following keyboard shortcuts. </p>
433:
434: <table cellpadding="3" border="1">
435: <tbody>
436: <tr class="backdropped">
437: <td align="center">Shortcut</td>
438: <td align="center">Purpose</td>
439: </tr>
440: <tr>
1.1.1.2 ! root 441: <td align="center"><span class="key">ALTGR+a</span></td>
! 442: <td align="center">record animation</td>
! 443: </tr>
! 444: <tr>
1.1 root 445: <td align="center"><span class="key">ALTGR+g</span></td>
446: <td align="center">grabs a screenshot</td>
447: </tr>
448: <tr>
1.1.1.2 ! root 449: <td align="center"><span class="key">ALTGR+i</span></td>
! 450: <td align="center">boss key: leave full screen mode and iconify window</td>
! 451: </tr>
! 452: <tr>
1.1 root 453: <td align="center"><span class="key">ALTGR+j</span></td>
454: <td align="center">activates joystick emulation via cursor keys</td>
455: </tr>
456: <tr>
457: <td align="center"><span class="key">ALTGR+m</span></td>
458: <td align="center">(un-)locks the mouse into the window</td>
459: </tr>
460: <tr>
461: <td align="center"><span class="key">ALTGR+r</span></td>
1.1.1.2 ! root 462: <td align="center">(warm) reset the ST</td>
1.1 root 463: </tr>
464: <tr>
465: <td align="center"><span class="key">ALTGR+c</span></td>
466: <td align="center">coldreset the ST (same as the original power switch)</td>
467: </tr>
468: <tr>
1.1.1.2 ! root 469: <td align="center"><span class="key">ALTGR+s</span></td>
! 470: <td align="center">enable/disable sound</td>
! 471: </tr>
! 472: <tr>
1.1 root 473: <td align="center"><span class="key">ALTGR+q</span></td>
474: <td align="center">quit the emulator</td>
475: </tr>
476: <tr>
1.1.1.2 ! root 477: <td align="center"><span class="key">ALTGR+x</span></td>
! 478: <td align="center">toggle normal/max speed</td>
! 479: </tr>
! 480: <tr>
! 481: <td align="center"><span class="key">ALTGR+y</span></td>
! 482: <td align="center">enable/disable sound recording</td>
! 483: </tr>
! 484: <tr>
1.1 root 485: <td align="center"><span class="key">F11</span></td>
486: <td align="center">toggles fullscreen and windowed mode</td>
487: </tr>
488: <tr>
489: <td align="center"><span class="key">F12</span></td>
1.1.1.2 ! root 490: <td align="center"><p>activate the GUI</p><p>You may need to hold <span class="key">SHIFT</span> down while in windowed mode.</p></td>
1.1 root 491: </tr>
492: <tr>
493: <td align="center"><span class="key">PAUSE</span></td>
494: <td align="center">will go to the debugger if it was activated at compile time</td>
495: </tr>
496: </tbody>
497: </table>
498:
499: <h3>Emulated Atari ST keyboard</h3>
500: <p> All other keys on the keyboard act as the normal Atari ST keys so
501: pressing SPACE on your PC will result in an emulated press of the SPACE
502: key on the ST. The following keys have special meanings: </p>
503:
504: <table cellpadding="3" border="1">
505: <tbody>
506: <tr class="backdropped">
507: <td align="center">Key</td>
508: <td align="center">Meaning</td>
509: </tr>
510: <tr>
511: <td align="center"><span class="key">Alt</span></td>
512: <td align="center">will act as the ST's ALTERNATE key</td>
513: </tr>
514: <tr>
515: <td align="center"><span class="key">left CTRL</span></td>
516: <td align="center">will act as the ST's CONTROL key</td>
517: </tr>
518: <tr>
1.1.1.2 ! root 519: <td align="center"><span class="key">Print Screen</span></td>
1.1 root 520: <td align="center">will emulate the ST's HELP key</td>
521: </tr>
522: <tr>
1.1.1.2 ! root 523: <td align="center"><span class="key">Scroll Lock</span></td>
1.1 root 524: <td align="center">will emulate the ST's UNDO key</td>
525: </tr>
1.1.1.2 ! root 526: <tr>
! 527: <td align="center"><span class="key">Page Up</span></td>
! 528: <td align="center">will emulate the ST's ( key in the keypad</td>
! 529: </tr>
! 530: <tr>
! 531: <td align="center"><span class="key">Page Down</span></td>
! 532: <td align="center">will emulate the ST's ) in the keypad</td>
! 533: </tr>
1.1 root 534: </tbody>
535: </table>
536:
537: <p> <span class="key">ALTGR</span> will act as ALTERNATE as well as long as you do not press it
538: together with a Hatari hotkey combination. </p>
539: <p> The <span class="key">right CTRL</span> key is used as the fire button of the emulated
540: joystick when you turn on joystick emulation via keyboard. </p>
541: <p> The cursor keys will act as the cursor keys on the Atari ST as long as joystick emulation
542: via keyboard has been turned off.</p>
543:
544: <h3>Emulated mouse</h3>
545: <p>For obvious reasons your PC mouse will act as the emulated Atari ST
546: mouse. In fullscreen mode it will act as expected, directly controlling
547: the ST mouse pointer. </p>
548: <p>However it is a little bit different in windowed mode. To make the
549: mouse work there as expected you need to grab it first or lock it into
550: the Hatari window. Do this by pressing the <span class="key">ALTGR+m</span> hotkey combination.
551: Press it again to go back to normal mouse behaviour which allows you to
552: work in other X11 windows while Hatari is up and running. </p>
553:
554: <h3>Emulated joystick</h3>
555: <p>The Atari ST joysticks are emulated ofcourse allowing you to play
556: your favourite games with Hatari. </p>
557: <p>The default mode is to use a connected PC joystick. You can use any
558: joystick that is supported by your kernel. If your joystick works with
559: other applications, it will likely work with Hatari as well. Make sure
560: it is calibrated and then off you go. Move the stick to point into the
561: desired direction. Please note that Hatari will not detect analogue
562: movement as the Atari ST only had digital joysticks. The first
563: firebutton will act as the normal firebutton on the Atari ST while the second
564: firebutton will emulate a keypress of the <span class="key">SPACE</span> key on the ST as many ST
565: games utilitze the SPACE bar for secondary game functions. (Xenon for example)</p>
566: <p>If you do not have a PC joystick or joypad, then you do not need to
567: desperate. You can emulate one of the two Atari ST joysticks via the
568: cursor keys. Just activate it in the GUI. Then the cursor keys will act
569: as the joystick directions, the right CTRL key will act as the
570: firebutton. You can still use the cursor keys as the ST's
571: cursorkeys in this mode as long as you press <span class="key">SHIFT</span> along with the cursorkeys. </p>
572:
1.1.1.2 ! root 573: <h3>Emulated video</h3>
! 574: <p>Hatari by default only handles ST modes, ST-LOW, ST-MED and ST-HIGH.</p>
! 575: <p>Overscan effects and socalled "Border Removal" are possible too.</p>
! 576: <p>Due to the fact that these effects are achieved by using quirks and glitches in the original chips to do things beyond their specification emulation is a bit tricky for these and not all ST applications utilizing these techniques will work properly in Hatari.
! 577: Especially socalled "Sync Scrolling", a special technique to emulate the low byte of the video address, currently does not work properly in Hatari.
! 578: </p>
! 579: <p>Beside that you can setup extended VDI modes. These only work with GEM-compliant applications and they are equal to fitting a videocard into your Mega ST.</p>
! 580: <p>Make sure to disable extended VDI modes for playing games as 99% of all ST games will not be able to make use of higher resolutions.</p>
! 581:
! 582:
! 583: <h3>Emulated printer</h3>
! 584: <p>Due to the fact that printer handling is very different between Unix style machines and the Atari ST, emulation
! 585: of the printer is achieved by writing all printer output to a file.</p>
! 586: <p>The file will contain a sequence of data, the same that would appear on the data pins of the Atari ST printer port.
! 587: That would include control characters and commands for graphic printing. Clicking "Print desktop" on the GEM desktop would result
! 588: in a messy data dump in the printer output.</p>
! 589: <p>Printer emulation works best for plain text files or programs that do not format the output for a specific printer.
! 590: The file contents can be used with your favourite text editor for further processing and printing to a real printer.</p>
! 591: <p>To get real direct printing out of Hatari on a PostScript printer, you may set up a GDOS printer with a PostScript driver on the emulated Atari and set your printer device file as Hatari's printer output.<br>
! 592: <em>NOTE:</em> This has not been tested yet and the Hatari team cannot guarantee that it will work.</p>
! 593:
! 594: <h3>Emulated RS232</h3>
! 595: <p>Serial communications in Hatari is designed to directly use a serial port on your PC.</p>
! 596: <p>Communications parameters are set automatically upon the settings of the emulated ST. This means all you do is to set
! 597: the communication parameters like baudrate from your ST communications software. Hatari will do the rest and handle
! 598: the serial input and output for you.</p>
! 599:
1.1 root 600: <h2>Floppy disk images</h2>
601: <p>Hatari does not use floppy disks directly but disk images due to
602: differences between the floppy disk controllers of the ST and the PC.
1.1.1.2 ! root 603: Three types of disk images are currently supported: The raw "ST" type, the similar "DIM" type and
! 604: the compressed "MSA" (Magic-Shadow-Archiver) type. </p>
1.1 root 605: <p> The raw type (file suffix should be "*.st") is simply a sector by
606: sector image of a real floppy disk. You can easily create such an image
607: with the <span class="commandline">dd</span> program which should normally be pre-installed on every
608: Unix-like system. Simply type something like <span class="commandline">dd if=/dev/fd0 of=myimage.st</span> to create a disk image. Of course you need access to
609: /dev/fd0, and depending on your system and the type of floppy disk you
610: might have to use another device name here (for example I use
611: /dev/fd0u720 for 720kB disks). However, if the disk is copy-protected or
612: doesn't use a MSDOS compatible file system, this might fail. So be very
613: careful if you're not sure about the disk format. </p>
614: <p> The other possibility is to image the disk on a real Atari ST. There
615: are programs like the Magic Shadow Archiver for this task. Hatari
616: supports this slightly compressed MSA disk images, too. Note that Hatari
617: only supports the "old" MSA format, there are some Magic Shadow Archiver
618: clones (like Jay-MSA) that create better compressed but
1.1.1.2 ! root 619: Hatari-incompatible disk images. However, if you have got such a MSA
! 620: disk and want to use it with Hatari, you can still run the corresponding
! 621: MSA program within Hatari to extract the incompatible disk image to a
! 622: normal floppy disk image. </p>
1.1 root 623: <p> While *.ST and *.MSA are more or less the "standard" types of Atari
1.1.1.2 ! root 624: disk images, you might sometimes also find STT or ADF images on the
! 625: internet. These currently do not work with Hatari. </p>
! 626:
! 627: <p>Hatari can now also utilize *.DIM images just as *.ST ones without any problems.
! 628: Note that DIM images are nearly the same as the raw ST images
! 629: (they only have an additional 32 bytes header), so you can easily transform
! 630: the DIM images into ST images by stripping the header from the files.
! 631: For example try something like:
! 632: <span class="commandline">dd if=input.dim of=output.st bs=32 skip=1</span>
! 633: </p>
! 634:
1.1 root 635: <p> If you've got a disk image that has been created with the old ST
636: emulator PaCifiST (for DOS) or with early versions of the program
637: Makedisk, and the disk image does not work with Hatari, then the disk
638: probably suffers from the "PaCifiST bootsector bug" (Hatari will print a
639: warning message then). In this case, the bootsector of the disk
640: contains some illegal data, so that the disk even does not work on a
641: real ST any more. However, if it is a .ST and not a .MSA disk, you can
642: easily fix it by using a hex-editor to change the byte at offset $D (13)
643: from 0 to 1 (don't forget to backup your disk image first, since you
644: can also easily destroy your disk image when changing a wrong byte
645: there). If the disk contains a bootsector program, you probably have to
646: adjust the boot sector check sum, too (it can be found at offset $1FE +
647: $1FF). </p>
1.1.1.2 ! root 648: <p>Hatari supports disk images that are compressed with (Pk-)ZIP
! 649: (file suffix must be ".zip") or GZip (file suffix must be ".st.gz" or
! 650: ".msa.gz"), so you can archive your disk images into zip archives.
! 651: You can also directly run the zip archives you may download from the
! 652: net as long as the archive contains a disk image in .ST or .MSA format.</p>
! 653: <p><em>Note:</em> Hatari does not save disk images back to *.ZIP files so
! 654: your highscores and savegames are lost if you load the game from such
! 655: a zipped disk image.</p>
1.1 root 656:
657: <h2>Hard disk support</h2>
658: <p>Hatari supports two ways of emulating a ST hard drive: The low-level
659: ACSI hard disk emulation and a GEMDOS based drive emulation. </p>
660: <p>To use the ACSI hard disk emulation, you need a hard disk image file
661: with a pre-installed HD driver in it. So either try to image your old ST
662: hard disk or grab one from the internet. There is a HD image on the
663: Hatari web page for download. Perhaps we'll also provide a tool for
664: creating HD images one day. </p>
665: <p>With the GEMDOS based drive emulation, you can easily "mount" a
666: folder from the host file system to a drive of the emulated Atari. To
667: use the GEMDOS based drive emulation, you should use a folder on your
668: hard disk that only contains files and folders with valid TOS filenames.
669: That means that all files/folders should be written in capital letters
670: and their length mustn't exceed the 8+3 file name length limit. If you
671: don't want to rename all files to get capital letters, it is also
672: possible to store that folder on a FAT filesystem since those
673: filesystems are case-insensitive. </p>
674: <p>GEMDOS drive emulation is an easy way to share files between the
675: host system and the emulated Atari, but it is known to be incomplete and
676: a little bit unstable, especially if you use it together with the ACSI
677: hard disk emulation. So if your programs complain that they could not
678: find/read/write files on the GEMDOS HD drive, you should try to copy
679: them to a floppy disk image or a real hard disk image! </p>
680: <p> Note that changing the HD-image or the GEMDOS HD-folder will reset
681: the emulated Atari since it is not possible to switch the hard disk
682: while the emulator is running. </p>
683: <p> May the fun without the price to be with you ;-) ! </p>
684:
685: <h2>Appendix</h2>
686:
687: <h3>Copying</h3>
688: <div class="backdropped">
689: <p>This program is free software; you can redistribute it and/or modify
690: it under the terms of the GNU General Public License as published by the
691: Free Software Foundation; either version 2 of the License, or (at your
692: option) any later version. </p>
693: <p>This program is distributed in the hope that it will be useful, but <em>WITHOUT
694: ANY WARRANTY</em>; without even the implied warranty of <em>MERCHANTABILITY</em>
695: or <em>FITNESS FOR A PARTICULAR PURPOSE</em>. See the GNU General Public
696: License for more details. </p>
697: <p>You should have received a copy of the GNU General Public License
698: along with this program; if not, write to Free Software Foundation,
699: Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA </p>
700: </div>
701:
702: <p><a href="http://www.gnu.org/">The GNU Project and the Free Software Foundation</a> | <a href="http://www.fsf.org/licenses/gpl.html">The GNU General Public License</a></p>
703:
704: <h3>Introduction to Emulation</h3>
705: <p>Emulation via software is an art and Hatari is an example of this.</p>
706: <p>Emulation is to make a computer behave like a (probably) completely different machine on the lowest possible niveau.
707: This includes CPU and custom chip emulation allowing software written for the emulated machine to be run without notice.
708: A good emulator will run most of the software intended for the emulated platform without trouble.
709: </p>
710: <p>
711: The key to emulation is to simply do those things with a software program, the emulator, that normally chips would perform.
712: So you have an CPU emulator that basically consists of a large loop that does exactly what the real thing would do:
713: </p>
714: <ul>
715: <li>fetch an instruction from virtual memory</li>
716: <li>interpret this instruction</li>
717: <li>fetch operands from the emulated registers and memory</li>
718: <li>perform the operation like addition or changing the program counter on a jump instruction</li>
719: <li>writes results back into the intended registers or memory locations</li>
720: <li>increment of the program counter and loop</li>
721: </ul>
722: <p>
723: The typical von-Neumann CPU can be emulated very fast, stable and error-free using such a simple loop system.
724: </p>
725: <p>
1.1.1.2 ! root 726: But in most cases the CPU emulation is the simplest part. Correct emulation of the various custom chips and hardware
1.1 root 727: parts of the emulated system is much trickier.
728: </p>
729:
730:
731: <h3>Software compatibility list</h3>
1.1.1.2 ! root 732: <p>This is a little compilation of what Atari software does work in Hatari. It is by no means finished.</p>
1.1 root 733:
734: <table cellpadding="3" border="1">
735: <caption align="bottom">tested games</caption>
736: <tbody>
737: <tr class="backdropped">
738: <td align="center">Game</td>
739: <td align="center">Working</td>
740: <td align="center">Sound</td>
741: <td align="center">Comment</td>
742: </tr>
743: <tr>
744: <td>Eliminator</td>
745: <td>yes</td>
746: <td>perfect</td>
747: <td> </td>
748: </tr>
749: <tr>
750: <td>Speedball</td>
751: <td>yes</td>
752: <td>perfect</td>
753: <td> </td>
754: </tr>
755: <tr>
756: <td>Xenon</td>
757: <td>yes</td>
758: <td>music ok - fx dodgy</td>
759: <td>bullets and explosions sound weired</td>
760: </tr>
761: <tr>
1.1.1.2 ! root 762: <td>Bubble Bobble</td>
! 763: <td>yes</td>
! 764: <td> </td>
! 765: <td> </td>
! 766: </tr>
! 767: <tr>
1.1 root 768: <td>F15 Strike Eagle 2</td>
769: <td>yes</td>
770: <td>ok</td>
771: <td>keyboard emulation seems to be dodgy</td>
772: </tr>
773: <tr>
774: <td>Rick Dangerous</td>
775: <td>yes</td>
776: <td>perfect</td>
777: <td> </td>
778: </tr>
779: <tr>
780: <td>Slayer</td>
781: <td>yes</td>
782: <td>ok</td>
783: <td>raster fx at highscore entry dodgy</td>
784: </tr>
785: <tr>
786: <td>Lethal Xcess</td>
787: <td>no</td>
788: <td> </td>
1.1.1.2 ! root 789: <td>crashes while loading, sync scrolling will not work properly</td>
1.1 root 790: </tr>
791: <tr>
792: <td>Star Goose</td>
793: <td>yes</td>
794: <td>music ok - bullet sound dodgy</td>
795: <td> </td>
796: </tr>
797: <tr>
798: <td>Xenon 2 - Megablast</td>
799: <td>yes</td>
1.1.1.2 ! root 800: <td>nearly perfect (including sampled intro)</td>
1.1 root 801: <td> </td>
802: </tr>
803: <tr>
804: <td>Metal Mutant</td>
805: <td>yes</td>
806: <td>seems ok</td>
807: <td>some color effects in the lower screen seem buggy</td>
808: </tr>
809: <tr>
810: <td>Defenders Of The Earth</td>
811: <td>yes</td>
812: <td> </td>
813: <td> </td>
814: </tr>
815: <tr>
816: <td>Nebulus</td>
817: <td>yes</td>
818: <td>music ok; snowball, balls and trapdoors dodgy</td>
819: <td>otherwise working to a playable extend</td>
820: </tr>
1.1.1.2 ! root 821: <tr>
! 822: <td>Leander</td>
! 823: <td>yes</td>
! 824: <td> </td>
! 825: <td> </td>
! 826: </tr>
! 827: <tr>
! 828: <td>Navy Seals</td>
! 829: <td>yes</td>
! 830: <td> </td>
! 831: <td> </td>
! 832: </tr>
! 833: <tr>
! 834: <td>Armalyte</td>
! 835: <td>yes</td>
! 836: <td> </td>
! 837: <td> </td>
! 838: </tr>
! 839: <tr>
! 840: <td>Wings Of Death</td>
! 841: <td>yes</td>
! 842: <td> </td>
! 843: <td> </td>
! 844: </tr>
! 845: <tr>
! 846: <td>Alien World</td>
! 847: <td>yes</td>
! 848: <td> </td>
! 849: <td>Only works with "--slowfdc"</td>
! 850: </tr>
! 851: <tr>
! 852: <td>Fantasia (Demo by Dune)</td>
! 853: <td>yes</td>
! 854: <td> </td>
! 855: <td>Only works with "--slowfdc"</td>
! 856: </tr>
! 857: <tr>
! 858: <td>If pigs could fly (Demo by Syndicate)</td>
! 859: <td>yes</td>
! 860: <td> </td>
! 861: <td>Only works with "--slowfdc"</td>
! 862: </tr>
! 863:
1.1 root 864: </tbody>
865: </table>
866:
867: <table cellpadding="3" border="1">
868: <caption align="bottom">tested applications</caption>
869: <tbody>
870: <tr class="backdropped">
871: <td align="center">Application</td>
872: <td align="center">Working</td>
873: <td align="center">Comment</td>
874: </tr>
875: <tr>
876: <td>DevPac 2.2</td>
877: <td>yes</td>
878: <td>MonST crashy</td>
879: </tr>
880: <tr>
881: <td>Turbo Assembler</td>
882: <td>yes</td>
883: <td> </td>
884: </tr>
885: <tr>
886: <td>GFABASIC 3.6TT</td>
887: <td>yes</td>
1.1.1.2 ! root 888: <td>MENU.PRG does not like harddisks. Use diskimages for compiling.</td>
1.1 root 889: </tr>
890: <tr>
891: <td>ST Basic</td>
892: <td>yes</td>
893: <td> </td>
894: </tr>
895: <tr>
896: <td>Neochrome</td>
897: <td>yes</td>
898: <td>rasters sometimes unstable</td>
899: </tr>
900: <tr>
1.1.1.2 ! root 901: <td>Crackart</td>
! 902: <td>yes</td>
! 903: <td> </td>
! 904: </tr>
! 905: <tr>
1.1 root 906: <td>Tempus</td>
907: <td>yes</td>
908: <td> </td>
909: </tr>
910: <tr>
911: <td>Sagrotan</td>
912: <td>yes</td>
913: <td> </td>
914: </tr>
915: <tr>
1.1.1.2 ! root 916: <td>SidSound Designer</td>
! 917: <td>yes</td>
! 918: <td> </td>
! 919: </tr>
! 920: <tr>
1.1 root 921: <td>MusicMon 2</td>
922: <td>yes</td>
923: <td> </td>
924: </tr>
925: <tr>
926: <td>Protracker</td>
927: <td>yes</td>
928: <td> </td>
929: </tr>
1.1.1.2 ! root 930: <tr>
! 931: <td>Teradesk</td>
! 932: <td>yes</td>
! 933: <td> </td>
! 934: </tr>
! 935: <tr>
! 936: <td>Qed</td>
! 937: <td>yes</td>
! 938: <td> </td>
! 939: </tr>
! 940: <tr>
! 941: <td>Everest</td>
! 942: <td>yes</td>
! 943: <td> </td>
! 944: </tr>
! 945: <tr>
! 946: <td>Speed Of Light</td>
! 947: <td>yes</td>
! 948: <td> </td>
! 949: </tr>
1.1 root 950: </tbody>
951: </table>
952:
953: <hr style="width: 100%; height: 2px;">
954:
955: <table border="0" width="100%">
956: <tbody>
957: <tr>
958: <td align="left"><a href="http://validator.w3.org/check/referer"><img border="0" src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" height="31" width="88"></a></td>
1.1.1.2 ! root 959: <td align="right"><address><a href="mailto:[email protected]">Matthias Arndt</a>July 08 2004</address></td>
1.1 root 960: </tr>
961: </tbody>
962: </table>
963:
964: </body>
965: </html>
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.