summaryrefslogtreecommitdiffstats
path: root/games/dolphin-emu/README
diff options
context:
space:
mode:
Diffstat (limited to 'games/dolphin-emu/README')
-rw-r--r--games/dolphin-emu/README35
1 files changed, 17 insertions, 18 deletions
diff --git a/games/dolphin-emu/README b/games/dolphin-emu/README
index d8612742c3..362efdb681 100644
--- a/games/dolphin-emu/README
+++ b/games/dolphin-emu/README
@@ -1,23 +1,22 @@
-Dolphin is a Gamecube, Wii and Triforce (the arcade machine based on
-the Gamecube) emulator which supports many extra features and
-abilities not present on the original consoles. Gamecube and Wii
-compatibility is good - one can expect "mainstream" titles to run;
-lesser known titles can be hit or miss. Triforce compatibility is
-currently limited to a couple of games - others require more of the
-Triforce-specific peripheral devices to be emulated.
+Dolphin is an emulator for two recent Nintendo video game consoles:
+the GameCube and the Wii. It allows PC gamers to enjoy games for these
+two consoles in full HD (1080p) with several enhancements:
+compatibility with all PC controllers, turbo speed, networked
+multiplayer, and even more!
-Optional dependencies: SFML, OpenAL, portaudio, soil, miniupnpc,
-soundtouch, ffmpeg, wxGTK3, gtest, embedtls and SDL2
+Dolphin will optionally build against internal system packages if
+present, these include: SFML, enet, fmt, hidapi, mbedtls, libminizip,
+libspng, mgba, miniupnpc, pugixml, and zstd-cmake.
-Optional dependencies (not used): wayland
+Analytic data collection is enabled by default, however, users are
+prompted about this on first launch. To disable analytics without being
+prompted, pass ANALYTICS=OFF to the build script.
-Optional dependencies (not on SBo): xxhash
+Discord Rich Presence is disabled by default, to enable Discord
+functionality, pass DISCORD=ON to the build script.
-Note: Wayland support is not enabled even if it is installed. Dolphin
-requires mesa to be rebuilt with Wayland support using the following
-configure parameters.
+If you would like to disable Gameboy Advance controller support, pass
+USEMGBA=OFF to the build script. This will remove the mgba dependecy.
- --with-egl-platforms=x11,drm,wayland
-
-In addition to adding Wayland support to mesa, libxkbcommon needs to
-be installed (version >= 0.4.0) that also requires xcb >= 1.10.
+If you have installed mgba <= 0.10.0, this build will fail, please
+install 0.10.0+ or 'removepkg mgba' prior to running this script.