**************************************************************************
*							  (Oct. 9 1994)  *
*               Apple II+ Emulator version 0.01 for Linux                *
*									 *
*      Author: Alexander Jean-Claude Bottema                             *
*      Email : d91a1bo@meryl.csd.uu.se                                   *
**************************************************************************

Contents
========

0. Installation issues (briefly)
1. Why did I make an Apple II+ Emulator when there are so many available?
2. System Files
3. Keyboard & keys
4. Diskette database
5. Future plans
6. Status of the current emulator
7. Can you port this to DOS?
8. Availability
9. Known problems
10. Changes since 0.00 (see CHANGES)
11. Final words

0. Installation issues (briefly)
================================

Unpack this distribution in a temporary directory and type "make
install".  Read section 2 for further information considering default
parameters and system files (these must be available). Type "apple2"
to run the emulator, check that the boot diskette is named disk_s6d1.

Requirements: SVGA lib version 1.05 (or later but < 1.08, see 9.)
              Kernel 1.0 (or later).
	      libc 4.4.4 (or later).

1. Why did I make an Apple II+ Emulator when there are so many available?
=========================================================================

For three reasons. The first is that there are no Apple II emulators
especially written for Linux; hence they do not take advantages that
are commonly provided in Linux systems, e.g. the SVGA library
distribution.  However, there is an Apple II emulator for X-Windows
that easily can be compiled on most UN*X architectures, but the major
disadvantage is slow emulation. You cannot obtain a fast emulator by
writing it in C, despite the elegant optimizations provided by GNU-C,
but of course it becomes more portable if you do that.

By contrast, this Apple II emulator is partly written in 386 (AT&T)
assembler; partly in C. Only those issues that were not time critical
were written in C. Especially the CPU emulation was written in
optimized assembler to achieve optimum performance. The emulator
approximately runs twice as fast as an ordinary Apple II+ computer if
it is running on a 486 DX-50.

The second reason is that there is no Apple II emulator which is 100%
usable. Either it is too slow or it is simply too fast (= there is no
option to trim the speed of the emulator). Furthermore, many
implementors happily avoid implementing mixed text/graphics in high
resolution mode; mostly because it complicates the programming. I have
never seen an Apple II+ emulator that is entirely complete. I think
most emulators fail on implementing the undocumented 6502 instructions
(those that are listed as ???), hence some games (or applications) may
not work despite they should.

The third reason is that no emulator support an easy way to switch
diskettes given a database of diskettes. With this emulator you can
easily switch diskettes through an intuitive interface. You can also
add additional information for each diskette (in your database), e.g.
which keys to use for a particular game program. The information is
kept in a plain text file that can be edited with an ordinary text
editor, preferbly GNU-Emacs.

2. System files
===============

Before you can run the emulator, three vital system files must be
available. These are:

apple_II.rom (12k)	This file contains the ROM of your Apple II+.
                        It is not distributed due to copyright issues.
			You have to fix this file by your own. If you
			have been running another emulator, you can
			probably use its ROM files directly. Technically
			speaking, this file is a memory dump of the
			consecutive addresses from D000 to FFFF.

slot6.rom (256 bytes)	Memory dump of the consecutive addresses from
			C600 to C6FF. This file is not distributed
                        either due to the same reasons as above.

character.rom		This file is distributed.

Other important files
---------------------

.apple2			This file is distributed. The file contains default
			parameter settings. The most important parameter is
			the setting of the system path, i.e. the directory
			where the three vital system files are stored. The
			other parameters can be changed during run time
			via the interface (activated by pressing F10).

                        Parameters (that can be set in .apple2):

			speed = <percentage>%	  Speed of the emulator
			path = <directory>        Diskette database directory
			color = off		  Monochrome mode
				on		  Plain color mode
				interpolated	  Interpolated color mode
			sound = off		  Silent mode
			        pc speaker	  Sound through PC speaker
			joystick = off		  Joystick disabled
				   linear	  Linear joystick mode
				   digital	  (Atari) digital joystick mode
						          not yet supported
			origin_x = 0-255	  Origin of the joystick (X)
			origin_y = 0-255	  Origin of the joystick (Y)
			sensitivity <percentage>% Joystick sensitivity
			system_path = <directory> Directory where the system
						  files are stored.

a2d.info		An example is distributed. This file contains
			information for various diskettes kept in the database.

			Syntax:
			{<Name of diskette>}      i.e. the name is written
						  within curly braces.
			<Any information...>
			
			{<Name of another diskette>}  ... etc.

3. Keyboard & keys
==================

F1			To switch diskettes in Drive A, Slot 6
F2			To switch diskettes in Drive B, Slot 6
F4			Pause
F5			Keyboard layout
F8			Words from the author
F9			Toggle between maximum speed and configured speed.
F10			General parameter settings
Print Screen/SysRq	Apple II Reset key
Pause/Break		Reboot Apple II emulator

