|
|
|
@ -2,10 +2,10 @@
|
|
|
|
|
|
|
|
|
|
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).
|
|
|
|
|
|
|
|
|
|
[](https://github.com/TASVideos/BizHawk/releases/latest)
|
|
|
|
|
[](https://github.com/TASEmulators/BizHawk/releases/latest)
|
|
|
|
|
[](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/build/artifacts)
|
|
|
|
|
[](https://gitlab.com/TASVideos/BizHawk/pipelines/master/latest)
|
|
|
|
|
[](https://github.com/TASVideos/BizHawk/issues)
|
|
|
|
|
[](https://github.com/TASEmulators/BizHawk/issues)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
@ -92,19 +92,19 @@ See [*Usage*](#usage) below for info on basic config needed to play games.
|
|
|
|
|
|
|
|
|
|
Released binaries can be found right here on GitHub (also linked at the top of this readme):
|
|
|
|
|
|
|
|
|
|
[](https://github.com/TASVideos/BizHawk/releases/latest)
|
|
|
|
|
[](https://github.com/TASEmulators/BizHawk/releases/latest)
|
|
|
|
|
|
|
|
|
|
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).
|
|
|
|
|
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*](#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](https://github.com/TASVideos/BizHawk-Prereqs/blob/master/README), and we've made an all-in-one installer which you can get [here](https://github.com/TASVideos/BizHawk-Prereqs/releases/latest).
|
|
|
|
|
EmuHawk does have some prerequisites which it can't work without (it will let you know if they're missing). The list is [here](https://github.com/TASEmulators/BizHawk-Prereqs/blob/master/README), and we've made an all-in-one installer which you can get [here](https://github.com/TASEmulators/BizHawk-Prereqs/releases/latest).
|
|
|
|
|
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 Win10 1909 or Win8.1 KB4586845. Read more on [MSDN](https://docs.microsoft.com/en-us/lifecycle/faq/windows).
|
|
|
|
|
|
|
|
|
|
A "backport" release, [1.13.2](https://github.com/TASVideos/BizHawk/releases/tag/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.
|
|
|
|
|
A "backport" release, [1.13.2](https://github.com/TASEmulators/BizHawk/releases/tag/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](#bizhawk)
|
|
|
|
|
|
|
|
|
@ -118,13 +118,13 @@ Install the listed package with your package manager (some buttons are links to
|
|
|
|
|
|
|
|
|
|
No package for your distro? Grab the latest release here on GitHub (it's the same as the Windows version):
|
|
|
|
|
|
|
|
|
|
[](https://github.com/TASVideos/BizHawk/releases/latest)
|
|
|
|
|
[](https://github.com/TASEmulators/BizHawk/releases/latest)
|
|
|
|
|
|
|
|
|
|
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, and `lsb_release`. .NET Core is **not** a runtime dependency, only Mono. WINE is also **not** a runtime dependency.
|
|
|
|
|
|
|
|
|
|
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*](#passing-command-line-arguments).
|
|
|
|
|
|
|
|
|
|
Most features and cores work, notable omissions being Lua support, Mupen64Plus (N64), and Octoshock (PSX). See [#1430](https://github.com/TASVideos/BizHawk/issues/1430) for details.
|
|
|
|
|
Most features and cores work, notable omissions being Lua support, Mupen64Plus (N64), and Octoshock (PSX). See [#1430](https://github.com/TASEmulators/BizHawk/issues/1430) for details.
|
|
|
|
|
|
|
|
|
|
[to top](#bizhawk)
|
|
|
|
|
|
|
|
|
@ -150,7 +150,7 @@ Click one of the buttons above to download a dev build (they're also at the top
|
|
|
|
|
* On the AppVeyor page for a Build, click "Artifacts", then `BizHawk_Developer-<datetime>-#<long hexadecimal>.zip`.
|
|
|
|
|
* On the GitLab CI page for a Pipeline, click "Jobs", then the download button on the right under the heading "Package". (On the Pipelines list page, there's also a download button on each Pipeline—choose `package_devbuild_*:archive` there.)
|
|
|
|
|
|
|
|
|
|
To find the dev builds for a specific commit, you can click the green checkmark next to it (in the [commit history](https://github.com/TASVideos/BizHawk/commits/master), for example) for a dropdown, then click either "Details" link to go to AppVeyor/GitLab.
|
|
|
|
|
To find the dev builds for a specific commit, you can click the green checkmark next to it (in the [commit history](https://github.com/TASEmulators/BizHawk/commits/master), for example) for a dropdown, then click either "Details" link to go to AppVeyor/GitLab.
|
|
|
|
|
|
|
|
|
|
## Building
|
|
|
|
|
|
|
|
|
@ -158,7 +158,7 @@ To find the dev builds for a specific commit, you can click the green checkmark
|
|
|
|
|
|
|
|
|
|
If you have WSL, Git BASH, or similar, clone the repo with:
|
|
|
|
|
```
|
|
|
|
|
git clone https://github.com/TASVideos/BizHawk.git BizHawk_master
|
|
|
|
|
git clone https://github.com/TASEmulators/BizHawk.git BizHawk_master
|
|
|
|
|
# or ssh: git clone git@github.com:TASVideos/BizHawk.git BizHawk_master
|
|
|
|
|
```
|
|
|
|
|
...then go into the repo's `Dist` folder and run `QuickTestBuildAndPackage_Release.bat`. This is the same process used by AppVeyor.
|
|
|
|
@ -174,7 +174,7 @@ With VS, start the build by choosing the `BizHawk.Client.EmuHawk` executable in
|
|
|
|
|
|
|
|
|
|
Before you can build, you'll need the .NET 5 SDK or later (package name is usually `dotnet-sdk-5.0`, see [full instructions](https://docs.microsoft.com/en-gb/dotnet/core/install/linux)). You may need to uninstall MSBuild and/or the 3.1 SDK first. Once it's installed, run:
|
|
|
|
|
```sh
|
|
|
|
|
git clone https://github.com/TASVideos/BizHawk.git BizHawk_master && cd BizHawk_master
|
|
|
|
|
git clone https://github.com/TASEmulators/BizHawk.git BizHawk_master && cd BizHawk_master
|
|
|
|
|
# or ssh: git clone git@github.com:TASVideos/BizHawk.git BizHawk_master && cd BizHawk_master
|
|
|
|
|
Dist/BuildRelease.sh
|
|
|
|
|
```
|
|
|
|
@ -189,7 +189,7 @@ VS 2019 isn't available on Linux, but Rider and VS Code are. You can always code
|
|
|
|
|
|
|
|
|
|
#### Passing command-line arguments
|
|
|
|
|
|
|
|
|
|
EmuHawk takes some command-line options which aren't well-documented; you might be able to figure them out from [the source](https://github.com/TASVideos/BizHawk/blob/78daf4913d4c8e47d24fc14d84ca33ddef913ed4/src/BizHawk.Client.Common/ArgParser.cs).
|
|
|
|
|
EmuHawk takes some command-line options which aren't well-documented; you might be able to figure them out from [the source](https://github.com/TASEmulators/BizHawk/blob/78daf4913d4c8e47d24fc14d84ca33ddef913ed4/src/BizHawk.Client.Common/ArgParser.cs).
|
|
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
```pwsh
|
|
|
|
@ -280,9 +280,9 @@ For now, the best way to learn how to TAS is to browse pages like [BasicTools](h
|
|
|
|
|
|
|
|
|
|
### 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](https://github.com/TASVideos/BizHawk-ExternalTools/wiki) for more details.
|
|
|
|
|
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](https://github.com/TASEmulators/BizHawk-ExternalTools/wiki) for more details.
|
|
|
|
|
|
|
|
|
|
We're looking to create [a catalog](https://github.com/TASVideos/BizHawk-ExternalTools/wiki/Catalog) of tools made by the community, share yours on IRC/Discord (links [below](#support-and-troubleshooting)).
|
|
|
|
|
We're looking to create [a catalog](https://github.com/TASEmulators/BizHawk-ExternalTools/wiki/Catalog) of tools made by the community, share yours on IRC/Discord (links [below](#support-and-troubleshooting)).
|
|
|
|
|
|
|
|
|
|
### Cores
|
|
|
|
|
|
|
|
|
@ -337,12 +337,12 @@ Please don't bother core devs about these WIPs unless you're looking to contribu
|
|
|
|
|
|
|
|
|
|
## Support and troubleshooting
|
|
|
|
|
|
|
|
|
|
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+PUT_ISSUE_KEYWORDS_HERE), you can try:
|
|
|
|
|
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/TASEmulators/BizHawk/issues?q=is%3Aissue+PUT_ISSUE_KEYWORDS_HERE), you can try:
|
|
|
|
|
* `#emulation` on [the TASVideos Discord](https://discordapp.com/invite/GySG2b6) (also the more specialised channels `#tas-production` and `#scripting`, and [the ApiHawk server](https://discord.gg/UPhN4um3px))
|
|
|
|
|
* `#bizhawk` on Libera Chat ([via Matrix](https://matrix.to/#/#bizhawk:libera.chat) or [via IRC](https://libera.chat/guides/connect))
|
|
|
|
|
* The TASVideos [forum for BizHawk](http://tasvideos.org/forum/viewforum.php?f=64)
|
|
|
|
|
|
|
|
|
|
You can [open a new issue](https://github.com/TASVideos/BizHawk/issues/new) 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.
|
|
|
|
|
You can [open a new issue](https://github.com/TASEmulators/BizHawk/issues/new) 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.
|
|
|
|
|
|
|
|
|
|
[to top](#bizhawk)
|
|
|
|
|
|
|
|
|
@ -350,7 +350,7 @@ You can [open a new issue](https://github.com/TASVideos/BizHawk/issues/new) at a
|
|
|
|
|
|
|
|
|
|
### EmuHawk development
|
|
|
|
|
|
|
|
|
|
Do you want your name next to [these fine people](https://github.com/TASVideos/BizHawk/graphs/contributors)? Fork the repo and work on one of our [many open issues](https://github.com/TASVideos/BizHawk/issues).
|
|
|
|
|
Do you want your name next to [these fine people](https://github.com/TASEmulators/BizHawk/graphs/contributors)? Fork the repo and work on one of our [many open issues](https://github.com/TASEmulators/BizHawk/issues).
|
|
|
|
|
If you ask on IRC/Discord (see above), you might get more info about the problem—or you might find someone else is also working on it. It's especially important to ask about adding new features.
|
|
|
|
|
|
|
|
|
|
All the source code for EmuHawk is in `/src`. The project file, `/src/BizHawk.Client.EmuHawk/BizHawk.Client.EmuHawk.csproj`, includes the other projects [in a tree](https://gitlab.com/TASVideos/BizHawk/snippets/1886666).
|
|
|
|
@ -387,7 +387,7 @@ ping YoshiRulz on IRC or Discord (`YoshiRulz#4472`)
|
|
|
|
|
|
|
|
|
|
### License
|
|
|
|
|
|
|
|
|
|
EmuHawk and DiscoHawk can be used by anyone for any purpose allowed by the permissive *MIT License* (Expat). The [full text](https://github.com/TASVideos/BizHawk/blob/master/LICENSE) is very short.
|
|
|
|
|
EmuHawk and DiscoHawk can be used by anyone for any purpose allowed by the permissive *MIT License* (Expat). The [full text](https://github.com/TASEmulators/BizHawk/blob/master/LICENSE) 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.
|
|
|
|
|
|
|
|
|
@ -407,6 +407,6 @@ Disclaimer time! Can't have emulation software without a disclaimer...
|
|
|
|
|
* [melonDS](http://melonds.kuribo64.net) for Nintendo DS — cross-platform
|
|
|
|
|
* [mGBA](https://mgba.io) for GBA and GB/C — cross-platform
|
|
|
|
|
|
|
|
|
|
Emulators for other systems can be found on the [EmulatorResources page](http://tasvideos.org/EmulatorResources.html) at TASVideos. The [TASVideos GitHub page](https://github.com/TASVideos) also holds copies of other emulators and plugins where development happens sometimes, their upstreams may be of use.
|
|
|
|
|
Emulators for other systems can be found on the [EmulatorResources page](http://tasvideos.org/EmulatorResources.html) at TASVideos. The [TASEmulators GitHub page](https://github.com/TASEmulators) also holds copies of other emulators and plugins where development happens sometimes, their upstreams may be of use.
|
|
|
|
|
|
|
|
|
|
[to top](#bizhawk)
|
|
|
|
|