--- hatari/doc/manual.html 2019/04/01 07:12:26 1.1.1.4 +++ hatari/doc/manual.html 2019/04/01 07:15:45 1.1.1.9 @@ -4,71 +4,124 @@ Hatari User's Manual - + - - + - + + +

Hatari User's Manual

+

-Version 0.70 +Version 1.2

-project initiator and main developer of Hatari: Thomas Huth <thothy@users.sourceforge.net>
-manual by Matthias Arndt <marndt@asmsoftware.de> +Manual written by: Thomas Huth, Matthias Arndt + & Eero Tamminen

-Hatari on the WWW: http://hatari.sourceforge.net/ +Hatari on the WWW: http://hatari.berlios.de/

-
-

Introduction

+

Index

+ + -

General description

+

Introduction

+ +

General description

-Hatari is an Atari ST emulator for Linux, FreeBSD, BeOS and other -Systems which are supported by the SDL library. +Hatari is an Atari ST, STE, TT and Falcon emulator for Linux, FreeBSD, BeOS and +other Systems which are supported by the SDL library. The emulator is open source software and is distributed under the terms of the -GNU General Public License (GPL). +GNU General +Public License (GPL).

The Atari ST was a 16/32 bit computer system which was first released by Atari @@ -81,77 +134,122 @@ Unlike many other Atari ST emulators whi environment for running GEM applications, Hatari tries to emulate the hardware of a ST as close as possible so that it is able to run most of the old ST games and demos. Of course you can run normal GEM applications with Hatari, too. +Recent versions of Hatari even feature basic STE, TT and Falcon emulation.

-

Features

+

Features

+ + +

STE hardware emulation

+STE emulation is still a little bit experimental, but basically +there is support for most of the enhanced/additional STE features: + + + +

Very experimental TT hardware emulation

+There is support for following additional TT features: + + + +

Very experimental Falcon hardware emulation

+There is support for following additional Falcon features: + +

-At the time of this writing there is neither a complete MMU emulation -nor support for STE specific features. +DSP emulation is still very experimental and unstable, but there's a dummy mode, +too, which helps to get some demos and games running.

-

System requirements

+ + +

System requirements

+

Hatari currently has the following system requirements:

-Hatari has been succesfully tested on the following machines: + +

+Certain versions of Hatari have successfully been tested by various people on +the following systems: +

-

Compiling and running

-

Compiling Hatari

+ +

Compiling and running

+ +

Compiling Hatari

+

First, you need the SDL library, you can get it at: http://www.libsdl.org/. Most distributions already ship a suitable version. @@ -165,12 +263,18 @@ most cases. Make sure to have the header for it installed as well.

+For optional features like PNG format screenshots and Hatari window +embedding, you need to have the header files for libpng and libX11. +

+

Of course, you need the GNU C compiler and (GNU) Make, too!

-