The numeric keypad is used for joystick emulation.

Delete			Joystick button 0
End			Joystick button 1
Page Down		Joystick button 2

4. Diskette database
====================

The diskettes are provided as plain binary files. These are actually
raw dumps, containg the tracks from 0 to 34 where each track is
partitioned into sectors numbered from 0 to 15. Each sector is 256
bytes.  Hence, the data is organized as the following:

File offset (in bytes)          Sector    	Track
----------------------          ------          -----
0				0		0
256				1		0
512				2		0
.				.		.
.				.		.
.				.		.
3840                            15		0
4096				0		1
4352				1		1
.				.		.
.				.		.
.				.		.
143104				15		34

To transfer Apple II diskettes into this format requires that you own
an original Apple II. Since the drives provided by the IBM PC:s are
not compatible with the original Apple II drives there are no
conversion programs directly available. If you have used other Apple
II emulators it is most likely that the files will work with this
emulator too. It seems to be a common standard to structure the
diskettes in the above described way, e.g. the Apl2em (emulator) for
DOS uses the same structure.

Emulated diskettes MUST have the .a2d (abbreviation to "Apple 2
Diskette") extension, otherwise the emulator will not recognize the
file as a valid diskette. However, it is valid to compress them by
using gnu-zip (then the extension becomes .a2d.gz). The emulator will
automatically decompress/compress them whenever required. The only
exception is the initial bootable diskette, which is always named as
disk_s6d1 (i.e. without the .a2d extension).

Note that you can add information/documentation for the a2d-diskettes
by using an oridnary text editor and edit the file "a2d.info". The
name of the diskette is written in curly braces (without the .a2d
extension) followed by any information.

5. Future plans
===============

I intend to improve the emulator. Actually, for the next major release
(i.e. version 1.00) the emulator will be entirely rewritten. For minor
changes, see file CHANGES.

6. Status of the current emulator
=================================

Works in standard VGA 			 	Y
Works in SVGA (then using SVGA facilities)	Y
Disk drive emulation (slot 6)			Y
Disk drive emulation (slot 5)			N (release 1.00)
High resolution emulation			Y
Low resolution emulation			Y
Mixed mode (in all resolution modes)		Y
Correct color emulation	(both Low and Hi-res)	Y
Interpolated color emulation			Y
Configurable speed				Y
Diskette switching				Y
Diskette database				Y
Interface for parameter settings, etc.		Y
Sound emulation (PC speaker)			Y
Flashing text					Y
Joystick emulation through numeric keypad	Y
Virtual console switching			Y (only when emu. is paused)
Raw keyboard mode (reading scancodes)		Y
Undocumented 6502 instructions			Y
Language card (i.e. additonal 16k RAM)		Y
Serial card					N (maybe release 1.00)
Works on DOS					N (AND NEVER WILL)

7. Can you port this to DOS?
============================

No, for two reasons. The first, and probably the most important, is
that the current emulator use kernel specific issues that are not, and
never will be, available in DOS. Future emulators will be based on the
same principles, so the emulator will never run in DOS. The second
reason is that DOS is a bad operating system. It is a pain in the neck
to write and debug programs in DOS and there is no usable memory
management provided by the kernel (if the DOS "interrupts" can be
called a "kernel" at all).

With this free software I hope that more users will switch to Linux
(which is a great operating system) and I have a dream that one day,
DOS will become a minority.

8. Availability
===============

This distribution is available at ftp.funet.fi and tsx-11.mit.edu and
sites mirroring these.

9. Known problems
=================

Problem: SVGAlib version 1.08 adds a Ctrl-C detection in RAW keyboard
         mode, but I don't know how to disable it. (I still haven't
         figured out how to disable it, perhaps time to contact the
         SVGAlib fellows.)

Solution: Please use SVGAlib version 1.05, 1.06 or 1.07.

Problem: The REPT (repeat) key doesn't work.

Answer: True. I was too lazy to implement it.

10. Changes since 0.00 (see file CHANGES)
=========================================

11. Final words
===============

Note that albeit you can switch between digital and linear joystick
emulation, only linear mode is presently supported. I still haven't
figured out how the atari (digital) joystick emulation works, so I'll
save it to the next release (as I said in the previous release :-) )

I hope you will enjoy this emulator. I do. Many games (that I have
ported) works perfectly, even those that use undocumented 6502
instructions. Suggestions to improvements are welcome. My email
address will be valid at least one more year, i.e. as long as I am a
computer science student at the University of Uppsala in Sweden.

    / Alexander Jean-Claude Bottema (Email: d91a1bo@meryl.csd.uu.se)
      Oct. 9 1994  15:44:21
