aboutsummaryrefslogtreecommitdiff
path: root/games/higan/README
diff options
context:
space:
mode:
authorB. Watson <yalhcru@gmail.com>2018-12-12 04:46:16 -0500
committerWilly Sudiarto Raharjo <willysr@slackbuilds.org>2018-12-15 20:44:29 +0700
commit2f4b88779c3eeb956eb7de2b2df87ffd4d382aa5 (patch)
treeee0714c82d5a1634d0dc8c20ad60d6817292c505 /games/higan/README
parent9e5373bf5b436f9034901c82c0caaa03fe756719 (diff)
games/higan: Updated for version 106, new maintainer.
Signed-off-by: B. Watson <yalhcru@gmail.com>
Diffstat (limited to 'games/higan/README')
-rw-r--r--games/higan/README53
1 files changed, 45 insertions, 8 deletions
diff --git a/games/higan/README b/games/higan/README
index 5f29a6f9ca11c..d5f3551c021b5 100644
--- a/games/higan/README
+++ b/games/higan/README
@@ -1,3 +1,5 @@
+higan (console multi-system emulator)
+
higan (formerly known as bsnes) is an emulator that began development
on 2004-10-14. The purpose of this emulator is a bit different from
others: it focuses on accuracy, debugging functionality, and clean
@@ -5,15 +7,50 @@ code. The emulator does not focus on things that would hinder accuracy.
This includes speed and game-specific hacks for compatibility. As a
result, the minimum system requirements for higan are very high.
-It currently supports the following systems: Famicom (NES), Super
-Famicom (SNES), Game Boy, Game Boy Color and Game Boy Advance.
-It also supports the following subsystems: Super Game Boy,
-BS-X Satellaview and Sufami Turbo.
+As of v104, higan has top-tier support for the following consoles:
+
+- Nintendo Super Famicom/SNES, including add-on hardware:
+ + Super Game Boy
+ + Sufami Turbo
+- Nintendo Game Boy Advance
+
+It also includes some level of support for these consoles:
+
+- Satellaview add-on for the Super Famicom
+- Nintendo Famicom/Nintendo Entertainment System
+- Nintendo Game Boy
+- Nintendo Game Boy Color
+- Sega Master System
+- Sega Game Gear
+- Sega Mega Drive/Genesis
+- NEC PC Engine/TurboGrafx 16 (but not the CD-ROM^2 System/TurboGrafx-CD)
+- NEC SuperGrafx
+- Bandai WonderSwan
+- Bandai WonderSwan Color
+
+Complete (though slightly outdated) documentation on higan is available
+at: https://higan.readthedocs.io/en/stable/
-* Configuration *
+*** Configuration:
-The default profile folder (where platform system files, cheats and
+The default profile directory (where platform system files, cheats and
shaders are located) is /usr/share/higan. If you want a personalized
-profile, store your files in ~/.config/higan/, then higan will use
-this folder instead.
+profile, store your files in ~/Emulation, then higan will use this
+directory instead.
+
+First time users note: By default there are *no* control mappings. You'll
+have to use Settings -> Input to map your preferred keyboard and/or
+gamepad controls for each emulated system. Also, by default, there's
+nothing 'plugged into' the emulated controller ports. In the menu bar,
+click on the system name (e.g. Famicom, Super Famicom) -> Controller
+Port 1 -> Gamepad (or whatever is required for the ROM you're running).
+
+*** Build options:
+
+- OpenAL is autodetected, and used if found. You can disable it with
+ OPENAL=no in the environment.
+
+- OSS is disabled by default. If you need it, set OSS=yes in the environment.
+- PulseAudio is enabled by default. You can disable it with PULSE=no in
+ the environment.