home *** CD-ROM | disk | FTP | other *** search
/ Supremacy 2 / Supremacy-2.iso / Tools / PC / Pacifist / PCST044.ZIP / PCST044 / DOCS / PACIFIST.DOC < prev    next >
Text File  |  1997-05-29  |  43KB  |  1,047 lines

  1.  
  2.                               PaCifiST v0.44
  3.                               ~~~~~~~~~~~~~~
  4.  
  5.                         written by Frederic Gidouin
  6.                          (frederic.gidouin@hol.fr)
  7.  
  8.                   YM-emulation & SB driver by Arnaud Carre
  9.                             (leonard@mygale.org)
  10.  
  11.                               (c) 1996-1997
  12.  
  13. Last Update: May 29, 1997
  14. -------------------------------------------------------------------------------
  15.  
  16.                             TABLE OF CONTENTS
  17.  
  18.                 0. Changes in this Document
  19.  
  20.                 1. Introduction
  21.                     1.1 What is PaCifiST?
  22.                     1.2 Why should you use it?
  23.                     1.3 Features
  24.                     1.4 Future Plans
  25.                     1.5 How much does it cost?
  26.  
  27.                 2. Installation
  28.                     2.1 Hardware Requirements
  29.                     2.2 PaCifiST Concepts
  30.                          2.2.1 A word about the Monitor
  31.                          2.2.2 Video Emulation
  32.                          2.2.3 Speed Modes
  33.                          2.2.4 Drives Emulation
  34.                          2.2.5 Sound
  35.                     2.3 Before running it...
  36.  
  37.                 3. Configuration
  38.                     3.1 INI directives reference
  39.                          3.1.1 System Section
  40.                          3.1.2 Screen Section
  41.                          3.1.3 Debug Section
  42.                          3.1.4 PACIFIST.INI example
  43.                     3.2 Command line parameters
  44.                     3.3 Configuration under Monitor
  45.                     3.4 The Disk Selection Screen
  46.  
  47.                 4. Miscellaneous
  48.                     4.1 Hints
  49.                     4.2 VBE 2.0
  50.                     4.3 Disk images
  51.                     4.4 Keyboard mapping
  52.                     4.5 Screen Snaphots
  53.  
  54.                 5. The Monitor
  55.                     5.1 Monitor Screen
  56.                     5.2 Monitor Commands
  57.  
  58.                 6. Resources & Acknowledgments
  59.                     6.1 Related programs
  60.                          6.1.1 Other Emulators
  61.                          6.1.2 Utilities
  62.                     6.2 Resources
  63.                     6.3 Greetings
  64.                     6.4 Contacting the author
  65.  
  66.  
  67. -------------------------------------------------------------------------------
  68.  
  69. 0. Changes in this Document
  70. ===========================
  71.  
  72. Since v0.43, changes in this document mainly cover the new "MIXED" video
  73. mode & joystick topics (calibration, patch command).
  74.  
  75. Important changes in this doc will be marked with [*NEW*].
  76.  
  77. 1. Introduction
  78. ===============
  79.  
  80.  
  81.  1.1 What is PaCifiST?
  82.  ---------------------
  83.  
  84. PaCifiST is an Atari ST emulator for PC. This is a SOFTWARE emulator, meaning
  85. you don't need a specific extension card with ST components, just your PC.
  86.  
  87. This allows you to run many Atari programs on your PC.
  88.  
  89.  
  90.  1.2 Why should you use it?
  91.  --------------------------
  92.  
  93. If you were an Atari ST owner, the answer is: Nostalgia! It is really cool to
  94. be able to run your old programs.
  95.  
  96. Nowadays, there are tons of multi-megabytes games for PC, with incredible
  97. graphics & unbelievable sounds, but except for a very few, they are boring,
  98. and have no "spirit"...
  99.  
  100. The Atari is not the only machine with great games (I also enjoy C64 & Amiga),
  101. but if you have ever played with Super Sprint, Stunt Car Racer,
  102. Dungeon Master, Colonial Conquest... I think you get the picture of what
  103. GOOD games are.
  104.  
  105. Of course, there are not only games on Atari ST! It was widely used by
  106. professional musicians for instance, and about all kind of programs exist.
  107.  
  108.  1.3 Features
  109.  ------------
  110.  
  111. PaCifiST emulates the following components of the original Atari ST:
  112.  
  113.        Motorola 68000   The 68000 emulation is written in 100% assembly
  114.                         language. All aspects of the processor are respected
  115.                         except for BCD instructions (not correct). Prefetch
  116.                         can now be emulated, using "pref" command in monitor.
  117.                         Because it slows down the whole emulation, you should
  118.                         only use this to bypass tricky routines. 68030
  119.                         emulation will come in the future
  120.  
  121.        Shifter (Video)  The 3 standard ST graphics mode are supported. You
  122.                         can choose between a monochrome (hires mode) or a
  123.                         color (lores & medres) emulation. All video emulation
  124.                         is also performed in 100% assembly language.
  125.                         Some special tricks (palette switching, rasters) are
  126.                         handled, provided you use a VBE2.0 driver and toggle
  127.                         the "LINE" video-building mode. Another mode (as of
  128.                         v0.44) is the MIXED mode. It's the same as the LINE
  129.                         mode, but allow also med/hi res mode switching.
  130.                         At this time, overscans and "syncscrolls" are
  131.                         NOT supported.
  132.  
  133.        6301 (Keyboard)  A genuine Atari uses this processor for keyboard,
  134.                         mouse, joystick & clock control. The exact behavior
  135.             of this chip is not emulated (It is much too time-
  136.             consuming) but the simulation is better and more
  137.                 accurate with each new version of the emulator. A
  138.             mouse is needed. If there is no joystick connected
  139.             to the PC (or you have disabled it in the INI file),
  140.                         a keyboard emulation is proposed.
  141.  
  142.        YM-2149 (Sound)  This soundchip is emulated if a supported soundcard is
  143.                         detected (SB only!). This part is written by Arnaud
  144.                         Carre.
  145.                         Since v0.41, I've started STF samples emulation.
  146.  
  147.        MFP (Interrupts) VBL, FDC, ACIA, TIMER C are correct, as well as TIMERs
  148.                         A, B & D in events count mode. HBL is not very
  149.                         accurate, but on a mere ST it's almost the same.
  150.  
  151.        FDC / HDC        PaCifiST uses 3 levels of disk emulation: Gemdos,
  152.                         BIOS and hardware level. The Gemdos level allows
  153.                         you to use all your harddisks space under emulation.
  154.                         For BIOS & hardware level, disk images are used to
  155.                         reflect real Atari ST floppy disks contents. Since
  156.                         v0.42, you can also use the PC floppy drive (A:) BUT
  157.                         USE IT AT YOUR OWN RISK!
  158.  
  159.        I/O              Output to Parallel are sent to LPT1:, the serial is
  160.                         not functional at this time, and there is NO midi.
  161.  
  162.  1.4 Future Plans
  163.  ----------------
  164.  
  165. There are many things left to do, as well as many things to fix.
  166. The "to do" list is as follows, in no particular order.
  167.  
  168.         - better STF samples
  169.         - fix the buckets of remaining bugs
  170.         - STE Blitter & DMA sound [in progress]
  171.         - support for more soundcards
  172.         - boost the 68000 a little more (I've one idea or two...) B-)
  173.         - support for two joysticks, two mice...
  174.         - overscans & syncscrolls
  175.         - stronger monitor (evaluator, conditional breakpoints...)
  176.         - working serial communication
  177.         - on-the-fly TOS change, monochrome selection
  178.         - Atari<->PC transfer program
  179.         - a freeze/reload memory option
  180.         - 68030 emulation
  181.         - extended graphics modes
  182.  
  183. Write me if you want another feature...
  184. Other neat features would be:
  185.  
  186.         - native 6301 emulation
  187.         - Midi support
  188.         - FDC-level emulation in PC drives A: & B: (no chances!)
  189.  
  190. But I haven't got enough docs (nor courage!) at this time.
  191.  
  192.  
  193.  1.5 How much does it cost?
  194.  --------------------------
  195.  
  196. Well, technically this program is FREEWARE. Even if I keep the rights on it,
  197. you are free and encouraged to spread it around you, provided you don't charge
  198. for this.
  199.  
  200.         Please read this ALSO:
  201.                          ====
  202.  
  203. ...BUT you are highly encouraged ^_^; to contribute. I spend almost all
  204. daytime on this project and I'd be really glad to receive any kind of reward
  205. for it. Sending me a few amount of money would be very kind, and will allow me
  206. to cover the phone bills. If not, you can send me a postcard, an old sci-fi
  207. movie [Ed.Wood...], a home-made CD or...a local beer!
  208.  
  209. I HATE crippled shareware programs, I don't want to do this: In return I hope
  210. those who can afford it will send some money.
  211.  
  212.  
  213. 2. Installation
  214. ===============
  215.  
  216.  
  217.  2.1 Requirements
  218.  ----------------
  219.  
  220. PaCifiST is designed to be run in a DOS environment. It works best under plain
  221. DOS, but will be happy in a box under Windows 3.11 or 95. I've been reported
  222. it was working under OS/2. Does it work under DosEMU?
  223.  
  224. The MINIMAL configuration you should run this program under is a 486DX-100. It
  225. will work with less, but don't expect it to be pleasant. I develop PaCifiST on
  226. an AMD 586-133 (about a P75 power), and the speed is almost always >= 8Mhz
  227. Atari ST at FULL FRAME RATE with sound enabled, under most games. Of course if
  228. you run a plasma routine with lots of color change, it will be slowed down...
  229.  
  230. PaCifiST takes about 1.5Mb of memory itself, add to this the amount of ST RAM
  231. you want to have under emulation. With 8Mb of memory for instance, you can
  232. emulate a 6Mb Atari.
  233.  
  234. A mouse is NEEDED. You can choose between the built-in mouse interrupt (SERIAL
  235. mouse in COM1 or COM2 only) or a mouse driver you have loaded before. The
  236. built-in driver doesn't work under windows 95. It is just a try to fix MANY
  237. mice-crashes encountered by several persons.
  238. If PaCifiST doesn't detect a joystick, it will use the numeric pad (with
  239. NumLock off) to simulate one. You can enable the joystick emulation with
  240. F4 under monitor.
  241.  
  242. A Soundblaster compatible card is needed if you want to hear something. GUS
  243. support is on the way.
  244.  
  245. Apart from these requirements, you need a dump of an Atari ST TOS (The ROM).
  246. If you can have at least 2 different TOS versions, you all likely to run
  247. more programq, because PaCifiST has different problems with each TOS
  248. version. Run the ST program DUMP_TOS.PRG (in STFILES directory) to extract
  249. a TOS to disk.
  250.  
  251. PaCifiST must be executed from its directory, which MUST contain PACIFIST.INI
  252. (the configuration ASCII file) and PATCH.H68 (some 68000 code needed to use
  253. mounted directories).
  254.  
  255.  
  256.  2.2 PaCifiST Concepts
  257.  ---------------------
  258.  
  259. This section explains some concepts you must understand to figure out how to
  260. configure the emulator options.
  261.  
  262.  
  263.    2.2.1 A word about the Monitor
  264.    ------------------------------
  265.  
  266. By default, when you run PaCifiST, you start in the MONITOR screen. In order
  267. to run the emulation, you must type "g" (go) and press enter. You can go back
  268. to this screen at any time by typing in the key under ESC and above TAB.
  269. You may want to do this to quit, reset the Atari, Choose a video Mode or a
  270. Speed mode...
  271.  
  272. IMPORTANT: Sometimes, when you come to the Monitor Screen, nothing you type on
  273. the keyboard will appear. Just press CTRL, SHIFT and ALT to clear the problem.
  274.  
  275.            When the 68000 hangs (bombs...) it is possible that the monitor
  276. does not show when you press the hotkey: Just wait a few seconds.
  277.  
  278.  
  279. Read the Monitor Commands Summary section for more information.
  280.  
  281.  
  282.    2.2.2 Video Emulation [*NEW*]
  283.    ---------------------
  284.  
  285. There are 3 different video emulation methods available under the emulator.
  286. This only concerns the standard low resolution Atari video mode.
  287.  
  288. The first mode (and default) is called the "Screen-Oriented" mode, because
  289. all the Atari screen is generated in a single pass. It means you can only have
  290. one palette (16 colors) for the whole screen, and no special effects. This is
  291. the mode you must use to run Gem applications, because it is faster.
  292.  
  293. The second mode is called "Line-Oriented" mode, and this time, each line of
  294. the ST screen is processed separately. This is the mode you should select
  295. to run some games and most demos.
  296.  
  297. The last mode is called the "Mixed" mode and requires a 640x400x256 linear
  298. videomode. It is the same as Line-Oriented, but is also able to render ST
  299. screen with resolution switching (in such games as Magnetic Scroll &
  300. Level 9 adventure game and in the Calimero demo for instance).
  301.  
  302.         Screen-Oriented mode:
  303.                 - don't allow any video tricks
  304.                 + works well under Windows (even windowed)
  305.                 + fast
  306.                 + work on all PC
  307.  
  308.         Line-Oriented mode:
  309.                 - slower
  310.                 - need a VBE2.0 driver
  311.                 - works ONLY in full screen under Windows
  312.                 + several video modes (320x200, 640x480...) available
  313.                 + able to emulate palette switching, rasters...
  314.  
  315.         Mixed-Mode:
  316.                 - *much* slower
  317.                 - requires a VBE2.0 driver with 640x400x256 or else
  318.                   640x400x256 mode
  319.                 - work only in full screen under Windows
  320.                 + able to emulate (limited) palette tricks & resolution
  321.                   change in the middle of an image.
  322.  
  323. You can switch from one mode to another easily whenever you want.
  324. IMPORTANT: Line-Oriented mode don't work in hires/medres, Mixed don't work
  325. in hires mode.
  326.  
  327.  
  328.    2.2.3 Speed Modes
  329.    -----------------
  330.  
  331. Since v0.4, there are two different speed modes: ST and MAX mode. The default
  332. mode is ST-speed: Even with the fastest Pentium-class machine, you won't
  333. exceed the speed of a genuine 8Mhz Atari ST: This is necessary for some
  334. programs to run properly. The other mode, MAX-Speed will synchronize the
  335. emulation to the PC speed. This is fine for all system-compliant applications,
  336. but MANY programs won't work in this mode.
  337.  
  338. It is NOT RECOMMENDED to change mode while running a program, it may crash.
  339. Change, BEFORE entering emulation.
  340.  
  341.  
  342.    2.2.4 Drives Emulation
  343.    ----------------------
  344.  
  345. PaCifiST provides you three ways to emulate ST drives:
  346.  
  347.     - PC DRIVE A:
  348.  
  349.         I made this because of MANY requests.
  350.         This is REALLY NOT RECOMMENDED!!! There are still many problems with
  351.         disk changing and write-protection handling. If the <pcdrive> directive
  352.         is enabled at startup and there are no images selected for disk A:,
  353.         then PaCifiST will boot on disk. This should work with some games,
  354.         but PLEASE DO USE IMAGES INSTEAD... ^_^;
  355.  
  356.         Please repeat: "I know that protected disks won't work. I shall *not*
  357.                         flame Frederic."
  358.  
  359.     - DISK IMAGES:
  360.  
  361.         This is a file that contains all the sectors of a given disks. For
  362.         the emulated Atari, they are similar to physical disks inserted in
  363.         drives A: & B:. Disk images work for all programs, even those that
  364.         directly use the disk controller. Please use the .ST extension.
  365.         You can choose two disk images at startup with the "IMAGE=" directive,
  366.         or during the emulation under the DISK SELECTION screen.
  367.         Since v0.41, PaCifiST is also able to directly use MSA files.
  368.         A new Image format will eventually come, but PaCifiST will remain
  369.         compatible with normal ".ST" files.
  370.  
  371.     - MOUNTED DIRECTORIES:
  372.  
  373.         This only works for programs that use Gemdos for file access, and
  374.     there are still some compatibility problems with file-selectors and
  375.     shell programs.
  376.         This allows you to mount any directory as an Atari unit. For instance,
  377.         if you mount "D:\ATARI" on the Atari C: at startup, the emulated
  378.         machine will see this directory and its subdirectories as its C: drive.
  379.         You CAN mount a whole partition, but it is NOT RECOMMENDED. You might
  380.         put all your Atari stuffs in a directory or two, and mount them as
  381.         units. This way, even if a big crash occurs, your PC system files
  382.         won't be affected.
  383.         You can't change the mounted directories on the fly, you must restart
  384.         the emulator to do so.
  385.  
  386.  
  387.    2.2.5 Sound
  388.    -----------
  389.  
  390. Only Soundblaster compatible cards are supported in v0.4.
  391. PaCifiST won't try to autodetect the settings by itself, but rely on the
  392. BLASTER environment variable. Before running the emulator, be sure it is
  393. properly set. Read your soundcard documentation if you don't manage, but
  394. if you know for sure the settings, type under DOS:
  395.  
  396. SET BLASTER= Axxx Ix Dx
  397.  
  398.         where Axxx is the Port value. By example A220
  399.         where Ix is the Irq number. By example I7
  400.         where Dx is the DMA channel. By example D1
  401.  
  402. The STF samples are really bad at this time (it also depends on the replayer).
  403. You can disable this emulation in the INI file. You can switch this feature
  404. with F5 under monitor.
  405.  
  406.  
  407.  2.3 Before running it...
  408.  ------------------------
  409.  
  410. PaCifiST is configured through a normal ASCII file: "PACIFIST.INI". You can
  411. edit it with any file editor to change the default behavior of the emulator.
  412. Some options can be overridden easily with commandline switches.
  413. This document contains a section which explains all the options. Please keep
  414. a copy of the original INI file, in case you made something wrong.
  415.  
  416. The first time you will run PaCifiST, there are a few things that must be
  417. adjusted that depend of your system.
  418.  
  419. The most important thing is to indicate PaCifiST where to find your TOS image,
  420. and at what memory location to load it. Note the size of your TOS file, load
  421. the INI file and go to the [system] section. Sections are just intended to
  422. group directives by topics. You can comment lines with ";". All text after
  423. this will be ignored.
  424.  
  425. tos=            is the directive that gives the TOS file name.
  426. tosbase=        is the directive that gives the TOS memory location.
  427.  
  428. Say your TOS file, called TOS.IMG or whatever, is 192Kb (196,608 bytes). It is
  429. likely to be version 1.0, which address is 0xfc0000. In this case, you must
  430. put in the ini file:
  431.  
  432.         tos= tos.img       ;you must specify the path if the file is not in the
  433.                            ;PaCifiST directory.
  434.         tosbase=0xfc0000   ;location for TOS1.0
  435.  
  436. If your TOS file is 256Kb (262,144 bytes), you're sure the address is 0xe00000.
  437.  
  438.         tos= tos.img
  439.         tosbase=0xe00000
  440.  
  441. IMPORTANT: If several TOS or TOSBASE directives are in the INI file, it is the
  442. last ones that will be take into consideration by the emulator. It is the same
  443. for all directives, apart from IMAGE & MOUNT.
  444.  
  445. The default INI file that comes with PaCifiST contain some sample of TOS
  446. configuration.
  447.  
  448. You must also be sure that the path specified for all MOUNT directives are
  449. valid. If you're unsure of understanding these MOUNT things, just comment the
  450. lines (put ";" before the directives) and read the INI directives reference.
  451.  
  452.  
  453.  
  454. 3. Configuration
  455. ================
  456.  
  457. There are 3 levels of configuration. The INI files contains global options,
  458. while command line switches affect only the current session. Some options can
  459. also be changed on the fly.
  460.  
  461. [*NEW*]
  462.  
  463. A file called JOY.CFG will also be created in the PACIFIST directory the
  464. first time you will run the joystick calibration, and loaded at started.
  465.  
  466.  3.1 INI directives reference
  467.  ----------------------------
  468.  
  469. all tabs, spaces and texts after ';' are ignored.
  470.  
  471.  
  472.     3.1.1 System Section
  473.     --------------------
  474.  
  475.         TOS = <file>            Name of the TOS dump file
  476.  
  477.         TOSBASE = <adr>         Address of the TOS in memory (0xfc0000 for 1.0,
  478.                                 0xe00000 for other versions)
  479.  
  480.         AUTORUN = [yes|no]      If YES, PaCifiST will jump into emulation when
  481.                                 you run it, skipping the monitor screen.
  482.  
  483.         RAMSIZE = <n>           Specify the RAM amount to emulate in megabytes.
  484.                                 This is a number from 1 to 14.
  485.  
  486.         SOUND = [yes|no]        Indicates whether or not you want sound.
  487.  
  488.         SAMPLES = [yes|no]      Do you want *bad* STF samples?
  489.  
  490.         VOLUME = <n>            Indicates the sound volume. Maximum is 255, and
  491.                                 is the default value as you probably will
  492.                                 prefer to adjust the sound level externally.
  493.  
  494.         INTERNALMOUSE=[yes|no]  default is no, and tell PaCifiST to use the
  495.                                 normal mouse driver given by DOS or Windows.
  496.                                 If you have encounter problems with a serial
  497.                                 mouse, try "YES" telling the emulator to use
  498.                                 its built-in serial handler (not under Win95).
  499.  
  500.         SENSITIVITY=[1-10]      Mouse sensitivity (only with external driver).
  501.                                 Default is 5.
  502.  
  503.         MOUSECOM = [1|2]        this works with the INTERNALMOUSE directive and
  504.                                 indicates on which Com port is your mouse.
  505.  
  506.         SERIAL = [yes|no]       Disable/enable the serial port emulation. Still
  507.                                 buggy anyway. Try no if PaCifiST hangs.
  508.  
  509.         JOYSTICK = [yes|no]     If disabled, no joystick will be used, but
  510.                                 instead an emulation with the numeric pad.
  511.  
  512.         LEDS = [yes|no]         Default is yes. If disabled, no LEDs blinking
  513.                                 will be done.
  514.  
  515.         KBDELAY = n             Keyboard delay value (1-10) Default 3. [*NEW*]
  516.                                 You can also change this number under monitor.
  517.                                 The 6301 processor send packets to the 68000 to
  518.                                 indicate mouse & joystick moves. Some apps can
  519.                                 be fooled if the emulator send too much bytes
  520.                                 from the IKBD at the time.
  521.  
  522.         IMAGE = <file>          This directive gives the name of a file (disk
  523.                                 image) to be "inserted" in drive A: & B:. You
  524.                                 can put two IMAGE directives in your INI file.
  525.  
  526.         MOUNT = <absolute path> Indicates to mount the given path (by example
  527.                                 C:\PACIFIST\STFILES) to an Atari unit. The
  528.                                 first one will be drive C:, you can specify
  529.                                 24 different locations. The specified PATH
  530.                                 must be ABSOLUTE, with the letter indicated.
  531.  
  532.         PCDRIVE = [yes|no]      Default is no - Should PaCifiST use the PC
  533.                                 Drive A:? Enabling this feature adds an
  534.                                 item in the diskselection screen.
  535.  
  536.     3.1.2 Screen Section
  537.     --------------------
  538.  
  539.         MONOCHROME = [yes|no]   Don't you guess? It has something to do with
  540.                                 colors...
  541.  
  542.         FASTVIDEO = [yes|no]    If you choose YES, PaCifiST will only convert
  543.                                 modified portions of video memory. This is
  544.                                 only used in the Screen-Oriented mode.
  545.                                 If your graphics card is very fast, you don't
  546.                                 need this option.
  547.  
  548.         REFRESHRATE = <n>       The default value is 1, meaning that EVERY
  549.                                 Atari screen is converted to the PC screen. Try
  550.                                 a bigger value if the emulation is too slow on
  551.                                 your PC. If you choose 3, only a screen out of
  552.                                 3 is displayed.
  553.  
  554.  
  555.     3.1.3 Debug Section
  556.     -------------------
  557.  
  558. This is only useful for beta-testers and those who want to examine PaCifiST's
  559. behavior, watch interrupts, FDC emulation, mouse events...
  560. You need to have a "debug" distribution of PaCifiST for this.
  561.  
  562.         LOGFILE = <file>        Name of the logfile, where all the
  563.                                         information is written into.
  564.  
  565.         TRAPIRQ = [all|none|v]  tell PaCifiST to stop execution when the given
  566.                                 exception occurs. Default is none. If v is
  567.                                 positive, it will be added in the list, if it
  568.                                 is negative it will be removed from the TRAP
  569.                                 list. You can specify several exceptions,
  570.                                 separated with comas.
  571.  
  572.         LOGIRQ = [all|none|v]   same as above, but this won't stop the 68000
  573.                                 but write information about the exception in
  574.                                 the logfile.
  575.  
  576.  
  577.     3.1.4 PACIFIST.INI example
  578.     --------------------------
  579.  
  580. [system]
  581.  
  582. tos = c:\pacifist\tos.rom
  583. tosbase= 0xe00000               ;tos
  584.  
  585. image=c:\pacifist\disks\boot.st ;name of disk image for Atari A:
  586. mount=c:\pacifist\stfiles       ;C:\PACIFIST\STFILES will be Atari C:
  587. mount=c:\pacifist\games         ;C:\PACIFIST\GAMES will be Atari D:
  588. autorun = yes                   ; jump directly to emulation mode
  589.  
  590. pcdrive=no                      ; :)
  591.  
  592. [video]
  593.  
  594. refreshrate = 2                 ;only render one screen out of 2.
  595. monochrome = no                 ;emulate an Atari with color monitor
  596.  
  597. [debug]                         ; only with DEBUG compiled PACIFIST
  598.  
  599. logfile = f:\debug.out          ; the logfile for debug
  600. logirq = none                   ; erase the LOG irq lists
  601. logirq = 0x21                   ; log GEMDOS calls
  602. logirq = 0x1c,69                ; log VBL & timer C too
  603. trapirq = 5                     ; Monitor zero divide exceptions
  604.  
  605.  
  606.  3.2 Command line parameters
  607.  ---------------------------
  608.  
  609. Some INI directives can be overridden on the command line. Valid options are:
  610.  
  611.         /[h(elp)|?]             list of options
  612.         /refreshrate n          same of REFRESHRATE directive
  613.         /mono [yes|no]          same as MONOCHROME directive
  614.         /autorun [yes|no]       same as AUTORUN directive
  615.         /ramsize n              same as RAMSIZE directive
  616.         /sound [yes|no]         same as SOUND directive
  617.         /image <filename>       Mount an Image BEFORE those in INI file
  618.         /mount <path>           Mount a Path BEFORE those in INI file
  619.         /line                   Start in line-oriented mode (not recommended)
  620.         /maxspeed               Start in maxspeed mode (not recommended)
  621.         /pcdrive [yes|no]       same as PCDRIVE directive
  622.  
  623.  
  624.  3.3 Configuration under Monitor
  625.  -------------------------------
  626.  
  627. Read the Monitor reference section for a complete description of all the
  628. commands. If you don't know 68000, the only commands you need are:
  629.  
  630.         g       go into emulation mode
  631.         x       quit to DOS
  632.         vol <n> set the volume (0-255)
  633.         help    some help. Yes.
  634.  
  635. Useful keys:
  636.  
  637. [F1]    shift between SCREEN, LINE & MIXED mode.
  638.         You need a VBE2.0 driver in order to be able to have the LINE and
  639.         MIXED method.
  640.  
  641. [F2]    Choose a video mode in the list. 256 colors mode don't work always,
  642.         but are faster than 32K & 64K colors mode. This affect LINE mode only.
  643.  
  644. [F3]    Change from ST speed mode to the MAXimum speed mode. Do this BEFORE
  645.         going into emulation.
  646.  
  647. [F4]    Enable/Disable the Joystick Emulation with keys. Numeric Pad & CTRL
  648.         (with NumLock off) are used to simulation movements and fire.
  649.  
  650. [F5]    Enable/Disable the samples emulation.
  651.  
  652. [F12]   Display the DISK SELECTION screen.
  653.         Can also be called during emulation.
  654.  
  655.  
  656.  3.4 The Disk Selection Screen
  657.  -----------------------------
  658.  
  659. Use F12 at any time for this disk-selection screen. It can be useful to switch
  660. between 2 disks (in a multi-disks game...). I wrote the same kind of interface
  661. that Ulrich Doewich does for the Amstrad emulator CPE.
  662.  
  663. It is pretty self-explaining. The file selector doesn't display all files, only
  664. .ST, .MSA .ZIP and directories, as well as all valid units.
  665.  
  666. Use <ESC> to exit the screen. <UP>, <DOWN>, <PAGEUP>, <PAGEDOWN>, <END>, <HOME>
  667. to navigate in the file selector.
  668. <TAB> <LEFT> <RIGHT> choose disk A or disk B. <ENTER> will insert the
  669. selected image disk for the current drive. There is an item in the list to
  670. remove the disk.
  671.  
  672. Of course, if the changed disk need to be booted (for a game to start...),
  673. you must also perform a reset (Ctrl-Break).
  674.  
  675. Since v0.4, the fileselector will consider .ZIP as normal directories, you can
  676. then group disk images in such archives. This is still *experimental*.
  677. In order to extract files from archives, PKUNZIP.EXE must be in the PATH.
  678. files will be extracted in the TEMP directory if this environment variable
  679. exists, or in the PACIFIST directory. The temporary files are called
  680. PCSTIMG*.TMP. They are not erased when you quit the emulator (in case you
  681. want to keep the changes in it).
  682.  
  683. Since v0.42, if the PCDRIVE directive is enabled, you can also choose the
  684. PC drive A: to emulate a real ST drive.
  685.  
  686. IMPORTANT: Changes in the extracted disk image WON'T BE reflected in the
  687. original archive file! It is the same with .MSA files, because they are
  688. converted to .ST file.
  689.  
  690. 4. Miscellaneous
  691. ================
  692.  
  693.  4.1 Hints
  694.  ---------
  695.  
  696.         - DO NOT USE ANY WRITE-DELAYED DISK CACHING ("smartdrv c+"...)
  697.  
  698.         - some GEMDOS function are not well-emulated. for instance, with
  699.           mounted drives, GFABASIC file selector is trashy (OK with images).
  700.  
  701.         - If you're having problems with PaCifiST configuration, you can try
  702.           a front-end utility: If you run PaCifiST from DOS, there is AssiST,
  703.           coded by Aengus Jankowsky. For Win95 users, there is PaCiLOAD done
  704.           by Andrew Knipe.
  705.  
  706.         - If you have enough memory, when debugging, put the logfile in a
  707.           ramdisk.
  708.  
  709.         - avoid using PCDRIVE. It is slow, unstable and less powerfull than
  710.           images.
  711.  
  712.  4.2 VBE2.0
  713.  ----------
  714.  
  715. In order to enable the LINE-building mode and emulate raster effects, you
  716. need to install a VBE2.0 driver in memory before running PaCifiST.
  717. Perhaps there is such a driver provided in you graphics card package?
  718.  
  719. A very good choice is to have Scitech's Display Doctor. You can download
  720. this shareware version on their web page http://www.scitechsoft.com.
  721.  
  722.  
  723.  4.3 Disk Images
  724.  ---------------
  725.  
  726. These images just contain all the sectors put together in logical order:
  727. for all TRACKS x all SIDES x all SECTORS, there is a 512 bytes block.
  728.  
  729. PaCifiST don't need any special information, because disk parameters can be
  730. read on the boot sector. If values seem wrong, PaCifiST tries to deduce it
  731. from the image file size.
  732.  
  733. You can create your own images from your ST disks with the little utility
  734. IMGBUILD. It permits also to make blank images of standard or non-standard
  735. sizes.
  736.  
  737. Read the RESOURCES section to see where to find it.
  738.  
  739. Alternatively, PaCifiST is also able to use MSA file, but in read only.
  740.  
  741.  
  742.  4.4 Keyboard Mapping
  743.  --------------------
  744.  
  745. Since v0.41, the keyboard mapping is similar to the Atari's, except that:
  746.  
  747.         - HELP is mapped on PageUp
  748.         - UNDO is mapped on PageDown
  749.  
  750.         - CTRL+Break performs a reset (add SHIFT if the reset vector is
  751.                                        trapped by the current program)
  752.  
  753.         - If NumLock is on, the Numeric Pad is the same as on Atari, else
  754.           it is used for the joystick emulation (CTRL is fire).
  755.  
  756.  
  757. Also, F12 brings up the disk selection screen, and the key under ESC aborts
  758. the emulation and skips to the monitor.
  759.  
  760.  
  761.  4.5 Screen Snapshots [*NEW*]
  762.  --------------------
  763.  
  764. This feature appears in v0.44, and allow you to save the screen as a PCX file
  765. in the PACIFIST directory. All the files will be called "PCST_xxx.PCX".
  766.  
  767. Just press the ScrollLock key to do so (The PrtScr key being used under
  768. Windows), please note that isn't not working in all video modes.
  769.  
  770. The video modes supported so far are:
  771.  
  772.         - ST hires
  773.         - ST lowres in SCREEN MODE
  774.         - ST lowres in standard LINE MODE (only 256 colors)
  775.  
  776. Not supported yet:
  777.  
  778.         - ST medium resolution
  779.         - MIXED MODE
  780.         - VBE LINE MODE (32K & 64K bit color)
  781.  
  782.  
  783. 5. The Monitor
  784. ==============
  785.  
  786.  
  787.  5.1 Monitor Screen
  788.  ------------------
  789.  
  790. The blue bar at the topmost contains a reminder of useful function keys as
  791. well as current video-building mode & speed-mode.
  792.  
  793. Right under, a display of the 68000 registers as well as an estimated relative
  794. speed and a (not accurate) rasterline counter.
  795.  
  796. On the right: Current Stack (USP or SSP) dump, a list of the breakpoints,
  797. breakaccesses & the breakopcode values.
  798.  
  799. The upper windows always show the 68000 instructions around the current PC
  800. location. a "*" right before an instruction indicates a breakpoint.
  801.  
  802. You can use CTRL-Z to step into or CTRL-T to trace over, like in the good old
  803. MONST2! CTRL-U can be used to trace in trace-mode, without entering the TRACE
  804. exception (but of course executing it!) CTRL-G is an alternative for the <g>
  805. command.
  806.  
  807.  
  808.  5.2 Monitor Commands
  809.  --------------------
  810.  
  811. Many commands need a "DEBUG" compilation of PaCifiST. Because this slows down
  812. the emulation, it is not included in normal distribution of the emulator, but
  813. you can find such a version easily: just read the RESOURCES section to see
  814. where are the PaCifiST support sites.
  815.  
  816. Arguments between parenthesis are optional.
  817. Most values in the monitor are hexadecimal numbers.
  818.  
  819.  
  820. h,help,?        Quick summary
  821. t               Trace over. This traces all instructions except for BSR, JSR
  822.                 & TRAP, which are executed till they return. Hit any key
  823.                 to abort if the execution seems in a long loop.
  824. z (n)           single step. If an IRQ or an exception (Bus Error,...)
  825.                 occurs just after, it will be triggered. This can be annoying
  826.                 with Timers in some programs. TRACE MODE can be traced
  827. d (adr)         dump a disassembling on a few lines.
  828. g (n)           go. You can specify a number of rasterlines.
  829. m (adr)         dump memory (hexa & ascii).
  830. bp (adr)        Add or remove a breakpoint. A breakpoint doesn't consist in a
  831.                 special opcode, the memory isn't changed but the PC is
  832.                 checked all the time. You can then put breakpoint BEFORE a
  833.                 program is loaded. Breakpoints don't always work when they are
  834.                 on the first instruction of an Exception routine (use TRAP
  835.                 in this case)
  836. ba (adr)        Add or remove a breakaccess. Any read or write (hopefully) to
  837.                 the given location will break execution. Be careful: A word
  838.                 access at $10000 will do nothing with a breakaccess at $10001.
  839. bo <msk> <cmp>  set the "break opcode". There can be only one! All opcodes are
  840.                 ANDed with the mask and compared to the second parameter. For
  841.                 instance "bo ffff 4e75" will make the execution stop after all
  842.                 RTS. To remove the breakopcode, enter something like "bo 0 1".
  843. s reg=<value>   Set any 68000 register to a given value.
  844. s [adr]=<bytes> change memory (even ROM). Use "s [1230] = 4e 71 4e 71" to nop
  845.                 a longword instruction. Each bytes must be separated by spaces.
  846. nop <adr> <n>   fill memory at <adr> with <n> NOPs... :)
  847. lb <file> <adr> (size) load a file (or part of it) in memory.
  848. sb <file> <adr> <size> save a part of memory to disk.
  849. reset (hard)    Perform a reset.
  850. trap (vector)   This command enables you to break execution each time a given
  851.                 exception occurs. Type TRAP alone for a list of the main
  852.                 vectors.
  853. animate <n>     This will single step n instructions, with a dump of all the
  854.                 registers in the logfile after each of them.
  855. status          Show some information about MFP & ST drives.
  856. disa <start> <end> Disassemble a part of memory in the logfile. FAST!
  857. kbd (bytes)     Display/Put values in the internal 6301 keyboard buffer.
  858. kbdelay [n]     Examine or set the KBDVALUE variable. [*NEW*]
  859. vol (volume)    Set the volume from 0 to 255 (dec), or display current value.
  860. x               eXit.
  861. pref [on|off]   If on, the 68000 prefetch queue will be emulated. Use this only
  862.                 when necessary because the emulation is slower in this mode.
  863.                 You can single step over prefetch queue, even if an opcode is
  864.                 changed.
  865. patch [off|...] Change the behaviour of PaCifiST in order to run more [*NEW*]
  866.                 programs.
  867.                 The only patch at this time "joy": Use it when the joystick
  868.                 button seems not to work.
  869.  
  870. The following commands NEED a debug build of the emulator:
  871. bp, ba, bo, trap
  872.  
  873. 6. Resources & Acknowledgments
  874. ===============================
  875.  
  876.  6.1 Related programs
  877.  --------------------
  878.  
  879.    6.1.1 Other Emulators
  880.    ---------------------
  881.  
  882. This only covers Atari ST emulation for PC. Refer to the comp.emulators.misc
  883. FAQ for more information.
  884.  
  885.         - STonX         Written by Marinos Yannikos(nino@complang.tuwien.ac.at)
  886.                         and Martin Griffiths (mgriffiths@ea.com).
  887.                         It's a free emulator for Unix which comes with sources.
  888.                         A DOS version now also exists, ported by Dirk Jansen.
  889.                         The official website is:
  890.                         http://www.complang.tuwien.ac.at/nino/home.html
  891.                         Nino & Martin are working hard on a new version.
  892.  
  893.         - STEmu         Written by Jochen Frank (uk9a@rz.uni-karlsruhe.de) is
  894.                         a new ST emulator. You can find it on Aengus's site.
  895.                         The first version I saw (0.2) works with TOS1.62, but
  896.                         the MFP was not yet implemented.
  897.  
  898.         - Gemulator 96  It is a COMMERCIAL emulator. It is faster than
  899.             STonX & PaCifisT but can only run 100% system-compliant
  900.                         apps. Gemulator Classic is an older (but free) DOS
  901.                         version. official site: http://www.emulators.com
  902.  
  903.  
  904.    6.1.2 Utilities
  905.    ---------------
  906.  
  907. AssiST - who:   Aengus Jankowsky (ajankows@iol.ie)
  908.          where: http://www.iol.ie/~ajankows/st/pacifist.html
  909.  
  910.         A DOS front-end configuration program for PaCifiST.
  911.         This program is very convenient to set up your .INI file. It's
  912.         not only recommended for beginners, but for all users!
  913.  
  914. PaCiLOAD - who: Andrew Knipe (alk@bluesky.net.au)
  915.         where : http://www.labyrinth.net.au/~contact/paciload.zip
  916.  
  917.         A Windows front-end interface for PaCifiST. Easy to use, can also
  918.         convert MSA to ST file before running the emulator.
  919.  
  920.  
  921. MSAtoST - who: Damien Burke (st@jetman.demon.co.uk)
  922.         where: http://www.jetman.demon.co.uk/st/index.html
  923.  
  924.         A converter to translate MSA files to ST files (the disk image
  925.         format used in PaCifiST). Many programs you may find on the
  926.         Internet (Umich archive...) are in MSA format. PaCifiST can *now*
  927.         deal internaly with MSA file, but in read only.
  928.  
  929. IMGBUILD - who  Frederic Gidouin (frederic.gidouin@hol.fr)
  930.          where: http://www.geocities.com/SiliconValley/Lakes/6878/download.html
  931.                 http://wwwperso.hol.fr/~gidouin/download.html
  932.  
  933.         A little utility to produce .ST files from floppies. It doesn't
  934.         handle 11 sectors disks or protected/abnormal format.
  935.         Can also be used to create blank new images.
  936.  
  937.  6.2 Resources
  938.  --------------
  939.  
  940.         PaCifiST-Support Sites:
  941.         =======================
  942.  
  943. - http://ireland.iol.ie/~ajankows/st/pacifist.html
  944.  
  945.         Contains many versions of PaCifiST, latest version of AssiST,
  946.         some disk images (games), TOS and links.
  947.  
  948.  
  949. - http://oasis.slcc.edu/~pitchja
  950.  
  951.         Latest version of PaCifiST, Spectrum 512 stuffs, links.
  952.  
  953.  
  954. - http://www.jetman.demon.co.uk/st/index.html
  955.  
  956.         Contains latest version of PaCifiST & the MSAtoST tool. Also, a
  957.         small how-to about the emulator configuration.
  958.  
  959.  
  960. - http://ourworld.compuserve.com/homepages/bfozard/pacifist.htm
  961.  
  962.         Latest version of the emulator, and some games in .ST format.
  963.  
  964. - http://wwwperso.hol.fr/~gidouin/pacifist.html
  965. - http://www.geocities.com/SiliconValley/Lakes/6875/pacifist.html
  966.  
  967.         Official PaCifiST sites. Up-to-date versions of the emulator,
  968.         many links to alternative sites, some programs.
  969.  
  970.  
  971.         Other Atari ST emulation-Related SITEs:
  972.         =======================================
  973.  
  974. - http://www.mygale.org/09/leonard/
  975.  
  976.         Arnaud Carre homepage, with all his great productions. Have a look at
  977.         his incredible YM-player!!!
  978.  
  979. - http://www.why.net/home/adam/cem/toc.html
  980.  
  981.         comp.emulators.misc FAQ, maintained by Adam Roach.
  982.  
  983.  
  984. - http://www.complang.tuwien.ac.at/nino/stemu.html
  985.  
  986.         The STonX project homepage.
  987.  
  988.  
  989.  6.3 GREETINGS
  990.  -------------
  991.  
  992. I wish to thank the following persons:
  993.  
  994. Damien Burke       For his website, his MSA to ST converter, information about
  995.                    the MSA format and keyboard commands reference.
  996.  
  997. Arnaud Carre       For his long, interesting & funny mails, his remarks and
  998.                    a great soundchip emulation, his SB driver source, and...
  999.                    patching some demos!!!
  1000.  
  1001. Ulrich Doewich     For his interesting mails and above all because he made
  1002.                    a very good & fast YM emulation and send me plenty of
  1003.                    cool sources and demos of games he wrote.
  1004.  
  1005. Ben Frozard        For his mails and having put PaCifiST on a US server.
  1006.  
  1007. Carolyn Horn       For being one of the few to have read this documentation
  1008.                    in every detail and her proofreading!
  1009.  
  1010.  
  1011. Aengus Jankowsky   For coding ASSIST.EXE, a menu-directed configuration tool,
  1012.                    all his interesting feedback, and also for setting up a
  1013.                    good alternative site for ST emulators.
  1014.  
  1015. Andrew Knipe       For his relevant mails (thanks for the Kagi hint!) and his
  1016.                    Windows front-end for the emulator.
  1017.  
  1018. Ludovic Olivencia  For all of his relevant phonecalls, having found plenty
  1019.                    of bugs for me to fix and disk images of non-working
  1020.                    programs.
  1021.  
  1022. Alan Reeve         For sending me very complete documentation of many
  1023.                    ST hardware components, for *MANY* disk images ;-)
  1024.  
  1025. Jamison Pitcher    For his website and Spectrum 512 information.
  1026.  
  1027. Simone Voltolini   For intensive betatesting and invaluable feedback.
  1028.  
  1029. Arsene Von Wyss    For his relevant mails and information about many ST
  1030.                    programs.
  1031.  
  1032. And in general to all persons who have send me contributions.
  1033.  
  1034.  
  1035.  6.4 CONTACTING THE AUTHOR
  1036.  -------------------------
  1037.  
  1038. Feel free to send any suggestions, remarks...gifts!
  1039.  
  1040. e-mail:      frederic.gidouin@hol.fr
  1041. snail mail:
  1042.              Frederic Gidouin
  1043.              9, Allee du Chevrefeuille
  1044.              29280 Plouzane
  1045.              FRANCE
  1046.  
  1047.