Change to the hatari/ directory and adapt the configuration file -Makefile.cnf to suite your system. -Alternatively, you can use the supplied configure script to auto-detect -all parameters (type " ./configure --help" +

Change to the hatari/ directory, copy +Makefile-default.cnf to +Makefile.cnf and adapt the configuration file +to suite your system. Alternatively, you can use the supplied configure +script to auto-detect all parameters (type +"./configure --help" to see the options of the script). Don't forget to use some good CFLAGS for the compiler optimizations, e.g. run configure in the following way: @@ -184,33 +288,40 @@ If all works fine, you'll get the executable hatari in the src/ subdirectory.

-

Installation of a TOS ROM

-

Then you'll have to copy a TOS ROM to the data directory (the data -directory is specified + +

Installation of a TOS ROM

+ +

+Before you can start Hatari, you have to copy a TOS ROM image to the data +directory (the data directory is specified in the configuration file Makefile.cnf) and rename it to tos.img, or use the --tos command line option to tell Hatari where to find a TOS ROM. Hatari needs a TOS ROM image because this contains the operating system -of the emulated Atari. Sorry, it is not possible to ship an image with -the Hatari package since these images are still copyrighted. But you -can -easily create an image with a real ST and one of those various -ROM-image programs for the ST. Or search the internet, but don't ask -the Hatari team -where to find one. -

-

Another solution is EmuTOS, which is an open-source -TOS clone. You can find EmuTOS at: http://emutos.sourceforge.net/. -It's -not the best solution for playing games or running other old software -due to compatibility issues, but it's free and officially compatible -with Hatari!

+of the emulated Atari. +

+

+Unfortunately it is not possible to ship an original ROM +image with the Hatari package since these images are still copyrighted. +But you can easily create an image with a real ST and one of those various +ROM-image programs for the ST (search for "TOSDUMP" with your +favourite internet search engine). If your old ST does not work anymore, you +can also try to search the internet directly for corresponding TOS ROM image, +but don't ask the Hatari team where to get one.

+

Another solution is EmuTOS, which is also shipped with the official +release versions of Hatari. EmuTOS is an open-source TOS clone. You can find +it at: +http://emutos.sourceforge.net/. +It is not the best solution for playing games or running other old software +due to compatibility issues (see emutos.txt for +more details), but it's free and compatible with Hatari.

If you do not specify a TOS image on the commandline nor can Hatari find a suitable TOS image in the default dir, you'll get the chance to select a TOS image file from the GUI.

-

Installation of the binary

+ +

Installation of the binary

+

Type make install as root to do a systemwide installation. In this case it is recommended to set the DATADIR variable in Makefile.cnf to a proper value. /usr/local/share/hatari @@ -220,7 +331,9 @@ anywhere.

When you finally have got a TOS image, try starting Hatari with the option --help to find out more about its command line parameters.

-

Running Hatari for the first time

+ +

Running Hatari for the first time

+

Now type hatari to run the emulator for the first time. If all goes well, you should now be presented with a window showing you the @@ -229,181 +342,1006 @@ little green desktop of the Atari ST. Pr to turn on the GUI to configure Hatari to suit your needs, press F11 to toggle windowed and fullscreen mode.

-

Command line options

-

Hatari ofcourse understands several command line options.

-

Type hatari --help to list them -all.

-

The command line options in detail are as follows (in brackets the -long version):

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +

Command line options

+ +

Usage:

+
+ hatari [options] [disk image name]
+
+ +

Hatari command line options are split into several categories:

+ + + + +

General options

+
OptionPurpose
-h (--help)prints command line options and terminates
-v (--version)prints version information and terminates
-m (--mono)starts the emulated Atari ST in monochrome -resolution
-f (--fullscreen)tries to use a fullscreen mode
--windowforces Hatari to use a windowed mode
-j (--joystick)activates joystick emulation via cursor keys
--nosounddisables sound (makes emulation faster)
--frameskipdrops every second frame (accelerates -emulation)
-D (--debug)activates the simple builtin debugger
--slowfdcslows down FDC emulation (needed to make some -games and demos work)
-d <dir> (--harddrive <dir>)emulates <dir> as a hard disk
--hdimage <imagefile>emulate hard disk with an image file
-
--cartridge <imagefile>
- 		sets imagefile as the cartridge -on the ROM port
-This currently does not work together with GEMDOS harddisc emulation!
-
--tos <imagefile>specify TOS ROM image to use
--memsize xset amount of emulated RAM
-x=0 for 512K, x=1,x=2 or x=4 for 1,2 or 4 MB
--cpulevel xspecify CPU (680x0) to use (TOS 2.06 only!!)
--compatibleuse a more compatible but slower 68000 CPU mode
--blitterenable blitter emulation
--vdiuse extended VDI resolution
--printerenable experimental printer support
--midi <filename>enable experimental MIDI output to the -mentioned file
--rs232 <filename>enable experimental RS232 communication via -the mentioned file
-c <filename> (--configfile)Use the mentioned file as configuration file -instead of ~/.hatari.cfg
+ + + +
+−h, −−help
+ + + + +
+Print command line options and terminate +
+ + + + +
+−v, −−version
+ + + + +
+Print version information and terminate +
+ + + + +
+−−confirm-quit <bool>
+ + + + +
+Whether Hatari confirms quitting +
+ + + + +
+−c, −−configfile +<filename>
+ + + + +
+use the given file as configuration file instead of +~/.hatari/hatari.cfg +
+ + + + +
+−−fast-forward <bool>
+ + + + +
+On fast machine helps skipping (fast forwarding) Hatari +output +
+ +

Display options

+ + + + +
+−m, −−mono
+ + + + +
+Start in monochrome mode instead of color +
+ + + + +
+−−monitor <x>
+ + + + +
+Select monitor type (x = mono/rgb/vga/tv) +
+ + + + +
+−f, −−fullscreen
+ + + + +
+Start the emulator in fullscreen mode +
+ + + + +
+−w, −−window
+ + + +
+Start the emulator in window mode +
-

Using the emulated system

+ + + + +
+−z, −−zoom <x>
+ + + + +
+Zoom low resolution (1=no, 2=yes) +
+ + + + +
+−−frameskips <x>
+ + + + +
+Skip <x> frames after each displayed frame to +accelerate emulation (0=disabled, >4 uses automatic +frameskip with given value as maximum) +
+ + + + +
+−−borders <bool>
+ + + + +
+Show screen borders (for overscan demos, ST(e) color mode +specific etc) +
+ + + + +
+−−statusbar <bool>
+ + + + +
+Show statusbar (with floppy leds etc etc) +
+ + + + +
+−−drive-led <bool>
+ + + + +
+Show overlay drive led when statusbar isn’t +shown +
+ + + + +
+−−spec512 <x>
+ + + + +
+Hatari uses this threshold to decide when to render a +screen with the slower but more accurate Spectrum512 screen +conversion functions (0 <= x <= 512, 0=disable) +
+ + + + +
+−−bpp <bool>
+ + + + +
+Force internal bitdepth (x = 8/15/16/32, 0=disable) +
+ +

VDI options

+ + + + +
+−−vdi <bool>
+ + + + +
+Whether to use VDI screen mode +
+ + + + +
+−−vdi−planes <x>
+ + + + +
+Use extended VDI resolution with bit depth <x> (x = +1, 2 or 4) +
+ + + + +
+−−vdi−width <w>
+ + + + +
+Use extended VDI resolution with width <w> (384 +<= w <= 1024) +
+ + + + +
+−−vdi−height <h>
+ + + + +
+Use extended VDI resolution with height <h> (200 +< h <= 768) +
+ +

Devices options

+ + + + +
+−j, −−joystick +<port>
+ + + + +
+Emulate joystick with cursor keys in given port (0-5) +
+ + + + +
+−−joy<port> +<type>
+ + + + +
+Set joystick type (none/keys/real) for given port +
+ + + + +
+−−printer <file>
+ + + + +
+Enable printer support and write data to <file> +
+ + + + +
+−−midi−in <filename>
+ + + + +
+Enable MIDI support and write MIDI data to <file> +
+ + + + +
+−−midi−out <filename>
+ + + + +
+Enable MIDI support and read MIDI data from <file> +
+ + + + +
+−−rs232−in <filename>
+ + + + +
+Enable serial port support and use <file> as the input device +
+ + + + +
+−−rs232−out <filename>
+ + + + +
+Enable serial port support and use <file> as the output device +
+ +

Disk options

+ + + + +
+−−disk-a <file>
+ + + + +
+Set disk image for floppy drive A +
+ + + + +
+−−disk-b <file>
+ + + + +
+Set disk image for floppy drive B +
+ + + + +
+−d, −−harddrive +<dir>
+ + + + +
+Emulate an ST harddrive (<dir> = root +directory) +
+ + + + +
+−−acsi <file>
+ + + + +
+Emulate an ACSI hard disk with an image <file> +
+ + + + +
+−−ide <file>
+ + + + +
+Emulate an IDE hard disk with an image <file> +
+ + + + +
+−−slowfdc <bool>
+ + + + +
+slow down FDC emulation (deprecated) +
+ +

Memory options

+ + + + +
+−s, −−memsize <x>
+ + + + +
+Set amount of emulated RAM, x = 1 to 14 MiB, or 0 for 512 +KiB +
+ + + + +
+−t, −−tos +<imagefile>
+ + + + +
+Specify TOS ROM image to use +
+ + + + +
+−−cartridge <imagefile>
+ + + + +
+Use ROM cartridge image <file> (only works if +GEMDOS HD emulation and extended VDI resolution are +disabled) +
+ + + + +
+−−memstate <file>
+ + + + +
+Load memory snap-shot <file> +
+ +

CPU options

+ + + + +
+−−cpulevel <x>
+ + + + +
+Specify CPU (680x0) to use (use x >= 1 with EmuTOS or +TOS >= 2.06 only!) +
+ + + + +
+−−cpuclock <x>
+ + + + +
+Set the CPU clock (8, 16 or 32 Mhz) +
+ + + + +
+−−compatible <bool>
+ + + + +
+Use a more compatible but slower 68000 CPU mode +
+ +

Misc system options

+ + + + +
+−−machine <x>
+ + + + +
+select machine type (x = st, ste, tt or falcon) +
+ + + + +
+−−blitter <bool>
+ + + + +
+Enable blitter emulation (ST only) +
+ + + + +
+−−dsp <x>
+ + + + +
+Falcon DSP emulation (x = none, dummy or emu, Falcon +only) +
+ + + + +
+−−sound <x>
+ + + + +
+Sound quality (off/low/med/hi, off=faster) +
+ + + + +
+−k, −−keymap +<file>
+ + + + +
+load keyboard mapping from <file> +
+ +

Debug options

+ + + + +
+−D, −−debug +<bool>
+ + + + +
+Enable Hatari debugger console interface +
+ + + + +
+−−bios-intercept
+ + + + +
+Enable Bios/XBios interception +
+ + + + +
+−−trace <trace1,...>
+ + + + +
+Activate debug traces, see --trace help for available tracing options +
+ + + + +
+−−control-socket <file>
+ + + + +
+Hatari reads options from given socket at run-time +
+ + + + +
+−−log-file <file>
+ + + + +
+Save log output to <file> (default=stderr) +
+ + + + +
+−−log-level <x>
+ + + + +
+Log output level (x=debug/todo/info/warn/error/fatal) +
+ + + + +
+−−alert-level <x>
+ + + + +
+Show dialog for log messages above given level +
+ + +

Type hatari --help to list all +the command line options supported by a given version of Hatari.

+ +

Using the emulated system

+

Once you've started Hatari succesfully, you can use the emulator as an allmost complete Atari ST computer system.

-

The GUI

-

General usage

+ +

The GUI

+

Press F12 to enter the GUI. Navigate it with the mouse. The GUI is rather self explanatory.

+ +

The Main Menu

+ +
+Hatari's GUI - the main menu +
+ +

From the main menu, you can reach the other setup dialogs by clicking on +the appropriate buttons.

+ +

You can load the current settings from a configuration file by clicking +on the Load config button and you can save the +current settings to a configuration file with the Save +config button.

+

Click Okay to go back to the emulated -ST. All checked options will be applied.

+ST. All changed options will be applied.

Check the Reset ST option if you want -the emulated ST to perform a soft reset. This should be equal to -pressing the reset button on your ST. +the emulated ST to perform a cold reset. This is equal to +switching the power off and on again on a real ST.

Click Quit to terminate Hatari and return to the host OS.

Click Cancel to abandon any changes -made.

-

The System Dialog

-

Check the CPU type to use here. For best Atari ST compatibility choose plain 68000 here.

-

Select whether you want to emulate an STFM or an STE. Note: STE emulation is very incomplete. In may not work at all.

-

Select the CPU clock you want to use. 8Mhz is ST standard and the most compatible, 16MHz is for Mega STE emulation.

-

Toggle Blitter and RTC emulation. Both have to be off for plain STFM emulation.

-

The Timer-D patch changes the Timer-D initialization from TOS. TOS -uses Timer-D as a baudrate generator for RS232. -The TOS default slows the emulation down so the patch gives you a -faster emulation. -

-

You can disable the Timer-D patch if games or demos require the -original TOS setting.

-

Select if you want to use slow FDC emulation. Slow is more compatible esp. with games and demos that use custom loaders.

+that you have made.

+ +

The System Dialog

+ +
+Hatari's GUI - the system dialog +
+ +

+ First you can select the CPU type here. Here are some important hints for + choosing the correct CPU type: +

+ + +

+ Beside the CPU type, you can also choose the machine type to emulate. + The ST was the very first 16/32-bit computer from Atari. Most older games + and demos require an ST. The STE was introduced some years later and had + some more advanced hardware features. There are not that many demos or + games that really require an STE but since most normal ST games/demos also + work with an STE, it's normally safe to always work in STE mode. +
+ TT and Falcon are more advanced, but they are not as compatible to the ST as + the STE was. Therefore many old games and demos do not work with these machine + types anymore. There were only very few programs that were made for the TT + exclusively, while there were some interesting games and demos specially made + for the Falcon. + Note: TT and Falcon emulation are very incomplete. They may not work + very well. +

+

+ For STE emulation a STE compatible TOS image, e.q. version 1.06, 1.62 or + 2.x, is strongly recommended. For TT emulation you need TOS 3.0x and for Falcon + emulation you need TOS 4.0x. EmuTOS can be used on all machine types. +

+

+ Select the CPU clock you want to use. 8Mhz is ST standard and the most + compatible. Use 16MHz for Mega STE and Falcon emulation. + The CPU in the TT was clocked with 32 MHz. +

+

With the "Slower but more compatible CPU" option, you can enable + the emulation of 68k address errors and the CPU prefetch buffer. This is needed + for best compatibility, but it slows down emulation a little bit so you can + disable it if you don't need it.

+

You can also enable/disable Blitter emulation here. The Blitter is a custom + chip that accelerates some graphical operations. This switch only toggles the + Blitter in plain ST mode. In STE mode, the Blitter is always enabled (since all + STEs have been sold with a Blitter chip).

+

If you enable the "Real time clock emulation" switch, a RTC will + be emulated based on the time of the host computer. Note that you need at least + TOS 1.02 for proper RTC emulation, TOS 1.00 does not support this.

+

The Timer-D patch changes the Timer-D initialization from TOS. TOS uses + the MFP timer D as a baudrate generator for RS232. However, the TOS default + value slows down the emulation. The patch gives you a better performance. + It is normally safe to enable the patch, but if you encounter a program that + does not work, you can try to disable the patch to see if it works then.

+

+ Select if you want to use slow FDC emulation. "Slow down FDC" is + normally not required, except for some few slideshows / intros which run too + fast without this option. +

NOTE: These parameters are very sensitive to the emulated ST and it is strongly recommended to reset the emulated ST after changing these options.

-

The Discs Dialog

+ +

The Disks Dialog

+ +
+Hatari's GUI - the disks dialog +
+

Use the upper dialog to choose which floppy disks should be emulated in the disk drives.

-

You can use most standard Atari ST disk image files. See the chapter -"Floppy disk images" + +

You can use most standard Atari ST disk image files. You may select +and browse also zipped disk images. See the chapter "Floppy disk images" for details.

+

Click on the button Browse next to the -A: and B: option to go to the fileselector. -You may select and browse zipped disk images as well.

+A: and B: option to go to the fileselector: +

+ +
+Hatari's GUI - the fileselector +
+

Click on Eject to eject a disk image from the emulated drive. The emulated ST will act as if had no floppy disk in its drive.

You can specify a default directory where Hatari will start to browse the filesystem.

-

Check the "Auto insert B" option if you want Hatari to be smart and -insert the second disk -of a two disk game automatically. This option will insert the second -disk in drive B and some -games may not be able to find the disks there. In that rare case you -will need to insert the -second disk manually when prompted.

-NOTE: This option does not always work properly. +Check the "Auto insert B" option if you want Hatari to be smart and +insert the second disk of a two disk game automatically. +Some games then use the second drive automatically. +In the case that a game is not able to find the disk in the second drive, +you have to insert the second disk in drive A: manually when prompted. +
+NOTE: This option only works properly if the file name of the +first disks ends with an 'a' before the extension and the second disk name +ends with a 'b'.

If you need to create a new blank disk image, click on Create disk image. @@ -432,7 +1370,13 @@ harddrive.

on the harddrive. This option is checked by default if you specify a harddrive image or a directory via the command line.

-

The Memory Dialog

+ +

The Memory Dialog

+ +
+Hatari's GUI - the memory dialog +
+

You can select the amount of RAM for the emulated ST here. Only amounts that were valid on a real unmodified STFM can be selected.

Note: This option is critical and you are strongly advised @@ -448,54 +1392,133 @@ restored.

different versions of Hatari. E.q. if you compile a newer Hatari, you cannot load your old memory snapshots back.

-

The ROM Dialog

+ +

The ROM Dialog

+ +
+Hatari's GUI - the ROM dialog +
+

Here you can select the TOS image to use. Click on Browse to select it via the fileselector.

+ class="button">Browse to select it via the fileselector. You can also select an optional cartridge image to use. Click on Browse to select one via the fileselector. Click on Eject to disconnect the custom cartridge image.

-

Keep in mind that any custom cartridge image will not work together with -GEMDOS harddisc emulation or the VDI extended resolution emulation + class="button">Eject to disconnect the custom cartridge image. +

+

+For ST mode, use TOS 1.00, 1.02, 1.04 or 2.06. +For STE mode, use TOS 1.06, 1.62, 2.05 or 2.06. +If you want to use the TT mode, you must specify a TOS 3.06 image here. +And in Falcon mode, you have to use either TOS 4.00, 4.02, 4.04 or 4.92. +However, you should always use TOS 4.04 for Falcon mode, it's the most common one. +Also note that TOS 4.92 can not be booted from a boot disk (like it's done on a +real Falcon), you have to specify it directly in the TOS ROM setup dialog here. +

+

+Keep in mind that any custom cartridge image will not work together with +GEMDOS hard disk emulation or the VDI extended resolution emulation since some additional driver code will be used in the cartridge memory -space for these emulations.
-

Note: These options are critical and you are strongly +space for these emulations. +

+

+Note: These options are critical and you are strongly advised to reset the emulated ST -when changing one of these option.

-

The Joystick Dialog

-

Here you can select which joystick you want to emulate via the -cursor keys.

+when changing one of these option. +

+ + +

The Joystick Dialog

+ +
+Hatari's GUI - the joystick dialog +
+ +

In this dialog, you can configure the emulated joysticks. +With the upper two arrows, you can choose the joystick which you want to +configure.

Joystick 1 is the normal ST joystick port and 99.9% of all ST games -use this port, Joystick 0 -emulates a joystick plugged into the ST mouse port allowing you to play -2 player games.

-

If no joystick is checked here, joystick emulation is done via a -connected PC joystick.

-

See the chapter "Emulated Joystick" for details.

- -

The Screen Dialog

-

Here you control the video output of the emulated ST.

-

Check "Fullscreen" to run Hatari fullscreen, default is windowed.

-

Check "Interleaved mode" if you wish to have that old TV feeling in -Hatari. Every second line will be black. -This will only work in ST-MEDIUM or ST-LOW in scaled up resolutions.

