SameBoy/README.md

48 lines
2.8 KiB
Markdown
Raw Normal View History

2016-04-01 19:15:21 +00:00
# SameBoy
SameBoy is an open source Gameboy (DMG) and Gameboy Color (CGB) emulator, written in portable C. It has a native Cocoa frontend for OS X, and an incomplete experimental SDL frontend for other operating systems. It also includes a text-based debugger with an expression evaluator.
## Features
Features common to both Cocoa and SDL versions:
* Supports Gameboy (DMG) and Gameboy Color (CGB) emulation
* Lets you choose the model you want to emulate regardless of ROM
* Includes open source DMG and CGB boot ROMs:
* Complete support for (and documentation of) *all* game-specific palettes in the CGB boot ROM, for accurate emulation of Gameboy games on a Gameboy Color
* Supports manual palette selection with key combinations, with 4 additional new palettes (A + B + direction)
* Supports palette selection in a CGB game, forcing it to run in 'paletted' DMG mode, if ROM allows doing so.
* Support for games with a non-Nintendo logo in the header
* No long animation in the DMG boot
* Has a text-based debugger with an expression evaluator
* Emulates [PCM_12 and PCM_34 registers](https://github.com/LIJI32/GBVisualizer)
* Emulates LCD timing effects, supporting the Demotronic trick, [GBVideoPlayer](https://github.com/LIJI32/GBVideoPlayer) and other tech demos
* Accurate instruction and memory timings
* Real time clock emulation
Features currently supported only with the Cocoa version:
* Native Cocoa interface, with support for all system-wide features, such as drag-and-drop and smart titlebars
* Retina display support, allowing a wider range of scaling factors without artifacts
* High quality 96KHz audio
* Battery save support
* Save states
* Optional frame blending
* Several [scaling algorithms](SCALING.md) (Including exclusive algorithms like OmniScale and Anti-aliased Scale2x)
2016-04-01 19:15:21 +00:00
## Compatibility
2016-08-20 15:15:15 +00:00
SameBoy passes many of [blargg's test ROMs](http://gbdev.gg8.se/wiki/articles/Test_ROMs#Blargg.27s_tests), as well as most of [mooneye-gb's](https://github.com/Gekkio/mooneye-gb) acceptance tests. SameBoy should work with most games and demos, please report any broken ROM.
2016-04-01 19:15:21 +00:00
## Compilation
SameBoy requires the following tools and libraries to build:
* clang
* make
* Cocoa port: OS X SDK and Xcode command line tools
* SDL port: SDL.framework (OS X) or libsdl (Other platforms)
* [rgbds](https://github.com/bentley/rgbds/releases/), for boot ROM compilation
2016-08-20 15:15:15 +00:00
On Windows, SameBoy also requires:
* Visual Studio (For headers, etc.)
* [GnuWin](http://gnuwin32.sourceforge.net/)
* Running vcvars32 before running make. Make sure all required tools and libraries are in %PATH% and %lib%, repsectively.
To compile, simply run: <code>make [CONF=(release|debug)] (cocoa|sdl|bootroms)</code>
SameBoy was compiled and tested on OS X, Ubuntu and Windows 7 32-bit.