Skip to content

Timendus/chip-8

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

83 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Warning

This project has been discontinued and is only still online for posterity. It is in no way a good example, or even a valid reference, of a CHIP-8 interpreter!

  • If you're looking for a nice web based CHIP-8 interpreter, check out my project Silicon8.
  • If you're looking for a good web based CHIP-8 IDE slash assembler, check out Octo.
  • If you're working on your own CHIP-8 interpreter, you may appreciate my CHIP-8 test suite.

CHIP-8 fun

Just a fun project that began when I had a free Saturday and wrote much of the emulator in a 24-hour programming spree. I've added an assembler over Christmas, again finding myself with some free time on my hands. Besides learning more about writing emulators and assemblers and having some fun, this has absolutely no practical purpose. And that's the whole idea of having fun in your spare time, isn't it? 😉

The emulator

See it in action at https://timendus.github.io/chip-8/. You can find some CHIP-8 programs here (and everywhere else on the internet, just Google) or you can try my own simple creations. Just download the binaries (*.ch8 seems to be the convention) and load them into the emulator ("Load file" button on the right).

Or if you're the tinkering kind of person, open the *.asm files from my playthings and copy'n'paste them into the code editor on the left. Clicking "Assemble & Run" should get you going. See The assembler below for more information.

Reliability

Note that there are no guarantees that this thing is bug-free. In fact, I found a couple of side effects to opcodes being documented differently by different sources. Hard to tell which is the right implementation. Also, I have no idea at what speed this thing is supposed to run, other than that the timers run at 60Hz.

But other than that, most programs seem to run pretty well. If you find a bug with the emulator still, please make a PR or at least submit an issue 😄

Debugging features

When you load a program, it gets disassembled to the "Disassembler" tab. You can also see the currently running instructions in the browser console by toggling "Log opcodes". Note that this outputs a lot of instructions, pretty quickly. So this is mostly useful for stepping through the code. Combined with the "Debugger" tab, this should make it pretty usable as a development emulator.

Keys

The keypad of CHIP-8 is pretty weird. You can click any of the keys (with the mouse or a touch screen) to trigger them. Also, you can press any of the keys on your physical keyboard that correspond to the labels on the virtual keys (0-9 and A-F). As an extra, I have bound the cursor keys to 2, 4, 6 and 8 and the space bar to 5, which is what many games seem to use.

Is it an emulator though..?

No, it's probably more of an interpreter. Or a virtual machine. Depends on your definitions. But I like the word emulator better in this case, because the bytecode for CHIP-8 so closely resembles assembler for real hardware. And also because I tried to make it look like a "device" 😉

The assembler

Having played with z80 assembler a lot, years ago, I thought it would be fun to have an assembler too. Just something simple that would allow me to see if this super limited instruction set is of any use in actually writing programs.

I have to admit that I didn't really like the instruction set. But I didn't hate it either, it's probably "fixable" 😉. In my opinion it mostly really misses push and pop. I had a hard time keeping all my registers safe without it. Also, having just one word-sized index register (i) makes it tricky to do the simplest things like keeping track of which character you're outputting while also looking up the sprite data for that character. I used an offset register to work around this in my hello_world program.

Opcodes and syntax

I couldn't find much information on what is "normal" syntax for CHIP-8 assembler, so I just based mine on z80 with some extra instructions. I'm sure if you take a look at the examples (and maybe read up on CHIP-8 a little) you'll get the hang of it in no time.

Reliability

Note that all the warnings about the reliability of the emulator above are equally applicable to the assembler 😂

Usage on the command line

Besides the web version you can use the assembler from the command line too:

$ cd src/assembler
$ npm install
$ ./asm.js

You need to specify a file to assemble.

./asm.js --file myprogram.asm [--output binary.ch8] [--outputModel] [--outputLabels]

If you don't specify an output file with the --output flag, it will just spit out bytes to the console in HEX format.

The command line syntax could be much better, but my goal with this was to have an editor and an assembler in the webbrowser. For some on-the-go fun.