Skip to content

Commit

Permalink
Prepare for release.
Browse files Browse the repository at this point in the history
  • Loading branch information
bustatu committed Sep 20, 2021
1 parent f9ac13d commit f6efbc1
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 18 deletions.
21 changes: 4 additions & 17 deletions README.md
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)
2 changes: 1 addition & 1 deletion menus/main_menu.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ void MenuState::update(double dt)
{
Gameboy::Emu* state = new Gameboy::Emu();
stateM -> changeState(state);
state -> loadROM("data/gameboy/roms/tests/dmg-acid2.gb");
state -> loadROM("data/gameboy/roms/Tetris.gb");
}
}

Expand Down

0 comments on commit f6efbc1

Please sign in to comment.