home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / programs / emulaton / arcvic / readme-1st next >
Text File  |  1998-08-10  |  8KB  |  223 lines

  1.                             =====================
  2.                                  A R C V I C
  3.                                  Version 0.3
  4.                              -------------------
  5.                              Copyright  (C) 1998
  6.                               B.W. van Schooten
  7.                             email:  vicman@dds.nl
  8.                             =====================
  9.  
  10.     License
  11.     -------
  12. This software is distributed as freeware. It may be freely used and
  13. distributed as long as all the original files are included in their original
  14. form. This software may not be modified or sold for profit, although a
  15. small fee may be assessed for the media used for copying the software.
  16.  
  17. This program and documentation is provided 'as is' and without any
  18. warranty, not even the implied warranty of merchantability of fitness for
  19. any purpose. In no event wil the author be liable for any damage or loss
  20. caused by use of this software or documentation.  
  21.  
  22.  
  23.  
  24.     What is so cool about Arcvic?
  25.     -----------------------------
  26. * Arcvic is a Commodore Vic-20 emulator for Archimedes and RISCPC machines.
  27.   Arcvic was written within a period of one week.
  28. * It is written in 100% assembler, and is optimised to run at 100% speed on
  29.   an 8 Mhz ARM-2 machine, and at double or higher speeds on just about any
  30.   other ARM machine.
  31. * It handles different screen sizes, and all standard memory expansions.
  32. * It autodetects the memory expansion and boots automatically when you load
  33.   a program. 
  34.    
  35.  
  36.  
  37.     What really sucks about Arcvic?
  38.     -------------------------------
  39. This is still a 0.x version, which means that this list is still bigger
  40. than the previous one. 
  41.  
  42. * STRONGARM users absolutely have to turn their cache off, since this
  43.   program relies heavily on self-modifying code (it uses JIT compiling).
  44. * It needs 768K of memory, which may make it hard to run on 1-meg machines.
  45. * It is in black&white.
  46. * It has no sound.
  47. * VIA emulation is limited, which means some programs won't run. Also, the
  48.   Run/Stop key (TAB) won't break BASIC programs. The Restore key is not
  49.   emulated. 
  50. * Only a few programs have been tested on it. 
  51. * The timing is not very accurate, as it depends on the screen mode you're
  52.   in (it should work best for 50Hz or 60Hz modes. 70Hz modes will result
  53.   in a Vic-20 that is too fast).
  54. * The program is rather braindead about saving files. At the moment, files
  55.   are saved to a fixed filename in the directory <Arcvic$WorkDir>
  56.  
  57.  
  58.    How do I get it to run?
  59.    -----------------------
  60. You will need the Vic-20 system ROMs, which are not included in this
  61. package. The main reason for this is that they are probably still
  62. copyrighted by Commodore. You will need the following ROMs:
  63.  
  64. * BASIC ROM           (8192 bytes) which should be named ROM-BASIC
  65. * Font definition ROM (4096 bytes) which should be named ROM-Char
  66. * Kernel              (8192 bytes) which should be named ROM-Kernel
  67.  
  68. These should be placed in Arcvic's directory. You can find them on
  69. ftp.funet.fi or on the Arcvic homepage:
  70.  
  71.     ftp://ftp.funet.fi/pub/cbm/firmware/vic20/ 
  72.     ftp://ftp.funet.fi/pub/cbm/firmware/characters/ 
  73.  
  74.     http://wwwhome.cs.utwente.nl/~schooten/software/vic-20/arcvic.html
  75. or
  76.     http://www.geocities.com/TimesSquare/Alley/3583/arcvic.html
  77.  
  78. It is possible that the files you find on Funet or other FTP sites are
  79. actually 8194 or 4098 bytes in size. This means they are in BIN format
  80. instead of raw format (see also the section on file formats). Delete
  81. the first 2 bytes from the file to convert them. 
  82.  
  83.  
  84.     How do I run programs on it?
  85.     ----------------------------
  86. Well, first you obtain some from the 'net, for example from the Funet site
  87.  
  88.   ftp://ftp.funet.fi/pub/cbm/
  89.  
  90. In case a program does not consist of multiple files, you drag the file
  91. onto the Arcvic icon, and the emulation should begin automatically.
  92. Two things may happen:
  93.  
  94. * In case it is a ROM program, the program should start automatically.
  95. * In case it is a RAM program, the Vic-20 should boot normally into BASIC.
  96.   Once it has booted, press the F6 key (undelete program) and type
  97.   'RUN' <ENTER> to start the program.
  98.  
  99. There are also multi-part ROM and RAM programs. These are a little harder
  100. to run.
  101.  
  102. * Multipart ROM programs: these are usually recognisable because they
  103.   consist of multiple files with the same name but with different suffixes
  104.   such as '-60', '-a0' or '.60', '.a0' or '.20', '.a0' or '6000', '-a000'
  105.   etc. There should always be an 'a0' part. Drag the parts onto ArcVic one
  106.   by one, dragging the 'a0' part last. After dropping the 'a0' part, the
  107.   program should boot automatically.  
  108. * Multipart RAM programs usually require some engineering to get them to
  109.   work. Sometimes you may get away by just treating the final part as
  110.   a single-part program.
  111.  
  112.  
  113.  
  114.        Reference guide
  115.        ===============
  116.  
  117.     The Vic-20 keyboard
  118.     -------------------
  119.  
  120. Archimedes keys are mapped 1-to-1 to Vic-20 keys. However, the meaning of
  121. some keys and key combinations is quite different. The mappings are chosen
  122. as to be topologically close to their counterparts. 
  123.  
  124. Archimedes  VIC-20
  125. ----------- ------------
  126. Left Alt    CBM
  127. tab         Run/Stop
  128.  `          Arrow Left
  129.  =           +
  130.  [           =
  131.  ]           *
  132.  ;           :
  133.  '           ;
  134.  \          clr/home
  135. Keypad /     ^
  136. Keypad *     @
  137. Right Alt   Crsr Up/Down
  138. Right Ctrl  Crsr Left/Right
  139.  
  140.  
  141.  
  142.     Emulation hot-keys
  143.     ------------------
  144.  
  145. * ESC: Back to desktop
  146.  
  147.   Should be obvious
  148.  
  149. * F9-F12: Select frame skipping
  150.  
  151.   Normally, frames are drawn every 'Vic-20' frame, which is about every
  152.   1/50th of a second. On slow (ARM-2) machines, you might want to use
  153.   frame skipping.
  154.   F9  - No frame skipping
  155.   F10 - Skip every other frame
  156.   F11 - Draw only one out of every three frames
  157.   F12 - Draw only one out of every four frames
  158.  
  159. * F8: Toggle use of Vsync
  160.  
  161.   Normally, Arcvic waits for the vertical sync before rendering the screen.
  162.   On slow machines, you may not want any wait loops, so you can turn it
  163.   off using this key.   
  164.  
  165. * F6: Undelete program
  166.  
  167.   When you press F6 when inside BASIC, the program that is currently in
  168.   memory is undeleted. This can be used to resurrect a program after
  169.   the system has been reset.
  170.  
  171. * Make screen grab (F4)
  172.  
  173.   A screen grab is saved to the file <Arcvic$WorkDir>.screengrab
  174.  
  175.  
  176.  
  177.     Menu items
  178.     ----------
  179. * Reset
  180.  
  181.   Reset as if issuing a RESET signal to the Vic-20 hardware. If there is
  182.   a bootable ROM program present, it will be booted, otherwise BASIC is
  183.   booted.
  184.  
  185. * Total reset
  186.  
  187.   Like Reset, but wipes all memory clean and reloads the ROMs first.
  188.  
  189. * Autoboot
  190.  
  191.   With this option turned on, the emulator will try to automatically set
  192.   the memory expansion and reset, according to the start address and the
  193.   size of the program that is dragged onto the Arcvic icon. 
  194.  
  195. * No/3K/8K/16K/24K RAM exp
  196.  
  197.   With these, you can select each of the standard memory expansion modules
  198.   as could be slotted into a real Vic-20. Note that a change in memory
  199.   expansion only takes effect after resetting the Vic-20.
  200.  
  201. * Save BASIC
  202.  
  203.   The program currently in the BASIC area (the area between the BASIC start
  204.   and end pointers 43/44 and 45/46) is saved to disk. This program can be
  205.   loaded again by dragging it onto Arcvic, letting the Vic-20 boot, and
  206.   pressing F6 (undelete).
  207.  
  208.   The program is saved to the file <Arcvic$WorkDir>.vicbasic
  209.  
  210.  
  211.     The Vic-20 image file formats
  212.     -----------------------------
  213. The Vic-20 program images typically come into two formats: BIN (also called
  214. PRG), and raw data.
  215.  
  216. The system ROMs (ROM-BASIC, ROM-Char, ROM-Kernel) are assumed to be raw
  217. data. 
  218.  
  219. All files dragged onto Arcvic are assumed to be BIN files. Essentially, BIN
  220. files are just like raw data, but with a two-byte header. This header
  221. contains the start address of the program in little-endian format.
  222.  
  223.