My first attempt at a Gameboy Advance Emulator

Go to file

Rekai Nyangadzayi Musuka 647bd83224 chore(io): rewrite certain error messages We can do this now that we know that it won't be because of any unimplemented feature in some circumstances		2022-10-29 02:37:54 -03:00
.vscode	chore: remove reccomended extension	2022-01-23 23:13:16 -04:00
lib	chore: replace OpenGL 4.5 bindings with OpenGL 3.3	2022-10-17 20:31:42 -03:00
src	chore(io): rewrite certain error messages	2022-10-29 02:37:54 -03:00
.gitignore	chore(gitignore): update .gitignore	2022-10-21 04:40:55 -03:00
.gitmodules	chore: add zig-toml dependency	2022-10-13 00:27:18 -03:00
README.md	chore: update README	2022-10-21 02:59:43 -03:00
build.zig	feat: write default config.toml if it doesn't exist	2022-10-21 04:39:16 -03:00
example.toml	chore(config): change defaults in config.toml	2022-10-21 06:01:22 -03:00

README.md

ZBA (working title)

A Game Boy Advance Emulator written in Zig ⚡!

Scope

I'm hardly the first to write a Game Boy Advance Emulator nor will I be the last. This project isn't going to compete with the GOATs like mGBA or NanoBoyAdvance. There aren't any interesting ideas either like in DSHBA.

This is a simple (read: incomplete) for-fun long-term project. I hope to get "mostly there", which to me means that I'm not missing any major hardware features and the set of possible improvements would be in memory timing or in UI/UX. With respect to that goal, here's what's outstanding:

TODO

Affine Sprites
Windowing (see this branch)
Audio Resampler (Having issues with SDL2's)
Immediate Mode GUI
Refactoring for easy-ish perf boosts

Tests

jsmolka's GBA Test Collection
- arm.gba and thumb.gba
- flash64.gba, flash128.gba, none.gba, and sram.gba
- hello.gba, shades.gba, and stripes.gba
- memory.gba
- bios.gba
- nes.gba
DenSinH's GBA ROMs
- eeprom-test and flash-test
- midikey2freq
- swi-tests-random
destoer's GBA Tests
- cond_invalid.gba
- dma_priority.gba
- hello_world.gba
- if_ack.gba
- line_timing.gba
- lyc_midline.gba
- window_midframe.gba
ladystarbreeze's GBA Test Collection
- retAddr.gba
- helloWorld.gba
- helloAudio.gba
armwrestler-gba-fixed.gba
FuzzARM

Resources

Compiling

Most recently built on Zig 0.10.0-dev.4474+b41b35f57

Dependencies

bitfields.zig from FlorenceOS is included under lib/util/bitfield.zig.

Use git submodule update --init from the project root to pull the git submodules SDL.zig, zig-clap, known-folders, zig-toml and zig-datetime

Be sure to provide SDL2 using:

Linux: Your distro's package manager
MacOS: ¯\_(ツ)_/¯
Windows: vcpkg (install sdl2:x64-windows)

SDL.zig will provide a helpful compile error if the zig compiler is unable to find SDL2.

Once you've got all the dependencies, execute zig build -Drelease-fast. The executable is located at zig-out/bin/.

Controls

Key	Button
`X`	A
`Z`	B
`A`	L
`S`	R
`Return`	Start
`RShift`	Select
Arrow Keys	D-Pad