home *** CD-ROM | disk | FTP | other *** search
/ Supremacy 2 / Supremacy-2.iso / Tools / PC / Pacifist / PCST043.ZIP / PCST043 / DOCS / PACIFIST.DOC < prev    next >
Text File  |  1997-04-24  |  40KB  |  985 lines

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