Skip to content

Commit a39243c

Browse files
README tweaks
1 parent 8b5925b commit a39243c

1 file changed

Lines changed: 25 additions & 17 deletions

File tree

README.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
# A CHIP-8 interpreter for Apple II / ProDOS-8
22

3-
CHIP-8 is a fantasy video game console definition from the 1970s by Joseph Weisbecker.
4-
5-
References:
6-
7-
* https://en.wikipedia.org/wiki/CHIP-8
8-
* https://github.com/mattmikolay/chip-8/
9-
* https://tobiasvl.github.io/blog/write-a-chip-8-emulator/
10-
* https://github.com/Timendus/chip8-test-suite
3+
[CHIP-8](https://en.wikipedia.org/wiki/CHIP-8) is a fantasy video game console definition from the 1970s by Joseph Weisbecker.
114

125
This version runs on Apple II models that support Double Low Resolution graphics (DGR):
136

@@ -20,15 +13,28 @@ This version runs on Apple II models that support Double Low Resolution graphics
2013
* Clones such as the Laser 128, Franklin ACE 2200, Franklin ACE 500
2114
* Emulators such as MAME, Virtual ][, AppleWin, etc.
2215

23-
It runs in ProDOS-8 and follows the "interpreter protocol" so that launchers such as Bitsy Bye and Apple II DeskTop can automatically launch CHIP-8 programs with it, when appropriately configured.
16+
It runs in ProDOS-8 and follows the "interpreter protocol" so that launchers such as [Bitsy Bye](https://prodos8.com/bitsy-bye/) and [Apple II DeskTop](https://a2desktop.com) can automatically launch CHIP-8 programs with it.
2417

2518
# For Users
2619

27-
If distributed on a disk with [ProDOS-8 2.4](https://prodos8.com/) and the file is named `BASIS.SYSTEM` then files selected in [Bitsy Bye](https://prodos8.com/bitsy-bye/) will launch with the interpreter automatically.
20+
To run a CHIP-8 program, copy the file to a [ProDOS-8 2.4](https://prodos8.com/) with the `CHIP8.SYSTEM` renamed to (or copied as) `BASIS.SYSTEM`, then boot the disk. [Bitsy Bye](https://prodos8.com/bitsy-bye/) will run. Pick the CHIP-8 file and it will run automatically.
2821

2922
> TIP: [Apple II DeskTop](https://a2desktop.com) will use a copy of `BASIS.SYSTEM` in the same directory to launch unknown file types.
3023
31-
* Press <kbd>Esc</kbd> at any time to return to ProDOS.
24+
## CHIP-8 Programs
25+
26+
There are many online archives of CHIP-8 programs:
27+
28+
* https://johnearnest.github.io/chip8Archive/?sort=platform#chip8
29+
* https://chip-8.github.io/links/
30+
* https://github.com/kripod/chip8-roms
31+
* https://www.zophar.net/pdroms/chip8/chip-8-games-pack.html
32+
33+
> NOTE: Only CHIP-8 games are supported, not SUPER-CHIP or XO-CHIP.
34+
35+
## Controls
36+
37+
* Press <kbd>Esc</kbd> at any time to quit to ProDOS.
3238
* Press <kbd>9</kbd> and <kbd>0</kbd> to change border colors.
3339
* Press <kbd>[</kbd> and <kbd>]</kbd> to change background colors.
3440
* Press <kbd>,</kbd> and <kbd>.</kbd> to change foreground colors.
@@ -52,13 +58,9 @@ Use these keys on a QWERTY keyboard instead:
5258
|<kbd>A</kbd>|<kbd>S</kbd>|<kbd>D</kbd>|<kbd>F</kbd>|
5359
|<kbd>Z</kbd>|<kbd>X</kbd>|<kbd>C</kbd>|<kbd>V</kbd>|
5460

55-
## CHIP-8 Programs
56-
57-
* https://johnearnest.github.io/chip8Archive/?sort=platform#chip8
58-
59-
> Note that only CHIP-8 ("chip8") games are supported, not SUPER-CHIP ("schip") or XO-CHIP ("xochip").
61+
> TIP: CHIP-8 programs use a variety of key combinations. Look for documentation where you found the program, or mash the keys to figure out the controls. Have fun!
6062
61-
CHIP-8 programs can be copied to a ProDOS disk and launched using Bitsy Bye, as long as `CHIP8.SYSTEM` has been placed on the disk and renamed `BASIS.SYSTEM`.
63+
### Compatibility & Quirks
6264

6365
Some CHIP-8 programs require different compatibility settings. This can be enabled by changing the ProDOS file type of the program to `$5D` (`ENT` or Entertainment), and setting the aux type to `$C800` (for "CHIP-8") with the lower byte used as "quirks" flags as follows:
6466

@@ -87,6 +89,12 @@ For detailed "quirks" definitions, see https://github.com/Timendus/chip8-test-su
8789
8890
# For Developers
8991

92+
## Development References
93+
94+
* https://tobiasvl.github.io/blog/write-a-chip-8-emulator/
95+
* https://github.com/Timendus/chip8-test-suite
96+
* https://chip-8.github.io/
97+
9098
## Building
9199

92100
Fetch, build, and install [cc65](http://cc65.github.io/cc65/) (in a separate directory):

0 commit comments

Comments
 (0)