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.
Go to file
James Groom 592c6cd945
Update README.md
2019-01-09 17:05:57 +00:00
Assets Add preliminary Unix compatibility (using Mono; resolves #1384) (#1380) 2019-01-04 01:50:55 +03:00
BizHawk.Client.ApiHawk CPCHawk: Initial project outline (may or may not come to something eventually) 2018-07-03 14:53:09 +01:00
BizHawk.Client.Common tastudio: allow to actually unbind markers from input, and unbind by default 2019-01-05 21:48:40 +03:00
BizHawk.Client.DBMan gamedb: added NGP/NGPC and improved homebrew detection 2018-09-21 16:10:35 +01:00
BizHawk.Client.DiscoHawk DoSettings file for all project to explicitely set language level to C#6 2018-06-23 13:06:13 -05:00
BizHawk.Client.EmuHawk tastudio: allow to actually unbind markers from input, and unbind by default 2019-01-05 21:48:40 +03:00
BizHawk.Client.MultiHawk DoSettings file for all project to explicitely set language level to C#6 2018-06-23 13:06:13 -05:00
BizHawk.Common rejigger PlatformLinkedLibSingleton so it can be used embedded in the EXE without requiring a dependency on dlls, so it can boot when dlls are relocated 2019-01-04 17:42:12 -05:00
BizHawk.Emulation.Common Add preliminary Unix compatibility (using Mono; resolves #1384) (#1380) 2019-01-04 01:50:55 +03:00
BizHawk.Emulation.Cores Fix quicknes 2019-01-06 12:16:28 -05:00
BizHawk.Emulation.DiscSystem DoSettings file for all project to explicitely set language level to C#6 2018-06-23 13:06:13 -05:00
BizHawk.Installer Update BizHawkFiles.wxs 2017-08-29 11:15:38 -04:00
Bizware remove junk accidentally added bizwareGL ClassDiagram 2018-11-30 09:08:44 -06:00
Build add a build tool command which can strip timestamps from PE files (for my own use). 2017-12-04 01:00:58 -06:00
CpuCoreGenerator Spaces -> tabs. 2017-04-15 16:37:30 -04:00
Dist include appconfigs in dist package 2017-08-03 17:08:13 -05:00
ExternalCoreProjects/Virtu Refactor ITraceable to work on TraceInfo objects that separate Disassembly and Register information. Make Tracelogger two columns. 2016-02-21 17:34:42 -05:00
LibretroBridge/vs2015 libretrobridge: fix warnings and rebuild dll 2017-06-13 16:25:15 -05:00
LuaInterface looks like i never got around to using the 64bit luaperks, so luasockets wasnt built-in as promised ever since we went 64bit. fixes #1077 2018-01-15 17:20:24 -06:00
References Add preliminary Unix compatibility (using Mono; resolves #1384) (#1380) 2019-01-04 01:50:55 +03:00
Version Lua: client.getversion() - #1314 2018-09-10 19:24:36 +03:00
attic remove all meteor and garbo stuff completely. These two GBA cores were never up to par, really. 2017-04-23 13:21:35 -04:00
blip_buf Add Blargg's "blip_buf" as an unmanaged dll. license is LGPL; if I like the way it works, I'll rewrite it with MIT code. Implement it as the new resampling output track for NES. Small (~3%)? speedup. Should sound better, especially when the emulator can't quite keep speed. 2012-12-09 03:13:47 +00:00
help Added help file 2014-07-26 21:24:27 +00:00
libgambatte Gambatte: savestate GB rgb palettes 2018-11-22 10:11:35 -06:00
libmupen64plus update gliden 2018-12-23 18:33:06 +03:00
lynx change output64 to output in some unmanaged core buildscripts 2017-06-12 16:13:54 -04:00
mgba@db0041340f mgba: update build - zero bios state bug fixed 2018-09-10 23:02:54 +03:00
miniz add Miniz-based ZipWriter. Ends up being aboot 15-20% faster than FrameworkZipWriter, but as a minus requires the entire contents of each chunk to be buffered first. Not connected until I can think of a better strategy... 2017-06-11 14:37:19 -04:00
output/dll update gliden 2018-12-23 18:33:06 +03:00
psx oops, i forgot to implement shock_Destroy. 2018-08-26 23:05:09 -05:00
quicknes change output64 to output in some unmanaged core buildscripts 2017-06-12 16:13:54 -04:00
vbanext get vbanext in the right place 2017-06-12 21:00:54 -04:00
waterbox bsnes: remove embarrassing leftover empty space from trace log 2018-05-21 22:25:34 +03:00
wonderswan change output64 to output in some unmanaged core buildscripts 2017-06-12 16:13:54 -04:00
.editorconfig add .editorconfig 2016-04-20 12:17:41 -05:00
.gitignore gitignore the .vs folder 2017-10-29 12:44:25 -05:00
.gitmodules mgba: update build - zero bios state bug fixed 2018-09-10 23:02:54 +03:00
BizHawk.sln trap more cases where n64 emulation can halt when running buggy code and shunt through my don't-halt-after-all logic. these are now all associated with error messages; it would be nice if someone knew a way to get those error messages out to c#. then again, that might make buggy code become hopelessly slow due to error spew 2018-11-03 14:04:34 -04:00
BizHawk.sln.DotSettings SxROM - some small cleanup/simplification 2018-11-01 10:27:51 -05:00
Building Other Solutions.txt Update Building Other Solutions.txt 2017-08-29 10:53:03 -04:00
CpuCoreGenerator.sln Upgrade CpuCoreGenerator solution also 2011-08-27 02:20:10 +00:00
Good Core Bad Core.txt philosophize about good cores and bad cores 2015-02-01 02:57:52 +00:00
LICENSE add MIT license to repository, since that's what it's always been, but add a long section describing what a mishmash this repository is -- fair warning. Fixes #933 2017-07-24 12:05:42 -05:00
README.md Update README.md 2019-01-09 17:05:57 +00:00
Settings.StyleCop Move VsyncNum and VsyncDen out of CoreComm and into IVideoProvider 2017-05-05 11:21:37 -05:00
subwcrev.sh Add subwcrev.sh build script for non-Windows platforms 2012-03-12 04:44:10 +00:00

README.md

BizHawk

GitHub latest release Unique systems emulated | 22

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).

tl;dr: click the "latest" button above to grab it. The changelog is here on tasvideos.org. Don't mix versions, copy config.ini to keep settings.

Core feature matrix

Most games for every system in the table will run perfectly, and every system supports fast-forward, frame advance, and rewind.

System Play+FF/ADV/RW Debugging (Input) Recording
Apple II ? ?
Atari 2600 ? ?
Atari 7800 ? ?
Atari Lynx ? ?
ColecoVision ? ?
Commodore 64 ? ?
Game Boy / GBC ? ?
GBA ? ?
Genesis ? ?
IntelliVision ? ?
Master System ? ?
N64 ? ?
Neo Geo Pocket ? ?
NES ? ?
PSX ? ?
Saturn ? ?
SNES ? ?
TI-83 ? ?
TurboGrafx-16 ? ?
Virtual Boy ? ?
WonderSwan ? ?
ZX Spectrum ? ?

EmuHawk's frontend also has a comprehensive input mapper, with keyboard and controller support (even simultaneously), hotkeys, and turbo/rapid fire.

In addition to input recording (with TAStudio), you can also record the emulated system's audio and video, either of your own gameplay or of a prerecorded movie (TAS). See the Usage (advanced) section below for more info about the many debugging and recording features.

Most of the frontend can be controlled with Lua scripts (only on Windows for now). These scripts can draw overlays for casual play or for RTA speedruns, change the running game to add complex cheats, assist TASers and romhackers in debugging a game, and more.

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 on tasvideos.org. Don't mix different versions of BizHawk, keep each version in its own folder.

Before you start (by running EmuHawk.exe), make sure you have the Windows-only prerequisites installed: .NET Framework 4.6.1; Visual C++ 2010 SP1, 2012, and 2015; and Direct3D 9. If you have a few Steam games, chances are these are already installed, otherwise you can get them all at once with this program.

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.

Win7 is supported from SP1, Win8 is supported from 8.1, and Win10 is supported from 1709 "Redstone 3", following Microsoft's support lifecycle.

Installing — GNU+Linux and macOS

Install BizHawk with your distro's package manager. The package name is given on each button below, and some buttons are links. For the changelog, see tasvideos.org.

Arch Linux (AUR) | bizhawk Debian (Launchpad) | bizhawk Linux Mint (Launchpad) | bizhawk macOS (Homebrew) | bizhawk Manjaro (AUR) | bizhawk Ubuntu (Launchpad) | bizhawk

If you run EmuHawkMono.sh from a terminal, note that File > Exit (Alt+F4) doesn't terminate the process correctly, you'll need to send SIGINT (^C).

Is your distro not there? Released binaries can be found right here on GitHub (same download as for Windows):

Misc. Linux | binaries

If you download BizHawk this way, don't mix different versions, keep each version in its own folder. Run EmuHawkMono.sh to give Mono the 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, you may need to edit it (if you use a terminal, it will say so in the output).

Linux distros are supported if the distributor is still supporting your version, you're using Linux 4.4/4.9/4.14/4.19 LTS or 4.20, and there are no updates available in your package manager. Please update and reboot.

macOS is supported from 10.11 "El Capitan" (Darwin 15.6). Apple doesn't seem to care about lifecycles, so we'll go with 6 months from the last security update.

Building

If you want to test the latest changes without building BizHawk yourself, grab the developer build from AppVeyor. Pick the topmost one that doesn't say "Pull request", then click "Artifacts" and download BizHawk_Developer-<datetime>-#<long hexadecimal>.zip.

If you use GNU+Linux, there might be a bizhawk-git package or similar in the same repo as the main package. If it's available, installing it will automate the build process.

GNU+Linux and macOS

Compiling requires MSBuild and running requires Mono and WINE, but BizHawk does not run under WINE — only the bundled libraries are required.

Building is as easy as:

git clone https://github.com/TASVideos/BizHawk.git BizHawk_master && cd BizHawk_master
# or ssh: git clone git@github.com:TASVideos/BizHawk.git BizHawk_master && cd BizHawk_master
msbuild /p:Configuration=Release BizHawk.sln

Remove the /p:... flag from MSBuild if you want debugging symbols.

If your distro isn't listed under Installing above, libblip_buf probably isn't in your package repos. You can easily build it yourself.

Once built, see the Installing section, substituting the repo's output folder for the download.

Again, if your distro isn't listed there, you might get an "Unknown distro" warning in the terminal, and BizHawk 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).

Windows 7/8.1/10

TODO

Compiling

Usage (casual)

TODO

Usage (advanced)

TODO

Commandline

CompactDiscInfoDump

Rerecording

TAS movie file format

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.org, or ask on IRC:

IRC | chat.freenode.net #bizhawk Matrix (IRC bridge) | #freenode_#bizhawk:matrix.org freenode webchat | #bizhawk

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 MIT license, this is optional, just be careful with reusing cores as some have copyleft licenses.

If you've already made changes, the best way to contribute is with a Pull Request here on GitHub. If you're looking for something to do, check the issue tracker here on GitHub:

GitHub open issues counter

It's a good idea to check if anyone is already working on an issue by asking on IRC (see Support above). And of course, open a "feature request" issue before adding features. No point making something that no-one's going to 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.