add flag support and update README
This commit is contained in:
parent
682175e8de
commit
84aa309a29
4 changed files with 155 additions and 53 deletions
51
README.md
51
README.md
|
|
@ -1,12 +1,56 @@
|
|||
# yacemu (Yet Another Chip Eight Emulator)
|
||||
A Chip-8 emulator written in C. Depends on SDL2.
|
||||
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
|
||||
- [ ] Rest of Instructions
|
||||
- [x] Proper Flag Handling
|
||||
- [ ] Working Input
|
||||
- [ ] Tetris Running
|
||||
- [ ] 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
|
||||
|
|
@ -16,3 +60,4 @@ A Chip-8 emulator written in C. Depends on SDL2.
|
|||

|
||||

|
||||

|
||||

|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue