64 lines
1.7 KiB
Markdown
64 lines
1.7 KiB
Markdown
# yacemu (Yet Another Chip Eight Emulator)
|
|
A Chip-8 emulator (interpereter) written in C. Depends on SDL2.
|
|
|
|
### Building & Testing
|
|
|
|
In order to run yacemu, you must have sdl2 and make installed.
|
|
|
|
Once you have the dependencies installed, you can build the emulator with:
|
|
```shell
|
|
make build
|
|
```
|
|
|
|
You can build start the emulator with:
|
|
```shell
|
|
make run ROM_FILE=[PATH_TO_YOUR_ROM]
|
|
```
|
|
|
|
If you would like to run it in turbo mode (faster emulation, useful for testing) then run:
|
|
```shell
|
|
make run-turbo ROM_FILE=[PATH_TO_YOUR_ROM]
|
|
```
|
|
|
|
If you would like to debug with gdb then run:
|
|
```shell
|
|
make debug ROM_FILE=[PATH_TO_YOUR_ROM]
|
|
```
|
|
|
|
If you would like to debug with gdb in turbo mode then run:
|
|
```shell
|
|
make debug-turbo ROM_FILE=[PATH_TO_YOUR_ROM]
|
|
```
|
|
|
|
### Running
|
|
|
|
If you have a binary, you can run it with the following:
|
|
|
|
```shell
|
|
yacemu [PATH_TO_YOUR_ROM]
|
|
```
|
|
|
|
If you would like to run it in turbo mode (faster emulation, useful for testing) then run:
|
|
|
|
```shell
|
|
yacemu [PATH_TO_YOUR_ROM] turbo
|
|
```
|
|
|
|
### Todo
|
|
- [x] Graphics
|
|
- [x] Corax+ Required Instructions
|
|
- [x] Proper Flag Handling
|
|
- [ ] Working Input
|
|
- [ ] Rest of Instructions
|
|
- [ ] Tetris Working Running
|
|
- [ ] Extended instruction set (MEGACHIP, SUPER CHIP-48)
|
|
- [ ] Add my own custom instructions
|
|
- [ ] Write a ROM that uses the above instructions
|
|
|
|
### Screenshots
|
|
|
|
|
|
|
|
|
|
|