-

Check "Frame Skip" to speed Hatari up if emulation is too slow. This -will only draw every second ST frame -instead of the default of drawing every ST frame. Uncheck if you have a -fast PC.

-

Check "Use Borders" if you wish to have the borders around the ST -screen.

-

"Force 8Bpp" will force SDL to use an 8bit video mode. You don't -need this for modern video cards.

-

You can select which sort of monitor to use. Check "Color" for games -and demos. If you check "Mono" here, -Hatari will emulate the good old SM124 and will not allow you to switch -to color modes from the running ST. -This toggle acts like a monitor switch with a color and monochrome -monitor connected.

-

"Zoom ST-Low res." will control if Hatari renders ST-LOW to a -320x200 or 640x400 PC display (with borders turned off) or 384x267 or -768x534. -Basically select this to toggle between a small or a large window.

+use this port. +Joystick 0 emulates a joystick plugged into the ST mouse port +and is often used in games for two players.

+

With STE joypad A and B, you can enable the emulation of Jaguar joypads +which are plugged in the enhanced joystick ports of the Atari STE. +Only very few STE games support these joypads, so you often won't need this.

+

Finally, Hatari also emulates joysticks which were plugged on the parallel +port with a special adapter on a real ST. These were used in some few +multi-player games like "Gauntlet 2".

