GitHub - TASEmulators/BizHawk: 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. (original) (raw)

BizHawk

An emulation project.

EmuHawk is 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). More info below.

A7800Hawk, Atari2600Hawk, C64Hawk, ColecoHawk, GBHawk, IntelliHawk, NesHawk, O2Hawk, PCEHawk, SMSHawk, TI83Hawk, VectrexHawk, and ZXHawk are bespoke emulation cores written in C#. MSXHawk is a bespoke emulation core written in C++. More info below.

(latest) release | GitHub GitHub open issues counter

latest dev build (Windows) | GitHub Actions latest dev build (Linux) | GitHub Actions
Build and test main solution

reproducible via | Nix OpenSSF Best Practices

Jump to:

Features and systems

EmuHawk's features (common across all cores) are:

OoT screencap SMW screencap

Supported consoles and computers:

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

to top

Installing

Windows

Released binaries can be found right here on GitHub (also linked at the top of this readme):

Windows | binaries

Click BizHawk-<version>-win-x64.zip to download it. Also note the changelog, the full version of which is over on TASVideos. Extract it anywhere, but don't mix different versions of BizHawk, keep each version in its own folder. 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.

Run EmuHawk.exe to start. If startup is blocked by a Windows SmartScreen dialog, click "More Info" to reveal the override button. Third-party antivirus may also block startup. There are some command-line arguments you can use: see Passing command-line arguments.

EmuHawk does have some prerequisites which it can't work without (it will let you know if they're missing). The list is here, and we've made an all-in-one installer which you can get here. You should only have to run this once per machine, unless the changelog says we need something extra.

We will be following Microsoft in dropping support for old versions of Windows, that is, we reserve the right to ignore your problems unless you've updated to at least Win11 21H2 (initial release) or Win10 22H2. Read more on MSDN.

A "backport" release, 1.13.2, is available for users of Windows XP, 7, or 8.1 32-bit. It has many bugs that will never be fixed and it doesn't have all the features of the later versions.

to top

Unix

Note: There's only one dev working on Linux (@YoshiRulz)! Please have patience, and try not to bother everyone else.

Install the listed package with your package manager (some buttons are links to the relevant package). The changelog can be found over on TASVideos.

Manjaro | bizhawk-monort (AUR)

No package for your distro? Install via Nix (see below), or install manually by grabbing the latest release here on GitHub:

Misc. Linux | bizhawk-monort

If you download BizHawk this way, don't mix different versions, keep each version in its own folder. The runtime dependencies are glibc, Mono "complete", OpenAL, Lua 5.4, and lsb_release. The .NET 6 Runtime (a.k.a. .NET Core) is not a runtime dependency, only Mono. WINE is also not a runtime dependency. If you try to use WINE anyway then you're on your own.

Run EmuHawkMono.sh to start EmuHawk—you can run it from anywhere, so creating a .desktop file to wrap the script is fine. The shell script should print an error if it fails, otherwise it's safe to ignore console output. It takes mostly the same command-line arguments as on Windows: see Passing command-line arguments.

Most features and cores work, a notable omission being Mupen64Plus (N64). See the Linux thread, #1430, for a more detailed breakdown.

to top

macOS (legacy BizHawk)

EmuHawk depends on certain libraries for graphics, and these don't work on macOS. Users on macOS have three options:

to top

Nix/NixOS

(Curious what this Nix thing is about? Start here.)

Dev builds and a few recent releases can be built with Nix, either by cloning the repo, or by fetchzip'ing a commit and importing the expression from it. (The repo isn't a Flake yet, but you should be able to IFD.) See the dedicated Nix usage readme for what attributes are exposed. If you use a non-NixOS distro with Nix installed, you just need to add one argument and your host graphics drivers will be picked up thanks to nixGL.

You can also quickly get a development setup, including the .NET SDK and an IDE, with the provided shell.nix. See the Nix-specific docs for details.

to top

Development builds

Development builds are made automatically whenever someone contributes. Because of this, we recommend using a release for work that requires stability (such as TASing), and only switching to a dev build if there's a specific change or addition you need.

recent dev builds | GitHub Actions latest dev build (Windows) | GitHub Actions latest dev build (Linux) | GitHub Actions

