README.md (view raw)
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 [mgba.io](http://mgba.io/).
7
8
9
10Features
11--------
12
13- Near full Game Boy Advance hardware support[<sup>[1]</sup>](#missing).
14- Fast emulation. Known to run at full speed even on low end hardware, such as netbooks.
15- Qt and SDL ports for a heavy-weight and a light-weight frontend.
16- Local (same computer) link cable support.
17- Save type detection, even for flash memory size[<sup>[2]</sup>](#flashdetect).
18- Real-time clock support, even without configuration.
19- A built-in BIOS implementation, and ability to load external BIOS files.
20- Turbo/fast-forward support by holding Tab.
21- Frameskip, configurable up to 10.
22- Screenshot support.
23- Cheat code support.
24- 9 savestate slots. Savestates are also viewable as screenshots.
25- Video and GIF recording.
26- Remappable controls for both keyboards and gamepads.
27- Loading from ZIP and 7z files.
28- IPS, UPS and BPS patch support.
29- Game debugging via a command-line interface (not available with Qt port) and GDB remote support.
30- Configurable emulation rewinding.
31
32### Planned features
33
34- Networked multiplayer link cable support ([Bug #1](http://mgba.io/b/1)).
35- Dolphin/JOY bus link cable support ([Bug #73](http://mgba.io/b/73)).
36- Re-recording support for tool-assist runs. ([Bugzilla keyword "TASBlocker"](https://endrift.com/mgba/bugs/buglist.cgi?quicksearch=TASBlocker))
37- Lua support for scripting ([Bug #62](http://mgba.io/b/62)).
38- A comprehensive debug suite ([Bug #132](http://mgba.io/b/132)).
39- OpenEmu core.
40- e-Reader support. ([Bug #171](http://mgba.io/b/171))
41
42
43Supported Platforms
44-------------------
45
46- Windows Vista or newer
47- OS X 10.7 (Lion)[<sup>[3]</sup>](#osxver) or newer
48- Linux
49- FreeBSD
50
51Other Unix-like platforms, such as OpenBSD, are known to work as well, but are untested and not fully supported.
52
53### System requirements
54
55Requirements 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.
56
57Downloads
58---------
59
60Downloads can be found on the official website, in the [Downloads][downloads] section. The source code can be found on [GitHub][source].
61
62Controls
63--------
64
65Controls 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:
66
67- **A**: X
68- **B**: Z
69- **L**: A
70- **R**: S
71- **Start**: Enter
72- **Select**: Backspace
73
74Compiling
75---------
76
77Compiling requires using CMake 2.8.11 or newer. GCC and Clang are both known to work to compile mGBA, but Visual Studio 2013 and older are known not to work. To use CMake to build on a Unix-based system, the recommended commands are as follows:
78
79 mkdir build
80 cd build
81 cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr ..
82 make
83 sudo make install
84
85This will build and install mGBA into `/usr/bin` and `/usr/lib`. Dependencies that are installed will be automatically detected, and features that are disabled if the dependencies are not found will be shown after running the `cmake` command after warnings about being unable to find them.
86
87### Dependencies
88
89mGBA 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.
90
91- Qt 5: for the GUI frontend. Qt Multimedia or SDL are required for audio.
92- SDL: for a more basic frontend and gamepad support in the Qt frontend. SDL 2 is recommended, but 1.2 is supported.
93- zlib and libpng: for screenshot support and savestate-in-PNG support.
94- libedit: for command-line debugger support.
95- ffmpeg or libav: for video recording.
96- libzip: for loading ROMs stored in zip files.
97- ImageMagick: for GIF recording.
98
99Footnotes
100---------
101
102<a name="missing">[1]</a> Currently missing features are
103
104- OBJ window for modes 3, 4 and 5 ([Bug #5](http://mgba.io/b/5))
105- Mosaic for transformed OBJs ([Bug #9](http://mgba.io/b/9))
106- BIOS call RegisterRamReset is partially stubbed out ([Bug #141](http://mgba.io/b/141))
107- Audio channel reset flags ([Bug #142](http://mgba.io/b/142))
108- Game Pak prefetch ([Bug #195](http://mgba.io/b/195))
109- BIOS call Stop, for entering sleep mode ([Bug #199](http://mgba.io/b/199))
110
111<a name="flashdetect">[2]</a> Flash memory size detection does not work in some cases. These can be configured at runtime, but filing a bug is recommended if such a case is encountered.
112
113<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.
114
115[downloads]: http://mgba.io/downloads.html
116[source]: https://github.com/mgba-emu/mgba/
117
118Copyright
119---------
120
121mGBA is Copyright © 2013 – 2015 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.
122
123mGBA contains the following third-party libraries:
124
125- [inih](https://code.google.com/p/inih/), which is copyright © 2009 Brush Technology and used under a BSD 3-clause license.
126- [blip-buf](https://code.google.com/p/blip-buf/), which is copyright © 2003 – 2009 Shay Green and used under a Lesser GNU Public License.
127- [LZMA SDK](http://www.7-zip.org/sdk.html), which is public domain.
128- [MurmurHash3](https://code.google.com/p/smhasher/wiki/MurmurHash3) implementation by Austin Appleby, which is public domain.