1mGBA
 2====
 3
 4mGBA is a new emulator for running Game Boy Advance games.
 5
 6Features
 7--------
 8
 9- Near full Game Boy Advance hardware support[<sup>[1]</sup>](#missing).
10- Fast emulation. Known to run at full speed even on low end hardware, such as netbooks.
11- Qt and SDL ports for a heavy-weight and a light-weight frontend.
12- Save type detection, even for flash memory size[<sup>[2]</sup>](#flashdetect).
13- Real-time clock support, even without configuration.
14- A built-in BIOS implementation, and ability to load external BIOS files.
15- Turbo/fast-forward support by holding Tab.
16- Frameskip, configurable up to 9.
17- Screenshot support.
18- 9 savestate slots. Savestates are also viewable as screenshots.
19- Video and GIF recording.
20- Remappable controls for both keyboards and gamepads.
21- Loading from ZIP files.
22- IPS and UPS support.
23- Game debugging via a command-line interface (not available with Qt port) and GDB remote support.
24
25### Planned features
26
27- Local and networked multiplayer link cable support ([Bug #1](https://endrift.com/mgba/bugs/show_bug.cgi?id=1)).
28- Dolphin/JOY bus link cable support ([Bug #73](https://endrift.com/mgba/bugs/show_bug.cgi?id=73)).
29- Cheat codes ([Bug #58](https://endrift.com/mgba/bugs/show_bug.cgi?id=58)).
30- Re-recording support for tool-assist runs. ([Bugzilla keyword "TASBlocker"](https://endrift.com/mgba/bugs/buglist.cgi?quicksearch=TASBlocker))
31- Lua support for scripting ([Bug #62](https://endrift.com/mgba/bugs/show_bug.cgi?id=62)).
32- A comprehensive debug suite ([Bug #132](https://endrift.com/mgba/bugs/show_bug.cgi?id=132)).
33- libretro core for RetroArch and OpenEmu ([Bug #86](https://endrift.com/mgba/bugs/show_bug.cgi?id=86)).
34
35
36Supported Platforms
37-------------------
38
39- Windows Vista or newer
40- OS X 10.7 (Lion)[<sup>[3]</sup>](#osxver) or newer
41- Linux
42- FreeBSD
43
44Other Unix-like platforms work as well, but are untested.
45
46Downloads
47---------
48
49Downloads can be found on the official website, in the [Downloads][downloads] section. The source code can be found on [GitHub][source].
50
51Compiling
52---------
53
54Compiling requires using CMake 2.8.11 or newer. To use CMake to build on a Unix-based system, the recommended commands are as follows:
55
56	mkdir build
57	cd build
58	cmake .. -DCMAKE_BUILD_TYPE=Release
59	make
60	make install
61
62Dependencies 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.
63
64### Dependencies
65
66mGBA 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.
67
68- Qt 5: for the GUI frontend. Qt Multimedia or SDL are required for audio.
69- SDL: for a more basic frontend and gamepad support in the Qt frontend. SDL 2 is recommended, but 1.2 is supported.
70- zlib and libpng: for screenshot support and savestate-in-PNG support.
71- libedit: for command-line debugger support.
72- ffmpeg: or libav for video recording. Libav is untested.
73- libzip: for loading ROMs stored in zip files.
74- ImageMagick: for GIF recording.
75
76Footnotes
77---------
78
79<a name="missing">[1]</a> Currently missing features are
80
81- OBJ window for modes 3, 4 and 5 ([Bug #5](https://endrift.com/mgba/bugs/show_bug.cgi?id=5))
82- Mosaic for transformed OBJs ([Bug #9](https://endrift.com/mgba/bugs/show_bug.cgi?id=9))
83- 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))
84
85<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.
86
87<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.
88
89[downloads]: https://endrift.com/mgba/downloads.html
90[source]: https://github.com/mgba-emu/mgba/
91
92Copyright
93---------
94
95mGBA 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.