Apple-2-Tools/Epple-II
1
0
Fork 0
mirror of https://github.com/cmosher01/Epple-II.git synced 2024-12-22 14:29:35 +00:00
Code Issues Projects Releases Wiki Activity

fix docs for WOZ, file-dialog, displays, other

Browse Source
This commit is contained in:
Christopher Mosher 2019-01-02 23:03:35 -05:00
parent eba0a8f4fd
commit b803a04260
3 changed files with 22 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/commands.asciidoc
View File

@ -91,33 +91,29 @@ anchor:load[]
==== load
The +load+ command loads a (nibble) floppy disk image into one of the emulated disk drives.
The +load+ command loads a https://applesaucefdc.com/woz/[WOZ 2.0 format] floppy disk image into one of the emulated disk drives.
--------
load slot <slot> drive <drive> <file-path>
load slot <slot> drive <drive> [ <file-path> ]
--------
+<slot>+ Slot number, 0 through 7, of Disk ][ controller card to load the nibble image into.
+<slot>+ Slot number, 0 through 7, of Disk ][ controller card to load the disk image into.
+<drive>+ Drive number, 1 or 2, of the disk drive on the controller card to load the nibble image into.
+<drive>+ Drive number, 1 or 2, of the disk drive on the controller card to load the disk image into.
+<file-path>+ Path of the nibble floppy disk image to import.
+<file-path>+ Optional path of the disk image to import. If omitted, a dialog box will be presented to select the file to load.
The +load+ command will load a nibble image into a disk drive. Specify the slot that
The +load+ command will load a WOZ 2.0 image into a disk drive. Specify the slot that
contains a Disk ][ controller peripheral card, and specify which drive number (1 or 2).
[NOTE]
The floppy disk image MUST be a NIBBLE DISK IMAGE.
Other formats (for example, DOS order, +.do+, PRODOS order,
+.po+, +.dsk+, or anything else) must first be converted to nibble format. A nibble image contains
all 35 tracks, in order 0-36, each track being 6656 ($1A00) bytes long. Nibble image files
will generally have a filetype of +.nib+.
The floppy disk image MUST be a WOZ 2.0 DISK IMAGE.
Other formats (for example, nibble, +.nib+, DOS order, +.do+, PRODOS order,
+.po+, +.dsk+, or anything else) must first be converted to WOZ 2.0 format.
The best floppy disk image conversion tool I've found is http://ciderpress.sourceforge.net/[CiderPress],
for Windows (but it supposedly runs under Wine on Linux, too). Thanks to Andy McFadden.
You can use https://applesaucefdc.com/[Applesauce] to generate such files from original floppy disks. Or you can convert +.dsk+ or +.d13+ images using +to_woz2+ (source: https://github.com/cmosher01/Apple-II-Disk-Tools ).
@ -149,15 +145,13 @@ anchor:save[]
The +save+ command saves changes made on an emulated floppy disk back to the original image file.
--------
save slot <slot> drive <drive> <file-path>
save slot <slot> drive <drive>
--------
+<slot>+ Slot number, 0 through 7, of Disk ][ controller card to which the drive is attached.
+<drive>+ Drive number, 1 or 2, of the disk drive on the controller card to save.
+<file-path>+ Path of the nibble floppy disk image to import.
The +save+ command saves any changes that the emulated Apple ][ has made to the floppy
disk image. It is important to note that the emulator operates on the image only in memory, and does
not immediately write changes back to the real file. You need to issue the +save+ command

27
doc/display.asciidoc
View File

@ -1,7 +1,7 @@
=== Display
The orignal Apple ][s didn't come with a display. The user needed to use either a standard
television, or a monitor, to see the computer's output. The EPPLE ][ emulates a variety of
television or a monitor in order to see the computer's output. The EPPLE ][ emulates a variety of
displays; you can cycle between the different types using +F2+.
There are two major types of displays: televisions and monitors. Monitors generally have
higher quality (sharper) displays. The displays show the normal visible area of the NTSC
@ -9,8 +9,8 @@ video signal generated by the emulated Apple ][ machine.
==== Monitors
The emulator provides a color monitor, and three monochrome monitors (white, green, and orange).
These emulate standard, no-frills NTSC monitors. The most noticeable characteristic of monitors
The emulator provides a color monitor, and a green monochrome monitor.
These emulate standard, no-frills NTSC monitors. The most noticeable characteristic of a monitor
is the horizontal display of pixels. Monitors react faster than TVs, so two adjacent pixels will
not merge together; both will be distinctly visible, with blackness between them. For example,
type in the following Applesoft command, then cycle through the display types. The monitors
@ -22,28 +22,11 @@ GR : COLOR=4 : HLIN 10,20 AT 10
==== Televisions
There are two types of television displays, referred to as ``old'' and ``new.'' Each has color and
monochrome (commonly known as ``black and white'') varieties. Televisions react more slowly to
Televisions react more slowly to
changes in the incoming video signal than monitors do, and as a result, horizontal pixels will
merge together, forming a more uniform appearance. The ``new'' color TV display uses the pre-defined
color pallette (described below under ``Colors''), and the black and white TV uses the same
pallette, but fully desaturated. The ``old'' color TV is the most interesting. It emulates the
merge together, forming a more uniform appearance. EPPLE ]['s television mode emulates the
signal decoding circuitry of a real television. This includes separating out the ``chroma'' portion
of the incoming NTSC video signal using a filter algorithm, and _calculating_ the color to display.
It does not use the pre-defined colors.
[NOTE]
This mode is very CPU intensive, so your computer (that is, the one that EPPLE ][ is running on)
may not be able to run fast enough to run at the speed of the original Apple ][. The Apple ][ CPU
runs at about 1 MHz, but the video generator runs at 14 MHz; so the inner-most loop in the
EPPLE ][ must run 14 million times per second to keep up.
==== Colors
The color palatte used for the
color monitor and new color TV is pre-defined, and was determined through observation of a real
Apple ][ machine on a standard TV, the colors being matched by eye. The old color TV, however,
uses _algorithms_ to calculate the colors it displays.
==== Scan Lines

17
doc/keyboard.asciidoc
View File

@ -44,18 +44,13 @@ buffer is on.
* +F4+ Toggles between showing scan lines on the display, or duplicating
each scan line to the following line, to fill-in the otherwise black line.
* +F5+ Go to ``command entry'' mode.
* +F6+ Emulates the RESET key.
* +F7+ Pastes characters from the clipboard into the emulated Apple
(as if they had been typed on the keyboard).
* +F8+ Save a bitmap file of the current EPPLE ][ screen.
The file will be in the default directory, named +ep2_YYYYMMDDHHMMSS.bmp+.
* +F9+ Quit the EPPLE ][ program, immediately!
* +F10+ Emulates the REPT key.
* +F11+ Toggles between running the emulator at authentic speed
(1.02 MHz CPU), or as fast as possible.
* +F12+ Toggles the keyboard buffer.
* +Break+ Emulates the RESET key.
* +Insert+ Pastes characters from the clipboard into the emulated Apple
(as if they had been typed on the keyboard).
* +Print&nbsp;Screen+ Save a bitmap file of the current EPPLE ][ screen.
The file will be in the default directory, named +ep2_YYYYMMDDHHMMSS.bmp+.
* +End+ Quit the EPPLE ][ program, immediately!
[WARNING]
If you have modification to any floppy images or cassette images, and you
press the +End+ key, you will LOSE all those changes, unless you
save them first. See <<commands>> for the +save+ command.