Skip to content

Latest commit

 

History

History
77 lines (53 loc) · 2.17 KB

README.md

File metadata and controls

77 lines (53 loc) · 2.17 KB

Chip8

Hardware emulation of chip8

Table of Contents

  1. Getting started
  2. Usage
  3. Controls
  4. Licenses
  5. Sources

Getting started

Clone the project files to your local repository:

  • HTTPS : https://github.com/edd-ie/Chip8_Emulator.git
  • SSH : [email protected]:edd-ie/Chip8_Emulator.git
  • Git CLI : gh repo clone edd-ie/Chip8_Emulator

Option 2 - download and extract the zip file

To run the program, open the terminal in the project folder.

./cmake-build-debug/Chip8_Emulator.exe 15 1 ./roms/1Tester.ch8

If this display then the program is working perfectly: App screenshot

Usage

To run the application you will require 3 values

./cmake-build-debug/Chip8_Emulator.exe <cmd1> <cmd2> <cmd3>
  • cmd1 - integer screen scaling, varies with monitors.
    • Tested with 10 - 40.
  • cmd2 - game run speed, varies with program, your choice.
    • Tested with 0.4 - 5.0 (lower == faster)
  • cmd - ROM location, you can add yours. Some ROMs have been sourced in roms folder.
    • Pick one and format it in this format ./roms/<rom_file>.ch8

Controls

To Quit the running application press esc

The chip 8 keypad was remapped for the keyboard

Keypad       Keyboard
+-+-+-+-+    +-+-+-+-+
|1|2|3|C|    |1|2|3|4|
+-+-+-+-+    +-+-+-+-+
|4|5|6|D|    |Q|W|E|R|
+-+-+-+-+ => +-+-+-+-+
|7|8|9|E|    |A|S|D|F|
+-+-+-+-+    +-+-+-+-+
|A|0|B|F|    |Z|X|C|V|
+-+-+-+-+    +-+-+-+-+

Licenses

The project is licensed under the GNU Affero General Public License v3.0

Sources

Research website - Cowgod's Chip-8 Technical Reference v1.0

A portion of the project were inspired by - Laurens Muller (CHIP-8 interpreter)