1mGBA
  2====
  3
  4mGBA is a new emulator for running Game Boy Advance games. It aims to be faster and more accurate than many existing Game Boy Advance emulators, as well as adding features that other emulators lack.
  5
  6Up-to-date news and downloads can be found at [endrift.com/mgba](https://endrift.com/mgba/).
  7
  8Features
  9--------
 10
 11- Near full Game Boy Advance hardware support[<sup>[1]</sup>](#missing).
 12- Fast emulation. Known to run at full speed even on low end hardware, such as netbooks.
 13- Qt and SDL ports for a heavy-weight and a light-weight frontend.
 14- Save type detection, even for flash memory size[<sup>[2]</sup>](#flashdetect).
 15- Real-time clock support, even without configuration.
 16- A built-in BIOS implementation, and ability to load external BIOS files.
 17- Turbo/fast-forward support by holding Tab.
 18- Frameskip, configurable up to 9.
 19- Screenshot support.
 20- 9 savestate slots. Savestates are also viewable as screenshots.
 21- Video and GIF recording.
 22- Remappable controls for both keyboards and gamepads.
 23- Loading from ZIP files.
 24- IPS and UPS patch support.
 25- Game debugging via a command-line interface (not available with Qt port) and GDB remote support.
 26
 27### Planned features
 28
 29- Local and networked multiplayer link cable support ([Bug #1](https://endrift.com/mgba/bugs/show_bug.cgi?id=1)).
 30- Dolphin/JOY bus link cable support ([Bug #73](https://endrift.com/mgba/bugs/show_bug.cgi?id=73)).
 31- Cheat codes ([Bug #58](https://endrift.com/mgba/bugs/show_bug.cgi?id=58)).
 32- Re-recording support for tool-assist runs. ([Bugzilla keyword "TASBlocker"](https://endrift.com/mgba/bugs/buglist.cgi?quicksearch=TASBlocker))
 33- Lua support for scripting ([Bug #62](https://endrift.com/mgba/bugs/show_bug.cgi?id=62)).
 34- A comprehensive debug suite ([Bug #132](https://endrift.com/mgba/bugs/show_bug.cgi?id=132)).
 35- libretro core for RetroArch and OpenEmu ([Bug #86](https://endrift.com/mgba/bugs/show_bug.cgi?id=86)).
 36
 37
 38Supported Platforms
 39-------------------
 40
 41- Windows Vista or newer
 42- OS X 10.7 (Lion)[<sup>[3]</sup>](#osxver) or newer
 43- Linux
 44- FreeBSD
 45
 46Other Unix-like platforms work as well, but are untested.
 47
 48### System requirements
 49
 50Requirements are minimal. Any computer that can run Windows Vista or newer should be able to handle emulation. Support for OpenGL 1.1 or newer is also required.
 51
 52Downloads
 53---------
 54
 55Downloads can be found on the official website, in the [Downloads][downloads] section. The source code can be found on [GitHub][source].
 56
 57Controls
 58--------
 59
 60Controls are configurable in the menu. The default gamepad controls are mapped so as to work with a DualShock 3. The default keyboard controls are as follows:
 61
 62- **A**: X
 63- **B**: Z
 64- **L**: A
 65- **R**: S
 66- **Start**: Enter
 67- **Select**: Backspace
 68
 69Compiling
 70---------
 71
 72Compiling requires using CMake 2.8.11 or newer. To use CMake to build on a Unix-based system, the recommended commands are as follows:
 73
 74	mkdir build
 75	cd build
 76	cmake ..
 77	make
 78	make install
 79
 80Dependencies that are installed will be automatically detected, and features that are disabled if the dependencies are not found will be shown at the end of the `cmake` command.
 81
 82### Dependencies
 83
 84mGBA has no hard dependencies, however, the following optional dependencies are required for specific features. The features will be disabled if the dependencies can't be found.
 85
 86- Qt 5: for the GUI frontend. Qt Multimedia or SDL are required for audio.
 87- SDL: for a more basic frontend and gamepad support in the Qt frontend. SDL 2 is recommended, but 1.2 is supported.
 88- zlib and libpng: for screenshot support and savestate-in-PNG support.
 89- libedit: for command-line debugger support.
 90- ffmpeg or libav: for video recording.
 91- libzip: for loading ROMs stored in zip files.
 92- ImageMagick: for GIF recording.
 93
 94Footnotes
 95---------
 96
 97<a name="missing">[1]</a> Currently missing features are
 98
 99- OBJ window for modes 3, 4 and 5 ([Bug #5](https://endrift.com/mgba/bugs/show_bug.cgi?id=5))
100- Mosaic for transformed OBJs ([Bug #9](https://endrift.com/mgba/bugs/show_bug.cgi?id=9))
101- Cartridges with light sensors (Boktai: The Sun is in Your Hand and Boktai 2: Solar Boy Django) ([Bug #46](https://endrift.com/mgba/bugs/show_bug.cgi?id=46))
102- BIOS call RegisterRamReset is currently stubbed out ([Bug #141](https://endrift.com/mgba/bugs/show_bug.cgi?id=141))
103- Audio channel reset flags ([Bug #142](https://endrift.com/mgba/bugs/show_bug.cgi?id=142))
104- Cartridges with tilt sensors (Yoshi's Universal Gravitation/Yoshi's Topsy-Turvy) ([Bug #143](https://endrift.com/mgba/bugs/show_bug.cgi?id=143))
105
106<a name="flashdetect">[2]</a> Flash memory size detection does not work in some cases, and may require overrides, which are not yet user configurable. Filing a bug is recommended if such a case is encountered.
107
108<a name="osxver">[3]</a> 10.7 is only needed for the Qt port. The SDL port is known to work on 10.6, and may work on older.
109
110[downloads]: https://endrift.com/mgba/downloads.html
111[source]: https://github.com/mgba-emu/mgba/
112
113Copyright
114---------
115
116mGBA is Copyright © 2013 – 2014 Jeffrey Pfau. It is distributed under the [Mozilla Public License version 2.0](https://www.mozilla.org/MPL/2.0/). A copy of the license is available in the distributed LICENSE file.
117
118mGBA contains [inih](https://code.google.com/p/inih/), which is copyright © 2009 Brush Technology and used under a BSD 3-clause license.