Home

Welcome to the higan wiki!

higan is a large and complex codebase, but while it's pretty easy to understand a small piece just by looking at it, it's not always obvious how the larger pieces fit together. As we explore and understand it better, please leave notes here to help other people understand, too. From time to time, documentation might be migrated to or from other places, like the higan source repo, https://byuu.net/ and https://higan.readthedocs.io/

A list of things we know, and things we need to find out:

• higan's History
• A map of higan's components
• Building higan
  • ...on Linux
  • ...on Windows
  • ...on macOS
  • ...on FreeBSD
  • Compilation options and how to set them
• Using higan
  • User Guide
  • Required firmware files
  • Why Game Paks?
• Developing higan
  • Using an IDE
  • nall API guide
  • ruby API guide
  • hiro API guide
  • Emulator::Interface

If you know something useful about higan that's not on the list, please add it where it makes sense! If there's something you want to know, add a broken link and hopefully somebody else will be able to fill it in!