From 0f4889d69a49d3f44684a18ea28a411c661498d2 Mon Sep 17 00:00:00 2001 From: Jeffrey Pfau Date: Sat, 17 Sep 2016 10:51:40 -0700 Subject: [PATCH] All: Refresh README --- README.md | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 53f3ad47d..8b78c3b50 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ mGBA ==== -mGBA is an 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. +mGBA is an 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. It also supports Game Boy and Game Boy Color games. Up-to-date news and downloads can be found at [mgba.io](https://mgba.io/). @@ -11,6 +11,7 @@ Features -------- - Near full Game Boy Advance hardware support[[1]](#missing). +- Game Boy/Game Boy Color hardware support. - 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. - Local (same computer) link cable support. @@ -19,6 +20,7 @@ Features - 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. +- Rewind by holding Backquote. - Frameskip, configurable up to 10. - Screenshot support. - Cheat code support. @@ -31,16 +33,19 @@ Features - Configurable emulation rewinding. - Support for loading and exporting GameShark and Action Replay snapshots. - Cores available for RetroArch/Libretro and OpenEmu. +- Many, many smaller things. ### Planned features -- Networked multiplayer link cable support ([Bug #1](http://mgba.io/b/1)). -- Dolphin/JOY bus link cable support ([Bug #73](http://mgba.io/b/73)). -- Re-recording support for tool-assist runs. ([Bugzilla keyword "TASBlocker"](https://endrift.com/mgba/bugs/buglist.cgi?quicksearch=TASBlocker)) -- Lua support for scripting ([Bug #62](http://mgba.io/b/62)). -- A comprehensive debug suite ([Bug #132](http://mgba.io/b/132)). -- e-Reader support. ([Bug #171](http://mgba.io/b/171)) - +- Networked multiplayer link cable support. +- Dolphin/JOY bus link cable support. +- M4A audio mixing, for higher quality sound than hardware. +- Re-recording support for tool-assist runs. +- Lua support for scripting. +- A comprehensive debug suite. +- e-Reader support. +- Wireless adapter support. +- Game Boy Printer support. Supported Platforms ------------------- @@ -67,7 +72,7 @@ Downloads can be found on the official website, in the [Downloads][downloads] se 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: +Controls are configurable in the settings menu. Many game controllers should be automatically mapped by default. The default keyboard controls are as follows: - **A**: X - **B**: Z @@ -118,9 +123,11 @@ mGBA has no hard dependencies, however, the following optional dependencies are - 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. +- libzip or zlib: for loading ROMs stored in zip files. - ImageMagick: for GIF recording. +Both libpng and zlib are included with the emulator, so they do not need to be externally compiled first. + Footnotes --------- @@ -139,7 +146,7 @@ Footnotes Copyright --------- -mGBA 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. +mGBA is Copyright © 2013 – 2016 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. mGBA contains the following third-party libraries: