Olympia is a gameboy emulator and toolkit, intended to run as a native or web assembly application targeting a cycle count accurate emulation.
Currently it is in a very early stage, with CPU instruction set emulation and a CLI debugger and disassembler completed.
Completed features:
- Most CPU instructions (except power saving)
- DMA transfers
- CLI Debugger
- PPU window/bg tile calculation
- Native GUI rendering with GTK
Missing features:
- Web UI
- PPU sprite tiles
- Input
- Power saving modes
- Audio
olympia_core - This module is used for core data structures and shared utilities that are required in both the engine crate
and the derive crate which is used to generate code for the engine crate. This should not use std, only alloc and core.
olympia_derive - This module is used to generate custom derives for instructions, allowing introspection at runtime as
used in the debugger and disassembler.
olympia_engine - This is the emulation engine for Olympia, inteded for use across various frontends. Because it needs to run in both a native application and a WebAssembly module, it must work in a no_std environment - alloc and core are allowed. The std feature is allowed to use libraries from std, but should not be used for any essential functionality.
olympia_cli - This provides a CLI that currently allows you to print ROM metadata or interactively debug execution.
olympia_native - This provides a native UI to run the emulator
Run cargo test
If writing tests that use GTK, make sure to wrap them in test_utils::with_unloaded_emu or test_utils::with_loaded_emu to properly handle GTK setup and running on a single thread.
Olympia is licensed under the GPL v3+, available at LICENSE.txt. (c) Tony Finn 2019
Some documentation (in /docs) and test ROMs (in /res) in this repo are under different licenses. For test roms, if the ROM itself was not created as part of Olympia, the original author and license will be listed in a .txt file alongside the .gb file.