+

For each ST joystick, choose whether you want to disable it, +use the keyboard for emulation or use a real PC joystick.

+

For keyboard emulation, you can select the keys by pressing the +Define keys button. You will be prompted to press +the keys for up, down, left, right and fire.

+

If you want to use a real PC joystick for the emulation, you should connect +it to your PC before you start Hatari. Then you can choose the joystick with +the two lower arrows.

+

Check the "Enable autofire" option if you are too lazy to pound +on the fire button in shoot'em-up games. However, this option only works with +certain games. In some other games, it gets worse if you enable this option.

+

See also the chapter "Emulated Joystick" for details.

+ + +

The Screen Dialog

+ +
+Hatari's GUI - the screen dialog +
+ +

+ Here you control the video output of the emulated Atari. +

+

+ Check "Fullscreen" to run Hatari fullscreen, default is windowed. +

+

+ "Use Borders" toggles the displaying of the borders around the ST + screen. Some few demos/games use the borders for displaying additional + graphics. However, when you enable this option, it increases CPU computing + time, so you should not enable it if you have a slow computer. + Please note that this option also only affects the ST and STE mode, TT and + Falcon modes are always displayed without borders. +

+

+ "Zoom ST-Low res." controls whether Hatari doubles the low + resolutions. For example Hatari then zooms the ST low resolution 320x200 to + 640x400 and it doubles 384x267 (ST low with borders) to 768x534. + Note that zooming also takes a lot of CPU computing time and should not be + enabled on slow computers. +

+

+ "Statusbar" toggles the statusbar at the bottom of the screen. + The statusbar shows the floppy drive LEDs, the current frameskip value, + the machine type including TOS version and memory size, and whether + recording is currently active. +

+

+ The "Frame Skip" option can be set to speed up the emulator + if it is running too slow on your system. Disable frame-skip if you have + a fast computer. When selecting 1, 2 or 4, drawing of corresponding number + of frames will be skipped after each frame actually shown by Hatari. + Select "Auto" to let the emulator to decide whether, and + how many frames will be skipped.
+ Note: The frameskip option also affects the frame rate of the + screen animation recording! +

+

+ You can select which sort of monitor to use. This option depends on the + machine type which you have selected in the "System options" + dialog. In ST and STE mode, you can choose between monochrome mode (select + "Mono") and color mode (select one of the other monitor types). + Note that when you select "TV" and use zoomed low resolution or + switch to ST medium resolution, you will get a TV-like screen rendering + which is a little bit faster but darker compared to the normal "RGB" + monitor mode. Switching between mono and a color monitor acts like a monitor + switch on a real ST - so beware, this will reboot your emulated system!
+ In TT mode, you can only choose between TT-high resolution ("Mono") + and normal modes (select one of the other monitor types). + Finally the Falcon mode supports all four types of monitors. Note that most + Falcon demos/games require a RGB or TV mode and do not work with VGA. +

+

Extended GEM resolutions will emulate some sort of extended graphics card in the emulated ST giving you larger resolutions and a higher colordepth in GEM. Select a resolution and color depth. Check to @@ -503,44 +1526,79 @@ activate. It will disable all other vide Uncheck to get back to a normal ST behaviour.
Note: Using an extended resolution will only work with GEM conformant applications. 99% of all games and demos will not run if you -activate any extended resolution here.
+activate any extended resolution here. +

Click Capture Screen to create a -screenshot in .BMP format to the current working directory or click Record Animation to record a sequence of single +screenshot in PNG (or BMP) format to the current working directory or click +Record Animation to record a sequence of single screenshots. You can opt to only record new movie frames when the screen content really changed.

-

The Keyboard Dialog

-

Here you can select the keyboard mapping to use.

-

Two different mappings called "Symbolic" and "Scancode" are -predefined.

-

You can also load a custom keymapping file here if you wish. Please -note that selecting to use a custom keyboard mapping will -use the "symbolic" mapping for all keys not defined by your map file. -See the supplied example mapfile on how to build your -own keyboard mapping.

-

The Sound Dialog

+ + +

The Keyboard Dialog

+ +
+Hatari's GUI - the keyboard dialog +
+ +

Here you can select the keyboard mapping to use. Two different mappings + called "Symbolic" and "Scancode" are predefined.

+

"Symbolic" tries to map the symbolic values of your PC keys + to the ST keys. It should be working pretty good on all systems as long + as your keyboard layout looks close to the standard english keyboard + layout. However, you might experience some problems with special keys like + brackets etc.

+

"Scancode" uses the scancode values of your PC keys for keyboard + mapping. This only works on certain architectures like Linux where the + scancodes are similar to the ST scancodes (e.g. it does not work on Mac OS X). + If it works on your system, this often gives better results than the symbolic + mapping. Note that you also need a TOS version with the right language + (e.g. use a French TOS if you are using a French keyboard).

+

You can also load a custom keyboard mapping file here if you wish. Please + note that the custom keyboard mapping will use the "symbolic" + mapping for all keys that are not defined by your map file. Have a look + at the supplied example mapfile (keymap-sample.txt) to see how to create + your own keyboard mapping.

+

+ When the emulator runs in fast forward mode, and you want to type text, + it can be annoying that the emulated system detects multiple key events + due to the key repetition of the emulated system. To avoid this you can + disable the key repetition in fast forward mode here. +

+ + +

The Sound Dialog

+ +
+Hatari's GUI - the sound dialog +
+

Here you can control the sound subsystem.

Check if you want emulated sound at all. Emulation is faster if sound emulation is turned off.

3 frequencies from low to high quality are available. Experiment a little bit to find out which fits best for your setup. Medium quality will work ok in most cases.

-

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 -you will need to return to the GUI to switch sound recording off again.

-

The Devices Dialog

+

You can select to record a piece of sound here. The file name +extension you use (.WAV or .YM), determines in which format the sound +is recorded in. The record button is a toggle so you will need to +return to the GUI to switch sound recording off again +(or to use the keyboard shortcut for that).

+ + +

The Devices Dialog

+ +
+Hatari's GUI - the device dialog +
+

Check here if you want to enable experimental printer support. See the chapter "Emulated printer" for details.

+

As Hatari currently only supports printing to file, click on Select to select the file to print to. You can enter a new filename as well.

-

NOTE: As the printer emulation is not perfect yet, -activated printer support may interfere with the emulated sound. -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 -disable printing while using games and demos. -

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 @@ -558,9 +1616,13 @@ MIDI device file for output.

NOTE: RS232 and MIDI emulation are very experimental, too. Don't enable them unless you really need them!

-

Keyboard shortcuts

+ + +

Keyboard shortcuts

+

While the emulator is running, you can activate or toggle various -features via the following keyboard shortcuts.

+features via Hatari keyboard shortcuts. Below are listed the default +shortcut key bindings:

@@ -573,20 +1635,21 @@ features via the following keyboard shor - + - + - + - + @@ -598,6 +1661,10 @@ window switch) + + + + @@ -614,25 +1681,36 @@ switch) - - + + - - + + + + + + + + + + - +
ALTGR+ggrabs a screenshotgrab a screenshot
ALTGR+iboss key: leave full screen mode and iconify -windowboss key: leave full screen mode, pause Hatari +and iconify its window
ALTGR+jactivates joystick emulation via cursor keystoggle joystick emulation via cursor keys +on/off between ports 0 and 1
ALTGR+m(un-)locks the mouse into the window(un-)lock the mouse into the window
ALTGR+r
ALTGR+dopen dialog to select/change disk A
ALTGR+s enable/disable sound
enable/disable sound recording
F11toggles fullscreen and windowed modeALTGR+ksave memory snapshot
F12 -

activate the GUI

-

You may need to hold SHIFT down -while in windowed mode.

- 		ALTGR+lload memory snapshot
ALTGR+f or F11toggle between fullscreen and windowed mode
ALTGR+o or F12activate the options GUI
PAUSEwill go to the debugger if it was activated at -compile timepause emulation or go to the debugger + if Hatari was started with the -D option
-

Emulated Atari ST keyboard

+ +

You can change the key bindings from the Hatari configuration file. +The required key values you can see from the SDL_keysym.h include file +(usually in /usr/include/SDL/).

+ + +

Emulated Atari ST keyboard

+

All other keys on the keyboard act as the normal Atari ST keys so pressing SPACE on your PC will result in an emulated press of the SPACE key on the ST. The following keys have special meanings:

@@ -668,16 +1746,15 @@ key on the ST. The following keys have s -

ALTGR will act as ALTERNATE as well as -long as you do not press it -together with a Hatari hotkey combination.

-

The right CTRL key is used as the fire -button of the emulated -joystick when you turn on joystick emulation via keyboard.

-

The cursor keys will act as the cursor keys on the Atari ST as long -as joystick emulation -via keyboard has been turned off.

-

Emulated mouse

+ +

If joystick emulation via keyboard is enabled, by default cursor keys +are used for the directions and right CTRL key +as the fire button. Otherwise they act as corresponding keys of the emulated +Atari ST.

+ + +

Emulated mouse

+

For obvious reasons your PC mouse will act as the emulated Atari ST mouse. In fullscreen mode it will act as expected, directly controlling the ST mouse pointer.

@@ -687,7 +1764,10 @@ the Hatari window. Do this by pressing t hotkey combination. Press it again to go back to normal mouse behaviour which allows you to work in other X11 windows while Hatari is up and running.

-

Emulated joystick

+

Mouse scrollwheel will act as cursor up and down keys.

+ +

Emulated joystick

+

The Atari ST joysticks are emulated ofcourse allowing you to play your favourite games with Hatari.

The default mode is to use a connected PC joystick. You can use any @@ -700,7 +1780,7 @@ firebutton will act as the normal firebu second firebutton will emulate a keypress of the SPACE key on the ST as many ST -games utilitze the SPACE bar for secondary game functions. (Xenon for +games utilize the SPACE bar for secondary game functions. (Xenon for example)

If you do not have a PC joystick or joypad, then you do not need to desperate. You can emulate one of the two Atari ST joysticks via the @@ -708,24 +1788,28 @@ cursor keys. Just activate it in the GUI as the joystick directions, the right CTRL key will act as the firebutton. You can still use the cursor keys as the ST's cursorkeys in this mode as long as you press SHIFT -along with the cursorkeys.

-

Emulated video

-

Hatari by default only handles ST modes, ST-LOW, ST-MED and ST-HIGH.

-

Overscan effects and socalled "Border Removal" are possible too.

-

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. -Especially socalled "Sync Scrolling", a special technique to emulate -the low byte of the video address, currently does not work properly in -Hatari. +along with the cursorkeys. You can also configure these keys from the +joystick options.

+ +

Emulated video

+ +

Hatari emulates all screen modes of the original machine.

+

+ST/STE shifter overscan effects are emulated, but 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 effects. As a result, some demos using these +techniques might not be displayed correctly in Hatari, known ones are +listed in the compatibility.html file.

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.

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.

-

Emulated printer

+ +

Emulated printer

+

Due to the fact that printer handling is very different between Unix style machines and the Atari ST, emulation of the printer is achieved by writing all printer output to a file.

@@ -743,7 +1827,9 @@ you may set up a GDOS printer with a Pos Atari and set your printer device file as Hatari's printer output.
NOTE: This has not been tested yet and the Hatari team cannot guarantee that it will work.

-

Emulated RS232

+ +

Emulated RS232

+

Serial communications in Hatari is designed to directly use a serial port on your PC.

Communications parameters are set automatically upon the settings of @@ -751,7 +1837,9 @@ the emulated ST. This means all you do i the communication parameters like baudrate from your ST communications software. Hatari will do the rest and handle the serial input and output for you.

-

Floppy disk images

+ +

Floppy disk images

+

Hatari does not use floppy disks directly but disk images due to differences between the floppy disk controllers of the ST and the PC. Three types of disk images are currently supported: The raw "ST" type, @@ -819,15 +1907,39 @@ net as long as the archive contains a di so your highscores and savegames are lost if you load the game from such a zipped disk image.

-

Hard disk support

-

Hatari supports two ways of emulating a ST hard drive: The low-level -ACSI hard disk emulation and a GEMDOS based drive emulation.

-

To use the ACSI hard disk emulation, you need a hard disk image file + +

Hard disk support

+ +

+Hatari supports two ways of emulating a ST hard drive: The low-level +ACSI hard disk emulation and a GEMDOS based drive emulation. Please +note that changing the HD-image or the GEMDOS HD-folder will reset +the emulated Atari since it is not possible to switch the hard disk +while the emulator is running. +

+ +

ACSI hard disk emulation

+

+To use the ACSI hard disk emulation, you need a hard disk image file with a pre-installed HD driver in it. So either try to image your old -ST -hard disk or grab one from the internet. There is a HD image on the -Hatari web page for download. Perhaps we'll also provide a tool for -creating HD images one day.

+ST hard disk or grab one from the internet (e.g. from the Hatari website). +Please note that AHDI 5.0 is currently the only hard disk driver +that is officially supported. Other hard disk drivers might not work. +

+

+To create a new ACSI hard disk image, you can start with an empty image that +you have for example created with the following command: +dd if=/dev/zero of=hd.img bs=512 count=xxx. +Then copy the complete AHDI 5.0 package to a floppy disk image, and enable +this floppy disk image and the fresh hard disk image in the emulator. +Start HDX.PRG from the floppy disk and format and partition the hard disk +with this tool. When you're finished, you have to restart the emulated system, +run AHDI.PRG from the floppy disk and HINSTALL.PRG afterwards. +With HINSTALL.PRG you can install the hard disk driver to the fresh HD image, +so you can directly boot from the hard disk image in the future. +

+ +

GEMDOS based hard disk emulation

With the GEMDOS based drive emulation, you can easily "mount" a folder from the host file system to a drive of the emulated Atari. To use the GEMDOS based drive emulation, you should use a folder on your @@ -839,23 +1951,25 @@ don't want to rename all files to get ca possible to store that folder on a FAT filesystem since those filesystems are case-insensitive.

GEMDOS drive emulation is an easy way to share files between the -host system and the emulated Atari, but it is known to be incomplete -and +host system and the emulated Atari, but it is known to be incomplete and a little bit unstable, especially if you use it together with the ACSI hard disk emulation. So if your programs complain that they could not find/read/write files on the GEMDOS HD drive, you should try to copy them to a floppy disk image or a real hard disk image!

-

Due to the way the GEMDOS drive emulation is implemented at the -moment, it is not possible to use a cartridge image together with -GEMDOS drive emulation.

-

Note that changing the HD-image or the GEMDOS HD-folder will reset -the emulated Atari since it is not possible to switch the hard disk -while the emulator is running.

-

May the fun without the price to be with you ;-) !

