BizHawk/README.md

286 lines
19 KiB
Markdown
Raw Normal View History

# BizHawk
2019-01-10 17:45:48 +00:00
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).
2019-01-11 15:53:13 +00:00
[![unique systems emulated | 26](https://img.shields.io/badge/unique_systems_emulated-26-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores)
2019-01-10 14:30:05 +00:00
[![GitHub latest release](https://img.shields.io/github/release/TASVideos/BizHawk.svg?logo=github&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/releases/latest)
[![dev builds | AppVeyor](https://img.shields.io/badge/dev_builds-AppVeyor-orange.svg?logo=appveyor&logoColor=333333&style=popout)](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history)
2019-01-10 17:00:34 +00:00
[![Windows prereqs | GitHub](https://img.shields.io/badge/Windows_prereqs-GitHub-darkred.svg?logo=github&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk-Prereqs/releases/latest)
2019-01-08 06:08:37 +00:00
2019-01-11 12:11:49 +00:00
***
2019-01-10 17:28:48 +00:00
Click the "release" button above to grab the latest stable version ([changelog at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html)).
2019-01-11 16:14:59 +00:00
New user on Windows? Install the prerequisites first, click the "prereqs" button to get that and see [*Installing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#windows-78110) for info.
2019-01-10 17:28:48 +00:00
**Never mix different versions** of BizHawk — Keep each version in its own folder.
2019-01-09 17:04:45 +00:00
2019-01-09 17:39:13 +00:00
Jump to:
2019-01-11 10:08:06 +00:00
* Installing
2019-01-10 17:18:42 +00:00
* [Windows 7/8.1/10](https://github.com/TASVideos/BizHawk/blob/master/README.md#windows-78110)
* [GNU+Linux and macOS](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux-and-macos)
2019-01-11 10:08:06 +00:00
* Building
2019-01-11 08:26:27 +00:00
* [Windows 7/8.1/10](https://github.com/TASVideos/BizHawk/blob/master/README.md#windows-78110-1)
* [GNU+Linux and macOS](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux-and-macos-1)
2019-01-10 17:18:42 +00:00
* [Usage](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage)
* [TASing](https://github.com/TASVideos/BizHawk/blob/master/README.md#tasing)
2019-01-10 17:34:01 +00:00
* [Cores](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores)
2019-01-09 17:39:13 +00:00
* [Support and troubleshooting](https://github.com/TASVideos/BizHawk/blob/master/README.md#support-and-troubleshooting)
* [Contributing](https://github.com/TASVideos/BizHawk/blob/master/README.md#contributing)
2019-01-10 17:27:38 +00:00
* [Testing](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing)
2019-01-10 05:01:37 +00:00
* [Related projects](https://github.com/TASVideos/BizHawk/blob/master/README.md#related-projects)
2019-01-09 17:39:13 +00:00
* [License](https://github.com/TASVideos/BizHawk/blob/master/README.md#license)
2019-01-10 17:06:17 +00:00
## Features and systems
2019-01-08 11:56:04 +00:00
2019-01-10 14:45:58 +00:00
The BizHawk common features (across all cores) are:
2019-01-10 17:45:48 +00:00
* format, region, and integrity detection for game images
2019-01-10 17:39:03 +00:00
* 10 save slots with hotkeys and ∞ named savestates
2019-01-09 18:37:10 +00:00
* speed control, including frame stepping and rewinding
2019-01-10 17:45:48 +00:00
* memory view/search/edit in all emulated hardware components
2019-01-10 14:35:54 +00:00
* input recording (making TAS movies)
2019-01-10 17:55:46 +00:00
* screenshotting and recording audio + video to file
2019-01-10 17:45:48 +00:00
* firmware management
* input, framerate, and more in a HUD over the game
2019-01-10 16:44:52 +00:00
* emulated controllers via a comprehensive input mapper
* Lua control over core and frontend (Windows only)
2019-01-10 17:45:48 +00:00
* hotkey bindings to control the UI
2019-01-08 11:56:04 +00:00
2019-01-10 17:55:46 +00:00
Supported consoles and computers:
2019-01-10 16:44:52 +00:00
2019-01-11 08:07:44 +00:00
* Apple II
2019-01-11 16:12:24 +00:00
* Atari
2019-01-11 16:13:58 +00:00
* Video Computer System / 2600
2019-01-11 16:12:24 +00:00
* 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
2019-01-11 16:12:50 +00:00
* Famicom / Nintendo Entertainment System + FDS
2019-01-11 16:12:24 +00:00
* Game Boy + Color
* Game Boy Advance
* Nintendo 64
* Super Famicom / Super Nintendo Entertainment System
* Virtual Boy
* Sega
* Game Gear
* Genesis + 32X + CD
* Master System + SG-1000
* Pico
* Saturn
* Sinclair ZX Spectrum
* Sony Playstation / PSX
* Texas Instruments TI-83
2019-01-11 15:53:13 +00:00
* Uzebox
2019-01-10 16:44:52 +00:00
* [More](http://tasvideos.org/Bizhawk/CoreRoadMap.html) coming soon..?
2019-01-09 18:37:10 +00:00
2019-01-11 15:58:20 +00:00
See [*Usage*](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage) below for details about specific tools and config menus.
2019-01-08 11:56:04 +00:00
2019-01-10 17:18:42 +00:00
## Installing
### Windows 7/8.1/10
2015-06-22 20:49:18 +00:00
2019-01-08 06:08:37 +00:00
Released binaries can be found right here on GitHub:
2019-01-08 17:52:51 +00:00
[![Windows | binaries](https://img.shields.io/badge/Windows-binaries-%230078D6.svg?logo=windows&logoColor=0078D6&style=popout)](https://github.com/TASVideos/BizHawk/releases/latest)
2019-01-08 06:08:37 +00:00
2019-01-10 15:29:37 +00:00
Click `BizHawk-<version>.zip` to download it. Also note the changelog, the full version of which is [here at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html). **Don't mix different versions** of BizHawk, keep each version in its own folder.
2019-01-08 06:08:37 +00:00
2019-01-09 17:31:16 +00:00
Before you start (by running `EmuHawk.exe`), you'll need the following Windows-only prerequisites installed. You can get them all at once with [this program](https://github.com/TASVideos/BizHawk-Prereqs/releases/latest).
* .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.
2019-01-08 06:08:37 +00:00
Win7 is supported from SP1, Win8 is supported from 8.1, and Win10 is supported from 1709 "Redstone 3", following [Microsoft's support lifecycle](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet).
2019-01-11 11:58:06 +00:00
A "backport" release, [1.13.2](https://github.com/TASVideos/BizHawk/releases/tag/1.13.2), is available for Windows XP and 32-bit users. Being in the 1.x series, many bugs remain and features are missing.
2019-01-11 12:15:06 +00:00
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
2019-01-10 17:18:42 +00:00
### GNU+Linux and macOS
2019-01-08 06:08:37 +00:00
2019-01-10 15:29:37 +00:00
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 here](http://tasvideos.org/Bizhawk/ReleaseHistory.html).
2019-01-08 06:08:37 +00:00
[![Arch Linux (AUR) | bizhawk](https://img.shields.io/badge/Arch_Linux_(AUR)-bizhawk-%231793D1.svg?logo=arch-linux&style=popout)](https://aur.archlinux.org/packages/bizhawk)
2019-01-09 14:31:48 +00:00
[![Debian (Launchpad) | bizhawk](https://img.shields.io/badge/Debian_(Launchpad)-bizhawk-%23A81D33.svg?logo=debian&style=popout)](https://example.com/bizhawk)
2019-01-09 10:44:11 +00:00
[![Linux Mint (Launchpad) | bizhawk](https://img.shields.io/badge/Linux_Mint_(Launchpad)-bizhawk-%2387CF3E.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAF7UlEQVR4nO2bXWwUVRTHz1YEsRaNRDEqpkbUYE2RENhuZ85F/AqJIWKIxvigJqgEtSpYisWIl92dc31Qo6BiTHww0UiIMQQjpERs1NJuuzvnEkMUEpSYKBI/AI0YoGXxoR/p3pltu7vTsi3zT87bmTn3/PbeM/drAUKFCnVeizQeIMbD5W6K8VelxSHFuJcYdxLjJmKxPN5l1chWmFQ0AMXiuNLi7Pg1zBLjQWJ8Pc72HACInGcABhmLHmKxK8lCjBjEhAKQAwK3yFT02oIBOK54x9H4eDkaMa4kjescxs2K8WvS4thQIEiLI0nXXlIQgKRr3z+irlMGamyprXQy1iJi+z2l8agvBBbdjotrIN+QGM8ABos6F0wnxvX+Qxqzjisk+EGYKAD6JTvqqolxp3c44Bnl4jOeB4ICQJ32TZTBpQPGuLDkbIrUk5l5FzqMRBrPGCBOkmthjnNgADSuM4inAsmmeEWIxYtKY9Zo14GmNqtqwGsCAwAAiJC23/YWRtww4DHBAcCq9thUpQUb84TjTio6AwB85gHaflimotNkKjqtsaW2Um6tmQwjmFWVKwAAAHItVCx6ciC49ksA4AVALLpJ46l+UxqPksYUufi8bK2+KG+QMgYAvfXgC7MWyFaYVNBUmDR+nm/lVQqAhh2zpiTS9u1KYzMxblKueJNcsUKydbXpm+gU1zuMDcS4sdfs1UrXz39gK1wwVAwng/eac4N4Oja34LVAknFZUACkhArS4lHS+JNZrfsa+Y/S2CxbYVJjS20lsXhLaXHSb6JDjK7KiHvyxVrVHptKjL/n9nZ7deGLIRYfBgFASqggxk3+iXuq9hal8dvh/US3w/YL+WIqxm3Gez8BYlzoMN6Zz4hxowGgIwgAjouPjST5Qo1YdDvautsXgLZfMQC4Q7Wxr6HiaaO77SsVgJRQoTTu8+ldx4nxS8W4mxj/zp8oHiUWu5TGVqXFv9734G7w+XI5bD9ixPutcAAsvi8VADFeoRhPG43em2yPXdPvk+wSM/0gEYt2uaf+yn6/RKb+BmI8aNaOhh2zpphxk669xOgBJ84JANlRV21+lymDS72xrQdNAAlX3OGJ7eITRuxTMhWdZvop115s+pUJAMwS4y2mX5ztOUbsnmSXmOkFYKGZ2NrMvEvHFYBE2rrZEztdf6tZ4AYPk34ltagPAYQAQgAhgBBACCAEEAIIAYQAQgDBAlDafspoxA/gs9YuBEBTm1VFjCt7391rsvW2yzyg2mOXD/YhxpWNLbWVYwrAXGoqLQ6VCiBojfIQyF2Tk8a//DYbTACKcW9A+Q2rUQWQZCGMGtDjt12t2F5rDJU/hzpHCFKjCkBm7OvMU1a/TUfvUMFsMmPbAeU4pPwABLYjJLfWTCYtjuT+uoMOF/M0om8YbJMSKgLKM68U23cZcf9b1R6b6vErBgAAgHnhgFh0gVEI+w4eDpu9QGlsHu7UplQpjc0GgJ/9YhYPwMUmsw4k3LrZHj/GDZ5eoDGrGPcoxpcdbT9HbD8blDkuriGN7xPjCQPAp76gigUQ77JqvLct8A3Tr6nNqvLd7x9Tw2xS432BApASKhRjJvdhcUx2zb/K9E3o6I3effoxNBbb8w25ogEAAJArVpjBiPFdP18nFZ1BGj8iFt1jlThpPNN3OdJT/QMBIFtrLiEtfjHG2mknYy3K80gk4dbNJsb1xLhTsfhOadwfsO0jLb5SLF5LulYdDHORoyQAAH7nhL0V12+B4gdklGzEKhlAw45ZU4hF2jsURJo6F0wv6GXnQCUDAACIp2Nzlc+JLDG6sqOuOvhmB6dAAAAAEIvlPpcQz5IWRxzGh8Zi9leMAgMAAJHeywa+11qyxOIbyuBSmZl3cZAJlKogAQAARJTGZs/1s9xv8h+KxXbF4lVie7XD2HCObXOQAAAAIMm4zLx8NF4sEAAAvbc5iMXHYznxKSsAfYrE07G5isUH+f68UG4WNIABNbVZVcq1FzuMcaXFZ8Siq2/m9mOZ2f5RARAqVKhxo/8B55jpMzoUPycAAAAASUVORK5CYII=&style=popout)](https://example.com/bizhawk)
2019-01-08 06:08:37 +00:00
[![macOS (Homebrew) | bizhawk](https://img.shields.io/badge/macOS_(Homebrew)-bizhawk-%23999999.svg?logo=apple&style=popout)](https://example.com/bizhawk)
2019-01-09 10:44:11 +00:00
[![Manjaro (AUR) | bizhawk](https://img.shields.io/badge/Manjaro_(AUR)-bizhawk-%2335BF5C.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAABRUlEQVR4nO3bQUrDQBTG8Qdu3dS91r2CAzYE3Cm9QBURmjq7Yk9QIsELJYJ2XYqh7UJbL9NcYFyoGAQZiFMygf8Hb/vNm192IREhhJBS+ou4Fa3vM71Kitv3B1P3lHer2qFXSTFYJ2l/EbesANev46y7HJkw1yZ4GdQ+5d2qdoS5Nt3lyNy8xakV4Hw+LOq+tGuA77mY322sAL48+W0AhLk2f93b2SE+A/zuAwAAAAAAAAAAAAAAAAAAcH3IqcNpJMBWAkATAVy+E2wkgE9dAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADAZzrTaOPT0i67OtPI/suMyq6efVraZdfJ4+WTFWD3bP9Ypb1JMIsq/zzlHcAsKlTam+wFB0dWABHZEZFDEVHi4NO2f3S47FIi0v66GyHkJx/0rGTAdYdsEwAAAABJRU5ErkJggg==&style=popout)](https://aur.archlinux.org/packages/bizhawk)
2019-01-08 06:08:37 +00:00
[![Ubuntu (Launchpad) | bizhawk](https://img.shields.io/badge/Ubuntu_(Launchpad)-bizhawk-%23E95420.svg?colorA=772953&logo=ubuntu&style=popout)](https://example.com/bizhawk)
2019-01-10 17:26:07 +00:00
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`). The systems that currently work are: Game Boy + GBC (GBHawk), NES (NesHawk), Master System, Atari 7800, Commodore 64, ColecoVision, IntelliVision, TurboGrafx, and ZX Spectrum. See #1430 for progress.
2019-01-08 06:37:17 +00:00
Is your distro not there? Released binaries can be found right here on GitHub (same download as for Windows):
2019-01-08 06:08:37 +00:00
2019-01-08 17:52:51 +00:00
[![Misc. Linux | binaries](https://img.shields.io/badge/Misc._Linux-binaries-%23FCC624.svg?logo=linux&logoColor=black&style=popout)](https://github.com/TASVideos/BizHawk/releases/latest)
2019-01-08 06:08:37 +00:00
2019-01-08 06:37:17 +00:00
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).
2015-06-22 20:49:18 +00:00
2019-01-10 18:08:52 +00:00
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 for x86_64/amd64, and there are no updates available in your package manager. *Please* update and reboot.
2015-06-22 20:49:18 +00:00
2019-01-08 06:08:37 +00:00
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.
2015-06-22 20:49:18 +00:00
2019-01-11 12:14:13 +00:00
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
2019-01-10 17:26:07 +00:00
## Building
2017-01-08 16:23:45 +00:00
2019-01-09 17:09:28 +00:00
### Windows 7/8.1/10
2019-01-11 08:25:16 +00:00
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](https://desktop.github.com). Otherwise, you'll have to download an archive from GitHub.
2019-01-09 17:09:28 +00:00
2019-01-11 08:25:16 +00:00
On Windows 10, open a PowerShell window in BizHawk_master (Shift+Mouse2 in File Explorer) and run `C:\Windows\Microsoft.NET\Framework\v4.0.30319\msbuild.exe /p:Configuration=Release BizHawk.sln`. TODO: didn't work for me. On older versions, a similar Command Prompt script should work.
2019-01-10 15:53:32 +00:00
2019-01-11 08:25:16 +00:00
The best free C# IDE is [VS Community 2017](https://visualstudio.microsoft.com/vs/community), which you'll need to work on the project efficiently. Open `BizHawk.sln` with VS to start.
2019-01-09 17:09:28 +00:00
2019-01-11 12:15:06 +00:00
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
2019-01-08 06:08:37 +00:00
### GNU+Linux and macOS
2019-01-08 06:37:17 +00:00
*Compiling* requires MSBuild and *running* requires Mono and WINE, but **BizHawk does not run under WINE** — only the bundled libraries are required.
2019-01-11 10:07:09 +00:00
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.
2019-01-08 06:37:17 +00:00
Building is as easy as:
```sh
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
2019-01-09 15:46:32 +00:00
msbuild /p:Configuration=Release BizHawk.sln
2019-01-08 06:37:17 +00:00
```
2019-01-09 15:46:32 +00:00
Remove the `/p:...` flag from MSBuild if you want debugging symbols.
2019-01-09 15:35:01 +00:00
2019-01-09 15:46:32 +00:00
If your distro isn't listed under *Installing* above, `libblip_buf` probably isn't in your package repos. You can easily [build it yourself](https://gitlab.com/TASVideos/libblip_buf/blob/unified/README.md).
2019-01-09 15:35:01 +00:00
2019-01-11 15:58:20 +00:00
Once built, see [*Installing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux-and-macos) above, substituting the repo's `output` folder for the download.
2019-01-08 06:37:17 +00:00
2019-01-09 15:46:32 +00:00
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).
2019-01-08 06:08:37 +00:00
2019-01-11 12:14:13 +00:00
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
2019-01-10 17:18:42 +00:00
## Usage
2019-01-08 06:08:37 +00:00
TODO
2019-01-11 12:15:06 +00:00
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
2019-01-10 17:18:42 +00:00
### TASing
2019-01-08 06:08:37 +00:00
2019-01-10 15:29:37 +00:00
This section refers to BizHawk specifically. For resources on TASing in general, see [Welcome to TASVideos](http://tasvideos.org/WelcomeToTASVideos.html).
2019-01-08 06:08:37 +00:00
TODO
2019-01-08 11:56:04 +00:00
[Commandline](http://tasvideos.org/Bizhawk/CommandLine.html)
[CompactDiscInfoDump](http://tasvideos.org/Bizhawk/CompactDiscInfoDump.html)
[Rerecording](http://tasvideos.org/Bizhawk/Rerecording.html)
[TAS movie file format](http://tasvideos.org/Bizhawk/TASFormat.html)
2019-01-11 12:15:06 +00:00
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
2019-01-10 17:34:01 +00:00
### Cores
2019-01-11 15:46:54 +00:00
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*.
2019-01-10 17:34:01 +00:00
2019-01-11 10:00:38 +00:00
System | Core | Alt. Core | Special Core
2019-01-11 09:45:36 +00:00
--:|:--|:--|:--
Apple II | Virtu ||
Atari 2600 | Atari2600Hawk ||
Atari 7800 | A7800Hawk ||
Atari Lynx | Handy ||
Commodore 64 | C64Hawk ||
ColecoVision | ColecoHawk ||
2019-01-11 12:11:18 +00:00
Game Boy / Color | GBHawk | Gambatte | SameBoy (on SNES with SGB)
2019-01-11 15:45:15 +00:00
Game Boy Advance | mGBA | VBA-Next |
2019-01-11 09:45:36 +00:00
IntelliVision | IntelliHawk ||
N64 | Mupen64Plus ||
2019-01-11 10:00:38 +00:00
Neo Geo Pocket / Color | NeoPop || Dual NeoPop (dual instance)
2019-01-11 09:45:36 +00:00
NES | NesHawk | QuickNes ||
2019-01-11 10:00:38 +00:00
PC-FX | T.S.T. ||
2019-01-11 09:45:36 +00:00
Playstation (PSX) | Octoshock ||
Sega Game Gear | SMSHawk ||
Sega Genesis | Genplus-gx ||
Sega Master System | SMSHawk ||
Sega Saturn | Saturnus ||
2019-01-11 10:02:51 +00:00
Sega Pico | PicoDrive ||
2019-01-11 15:45:15 +00:00
SNES | BSNES | Snes9x |
2019-01-11 09:45:36 +00:00
TI-83 | TI83Hawk ||
TurboGrafx / SuperGrafx | PCEHawk ||
2019-01-11 15:53:13 +00:00
Uzebox | Uzem ||
2019-01-11 09:45:36 +00:00
Virtual Boy | Virtual Boyee ||
WonderSwan / Color | Cygne ||
ZX Spectrum | ZXHawk ||
2019-01-11 15:58:20 +00:00
Amstrad CPC, Magnavox Odyssey², and 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).
2019-01-10 17:34:01 +00:00
2019-01-11 12:14:13 +00:00
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
2019-01-09 06:21:12 +00:00
## Support and troubleshooting
2019-01-08 06:08:37 +00:00
2019-01-10 15:29:37 +00:00
A short [FAQ](http://tasvideos.org/Bizhawk/FAQ.html) is provided on the [BizHawk wiki](http://tasvideos.org/Bizhawk.html). If your problem is one of the many not answered there, and you can't find it in the [issue tracker search](https://github.com/TASVideos/BizHawk/issues?q=is%3Aissue+ISSUE_KEYWORDS), check the [BizHawk forum](http://tasvideos.org/forum/viewforum.php?f=64) at TASVideos, or ask on IRC:
2019-01-08 06:08:37 +00:00
2019-01-10 10:50:32 +00:00
[![IRC | chat.freenode.net #bizhawk](https://img.shields.io/badge/IRC-chat.freenode.net_%23bizhawk-steelblue.svg?style=flat)](ircs://chat.freenode.net:6697/bizhawk)
[![Matrix (IRC bridge) | #freenode_#bizhawk:matrix.org](https://img.shields.io/badge/Matrix_(IRC_bridge)-%23freenode__%23bizhawk:matrix.org-mediumpurple.svg?logo=matrix&style=flat)](https://matrix.to/#/#freenode_#bizhawk:matrix.org)
[![freenode webchat | #bizhawk](https://img.shields.io/badge/freenode_webchat-%23bizhawk-lightcoral.svg?style=flat)](http://webchat.freenode.net/?channels=bizhawk)
2015-06-22 20:49:18 +00:00
2019-01-09 17:24:20 +00:00
If there's no easy solution, what you've got is a bug. Or maybe a feature request. Either way, [open a new issue](https://github.com/TASVideos/BizHawk/issues/new) (you'll need a GitHub account, signup is very fast).
2019-01-11 12:15:06 +00:00
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
2019-01-08 11:56:04 +00:00
## Contributing
2015-06-22 20:49:18 +00:00
2019-01-08 11:56:04 +00:00
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.
2015-06-22 20:49:18 +00:00
2019-01-09 17:18:41 +00:00
If you'd like to fix bugs, check the issue tracker here on GitHub:
2015-06-22 20:49:18 +00:00
2019-01-10 11:11:26 +00:00
[![GitHub open issues counter](https://img.shields.io/github/issues-raw/TASVideos/BizHawk.svg?logo=github&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/issues)
2015-06-22 20:49:18 +00:00
2019-01-11 15:58:20 +00:00
It's a good idea to check if anyone is already working on an issue by asking on IRC (see [*Support*](https://github.com/TASVideos/BizHawk/blob/master/README.md#support-and-troubleshooting) above).
2019-01-09 17:18:41 +00:00
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.
2019-01-09 05:53:31 +00:00
2019-01-11 14:40:18 +00:00
For the time being, style is not enforced in PRs, only build success is. Please use CRLF, tabs, and [Allman braces](https://en.wikipedia.org/wiki/Indentation_style#Allman_style) in new files.
2019-01-11 14:33:19 +00:00
2019-01-11 12:08:42 +00:00
Past contrbutors to the frontend and custom-built cores are listed [here](https://github.com/TASVideos/BizHawk/graphs/contributors). See a core's docs for its authors.
2019-01-10 17:17:12 +00:00
### Testing
Dev builds are automated with AppVeyor, every green checkmark in the [commit history](https://github.com/TASVideos/BizHawk/commits/master) is a successful build and clicking the check takes you straight there. The full list is [here](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history), in future use the "dev builds" button at the top of this readme.
2019-01-11 10:07:09 +00:00
Once you're on the build page, click "Artifacts" and download `BizHawk_Developer-<datetime>-#<long hexadecimal>.zip`.
2019-01-11 12:14:13 +00:00
[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk)
2019-01-10 05:01:37 +00:00
## Related projects
* [DeSmuME](https://desmume.org) for DS/Lite — cross-platform
* [Dolphin](https://dolphin-emu.org) for GameCube and (original) Wii — cross-platform
* [FCEUX](http://www.fceux.com/web/home.html) for NES/Famicom — TASing is Windows-only, but it should run on Unix
2019-01-10 16:44:52 +00:00
* [libTAS](https://github.com/clementgallet/libTAS) for Linux ELF — GNU+Linux-only, also emulates other emulators
2019-01-11 08:07:44 +00:00
* [lsnes](http://tasvideos.org/Lsnes.html) for GB and SNES — cross-platform
2019-01-10 05:01:37 +00:00
* [openMSX](https://openmsx.org) for MSX — cross-platform
2019-01-08 11:56:04 +00:00
## License
2019-01-09 05:53:31 +00:00
From the [full text](https://github.com/TASVideos/BizHawk/blob/master/LICENSE):
> 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.
2019-01-09 05:54:24 +00:00
In short, the frontend is MIT (Expat), beyond that you're on your own.