--- hatari/doc/manual.html 2019/04/01 07:12:52 1.1.1.5 +++ hatari/doc/manual.html 2019/04/01 07:13:21 1.1.1.6 @@ -48,7 +48,7 @@

Hatari User's Manual

-Version 0.80 +Version 0.90

Project initiator and main developer of Hatari: Thomas Huth @@ -102,6 +102,10 @@ Hatari on the WWW: Floppy disk images

  • Hard disk support +
  • Appendix @@ -151,7 +156,7 @@ and demos. Of course you can run normal
  • ST Shifter with ST-High, ST-Medium and ST-Low resolutions, overscan effects for lower border and partially in the upper, left and right border too
    • -
  • 512 colour ST palette
    • +
  • 512 color ST palette
  • Blitter chip emulation (not very accurate)
  • PSG YM2149 emulation (soundchip) including STFM samples
  • Printer emulation on GEMDOS and Hardware level (print to file)
    • @@ -175,16 +180,17 @@ and *.DIM)
  • recording of sound as .WAV and .YM files
  • screenshots in .BMP format
  • animation capturing
    • -
  • interlaced rendering of ST-Low and ST-Medium resolutions
    • -
  • scaling of ST-Low and ST-Medium to 800x600 resolution
    • +
  • scaling of ST-low resolution by factor two
    • +
  • interleaved lines rendering of ST-medium and (scaled) ST-low resolutions

    • Experimental STE hardware emulation:

    -STE emulation is still considered as instable, but if you dare to use it, +STE emulation is still a little bit experimental, but basically there is support for most of the enhanced STE features: @@ -224,7 +230,8 @@ the following systems: FreeBSD 5.1
  • OpenBSD 3.5
  • Solaris 8 on a SUN UltraSparc 1
    • -
  • Zaurus SL-C760 PDA
    • +
  • Zaurus SL-C760 PDA
    • +
  • Nokia N770 Linux Web Tablet

    • Compiling and running

    @@ -266,15 +273,18 @@ 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 +

    +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 original ROM +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 @@ -316,7 +326,7 @@ to toggle windowed and fullscreen mode.

    Command line options

    -

    Hatari ofcourse understands several command line options.

    +

    Hatari of course understands several command line options.

    Type hatari --help to list them all.

    The command line options in detail are as follows (in brackets the @@ -349,8 +359,9 @@ resolution forces Hatari to use a windowed mode - -j (--joystick) - activates joystick emulation via cursor keys + -j <port> (--joystick <port>) + activates joystick emulation via cursor keys +for given joystick "port" (0-5, see joystick dialog) --nosound @@ -380,10 +391,9 @@ games and demos work) - --cartridge <imagefile>
    + --cartridge <imagefile>
    - sets imagefile as the cartridge -on the ROM port
    + sets imagefile as the cartridge on the ROM port
    This currently does not work together with GEMDOS hard disk emulation!
    @@ -392,9 +402,9 @@ This currently does not work together wi specify TOS ROM image to use - --memsize x - set amount of emulated RAM
    -x=0 for 512K, x=1,x=2 or x=4 for 1,2 or 4 MB + -s x (--memsize x) + set amount of emulated RAM upto 14MB
    +x=0 for 512K, x=1,x=2 or x=4 for 1, 2 or 4 MB --cpulevel x @@ -429,12 +439,17 @@ the mentioned file -c <filename> (--configfile) - Use the mentioned file as configuration file + Use the given file as configuration file instead of ~/.hatari.cfg + -k <filename> (--keymap) + Sets keyboard mapping to "From file" and
    +uses the given file as keyboard mapping file + + --machine <x> - Select machine type (x = st or ste) + Select machine type (x = st, ste or tt) @@ -485,7 +500,8 @@ that you have made.

    plain 68000.

    Choose whether you want to emulate a normal ST or an STE. Note: STE emulation is very incomplete. It 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 STE emulation a STE compatible TOS image, e.q. version 1.06, 1.62 or +2.x, is strongly recommended. EmuTOS can also be used.

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

    With the "Slower but more compatible CPU" option, you can enable @@ -539,15 +555,16 @@ from the emulated drive. The emulated ST 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. @@ -676,8 +693,8 @@ 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. +320x200 or 640x400 PC display (with borders turned off) or 384x276 or +768x552. Basically select this to toggle between a small or a large window.

    Extended GEM resolutions will emulate some sort of extended graphics card in the emulated ST giving you larger resolutions and a higher @@ -714,9 +731,10 @@ screen content really changed. 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 to see how to create your own keyboard mapping.

    + 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.

    The Sound Dialog

    @@ -773,7 +791,8 @@ Don't enable them unless you really need

    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:

    @@ -795,7 +814,8 @@ window - + @@ -842,6 +862,11 @@ switch)
    ALTGR+jactivates joystick emulation via cursor keystoggles joystick emulation via cursor keys +between port 0, port 1 and being off from those ports
    ALTGR+m
    +

    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 @@ -899,6 +924,7 @@ 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.

    +

    Mouse scrollwheel will act as cursor up and down keys.

    Emulated joystick

    @@ -1046,12 +1072,30 @@ a zipped disk image.

    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 + +

    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 the only hard disk driver that +is currently working and supported. Other hard disk drivers likely will 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 @@ -1075,7 +1119,11 @@ 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 ;-) !

    + +

    +That's all for the moment. +May the fun without the price to be with you ;-) ! +

    Appendix

    @@ -1290,13 +1338,13 @@ tested with the current STE hardware emu Comment - Fantasia (by Dune) + Fantasia (by Dune/Sector1) yes   Only works with "--slowfdc" - Oddstuff (by Dune/SectorOne) + Oddstuff (by Dune/Sector1) yes   Only works with "--slowfdc". @@ -1345,12 +1393,24 @@ tested with the current STE hardware emu   + Hallucinations (by Reservoir Gods) + yes +   +   + + Sweety (by DHS) yes   Does not work with HD emulation + Popstars (chiptunes by YmRockerz) + yes +   + Sound works only with Hatari version >0.80 + + B.I.G-demo (musicdemo by Exceptions) partially   @@ -1379,6 +1439,9 @@ tested with the current STE hardware emu

    ST applications

    +

    Note that some applications can even crash at startup if their +configuration or data files are not writable. + @@ -1411,6 +1474,11 @@ compiling. + + + + + @@ -1419,6 +1487,17 @@ compiling. + + + + + + + + + + @@ -1429,10 +1508,9 @@ compiling. - + - + @@ -1443,14 +1521,14 @@ with disk images - + - + - + @@ -1458,21 +1536,31 @@ with disk images - + - + - + - + + + + + + + + + + + @@ -1504,6 +1592,22 @@ with disk images + + + + + + + + + + + + + + + @@ -1513,6 +1617,11 @@ with disk images + + + + + @@ -1531,7 +1640,30 @@ with disk images - + + + + + + + + + + + + + + + + + + + + + + + + @@ -1539,10 +1671,42 @@ with disk images + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    tested applications
     
    Gulam shellyes 
    Orcs Resource editor yes   Graphics
    CrackartyesHarddisk access does not work with GEMDOS emulation - fine +with disk images
    ImConyes 
    Mgif yes   rasters sometimes unstable
    CrackartOCR yesHarddisk access does not work with GEMDOS emulation - fine -with disk imagesDidn't try scanning
    Speed Of Light Sound
    SidSound DesignerMusicMon 2 yes  
    MusicMon 2Noise Tracker yes Sound is very noisy, and didn't work with v0.80 (and earlier?)
    Protracker  
    Accompanist
    (Henry Cosh Sequencer)    		Quartet yesProgram works, but couldn't get Hatari midi output to work 
    Sequencer OneSidSound Designer yesProgram and sample sounds work, but couldn't get Hatari midi - output to work 
    Accompanist
    (Henry Cosh Sequencer)    		yesProgram works, but couldn't get Hatari midi output to work
    Cubase Lite yes Program works, but couldn't get Hatari midi output to work
    Sequencer OneyesProgram and sample sounds work, but couldn't get Hatari midi + output to work
    Text Editors
    yes  
    Sheet spreadsheetyes 
    Calamus SL (demo)yesNice with Hatari 32Mhz 68020+FPU STE emulation at 1024x768x1 + resolution...
    Outline Art 3 (demo)yes 
    Communications
     
    Connectyes 
    Kivi QWK Reader yes    
    OthersScience
    Euleryes 
    Minidraftyes 
    Molsysyes 
    Utilities
    Revenge Document Displayeryes 
    ST-Guide  
    ST-Zipyes 
    STCatyes 
    Lharc Shellyes 
    TwoInOneyes 
    Sagrotan viruskiller yes  
    Others
    ZX Spectrum emulatoryesInstaller needs to be run from a floppy image and (HD) + install directory needs to be already present. After installing, + use unzip to get zero byte sized files from the original + self-extracting zip files. Both 68000 and 68030 versions work + both in color and mono.
    @@ -1597,6 +1761,18 @@ are just STE enhanced. These are marked THE ultimate scene game + Chronicles of Omega* + yes +   +   + + + Chaos Engine (demo) + yes +   +   + + ChuChu Rocket yes   @@ -1633,10 +1809,10 @@ are just STE enhanced. These are marked   - Obsession + Obsession (demo) yes   - opens top & bottom border, but part from the right is not visible on screen + opens top, right and bottom borders Operation Garfield @@ -1651,6 +1827,12 @@ are just STE enhanced. These are marked   + Pooz* + yes +   + Uses STE DMA, blitter and palette + + Power Up* yes   @@ -1667,16 +1849,16 @@ are just STE enhanced. These are marked Skulls yes   - part from the right border is not visible on screen + Opens right border Starball* yes   -   + Uses DMA sound - Stardust + Stardust (demo) yes     @@ -1688,7 +1870,7 @@ are just STE enhanced. These are marked   - Substation + Substation (demo) yes     @@ -1700,7 +1882,7 @@ are just STE enhanced. These are marked   - Utopos + Utopos (demo) partially   screen corrupted @@ -1715,10 +1897,10 @@ are just STE enhanced. These are marked Wolfenstein 3D* yes   - STE DMA sound does work + v0.8 needs to be run from a disk image, STE DMA sound - Zool + Zool (demo) partially   screen corrupted, scrolling fails @@ -1750,6 +1932,18 @@ are just STE enhanced. These are marked bottom border broken + T. Barker: Fantasia + yes +   + For any other than TOS 1.6, you need to use fantfix.prg first + + + T. Barker: TT-Wars STE + yes +   +   + + DHS: Tyranny & Massacre yes   @@ -1786,6 +1980,12 @@ are just STE enhanced. These are marked   + N.L.C: Techno Drugs + yes +   +   + + Omega: Grotesque yes   @@ -1793,15 +1993,23 @@ are just STE enhanced. These are marked Paradox: X-mas 1994 demo - yes + Partially   + Fullscreen scroller doesn't work + + + Paradox: Pacemaker + yes   + The end screen doesn't look quite correct and when returning + to desktop, the screen is corrupted. Otherwise this is perfect. + With EmuTOS, stops in the middle. Reservoir Gods: Mind Rewind yes   - opens all borders + Opens all borders Reservoir Gods: Grimey @@ -1819,7 +2027,14 @@ are just STE enhanced. These are marked MJJ-Prod: Tribute To Rainbow Tos partially   - screen corrupted, Blittermania does not work but the code does not crash nor lockup + screen corrupted, Blittermania does not work but the code + does not crash nor lockup + + + MJJ-Prod: Badger Badger + yes +   +   Armada: RGBRuler demo @@ -1839,12 +2054,18 @@ are just STE enhanced. These are marked   doesn't look right + + GGN: The Sierpinski overdose 4K + no +   + Hatari doesn't have required blitter support +

    STE applications

    -

    Finally some tested STE applications

    +

    Finally some STE only or STE enhanced applications

    @@ -1854,10 +2075,16 @@ are just STE enhanced. These are marked + + + + + + - + @@ -1870,6 +2097,38 @@ are just STE enhanced. These are marked
    +

    68030 software

    + +

    Here're listed some Atari programs that don't work on STs/STEs because +they require 68030 CPU, but work in Hatari TT-emulation when using +ST-resolution

    +
    tested STE applications
    Comment
    MaxYMiser DMAyes  
    Octalyzer yes  part from the right is not visible on screenopens right and bottom borders, doesn't work with EmuTOS
    Protracker STE
    + + + + + + + + + + + + + + + + + + + + +
    68030 software
    TitleWorkingSoundComment
    TT/Falcon bytetros (ray//.tSCc)yes glasstro, bragg256, 256mbrot, yabt
    Movie playeryes 68030 version
    + +

    (Naturally these work also on TTs and Falcons)

    + +
    +
    @@ -1879,7 +2138,7 @@ are just STE enhanced. These are marked border="0" height="31" width="88">
    Matthias Arndt -August 31 2005
    +November 30 2005