summaryrefslogtreecommitdiffstats
path: root/games/vbam/README
diff options
context:
space:
mode:
Diffstat (limited to 'games/vbam/README')
-rw-r--r--games/vbam/README45
1 files changed, 31 insertions, 14 deletions
diff --git a/games/vbam/README b/games/vbam/README
index a300e865d2..940fe37e79 100644
--- a/games/vbam/README
+++ b/games/vbam/README
@@ -1,19 +1,36 @@
-vbam (cross-platform GameBoy emulator)
+vbam (cross-platform gameboy/gbc/gba emulator)
-VisualBoyAdvance-M is a Nintendo Game Boy Emulator with high compatibility
-with commercial games. It emulates the Nintendo Game Boy Advance hand
-held console, in addition to the original Game Boy hand held systems
-and its Super and Color variants. VBA-M is a continued development of
-the now inactive VisualBoy Advance project, with many improvements from
-various developments of VBA.
+VisualBoyAdvance-M is a Nintendo Game Boy Advance Emulator with high
+compatibility with commercial games. It emulates the Nintendo Game Boy
+Advance hand held console, in addition to the original Game Boy hand
+held systems and its Super and Color variants. VBA-M is a continued
+development of the now inactive VisualBoy Advance project, with many
+improvements from various developments of VBA.
-This application is the wxGTK GUI version of VisualBoyAdvance-M. The
-name of the executable is "visualboyadvance-m".
+The main executable is /usr/games/vbam, which is a command-line app
+with no GUI controls.
-FFMPEG=ON will enable recording and playback. It requires ffmpeg.
+Optional dependencies:
-There are a couple of alternatives on SBo you might try instead of this
-VBAM SlackBuild: vbam-libretro, mgba, and/or libretro-mgba.
+wxGTK3 - highly recommended, autodetected (can be disabled via
+WX=no). This gives you a /usr/games/visualboyadvance-m executable that
+has a modern graphical user interface, plus desktop integration.
-Note: when upgrading from 2.0.2 to 2.1.0, you may have to "rm -rf
-~/.vbam". Do this if vbam segfaults.
+SFML - autodetected (can be disabled via SFML=no). Only required for
+emulating the GBA Link cable.
+
+lirc - autodetected (can be disabled via LIRC=no). Allows using an
+IR remote control to control the emulator. Only works with the SDL
+user interface (the vbam executable). Untested by the SlackBuild
+maintainer, as I don't own any lirc-compatible hardware.
+
+Notes:
+
+The config file (vbam.ini) is shared between the visualboyadvance-m
+and vbam executables, and lives in ~/.config/visualboyadvance-m/
+(mentioned here because the man pages don't document this). When
+upgrading versions, you might have to delete the config file if vbam
+and/or visualboyadvance-m crash or act weird.
+
+There are a couple of alternatives on SBo you might try instead of
+this vbam SlackBuild: mgba and/or higan.