readme.md

Chip 8 Emulator

Table of Contents

1. About The Project
2. Getting Started
   • Requirements
   • Installation
3. Usage
4. ROMs
5. MAN Page
6. Mentions

About the Project

This Chip8 Emulator is a hobby project to learn more about emulators. It's written in Rust and uses SDL2 for rendering and user input.

It's still WIP.

Getting Started

Requirements

You need rust.

Installation

git clone https://github.com/CHC0815/chip8.git

cd chip8

RUN:

cargo run -- (emu|dis|dbg) (path to rom)

BUILD:

cargo build --release

Output file: ./target/release/chip8

Usage

Emulate a ROM

chip8 emu rom.ch8

Disassemble a ROM

chip8 dis rom.ch8

Debug a ROM

chip8 dbg rom.ch8

For help on how to use the debugger. Enter h in the debugger.

ROMs

Most of the roms are from https://github.com/Timendus/chip8-test-suite

MAN Page

man -l chip8.1

Mentions

Cowgod's Chip8 Technical Reference v1.0