libretro/mgba
1
0
Fork 0
mirror of https://github.com/libretro/mgba.git synced 2024-11-28 10:40:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
mGBA Game Boy Advance Emulator
1,707 Commits 17 Branches 2 Tags 49 MiB
C 77.8%
C++ 15.5%
Python 2.8%
CMake 2%
GLSL 1.2%
Other 0.6%
7149dd3102
Go to file
Jeffrey Pfau 7149dd3102 GBA: Refactor gba directory, dropping gba- prefix and making supervisor directory
2015-02-03 03:12:04 -08:00
res Qt: Allow graphics switching on OS X 2015-01-07 23:04:19 -08:00
src GBA: Refactor gba directory, dropping gba- prefix and making supervisor directory 2015-02-03 03:12:04 -08:00
tools Tools: Allow perf.py to accept zipped games 2015-01-13 21:46:41 -08:00
.gitignore Ignore swapfiles 2014-04-23 02:05:50 -07:00
CHANGES GBA: Refactor gba directory, dropping gba- prefix and making supervisor directory 2015-02-03 03:12:04 -08:00
CMakeLists.txt GBA: Refactor gba directory, dropping gba- prefix and making supervisor directory 2015-02-03 03:12:04 -08:00
LICENSE All: Add MPL 2.0 license and associated headers 2014-12-03 00:39:06 -08:00
README.md All: Update README 2015-01-25 00:15:58 -08:00

README.md

mGBA

mGBA 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.

Up-to-date news and downloads can be found at endrift.com/mgba.

Features

  • Near full Game Boy Advance hardware support[1].
  • Fast emulation. Known to run at full speed even on low end hardware, such as netbooks.
  • Qt and SDL ports for a heavy-weight and a light-weight frontend.
  • Save type detection, even for flash memory size[2].
  • Real-time clock support, even without configuration.
  • A built-in BIOS implementation, and ability to load external BIOS files.
  • Turbo/fast-forward support by holding Tab.
  • Frameskip, configurable up to 9.
  • Screenshot support.
  • 9 savestate slots. Savestates are also viewable as screenshots.
  • Video and GIF recording.
  • Remappable controls for both keyboards and gamepads.
  • Loading from ZIP and 7z files.
  • IPS, UPS and BPS patch support.
  • Game debugging via a command-line interface (not available with Qt port) and GDB remote support.
  • Configurable emulation rewinding.

Planned features

Supported Platforms

  • Windows Vista or newer
  • OS X 10.7 (Lion)[3] or newer
  • Linux
  • FreeBSD

Other Unix-like platforms work as well, but are untested.

System requirements

Requirements 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.

Downloads

Downloads can be found on the official website, in the Downloads section. The source code can be found on GitHub.

Controls

Controls 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:

  • A: X
  • B: Z
  • L: A
  • R: S
  • Start: Enter
  • Select: Backspace

Compiling

Compiling requires using CMake 2.8.11 or newer. To use CMake to build on a Unix-based system, the recommended commands are as follows:

mkdir build
cd build
cmake ..
make
make install

Dependencies 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.

Dependencies

mGBA 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.

  • Qt 5: for the GUI frontend. Qt Multimedia or SDL are required for audio.
  • SDL: for a more basic frontend and gamepad support in the Qt frontend. SDL 2 is recommended, but 1.2 is supported.
  • zlib and libpng: for screenshot support and savestate-in-PNG support.
  • libedit: for command-line debugger support.
  • ffmpeg or libav: for video recording.
  • libzip: for loading ROMs stored in zip files.
  • ImageMagick: for GIF recording.

Footnotes

[1] Currently missing features are

  • OBJ window for modes 3, 4 and 5 (Bug #5)
  • Mosaic for transformed OBJs (Bug #9)
  • BIOS call RegisterRamReset is partially stubbed out (Bug #141)
  • Audio channel reset flags (Bug #142)

[2] 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.

[3] 10.7 is only needed for the Qt port. The SDL port is known to work on 10.6, and may work on older.

Copyright

mGBA is Copyright © 2013 – 2015 Jeffrey Pfau. It is distributed under the Mozilla Public License version 2.0. A copy of the license is available in the distributed LICENSE file.

mGBA contains inih, which is copyright © 2009 Brush Technology and used under a BSD 3-clause license; and blip-buf, which is copyright © 2003 – 2009 Shay Green and used under a Lesser GNU Public License.