+

+There are also some known limitations which are due to the way the GEMDOS +drive emulation is implemented: First, it is not possible to use a cartridge +image together with GEMDOS drive emulation at the same time. +Second, the GEMDOS HD emulation does not work very well with TOS +1.00 and 1.02. So you should use at least TOS 1.04 if you want +to use the GEMDOS HD emulation. +

+ + +

Appendix

-

Appendix

+

Copying

-

Copying

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -876,7 +1990,8 @@ Inc., 51 Franklin Street, Fifth Floor, B Foundation | The GNU General Public License

-

Introduction to Emulation

+

Introduction to Emulation

+

Emulation via software is an art and Hatari is an example of this.

Emulation is to make a computer behave like a (probably) completely different machine on the lowest possible niveau. @@ -911,274 +2026,6 @@ emulation of the various custom chips an parts of the emulated system is much trickier.

-

Software compatibility list

-

This is a little compilation of what Atari software does work in -Hatari. It is by no means finished.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
tested games
GameWorkingSoundComment
Eliminatoryesperfect 
Speedballyesperfect 
Xenonyesmusic ok - fx dodgybullets and explosions sound weired
Bubble Bobbleyes  
F15 Strike Eagle 2yesokkeyboard emulation seems to be dodgy
Rick Dangerousyesperfect 
Slayeryesokraster fx at highscore entry dodgy
Lethal Xcessno crashes while loading, sync scrolling will not work properly
Star Gooseyesmusic ok - bullet sound dodgy 
Xenon 2 - Megablastyesnearly perfect (including sampled intro) 
Metal Mutantyesseems oksome color effects in the lower screen seem buggy
Defenders Of The Earthyes  
Nebulusyesmusic ok; snowball, balls and trapdoors dodgyotherwise working to a playable extend
Leanderyes  
Navy Sealsyes  
Armalyteyes  
Wings Of Deathyes  
Tokiyes  
Alien Worldyes Only works with "--slowfdc"
Skweekyes Does not work with cartridge / HD emulation
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
tested demos
DemoWorkingSoundComment
Fantasia (by Dune)yes Only works with "--slowfdc"
Oddstuff (by Dune/SectorOne)yes Only works with "--slowfdc". - Enable "frameskip" to avoid the flicker.
If pigs could fly (by Syndicate)yes Only works with "--slowfdc"
LongScreen (by X-Troll)yes Only works with "--slowfdc"
Overdose (by Aggression)yes Does not work with cartridge / HD emulation
- -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
tested applications
ApplicationWorkingComment
DevPac 2.2yesMonST crashy
Turbo AssembleryesDue to a bug you need to have a proper disk image inserted into drive A. Works otherwise!
GFABASIC 3.6TTyesMENU.PRG does not like harddisks. Use diskimages for -compiling.
ST Basicyes 
Neochromeyesrasters sometimes unstable
CrackartyesHarddisk access does not work with GEMDOS emulation - fine -with disk images
Tempusyes 
Sagrotanyes 
SidSound Designeryes 
MusicMon 2yes 
Protrackeryes 
Teradeskyes 
Qedyes 
Everestyes 
Speed Of Lightyes 
-
@@ -1189,8 +2036,7 @@ with disk images src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" border="0" height="31" width="88"> -
Matthias Arndt -February 28 2005
+ November 23rd 2008