bsnes-libretro/docs/index.md
Tim Allen 3c3f1de317 Convert README docs to MkDocs format.
The existing documentation was getting *way* too long to be a single
document.

I've just bulk moved the existing content into the new structure, but it
definitely needs another pass to make the prose match, fix hyperlinks,
etc. etc.
2017-08-12 20:58:01 +10:00

3.9 KiB

higan, the multi-system emulator

higan emulates a number of classic videogame consoles of the 1980s and 1990s, allowing you to play classic games on a modern general-purpose computer.

About higan

As of v102, higan has top-tier support for the following consoles:

  • Nintendo Super Famicom/Super Nintendo Entertainment System, including addon hardware:
    • Super Game Boy
    • Sufami Turbo
  • Nintendo Game Boy Advance

It also includes some level of support for these consoles:

  • Satellaview addon for the Super Famicom
  • Nintendo Famicom/Nintendo Entertainment System
  • Nintendo Game Boy
  • Nintendo Game Boy Color
  • Sega Master System
  • Sega Game Gear
  • Sega Megadrive/Genesis
  • NEC PC Engine/TurboGrafx 16 (but not the CD-ROM² System/TurboGrafx-CD)
  • NEC SuperGrafx
  • Bandai Wonderswan
  • Bandai Wonderswan Color

Note: Some consoles were released under different names in different geographic regions. To avoid listing all possible names every time such a console is mentioned, higan uses the name from the console's region of origin. In practice, that means Japanese names: "Famicom" and "Super Famicom" instead of NES and SNES, "Mega Drive" instead of "Genesis", "PC Engine" instead of "TurboGrafx-16".

higan is actively supported on FreeBSD 10 and above, and Microsoft Windows 7 and above. It also includes some level of support for GNU/Linux and macOS.

If you want to install higan and try it out, see the Quick Start section below.

higan is officially spelled with a lowercase "h", not a capital.

About this document

This is the unofficial higan README, a community-maintained introduction and reference. It may be out of date by the time you read this, and it may contain errors or omissions. If you find something that's wrong, or you have a suggestion, see "Unofficial higan resources" below.

Official higan resources

Unofficial higan resources

There are also other projects based on current or older versions of higan, in whole or in part, that you might want to check out.

  • Mednafen is another multi-system emulator. Its Super Famicom emulation is based on bsnes v059, from the time before bsnes was renamed to higan.
  • BizHawk is another multi-system emulator, specialising in the creation of tool-assisted speedruns. Its Super Famicom emulation is based on bsnes v087.
  • nSide is a fork of higan that greatly enhances its NES emulation support, and adds minor features to the other cores too. It also restores the "balanced" Super Famicom emulation core that was removed from higan in v099, which is less CPU intensive than the current accuracy-focussed core.
  • bsnes-plus is a fork of bsnes v073 that adds improved support for debugging Super Famicom software.