Max/SameBoy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Lior Halphon 2016-10-29 22:54:32 +03:00 committed by GitHub
parent 388fb600de
commit 15f6412581
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -6,20 +6,20 @@ SameBoy is an open source Gameboy (DMG) and Gameboy Color (CGB) emulator, writte
Features common to both Cocoa and SDL versions: Features common to both Cocoa and SDL versions:
* Supports Gameboy (DMG) and Gameboy Color (CGB) emulation * Supports Gameboy (DMG) and Gameboy Color (CGB) emulation
* Lets you choose the model you want to emulate regardless of ROM * Lets you choose the model you want to emulate regardless of ROM
* High quality 96KHz audio
* Battery save support
* Save states
* Includes open source DMG and CGB boot ROMs: * 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 * 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 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. * 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 * Support for games with a non-Nintendo logo in the header
* No long animation in the DMG boot * No long animation in the DMG boot
* Has a text-based debugger with an expression evaluator * Advanced text-based debugger with an expression evaluator, disassembler, conditional breakpoints, conditional watchpoints, backtracing and other features
* Emulates [PCM_12 and PCM_34 registers](https://github.com/LIJI32/GBVisualizer) * 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 * Emulates LCD timing effects, supporting the Demotronic trick, [GBVideoPlayer](https://github.com/LIJI32/GBVideoPlayer) and other tech demos
* Accurate instruction and memory timings * Extermely high accuracy
* Real time clock emulation * Real time clock emulation
* High quality 96KHz audio
* Battery save support
* Save states
Features currently supported only with the Cocoa version: 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 * Native Cocoa interface, with support for all system-wide features, such as drag-and-drop and smart titlebars
@ -29,7 +29,7 @@ Features currently supported only with the Cocoa version:
* GameBoy Camera support * GameBoy Camera support
## Compatibility ## Compatibility
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. The latest results for SameBoy's automatic tester are available [here](http://htmlpreview.github.io/?https://github.com/LIJI32/SameBoy/blob/automation_results/results.html). 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](https://github.com/LIJI32/SameBoy/issues/new) any broken ROM. The latest results for SameBoy's automatic tester are available [here](http://htmlpreview.github.io/?https://github.com/LIJI32/SameBoy/blob/automation_results/results.html).
## Compilation ## Compilation
SameBoy requires the following tools and libraries to build: SameBoy requires the following tools and libraries to build:
@ -44,6 +44,6 @@ On Windows, SameBoy also requires:
* [GnuWin](http://gnuwin32.sourceforge.net/) * [GnuWin](http://gnuwin32.sourceforge.net/)
* Running vcvars32 before running make. Make sure all required tools and libraries are in %PATH% and %lib%, repsectively. * Running vcvars32 before running make. Make sure all required tools and libraries are in %PATH% and %lib%, repsectively.
To compile, simply run `make`. The targets are cocoa (Default for OS X), sdl (Default for everything else) and bootroms. You may also specify CONF=debug (default) or CONF=release to control optimization and symbols, and specify BOOTROMS_DIR=... to a directory containing precomiled dmg_boot.bin and cgb_boot.bin files, otherwise the build system will compile and use SameBoy's own boot ROMs. To compile, simply run `make`. The targets are cocoa (Default for OS X), sdl (Default for everything else), bootroms and tester. You may also specify CONF=debug (default) or CONF=release to control optimization and symbols, and specify BOOTROMS_DIR=... to a directory containing precompiled dmg_boot.bin and cgb_boot.bin files, otherwise the build system will compile and use SameBoy's own boot ROMs.
SameBoy was compiled and tested on OS X, Ubuntu and Windows 7 32-bit. SameBoy was compiled and tested on OS X, Ubuntu and Windows 7 32-bit.