recent dev builds | GitLab CI latest dev build | GitLab CI

Click one of the buttons above to download a dev build (they're also at the top of this readme).

To find the dev builds for a specific commit, you can click the green checkmark next to it (in the commit history, for example) for a dropdown, then click the link for any GitHub Actions workflow. (GitLab has a similar feature, but its Pipelines don't appear in GitHub's UI.)

Building

See the contributor guidelines.

tl;dr:

to top

Usage

Passing command-line arguments

EmuHawk takes some command-line options which are documented in the source. On Linux starting from 2.10, these can also be viewed offline with the usual --help.

On Windows 8.1/10, it's easiest to use PowerShell for this. For example, to pass --lua=C:\path\to\script.lua as the first argument and C:\path\to\rom.n64 as the second, navigate to the BizHawk install folder and run:

./EmuHawk.exe '--lua=C:\path\to\script.lua' 'C:\path\to\rom.n64'

On Linux, you can pass arguments to EmuHawkMono.sh as expected and they will be forwarded to mono. (You can also export env. vars.) All the arguments work as on Windows, with some caveats:

The same example as above would be ./EmuHawkMono.sh --lua=/path/to/script.lua /path/to/rom.n64.

For char escaping tips, see Unix StackExchange your shell's man/info page. BASH and Zsh have different rules!

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 EmuHawk looks for firmware by going to Config > Paths... and changing "Firmware" in the "Global" tab to the new location. This allows multiple installs to use the same folder.

Identifying a good rom

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

Rebinding hotkeys and virtual gamepads

There are two keybind windows, Config > Controllers... and Config > Hotkeys.... These let you bind your keyboard/mouse and gamepads to virtual gamepads, 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.

Selecting and configuring cores

To change which core is used where multiple cores emulate the same system (currently: NES, SNES, GB/C, SGB, and PCE/TG-16), look under Config > Cores. Under that menu, you'll also find the GB in SGB checkbox. When checked, GB/C games will be loaded using the chosen SGB core instead of the chosen GB core.

Cores have their own settings, which you can find in various windows under the system-specific menu (between Tools and Help when a rom is loaded). Some cores, like Mupen64Plus, have a labyrinth of menus while others have one.

Running Lua scripts

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 often have a "save progress" feature, which writes some save data on the cart or some sort of memory card. (Not to be confused with EmuHawk's savestates.) But when EmuHawk emulates this process, the in-game saves remain in the host system's memory (RAM) along with the rest of the virtual system, meaning it's not really saved. The save data needs to be copied to a file on disk (on the host), which we call "SaveRAM flushing".

You can simply use File > Save RAM > Flush Save Ram (default hotkey: Ctrl+S) to make EmuHawk save properly. The .SaveRAM files are in system-specific subfolders of the BizHawk install folder (configurable) for if you want to make backups, which you should.

The File > Save RAM menu is printed in bold when the virtual system does a save, which usually corresponds to pushing a "save progress" button in-game. Note that some games use SRAM for miscellaneous tasks, so it may not be strictly necessary to flush the SaveRAM every time it's changed. Can't hurt though.

EmuHawk can also flush automatically, which you can configure with Config > Customize... > Advanced > AutoSaveRAM. When closing or switching roms, EmuHawk may also try to flush SaveRAM. A disclaimer: Automatic flushing is extremely unreliable and not being maintained. It may corrupt your previous saves!

More disclaimers: Develop a habit to always flush saves manually every time you save in the game, and make backups of the flushed save files! If you don't flush saves manually and something breaks, you're on your own. If your save has been corrupted and you didn't make a backup, 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 The8bitbeast's and Sand_Knight and dwangoAC's.

TAStudio

A lot of useful information is presented in the video tutorials thread on TASVideos.

Analog controls

Enter analog editing mode by double-clicking on an analog input cell. The cell color will change. There are several ways to edit values:

While in analog editing mode, you can select multiple rows if you hold Shift or Control key and click on the Frame# column. That will allow you editing all those cells at once using Arrow keys or numeric input.

to top

External tools

Creating a GUI with Lua scripts is fiddly. If you know some C# (or another .NET language), you can replace your Lua script with an external tool. See the ext. tools wiki for more details.

We're looking to create a catalog of tools made by the community, share yours on IRC/Discord (links below).

Cores

A core is what we call the smaller bits of software that emulate just one system or family of systems, e.g. NesHawk for NES/Famicom. For the most part, we have one core per system, but sometimes you have the choice between speed (in terms of CPU usage) and accuracy.

In the table below, core names in bold are accuracy-focused and acceptable on TASVideos. The -Hawk cores are part of the BizHawk project. All other cores are ported, mainly from the Mednafen project.

System Cores
Apple II Virtu
Arcade MAME
Atari 2600 Atari2600Hawk
Atari 7800 A7800Hawk
Atari Jaguar Virtual Jaguar
Atari Lynx Handy
Commodore 64 C64Hawk
ColecoVision ColecoHawk
Game Boy / Color Gambatte, GBHawk, SameBoy
Game Boy Advance mGBA
Intellivision IntelliHawk
MSX MSXHawk
N64 Ares64, Mupen64Plus
NDS melonDS
Neo Geo Pocket NeoPop
NES NesHawk, quickerNES
Odyssey² O2Hawk
PC-FX T.S.T.
Playstation (PSX) Nymashock, Octoshock
Sega 32X PicoDrive
Sega Game Gear SMSHawk
Sega Genesis Genplus-gx
Sega Master System SMSHawk
Sega Saturn Saturnus
SNES BSNES, Faust, Snes9x
Super Game Boy BSNES, Gambatte
TI-83 Emu83, TI83Hawk
TIC-80 TIC-80 reference implementation
TurboGrafx HyperNyma, PCEHawk, TurboNyma
Uzebox Uzem
Vectrex VectrexHawk
Virtual Boy Virtual Boyee
WonderSwan / Color Cygne
ZX Spectrum ZXHawk

There are also works-in-progress for:

Please don't bother core devs about these WIPs unless you're looking to contribute in some way.

to top

Support and troubleshooting

A short FAQ is provided on the TASVideos wiki. If your problem is one of the many not answered there, and you can't find it in the issue tracker search, you can try:

You can open a new issue at any time if you're logged in to GitHub. Please at the very least read the issue templates, we tend to ask the same questions for every one-line issue that's opened.

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

to top

Contributing

EmuHawk or core development

Do you want your name next to these fine people? We have many open issues with no-one to work on them. Any which would be a good fit for someone who's new to Open Source are listed here (spoilers: it's probably empty).

The contribution guidelines have more details on how to get set up, work with the code, and submit changes to us.

Don't shy away from asking about an Issue on IRC/Discord (see above)! You might be given more info about the problem—or you might find out someone is already working on it. For adding new features it's especially important, because details are often left out of the issue tracker, and we may want to make sure the new addition is future-proofed.

With regards to core development, we're not particularly interested in PRs adding cores out-of-the-blue, but if you have experience in emulator development please get in touch. We have a wishlist of cores to port, and on top of that, many of our in-house cores are without a maintainer.

to top

Testing/QA

Not a programmer? You can still be helpful by grabbing a recent dev build and reproducing old bugs, i.e. checking if they've been fixed or not.

Those with hardware or other domain knowledge may be able to help triage issues like these.

to top

Localization

Not available. Contact YoshiRulz on Discord or elsewhere if you're interested in translating.

to top

License

EmuHawk and DiscoHawk can be used by anyone for any purpose allowed by the permissive MIT License (Expat). The full text is very short.

Any developers looking to re-use code from BizHawk in their own work should understand which files the license applies to. It's included in the text, but tl;dr: anything outside /src isn't ours and we can't give you permission to share, use, or sell it. That means not all the files included with BizHawk releases or dev builds are free to share, either.

Disclaimer time! Can't have emulation software without a disclaimer...

Following the terms of our license does not make you immune from other contracts or laws. Some or all of the following may be illegal where you live: creating a copy of non-free software for backup purposes ("dumping" or "ripping"); distributing copies of non-free software; soliciting pirated copies of software; knowingly posessing pirated copies of software; importing software from the USA (GitHub and TASVideos are American entities); using a backup copy of non-free software without the original. For obvious reasons, we cannot and will not distribute dumped games or firmware that is under copyright.

to top