-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
5 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,14 @@ | ||
# Emulator Engine | ||
|
||
A CHIP8, Bytepusher and Gameboy (WIP) emulator. | ||
A CHIP8, Bytepusher and Gameboy emulator. | ||
|
||
## How to build | ||
|
||
First you need to install *vcpkg* and download the *sdl2* and *sdl2-ttf* packages from it. | ||
|
||
Depending on your platform, make a build file called *build.sh* or *build.bat* with the following contents, changing the contents in <> to fit your requirements: | ||
|
||
```shell | ||
mkdir build | ||
cmake -S . -B build -G Ninja -DCMAKE_TOOLCHAIN_FILE=<Path to vcpkg>/scripts/buildsystems/vcpkg.cmake -DCMAKE_BUILD_TYPE=<Release \ Debug> | ||
cmake --build build | ||
``` | ||
|
||
After executing this, the executable should be in the */build/* file along with the */build/data/* folder. | ||
|
||
## Currently supported platforms: | ||
## Currently supported platforms and their issues: | ||
- Bytepusher | ||
- works perfectly, open an issue if something unexpected happens. | ||
- CHIP8 | ||
- might have some unsuported SCHIP or XOCHIP opcodes, open an issue if so. | ||
- Gameboy | ||
- no APU is implemented. | ||
- only MBC1, MBC3 (partially) and MBC5 are implemented. | ||
- NES (soon) | ||
- NES (soon) | ||
- PS1 (maybe) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters