Skip to content
BizHawk is a multi-system emulator written in C#. BizHawk provides nice features for casual gamers such as full screen, and joypad support in addition to full rerecording and debugging tools for all system cores.
Branch: master
Clone or download
adelikat move Subneshawk menu to the nes submenu and enforce that you can not …
…have quicknes=true and subneshawk=true, put "experiemental" on the menu item because while it is being officially "released" it is a very big edge case and I dont' want to confuse average TASers into thinking this is a core they should use for normal use cases
Latest commit 02a3e4c Jun 18, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Assets update gargoyles script (with a 2yo version) Jun 15, 2019
BizHawk.Client.ApiHawk Inline interpolated string literals Jun 14, 2019
BizHawk.Client.Common Vectrex: Add minestorm and bug fixes Jun 17, 2019
BizHawk.Client.DBMan Use string interpolation Jun 14, 2019
BizHawk.Client.DiscoHawk Use string interpolation Mar 20, 2019
BizHawk.Client.EmuHawk move Subneshawk menu to the nes submenu and enforce that you can not … Jun 17, 2019
BizHawk.Client.MultiHawk Use string interpolation Jun 14, 2019
BizHawk.Common Inline ToHexString extension where param numdigits is constant Jun 14, 2019
BizHawk.Emulation.Common Vectrex: Add minestorm and bug fixes Jun 17, 2019
BizHawk.Emulation.Cores Vectrex: Add minestorm and bug fixes Jun 17, 2019
BizHawk.Emulation.DiscSystem Replace $"{a}{b}" and similar with concatenation Jun 14, 2019
BizHawk.Installer Update BizHawkFiles.wxs Aug 29, 2017
Bizware Merge branch 'master' into clean_docs Jun 14, 2019
Build add a build tool command which can strip timestamps from PE files (fo… Dec 4, 2017
CpuCoreGenerator Spaces -> tabs. Apr 15, 2017
Dist Add build scripts for Unix May 19, 2019
ExternalCoreProjects/Virtu Remove empty docs Jun 6, 2019
LibretroBridge/vs2015 libretrobridge: fix warnings and rebuild dll Jun 13, 2017
LuaInterface looks like i never got around to using the 64bit luaperks, so luasock… Jan 15, 2018
References Merge branch 'master' into appleii_fixattempt Mar 28, 2019
Version Lua: client.getversion() - #1314 Sep 10, 2018
attic remove all meteor and garbo stuff completely. These two GBA cores wer… Apr 23, 2017
blip_buf Add Blargg's "blip_buf" as an unmanaged dll. license is LGPL; if I li… Dec 9, 2012
help Added help file Jul 26, 2014
libgambatte Gambatte core: Add RTC divisor offset support. Jun 2, 2019
libmupen64plus update gliden to release 4.0 Jun 16, 2019
lynx change output64 to output in some unmanaged core buildscripts Jun 12, 2017
mgba @ 5680aba minor tweak to mgba, update its version in hawk Jun 10, 2019
miniz add Miniz-based ZipWriter. Ends up being aboot 15-20% faster than Fra… Jun 11, 2017
output/dll update gliden to release 4.0 Jun 16, 2019
psx oops, i forgot to implement shock_Destroy. Aug 27, 2018
quicknes change output64 to output in some unmanaged core buildscripts Jun 12, 2017
vbanext get vbanext in the right place Jun 13, 2017
waterbox bsnes: remove embarrassing leftover empty space from trace log May 21, 2018
wonderswan change output64 to output in some unmanaged core buildscripts Jun 12, 2017
.editorconfig add .editorconfig Apr 20, 2016
.gitignore Update .gitignore May 18, 2019
.gitmodules mgba: update build - zero bios state bug fixed Sep 10, 2018
BizHawk.sln Remove Virtu.csproj references from solution (because they shouldnt b… May 20, 2019
BizHawk.sln.DotSettings SxROM - some small cleanup/simplification Nov 1, 2018
Building Other Solutions.txt Update Building Other Solutions.txt Aug 29, 2017
CpuCoreGenerator.sln Upgrade CpuCoreGenerator solution also Aug 27, 2011
Good Core Bad Core.txt philosophize about good cores and bad cores Feb 1, 2015
LICENSE add MIT license to repository, since that's what it's always been, bu… Jul 24, 2017
README.md Elaborate on Windows prereqs Jun 14, 2019
Settings.StyleCop Move VsyncNum and VsyncDen out of CoreComm and into IVideoProvider May 5, 2017

README.md

BizHawk

A multi-system emulator written in C#. As well as quality-of-life features for casual players, it also has recording/playback and debugging tools, making it the first choice for TASers (Tool-Assisted Speedrunners).

unique systems emulated | 27 GitHub latest release dev builds | AppVeyor Windows prereqs | GitHub GitHub open issues counter


Click the "release" button above to grab the latest stable version (changelog at TASVideos).

New user on Windows? Install the prerequisites first, click the "prereqs" button to get that and see Installing for info.

Never mix different versions of BizHawk — Keep each version in its own folder.

Jump to:

Features and systems

The BizHawk common features (across all cores) are:

  • format, region, and integrity detection for game images
  • 10 save slots with hotkeys and infinite named savestates
  • speed control, including frame stepping and rewinding
  • memory view/search/edit in all emulated hardware components
  • input recording (making TAS movies)
  • screenshotting and recording audio + video to file
  • firmware management
  • input, framerate, and more in a HUD over the game
  • emulated controllers via a comprehensive input mapper
  • Lua control over core and frontend (Windows only)
  • hotkey bindings to control the UI

Supported consoles and computers:

  • Apple II
  • Atari
    • Video Computer System / 2600
    • 7800
    • Lynx
  • Bandai WonderSwan + Color
  • CBM Commodore 64
  • Coleco Industries ColecoVision
  • Mattel Intellivision
  • NEC
    • PC Engine / TurboGrafx-16 + SuperGrafx + CD
    • PC-FX
  • Neo Geo Pocket + Color
  • Nintendo
    • Famicom / Nintendo Entertainment System + FDS
    • Game Boy + Color
    • Game Boy Advance
    • Nintendo 64
    • Super Famicom / Super Nintendo Entertainment System
    • Virtual Boy
  • Sega
    • Game Gear
    • Genesis + 32X + CD
    • Master System
    • Pico
    • Saturn
    • SG-1000
  • Sinclair ZX Spectrum
  • Sony Playstation (PSX)
  • Texas Instruments TI-83
  • Uzebox
  • More coming soon..?

See Usage below for info on basic config needed to play games.

to top

Installing

Windows 7/8.1/10

Released binaries can be found right here on GitHub:

Windows | binaries

Click BizHawk-<version>.zip to download it. Also note the changelog, the full version of which is here at TASVideos. Don't mix different versions of BizHawk, keep each version in its own folder.

Note: Before you start (by running EmuHawk.exe), you'll need the Windows-only prerequisites installed. You can get them all at once with this program (you don't need to do this every time BizHawk updates, check the date on its release page, but it can't hurt installing it again to be sure). The specific libraries it installs are:

  • .NET Framework 4.6.1
  • Visual C++ Redists
    • 2010 SP1
    • 2012
    • 2015
  • Direct3D 9

BizHawk functions like a "portable" program, you may move or rename the folder containing EmuHawk.exe, even to another drive — as long as you keep all the files together, and the prerequisites are installed when you go to run it.

Following Microsoft's support lifecycle, Win10 is supported from 1803 "Redstone 4", Win8 is supported from 8.1 (not 8.0), and Win7 is supported from SP1 (ends Jan 2020, upgrade to Win10 or try ReactOS).

A "backport" release, 1.13.2, is available for users of Windows XP and/or 32-bit Windows. Being in the 1.x series, many bugs remain and features are missing.

to top

GNU+Linux

...or, as I’ve recently taken to calling it, Mono+GNU+Linux.

IMPORTANT: Linux support is a work-in-progress! It is not complete, does not look very nice, and is not ready for anything that needs accuracy.

You'll need to either build BizHawk yourself (see Building below), or download a dev build (see Testing below).

The runtime dependencies are: Mono "complete", Mono VB.NET, WINE (just libwine if available), glibc, NVIDIA's cgc utility, and your distro's LSB implementation. Run EmuHawkMono.sh to start Mono with the right library and executable paths — you can run it from anywhere, so putting it in a .desktop file is fine. If running the script doesn't start EmuHawk, it might be because the library path for your distro isn't known (if you use a terminal, it will say so in the output).

The systems that currently work are: GB + GBC (GBHawk), NES (NesHawk), SMS, Atari 7800, and some classic home computers. Nothing other than EmuHawk has been ported. See #1430 for progress.

to top

Building

Windows 7/8.1/10

If you have WSL, Git BASH, or similar, clone the repo with:

git clone https://github.com/TASVideos/BizHawk.git BizHawk_master
# or ssh: git clone git@github.com:TASVideos/BizHawk.git BizHawk_master

...or use a Git GUI. Otherwise, you'll have to download an archive from GitHub.

Once it's downloaded and extracted, go into the repo's Dist folder and run BuildAndPackage_Release.bat. BizHawk will be built as a .zip just like any other release.

For anything more complicated than just building, you'll need an IDE like VS Community 2019, currently the best free C# IDE (if you can get JetBrains tools, use Rider). Open BizHawk.sln with VS to start and use the toolbar to choose BizHawk.Client.EmuHawk | Release and build. See Compiling at TASVideos (somewhat outdated) for more detailed instructions.

to top

GNU+Linux

Note: Currently, running (not building) requires WINE, but only the bundled libraries. BizHawk should not run on WINE.

If there is a package named bizhawk-git or similar in the same repo as the normal package, install that to build master. Otherwise, building is as easy as:

git clone https://github.com/TASVideos/BizHawk.git BizHawk_master && BizHawk_master/Dist/BuildRelease.sh
# or ssh: git clone git@github.com:TASVideos/BizHawk.git BizHawk_master && BizHawk_master/Dist/BuildRelease.sh
# devs may use `Dist/BuildDebug.sh` instead to get `#if DEBUG` code compiled into the binaries

Once built, see Installing above, the built output is BizHawk_master/output. Again, if your distro isn't in the list, you might get an "Unknown distro" warning in the terminal, and EmuHawk may not open or may show the missing dependencies dialog. You may need to add your distro to the case statement in the script, setting libpath to the location of d3dx9_43.dll.so (please do share if you get it working).

to top

Usage

Loading firmware

Put all your dumped firmware files in the Firmware folder and everything will be automatically detected and loaded when you try to load a game (filenames and subfolders aren't enforced, you can just throw them in there). If you're missing required or optional firmware, you will see a "You are missing the needed firmware files [...]" dialog.

Keep in mind some firmware is optional, and some have multiple versions, only one of which needs to be set.

If you want to customise firmware (when there are alternative firmwares, for example) go to Config > Firmwares..., right-click the line of the firmware you want to change, click "Set Customization", and open the file.

You can change where BizHawk looks for firmware by going to Config > Paths... and changing "Firmware" in the "Global" tab to the new location. This allows multiple BizHawk releases to use the same folder.

Identifying a good rom

With a core and game loaded, look in the very left of the status bar (View > Display Status Bar):

  • a green checkmark means you've loaded a "known good" rom;
  • a "!" in a red circle means you've loaded a "known bad" rom, created by incorrect dumping methods; and
  • something else, usually a ?-block, means you've loaded something that's not in the database.

Rebinding keys and controllers

There are two keybind windows, Config > Controllers... and Config > Hotkeys.... These let you bind your keyboard and controllers to virtual controllers and to frontend functions, respectively.

Using them is simple, click in a box next to an action and press the button (or bump the axis) you want bound to that action. If the "Auto Tab" checkbox at the bottom of the window is checked, the next box will be selected automatically and whatever button you press will be bound to that action, and so on down the list. If "Auto Tab" is unchecked, clicking a filled box will let you bind another button to the same action. Keep in mind there are multiple tabs of actions.

Changing cores

To change which core is used for NES, SNES, GB, or GBA, go to Config > Cores. There, you'll also find the GB in SGB item, which is a checkbox that makes GB games run with the Super Game Boy on an SNES.

Most cores have their own settings window too, look in the menubar for the system name after Tools. Some have multiple windows, like Mupen64Plus which has virtual controller settings and graphics settings.

Running Lua scripts

(Reminder that this feature is Windows-only for now.)

Go to Tools > Lua Console. The opened window has two parts, the loaded script list and the console output. The buttons below the menubar are shortcuts for items in the menus, hover over them to see what they do. Any script you load is added to the list, and will start running immediately. Instead of using "Open script", you can drag-and-drop .lua files onto the console or game windows.

Running scripts have a "▶️" beside their name, and stopped scripts (manually or due to an error) have a "⏹️" beside them. Using "Pause or Resume", you can temporarily pause scripts, those have a "⏸️".

"Toggle script" does just that (paused scripts are stopped). "Reload script" stops it and loads changes to the file, running scripts are then started again. "Remove script" stops it and removes it from the list.

In-game Saves

Games may internally save your progress into memory (SRAM, memory cards) or file. When this happens, BizHawk stores this in-game save in the Operating System memory and makes the File > Save RAM menu bold.

BizHawk can write in-game saves to disk - this is called flushing. Every time you save in the game (not to be confusing with emulator savestates), you should backup your saves! Go to File > Save RAM and hit Flush Save Ram. Note that some systems use SRAM for irrelevant tasks and store temporary data there, and the menu may become bold without in-game saves involved. Be aware when the game is supposed to save and flush accordingly.

BizHawk can be configured to flush saves to disk automatically in Config > Customize > Advanced AutoSaveRAM. Opon closing the ROM (which includes any core reboot) BizHawk may try to flush save RAM automatically as well.


DISCLAIMER

Automatic flushing is extremely unreliable and not being maintained.
It may corrupt your previous saves!
It will be completely removed in future.
Develop a habit to always flush saves manually every time you save in the game.
Make backups of the flushed save files!
If you don't flush saves manually and backup them, and something breaks, you're on your own.
If your save has been corrupted, there's nothing we can do about it.

to top

TASing

This section refers to BizHawk specifically. For resources on TASing in general, see Welcome to TASVideos. This section hasn't been written yet.

For now, the best way to learn how to TAS is to browse pages like BasicTools on TASVideos and watch tutorials like Sand_Knight and dwangoAC's.

to top

Testing

Testing bugfixes or new features can be just as helpful as making them! If code's more your thing, see Contributing below.

Dev builds are automated with AppVeyor, every green checkmark in the commit history is a successful build. Clicking a checkmark and then "Details" in the box that appears takes you straight to the build page. The full list is here, in future use the "dev builds" button at the top of this readme.

Once you're on the build page, click "Artifacts" and download BizHawk_Developer-<datetime>-#<long hexadecimal>.zip.

to top

Cores

A core is what we call the smaller bits of software that emulate just one system or family of systems, e.g. NES/Famicom. For the most part, there's a "best" core for each system, based on accuracy, but there are a few alternative cores which are faster and less accurate.

System Core Alt. Core
Apple II Virtu
Atari 2600 Atari2600Hawk
Atari 7800 A7800Hawk
Atari Lynx Handy
Commodore 64 C64Hawk
ColecoVision ColecoHawk
Game Boy / Color GBHawk Gambatte
Game Boy Advance mGBA VBA-Next
Intellivision IntelliHawk
N64 Mupen64Plus
Neo Geo Pocket / Color NeoPop
NES NesHawk QuickNes
PC-FX T.S.T.
Playstation (PSX) Octoshock
Sega Game Gear SMSHawk
Sega Genesis Genplus-gx
Sega Master System SMSHawk
Sega Saturn Saturnus
Sega Pico PicoDrive
SNES BSNES Snes9x
Super Game Boy BSNES SameBoy
TI-83 TI83Hawk
TurboGrafx / SuperGrafx PCEHawk
Uzebox Uzem
Virtual Boy Virtual Boyee
WonderSwan / Color Cygne
ZX Spectrum ZXHawk

Amstrad CPC, Magnavox Odyssey², and Sony PSP emulation are works-in-progress and there is no ETA. Cores for other systems are only conceptual. If you want to help speed up development, ask on IRC (see below).

to top

Support and troubleshooting

A short FAQ is provided on the BizHawk wiki.

If your problem is one of the many not answered there, and you can't find it in the issue tracker search, check the BizHawk forum at TASVideos, or ask on IRC:

If there's no easy solution, what you've got is a bug. Or maybe a feature request. Either way, open a new issue (you'll need a GitHub account, signup is very fast).

to top

Contributing

BizHawk is Open Source Software, so you're free to modify it however you please, and if you do, we invite you to share! Under the permissive MIT License, this is optional, just be careful with reusing cores as some have copyleft licenses.

Not a programmer? Something as simple as reproducing bugs with different software versions is still very helpful! See Testing above to learn about dev builds if you'd rather help us get the next release out.

If you'd like to fix bugs, check the issue tracker here on GitHub.

It's a good idea to check if anyone is already working on an issue by asking on IRC (see Support above).

If you'd like to add a feature, first search the issue tracker for it. If it's a new idea, make your own feature request issue before you start coding.

For the time being, style is not enforced in PRs, only build success is. Please use CRLF, tabs, and Allman braces in new files.

Past contrbutors to the frontend and custom-built cores are listed here. See the wiki for core authors.

to top

Related projects

  • DeSmuME for DS/Lite — cross-platform
  • Dolphin for GameCube and (original) Wii — cross-platform
  • FCEUX for NES/Famicom — TASing is Windows-only, but it should run cross-platform
  • libTAS for Linux ELF — GNU+Linux-only, also emulates other emulators
  • lsnes for GB and SNES — cross-platform
  • openMSX for MSX — cross-platform

Emulators for other systems can be found on the EmulatorResources page at TASVideos. The TASVideos GitHub page also holds copies of other emulators and plugins where development happens sometimes, their upstreams may be of use.

License

From the full text:

This repository contains original work chiefly in c# by the BizHawk team (which is all provided under the MIT License), embedded submodules from other authors with their own licenses clearly provided, other embedded submodules from other authors WITHOUT their own licenses clearly provided, customizations by the BizHawk team to many of those submodules (which is provided under the MIT license), and compiled binary executable modules from other authors without their licenses OR their origins clearly indicated.

In short, the frontend is MIT (Expat), beyond that you're on your own.

You can’t perform that action at this time.