From 5f642845e710cd56981ae8f4af0d64c65a1bf598 Mon Sep 17 00:00:00 2001 From: James Groom Date: Tue, 8 Jan 2019 16:08:37 +1000 Subject: [PATCH 001/153] draft 1 --- README.md | 89 +++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 74 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 05d9dd6cda..18ec806b05 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,84 @@ # BizHawk +![GitHub latest release](https://img.shields.io/github/release/TASVideos/BizHawk.svg?logo=github&style=flat) + BizHawk is a multi-system emulator written in C#. BizHawk provides nice features for casual gamers such as fullscreen, rewind, and joypad support in addition to rerecording and debugging tools for all system cores. -[Release Notes](http://tasvideos.org/Bizhawk/ReleaseHistory.html) +## Installing — Windows 7/8.1/10 + +Released binaries can be found right here on GitHub: + +[![Windows | binaries](https://img.shields.io/badge/Windows-binaries-%230078D6.svg?logo=windows&logoColor=0078D6&style=popout)](http://github.com/TASVideos/BizHawk/releases) + +Click `BizHawk-.zip` to download it. Also note the changelog, the full version of which is [on tasvideos.org](http://tasvideos.org/Bizhawk/ReleaseHistory.html). **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](http://github.com/TASVideos/BizHawk-Prereqs/releases). + +BizHawk functions like a "portable" program, you may move or rename the folder containing `EmuHawk.exe`, even to another drive, as long as 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](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet). + +## 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](http://tasvideos.org/Bizhawk/ReleaseHistory.html). + +[![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) +[![CentOS | bizhawk](https://img.shields.io/badge/CentOS-bizhawk-%23941D7A.svg?logo=centos&style=popout)](https://example.com/bizhawk) +[![Debian (Launchpad) | bizhawk](https://img.shields.io/badge/Debian_(Launchpad)-bizhawk-%23A81D33.svg?logo=debian&style=popout)](https://example.com/bizhawk) +[![elementaryOS (Launchpad) | bizhawk](https://img.shields.io/badge/elementaryOS-bizhawk-%2364BAFF.svg?logo=elementary&style=popout)](https://example.com/bizhawk) +[![Fedora | bizhawk](https://img.shields.io/badge/Fedora-bizhawk-%23294172.svg?logo=fedora&style=popout)](https://example.com/bizhawk) +[![Gentoo | bizhawk](https://img.shields.io/badge/Gentoo-bizhawk-%234E4371.svg?logo=gentoo&style=popout)](https://example.com/bizhawk) +[![Hyperbola | bizhawk](https://img.shields.io/badge/Hyperbola-bizhawk-black.svg?logo=hyperbola&style=popout)](https://example.com/bizhawk) +[![Linux Mint (Launchpad) | bizhawk](https://img.shields.io/badge/Linux_Mint_(Launchpad)-bizhawk-%2387CF3E.svg?logo=linux-mint&style=popout)](https://example.com/bizhawk) +[![macOS (Homebrew) | bizhawk](https://img.shields.io/badge/macOS_(Homebrew)-bizhawk-%23999999.svg?logo=apple&style=popout)](https://example.com/bizhawk) +[![Manjaro (AUR) | bizhawk](https://img.shields.io/badge/Manjaro_(AUR)-bizhawk-%2335BF5C.svg?logo=manjaro&style=popout)](https://aur.archlinux.org/packages/bizhawk) +[![MX Linux | bizhawk](https://img.shields.io/badge/MX_Linux-bizhawk-%23506E88.svg?logo=mx-linux&style=popout)](https://example.com/bizhawk) +[![NixOS | bizhawk](https://img.shields.io/badge/NixOS-bizhawk-%234F73BC.svg?colorA=7EB5E0&logo=nixos&style=popout)](https://example.com/bizhawk) +[![openSUSE | bizhawk](https://img.shields.io/badge/openSUSE-bizhawk-%236DA741.svg?logo=opensuse&style=popout)](https://example.com/bizhawk) +[![Solus | bizhawk](https://img.shields.io/badge/Solus-bizhawk-%235294E2.svg?colorA=4C5164&logo=solus&style=popout)](https://example.com/bizhawk) +[![SteamOS (Launchpad) | bizhawk](https://img.shields.io/badge/SteamOS-bizhawk-%231B2838.svg?logo=steam&logoColor=1B2838&style=popout)](https://example.com/bizhawk) +[![Ubuntu (Launchpad) | bizhawk](https://img.shields.io/badge/Ubuntu_(Launchpad)-bizhawk-%23E95420.svg?colorA=772953&logo=ubuntu&style=popout)](https://example.com/bizhawk) + +Is your distro not there? Released binaries can be found right here on GitHub: + +[![Misc. Linux | binaries](https://img.shields.io/badge/Misc._Linux-binaries-%23FCC624.svg?logo=linux&logoColor=black&style=popout)](http://github.com/TASVideos/BizHawk/releases) + +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](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history). Pick the topmost one that doesn't say "Pull request", then click "Artifacts" and download the single listed file (it's compressed as .zip). + +If you use GNU+Linux, there might be a `bizhawk-git` package or similar in the same repo as `bizhawk`. This will build and install from the `master` branch here on GitHub. + +### GNU+Linux and macOS + +TODO + +### Windows 7/8.1/10 + +TODO + +## Usage and troubleshooting (casual) + +TODO + +## Usage (TASing or romhacking) + +TODO + +## License + +TODO + +## junk [Here](http://tasvideos.org/Bizhawk/Features.html) is a list of features offered by bizhawk. -## Download Binaries - -Windows users, don't forget to run the [prereq installer](http://github.com/TASVideos/BizHawk-Prereqs/releases) first! - -Release binaries can be found on [on github](http://github.com/TASVideos/BizHawk/releases) - -[Developer build](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/build/artifacts) of the most recent commit - -Never mix different versions of BizHawk. Keep each version in its own folder. - -## Supported Systems - * Nintendo Entertainment System / Famicom / Famicom Disk System (NES/FDS) * Super Nintendo (SNES) * Nintendo 64 @@ -38,8 +99,6 @@ Never mix different versions of BizHawk. Keep each version in its own folder. * Commodore 64 * Sinclair ZX Spectrum -## Resources - [BizHawk homepage](http://tasvideos.org/Bizhawk.html) [FAQ](http://tasvideos.org/Bizhawk/FAQ.html) - Frequently Asked Questions / Troubleshooting From a53f1f97dc014fae82fc58cff88b9d38d3e1de9c Mon Sep 17 00:00:00 2001 From: James Groom Date: Tue, 8 Jan 2019 16:37:17 +1000 Subject: [PATCH 002/153] draft 2 --- README.md | 29 +++++++++++++++++++++++------ 1 file changed, 23 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 18ec806b05..9256672fce 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Click `BizHawk-.zip` to download it. Also note the changelog, the full 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](http://github.com/TASVideos/BizHawk-Prereqs/releases). -BizHawk functions like a "portable" program, you may move or rename the folder containing `EmuHawk.exe`, even to another drive, as long as the prerequisites are installed when you go to run it. +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](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet). @@ -39,11 +39,13 @@ Install BizHawk with your distro's package manager. The package name is given on [![SteamOS (Launchpad) | bizhawk](https://img.shields.io/badge/SteamOS-bizhawk-%231B2838.svg?logo=steam&logoColor=1B2838&style=popout)](https://example.com/bizhawk) [![Ubuntu (Launchpad) | bizhawk](https://img.shields.io/badge/Ubuntu_(Launchpad)-bizhawk-%23E95420.svg?colorA=772953&logo=ubuntu&style=popout)](https://example.com/bizhawk) -Is your distro not there? Released binaries can be found right here on GitHub: +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](https://img.shields.io/badge/Misc._Linux-binaries-%23FCC624.svg?logo=linux&logoColor=black&style=popout)](http://github.com/TASVideos/BizHawk/releases) -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). +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. @@ -51,13 +53,28 @@ macOS is supported from 10.11 "El Capitan" (Darwin 15.6). Apple doesn't seem to ## Building -If you want to test the latest changes without building BizHawk yourself, grab the developer build from [AppVeyor](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history). Pick the topmost one that doesn't say "Pull request", then click "Artifacts" and download the single listed file (it's compressed as .zip). +If you want to test the latest changes without building BizHawk yourself, grab the developer build from [AppVeyor](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history). Pick the topmost one that doesn't say "Pull request", then click "Artifacts" and download `BizHawk_Developer--#.zip`. -If you use GNU+Linux, there might be a `bizhawk-git` package or similar in the same repo as `bizhawk`. This will build and install from the `master` branch here on GitHub. +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 -TODO +*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: +```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 +msbuild BizHawk.sln +``` + +Running is even easier, just execute `EmuHawkMono.sh` in the repo's `output` folder (this folder is what gets distributed in a Release build, you can move/rename it). + +If your distro isn't listed under *Installing* above, 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). + +Again, if your distro isn't listed 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). + +Otherwise, see the *Installing* section above. ### Windows 7/8.1/10 From a6b371727197a85ef625aeb7443080d271472f5f Mon Sep 17 00:00:00 2001 From: James Groom Date: Tue, 8 Jan 2019 21:56:04 +1000 Subject: [PATCH 003/153] draft 3 --- README.md | 112 +++++++++++++++++++++++++++++++++++------------------- 1 file changed, 72 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 9256672fce..6fe249b572 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,41 @@ BizHawk is a multi-system emulator written in C#. BizHawk provides nice features for casual gamers such as fullscreen, rewind, and joypad support in addition to rerecording and debugging tools for all system cores. +## 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: @@ -74,57 +109,54 @@ If your distro isn't listed under *Installing* above, you might get an "Unknown Again, if your distro isn't listed 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). -Otherwise, see the *Installing* section above. +Once built, see the *Installing* section above. ### Windows 7/8.1/10 TODO -## Usage and troubleshooting (casual) +[Compiling](http://tasvideos.org/Bizhawk/Compiling.html) + +## Usage (casual) TODO -## Usage (TASing or romhacking) +## Usage (advanced) TODO +[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) + +## Troubleshooting and support + +TODO + +[BizHawk forum](http://tasvideos.org/forum/viewforum.php?f=64) + +[BizHawk wiki](http://tasvideos.org/Bizhawk.html) + +[FAQ](http://tasvideos.org/Bizhawk/FAQ.html) + +## 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](https://img.shields.io/github/issues-raw/TASVideos/BizHawk.svg?logo=github&style=flat)](https://github.com/TASVideos/BizHawk/issues) + +It's a good idea to check if anyone else is working on an issue by asking on IRC: + +[![IRC | chat.freenode.net #bizhawk](https://img.shields.io/badge/IRC-chat.freenode.net_%23bizhawk-black.svg?style=flat)](ircs://chat.freenode.net:6697/bizhawk) +[![Matrix (via bridge) | #freenode_#bizhawk:matrix.org](https://img.shields.io/badge/Matrix_(via_bridge)-%23freenode__%23bizhawk:matrix.org-black.svg?logo=matrix&style=flat)](https://matrix.to/#/#freenode_#bizhawk:matrix.org) +[![freenode webchat | #bizhawk](https://img.shields.io/badge/freenode_webchat-%23bizhawk-black.svg?style=flat)](http://webchat.freenode.net/?channels=bizhawk) + ## License TODO - -## junk - -[Here](http://tasvideos.org/Bizhawk/Features.html) is a list of features offered by bizhawk. - - * Nintendo Entertainment System / Famicom / Famicom Disk System (NES/FDS) - * Super Nintendo (SNES) - * Nintendo 64 - * Game Boy, Game Boy Color, and Super Game Boy - * Game Boy Advance - * Sony PlayStation - * Sega Master System, Game Gear, and SG-1000 - * Sega Genesis / Sega-CD - * Sega Saturn - * PC-Engine (TurboGrafx-16) / CD-ROM & SuperGrafx - * Atari 2600 - * Atari 7800 - * Atari Lynx - * ColecoVision - * TI-83 Calculator - * Wonderswan and Wonderswan Color - * Apple II - * Commodore 64 - * Sinclair ZX Spectrum - -[BizHawk homepage](http://tasvideos.org/Bizhawk.html) - -[FAQ](http://tasvideos.org/Bizhawk/FAQ.html) - Frequently Asked Questions / Troubleshooting - -[Compiling](http://tasvideos.org/Bizhawk/Compiling.html) - What is needed to compile BizHawk src - -[CompactDiscInfoDump](http://tasvideos.org/Bizhawk/CompactDiscInfoDump.html) - A concise explanation of compact disc CDs, gathered for the first time EVER in one location, and mostly inaccurate - -[Rerecording](http://tasvideos.org/Bizhawk/Rerecording.html) - (Work in progress) - Documentation of the rerecording implementation of BizHawk - * [TAS movie file format](http://tasvideos.org/Bizhawk/TASFormat.html) - Mnemonic patterns for each platform for .tas (input) files. - -[Commandline](http://tasvideos.org/Bizhawk/CommandLine.html) - Documentation of the command line options in BizHawk From 47064f3d21bc9a727bcacb7a73119a6695dd39f7 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 03:52:51 +1000 Subject: [PATCH 004/153] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6fe249b572..8974b9173f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # BizHawk -![GitHub latest release](https://img.shields.io/github/release/TASVideos/BizHawk.svg?logo=github&style=flat) +[![GitHub latest release](https://img.shields.io/github/release/TASVideos/BizHawk.svg?logo=github&style=flat)](https://github.com/TASVideos/BizHawk/releases/latest) ![Unique systems emulated | 22](https://img.shields.io/badge/Unique_systems_emulated-22-darkgreen.svg?style=flat) BizHawk is a multi-system emulator written in C#. BizHawk provides nice features for casual gamers such as fullscreen, rewind, and joypad support in addition to rerecording and debugging tools for all system cores. @@ -43,11 +43,11 @@ Most of the frontend can be controlled with Lua scripts (only on Windows for now Released binaries can be found right here on GitHub: -[![Windows | binaries](https://img.shields.io/badge/Windows-binaries-%230078D6.svg?logo=windows&logoColor=0078D6&style=popout)](http://github.com/TASVideos/BizHawk/releases) +[![Windows | binaries](https://img.shields.io/badge/Windows-binaries-%230078D6.svg?logo=windows&logoColor=0078D6&style=popout)](https://github.com/TASVideos/BizHawk/releases/latest) Click `BizHawk-.zip` to download it. Also note the changelog, the full version of which is [on tasvideos.org](http://tasvideos.org/Bizhawk/ReleaseHistory.html). **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](http://github.com/TASVideos/BizHawk-Prereqs/releases). +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](https://github.com/TASVideos/BizHawk-Prereqs/releases/latest). 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. @@ -78,7 +78,7 @@ If you run `EmuHawkMono.sh` from a terminal, note that `File > Exit (Alt+F4)` do Is your distro not there? Released binaries can be found right here on GitHub (same download as for Windows): -[![Misc. Linux | binaries](https://img.shields.io/badge/Misc._Linux-binaries-%23FCC624.svg?logo=linux&logoColor=black&style=popout)](http://github.com/TASVideos/BizHawk/releases) +[![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) 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). From 689eb388018942fb0969bca573a73b28e6c57359 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 03:57:51 +1000 Subject: [PATCH 005/153] Copy blurb from GitLab mirror --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8974b9173f..11f858ae01 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![GitHub latest release](https://img.shields.io/github/release/TASVideos/BizHawk.svg?logo=github&style=flat)](https://github.com/TASVideos/BizHawk/releases/latest) ![Unique systems emulated | 22](https://img.shields.io/badge/Unique_systems_emulated-22-darkgreen.svg?style=flat) -BizHawk is a multi-system emulator written in C#. BizHawk provides nice features for casual gamers such as fullscreen, rewind, and joypad support in addition to rerecording and debugging tools for all system cores. +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). ## Core feature matrix From 0005b938e0a632e55d153a4cb0e4479e391e88f2 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 15:53:31 +1000 Subject: [PATCH 006/153] Update README.md --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 11f858ae01..e3a26c0df7 100644 --- a/README.md +++ b/README.md @@ -154,9 +154,14 @@ If you've already made changes, the best way to contribute is with a Pull Reques It's a good idea to check if anyone else is working on an issue by asking on IRC: [![IRC | chat.freenode.net #bizhawk](https://img.shields.io/badge/IRC-chat.freenode.net_%23bizhawk-black.svg?style=flat)](ircs://chat.freenode.net:6697/bizhawk) -[![Matrix (via bridge) | #freenode_#bizhawk:matrix.org](https://img.shields.io/badge/Matrix_(via_bridge)-%23freenode__%23bizhawk:matrix.org-black.svg?logo=matrix&style=flat)](https://matrix.to/#/#freenode_#bizhawk:matrix.org) +[![Matrix (IRC bridge) | #freenode_#bizhawk:matrix.org](https://img.shields.io/badge/Matrix_(IRC_bridge)-%23freenode__%23bizhawk:matrix.org-black.svg?logo=matrix&style=flat)](https://matrix.to/#/#freenode_#bizhawk:matrix.org) [![freenode webchat | #bizhawk](https://img.shields.io/badge/freenode_webchat-%23bizhawk-black.svg?style=flat)](http://webchat.freenode.net/?channels=bizhawk) +And of course, open a "feature request" issue before adding features. No point making something that no-one's going to use. + ## License -TODO +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. + +In short, the frontend is MIT, and past that you're on your own. From a43eacaa40a8e7173504d040df40a7cec2b5105d Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 15:54:24 +1000 Subject: [PATCH 007/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e3a26c0df7..d367efc523 100644 --- a/README.md +++ b/README.md @@ -164,4 +164,4 @@ And of course, open a "feature request" issue before adding features. No point m 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. -In short, the frontend is MIT, and past that you're on your own. +In short, the frontend is MIT (Expat), beyond that you're on your own. From 220e0612a9d25ac964e8a721d5d9bf598a450ad1 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 15:58:16 +1000 Subject: [PATCH 008/153] Update README.md --- README.md | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index d367efc523..3538a319db 100644 --- a/README.md +++ b/README.md @@ -135,13 +135,11 @@ TODO ## Troubleshooting and support -TODO +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, check the [BizHawk forum](http://tasvideos.org/forum/viewforum.php?f=64) at tasvideos.org, or ask on IRC: -[BizHawk forum](http://tasvideos.org/forum/viewforum.php?f=64) - -[BizHawk wiki](http://tasvideos.org/Bizhawk.html) - -[FAQ](http://tasvideos.org/Bizhawk/FAQ.html) +[![IRC | chat.freenode.net #bizhawk](https://img.shields.io/badge/IRC-chat.freenode.net_%23bizhawk-black.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-black.svg?logo=matrix&style=flat)](https://matrix.to/#/#freenode_#bizhawk:matrix.org) +[![freenode webchat | #bizhawk](https://img.shields.io/badge/freenode_webchat-%23bizhawk-black.svg?style=flat)](http://webchat.freenode.net/?channels=bizhawk) ## Contributing @@ -151,13 +149,7 @@ If you've already made changes, the best way to contribute is with a Pull Reques [![GitHub open issues counter](https://img.shields.io/github/issues-raw/TASVideos/BizHawk.svg?logo=github&style=flat)](https://github.com/TASVideos/BizHawk/issues) -It's a good idea to check if anyone else is working on an issue by asking on IRC: - -[![IRC | chat.freenode.net #bizhawk](https://img.shields.io/badge/IRC-chat.freenode.net_%23bizhawk-black.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-black.svg?logo=matrix&style=flat)](https://matrix.to/#/#freenode_#bizhawk:matrix.org) -[![freenode webchat | #bizhawk](https://img.shields.io/badge/freenode_webchat-%23bizhawk-black.svg?style=flat)](http://webchat.freenode.net/?channels=bizhawk) - -And of course, open a "feature request" issue before adding features. No point making something that no-one's going to use. +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 ff19a708a42a18d70a7ca0f8160dbc953ec15ad4 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 16:11:27 +1000 Subject: [PATCH 009/153] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3538a319db..64b37f7cf8 100644 --- a/README.md +++ b/README.md @@ -137,9 +137,9 @@ TODO 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, check the [BizHawk forum](http://tasvideos.org/forum/viewforum.php?f=64) at tasvideos.org, or ask on IRC: -[![IRC | chat.freenode.net #bizhawk](https://img.shields.io/badge/IRC-chat.freenode.net_%23bizhawk-black.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-black.svg?logo=matrix&style=flat)](https://matrix.to/#/#freenode_#bizhawk:matrix.org) -[![freenode webchat | #bizhawk](https://img.shields.io/badge/freenode_webchat-%23bizhawk-black.svg?style=flat)](http://webchat.freenode.net/?channels=bizhawk) +[![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) ## Contributing From 10d7bcee6e9085e4ace71eba65a4302eec05d267 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 16:21:12 +1000 Subject: [PATCH 010/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 64b37f7cf8..65bba1c5ba 100644 --- a/README.md +++ b/README.md @@ -133,7 +133,7 @@ TODO [TAS movie file format](http://tasvideos.org/Bizhawk/TASFormat.html) -## Troubleshooting and support +## 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, check the [BizHawk forum](http://tasvideos.org/forum/viewforum.php?f=64) at tasvideos.org, or ask on IRC: From d8c22b5c9ea007424a4c58b8f8e2d1ea3c08e95f Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 16:23:16 +1000 Subject: [PATCH 011/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 65bba1c5ba..485e736806 100644 --- a/README.md +++ b/README.md @@ -135,7 +135,7 @@ TODO ## 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, check the [BizHawk forum](http://tasvideos.org/forum/viewforum.php?f=64) at tasvideos.org, or ask on IRC: +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.org, or ask on IRC: [![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) From bafcd6c7240dcca5f5fd5da4de718bad77b6c2fa Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 20:27:28 +1000 Subject: [PATCH 012/153] Update README.md --- README.md | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 485e736806..449eba295f 100644 --- a/README.md +++ b/README.md @@ -58,22 +58,12 @@ Win7 is supported from SP1, Win8 is supported from 8.1, and Win10 is supported f 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](http://tasvideos.org/Bizhawk/ReleaseHistory.html). [![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) -[![CentOS | bizhawk](https://img.shields.io/badge/CentOS-bizhawk-%23941D7A.svg?logo=centos&style=popout)](https://example.com/bizhawk) -[![Debian (Launchpad) | bizhawk](https://img.shields.io/badge/Debian_(Launchpad)-bizhawk-%23A81D33.svg?logo=debian&style=popout)](https://example.com/bizhawk) -[![elementaryOS (Launchpad) | bizhawk](https://img.shields.io/badge/elementaryOS-bizhawk-%2364BAFF.svg?logo=elementary&style=popout)](https://example.com/bizhawk) -[![Fedora | bizhawk](https://img.shields.io/badge/Fedora-bizhawk-%23294172.svg?logo=fedora&style=popout)](https://example.com/bizhawk) -[![Gentoo | bizhawk](https://img.shields.io/badge/Gentoo-bizhawk-%234E4371.svg?logo=gentoo&style=popout)](https://example.com/bizhawk) -[![Hyperbola | bizhawk](https://img.shields.io/badge/Hyperbola-bizhawk-black.svg?logo=hyperbola&style=popout)](https://example.com/bizhawk) -[![Linux Mint (Launchpad) | bizhawk](https://img.shields.io/badge/Linux_Mint_(Launchpad)-bizhawk-%2387CF3E.svg?logo=linux-mint&style=popout)](https://example.com/bizhawk) [![macOS (Homebrew) | bizhawk](https://img.shields.io/badge/macOS_(Homebrew)-bizhawk-%23999999.svg?logo=apple&style=popout)](https://example.com/bizhawk) -[![Manjaro (AUR) | bizhawk](https://img.shields.io/badge/Manjaro_(AUR)-bizhawk-%2335BF5C.svg?logo=manjaro&style=popout)](https://aur.archlinux.org/packages/bizhawk) -[![MX Linux | bizhawk](https://img.shields.io/badge/MX_Linux-bizhawk-%23506E88.svg?logo=mx-linux&style=popout)](https://example.com/bizhawk) -[![NixOS | bizhawk](https://img.shields.io/badge/NixOS-bizhawk-%234F73BC.svg?colorA=7EB5E0&logo=nixos&style=popout)](https://example.com/bizhawk) -[![openSUSE | bizhawk](https://img.shields.io/badge/openSUSE-bizhawk-%236DA741.svg?logo=opensuse&style=popout)](https://example.com/bizhawk) -[![Solus | bizhawk](https://img.shields.io/badge/Solus-bizhawk-%235294E2.svg?colorA=4C5164&logo=solus&style=popout)](https://example.com/bizhawk) -[![SteamOS (Launchpad) | bizhawk](https://img.shields.io/badge/SteamOS-bizhawk-%231B2838.svg?logo=steam&logoColor=1B2838&style=popout)](https://example.com/bizhawk) [![Ubuntu (Launchpad) | bizhawk](https://img.shields.io/badge/Ubuntu_(Launchpad)-bizhawk-%23E95420.svg?colorA=772953&logo=ubuntu&style=popout)](https://example.com/bizhawk) +[![Linux Mint (Launchpad) | bizhawk](https://img.shields.io/badge/Linux_Mint_(Launchpad)-bizhawk-%2387CF3E.svg?logo=linux-mint&style=popout)](https://example.com/bizhawk) +[![Manjaro (AUR) | bizhawk](https://img.shields.io/badge/Manjaro_(AUR)-bizhawk-%2335BF5C.svg?logo=manjaro&style=popout)](https://aur.archlinux.org/packages/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): From 8557cdb90aae12d45bb17f32e6d8e9661ea0c226 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 20:44:11 +1000 Subject: [PATCH 013/153] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 449eba295f..0ace764534 100644 --- a/README.md +++ b/README.md @@ -58,12 +58,11 @@ Win7 is supported from SP1, Win8 is supported from 8.1, and Win10 is supported f 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](http://tasvideos.org/Bizhawk/ReleaseHistory.html). [![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) +[![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) [![macOS (Homebrew) | bizhawk](https://img.shields.io/badge/macOS_(Homebrew)-bizhawk-%23999999.svg?logo=apple&style=popout)](https://example.com/bizhawk) +[![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) [![Ubuntu (Launchpad) | bizhawk](https://img.shields.io/badge/Ubuntu_(Launchpad)-bizhawk-%23E95420.svg?colorA=772953&logo=ubuntu&style=popout)](https://example.com/bizhawk) -[![Linux Mint (Launchpad) | bizhawk](https://img.shields.io/badge/Linux_Mint_(Launchpad)-bizhawk-%2387CF3E.svg?logo=linux-mint&style=popout)](https://example.com/bizhawk) -[![Manjaro (AUR) | bizhawk](https://img.shields.io/badge/Manjaro_(AUR)-bizhawk-%2335BF5C.svg?logo=manjaro&style=popout)](https://aur.archlinux.org/packages/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): From a0d9c8133101fb722975b2a0cfed9e352bea1bf5 Mon Sep 17 00:00:00 2001 From: James Groom Date: Thu, 10 Jan 2019 00:31:48 +1000 Subject: [PATCH 014/153] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0ace764534..337eee1031 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ Win7 is supported from SP1, Win8 is supported from 8.1, and Win10 is supported f 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](http://tasvideos.org/Bizhawk/ReleaseHistory.html). [![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) +[![Debian (Launchpad) | bizhawk](https://img.shields.io/badge/Debian_(Launchpad)-bizhawk-%23A81D33.svg?logo=debian&style=popout)](https://example.com/bizhawk) [![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) [![macOS (Homebrew) | bizhawk](https://img.shields.io/badge/macOS_(Homebrew)-bizhawk-%23999999.svg?logo=apple&style=popout)](https://example.com/bizhawk) [![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) From 31300b9ccab3bc8c3220dd3a49552ae2ecd4eb26 Mon Sep 17 00:00:00 2001 From: James Groom Date: Thu, 10 Jan 2019 01:35:01 +1000 Subject: [PATCH 015/153] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 337eee1031..4316c3df24 100644 --- a/README.md +++ b/README.md @@ -90,9 +90,13 @@ 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 -msbuild BizHawk.sln +msbuild --release BizHawk.sln ``` +Remove the `--release` flag from MSBuild if you want debugging symbols. + +TODO it's not --release + Running is even easier, just execute `EmuHawkMono.sh` in the repo's `output` folder (this folder is what gets distributed in a Release build, you can move/rename it). If your distro isn't listed under *Installing* above, 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). From fe52089b1af91507d1dcef386c1d494e245ea0eb Mon Sep 17 00:00:00 2001 From: James Groom Date: Thu, 10 Jan 2019 01:37:09 +1000 Subject: [PATCH 016/153] Update README.md --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4316c3df24..6d143e9780 100644 --- a/README.md +++ b/README.md @@ -97,13 +97,9 @@ Remove the `--release` flag from MSBuild if you want debugging symbols. TODO it's not --release -Running is even easier, just execute `EmuHawkMono.sh` in the repo's `output` folder (this folder is what gets distributed in a Release build, you can move/rename it). +If your distro isn't listed 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). -If your distro isn't listed under *Installing* above, 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). - -Again, if your distro isn't listed 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). - -Once built, see the *Installing* section above. +Once built, see the *Installing* section above, substituting the repo's `output` folder for the download. 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 From 5297ba8eb78e7dda473b7506ff864208993091c0 Mon Sep 17 00:00:00 2001 From: James Groom Date: Thu, 10 Jan 2019 01:46:32 +1000 Subject: [PATCH 017/153] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6d143e9780..0100b3349b 100644 --- a/README.md +++ b/README.md @@ -90,16 +90,16 @@ 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 -msbuild --release BizHawk.sln +msbuild /p:Configuration=Release BizHawk.sln ``` -Remove the `--release` flag from MSBuild if you want debugging symbols. +Remove the `/p:...` flag from MSBuild if you want debugging symbols. -TODO it's not --release +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). -If your distro isn't listed 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). +Once built, see the *Installing* section, substituting the repo's `output` folder for the download. -Once built, see the *Installing* section above, substituting the repo's `output` folder for the download. 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). +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 From 245dce55712d8bf9436a9b33a5f05e6b9c3aefab Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 17:04:45 +0000 Subject: [PATCH 018/153] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 0100b3349b..aababd758e 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ 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](http://tasvideos.org/Bizhawk/ReleaseHistory.html). + ## Core feature matrix Most games for every system in the table will run perfectly, and every system supports fast-forward, frame advance, and rewind. From 592c6cd9456c474bea8b808e00383404a34d4654 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 17:05:57 +0000 Subject: [PATCH 019/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index aababd758e..e49a7d7a5c 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ 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](http://tasvideos.org/Bizhawk/ReleaseHistory.html). +tl;dr: click the "latest" button above to grab it. The changelog is [here on tasvideos.org](http://tasvideos.org/Bizhawk/ReleaseHistory.html). **Don't mix versions**, copy `config.ini` to keep settings. ## Core feature matrix From 49301f4fe0e426f9116ae6bdf92dc9547c414535 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 17:09:28 +0000 Subject: [PATCH 020/153] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e49a7d7a5c..35bf9e96dc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # BizHawk -[![GitHub latest release](https://img.shields.io/github/release/TASVideos/BizHawk.svg?logo=github&style=flat)](https://github.com/TASVideos/BizHawk/releases/latest) ![Unique systems emulated | 22](https://img.shields.io/badge/Unique_systems_emulated-22-darkgreen.svg?style=flat) +[![GitHub latest release](https://img.shields.io/github/release/TASVideos/BizHawk.svg?logo=github&style=flat)](https://github.com/TASVideos/BizHawk/releases/latest) [![dev builds | AppVeyor](https://img.shields.io/badge/dev_builds-AppVeyor-orange.svg?style=flat)](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history) ![unique systems emulated | 22](https://img.shields.io/badge/unique_systems_emulated-22-darkgreen.svg?style=flat) 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). @@ -84,6 +84,12 @@ If you want to test the latest changes without building BizHawk yourself, grab t 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. +### Windows 7/8.1/10 + +TODO + +[Compiling](http://tasvideos.org/Bizhawk/Compiling.html) + ### 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. @@ -103,12 +109,6 @@ Once built, see the *Installing* section, substituting the repo's `output` folde 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](http://tasvideos.org/Bizhawk/Compiling.html) - ## Usage (casual) TODO From 233ac59d8a914dd57bd6f2ace48e520a23c15c70 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 17:14:16 +0000 Subject: [PATCH 021/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 35bf9e96dc..741b315516 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ Linux distros are supported if the distributor is still supporting your version, 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 +## Building/Testing If you want to test the latest changes without building BizHawk yourself, grab the developer build from [AppVeyor](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history). Pick the topmost one that doesn't say "Pull request", then click "Artifacts" and download `BizHawk_Developer--#.zip`. From 65ce6409ab3bea5023528ccc56cdbd502b7c9ccc Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 17:18:41 +0000 Subject: [PATCH 022/153] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 741b315516..fce0c411d0 100644 --- a/README.md +++ b/README.md @@ -137,11 +137,13 @@ A short [FAQ](http://tasvideos.org/Bizhawk/FAQ.html) is provided on the [BizHawk 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: +If you'd like to fix bugs, check the issue tracker here on GitHub: [![GitHub open issues counter](https://img.shields.io/github/issues-raw/TASVideos/BizHawk.svg?logo=github&style=flat)](https://github.com/TASVideos/BizHawk/issues) -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. +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. ## License From 43686a2cf173786f450996aa43ea4cb5e7b5d122 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 17:24:20 +0000 Subject: [PATCH 023/153] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index fce0c411d0..12a0043134 100644 --- a/README.md +++ b/README.md @@ -133,6 +133,8 @@ A short [FAQ](http://tasvideos.org/Bizhawk/FAQ.html) is provided on the [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) +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). + ## 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. From 37eb3a41fdb86f124955a82dc48b89bf44ebfb58 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 17:31:16 +0000 Subject: [PATCH 024/153] Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 12a0043134..29c2749017 100644 --- a/README.md +++ b/README.md @@ -49,9 +49,15 @@ Released binaries can be found right here on GitHub: Click `BizHawk-.zip` to download it. Also note the changelog, the full version of which is [on tasvideos.org](http://tasvideos.org/Bizhawk/ReleaseHistory.html). **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](https://github.com/TASVideos/BizHawk-Prereqs/releases/latest). +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. +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](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet). From 96042e217426338dcac28895b8de387b6be24dee Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 9 Jan 2019 17:39:13 +0000 Subject: [PATCH 025/153] Update README.md --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 29c2749017..f24feb9b6f 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,16 @@ A multi-system emulator written in C#. As well as quality-of-life features for c tl;dr: click the "latest" button above to grab it. The changelog is [here on tasvideos.org](http://tasvideos.org/Bizhawk/ReleaseHistory.html). **Don't mix versions**, copy `config.ini` to keep settings. +Jump to: +* [Installing — Windows 7/8.1/10](https://github.com/TASVideos/BizHawk/blob/master/README.md#installing--windows-78110) +* [Installing — GNU+Linux and macOS](https://github.com/TASVideos/BizHawk/blob/master/README.md#installing--gnulinux-and-macos) +* [Building/Testing](https://github.com/TASVideos/BizHawk/blob/master/README.md#buildingtesting) +* [Usage (emulation)](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage-emulation) +* [Usage (TASing)](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage-tasing) +* [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) +* [License](https://github.com/TASVideos/BizHawk/blob/master/README.md#license) + ## Core feature matrix Most games for every system in the table will run perfectly, and every system supports fast-forward, frame advance, and rewind. @@ -115,11 +125,11 @@ Once built, see the *Installing* section, substituting the repo's `output` folde 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). -## Usage (casual) +## Usage (emulation) TODO -## Usage (advanced) +## Usage (TASing) TODO From 531e4d8909fe4eb1223183c3845afba31ba32581 Mon Sep 17 00:00:00 2001 From: James Groom Date: Thu, 10 Jan 2019 04:37:10 +1000 Subject: [PATCH 026/153] Update README.md --- README.md | 62 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 34 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index f24feb9b6f..2b99087a1c 100644 --- a/README.md +++ b/README.md @@ -16,40 +16,46 @@ Jump to: * [Contributing](https://github.com/TASVideos/BizHawk/blob/master/README.md#contributing) * [License](https://github.com/TASVideos/BizHawk/blob/master/README.md#license) -## Core feature matrix +## Features -Most games for every system in the table will run perfectly, and every system supports fast-forward, frame advance, and rewind. +The "core" features, common to every system core, are: +* rom format and region detection and a corruption check +* speed control, including frame stepping and rewinding +* input recording (making TAS movies) +* memory view/search/edit in all parts of the emulated HW +* 10 savestate slots and save/load to file +* more things I can't remember -System | Play+FF/ADV/RW | Debugging | (Input) Recording +System | "Core" Features | Game Coverage† | Peripherals --:|:-:|:-:|:-: -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 | ✓ | ? | ? +Apple II | ✓ | 95%? | ? +Atari 2600 | ✓ | 95%? | ? +Atari 7800 | ✓ | 95%? | ? +Atari Lynx | ✓ | 95%? | ? +ColecoVision | ✓ | 95%? | ? +Commodore 64 | ✓ | 95%? | ? +Game Boy / GBC | ✓ | 95%? | ? +GBA | ✓ | 95%? | ? +Genesis | ✓ | 95%? | ? +IntelliVision | ✓ | 95%? | ? +Master System | ✓ | 95%? | ? +N64 | ✓ | 95%? | ? +Neo Geo Pocket | ✓ | 95%? | ? +NES | ✓ | 95%? | ? +PSX | ✓ | 95%? | ? +Saturn | ✓ | 95%? | ? +SNES | ✓ | 95%? | ? +TI-83 | ✓ | 95%? | ? +TurboGrafx-16 | ✓ | 95%? | ? +Virtual Boy | ✓ | 95%? | ? +WonderSwan | ✓ | 95%? | ? +ZX Spectrum | ✓ | 95%? | ? -EmuHawk's frontend also has a comprehensive input mapper, with keyboard and controller support (even simultaneously), hotkeys, and turbo/rapid fire. +† *approximately* what portion of games run perfectly, not counting romhacks/homebrew (if you want to count, go right ahead) -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. +EmuHawk's frontend also has a firmware manager, nice overlays, and a comprehensive input mapper. We're talking keyboard and controller mapped to one emulated controller with analog support, keyboard hotkeys, controller hotkeys, and rapid fire for emulated controllers. 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. But most importantly: BizHawk is Hawk Biz. -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. +See the *Usage* sections below for details about specific tools and config menus. ## Installing — Windows 7/8.1/10 From b29516fb59c0264faf061d3ff20e123bd8efb7dd Mon Sep 17 00:00:00 2001 From: James Groom Date: Thu, 10 Jan 2019 04:39:40 +1000 Subject: [PATCH 027/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2b99087a1c..9ca2cfddc3 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ ZX Spectrum | ✓ | 95%? | ? † *approximately* what portion of games run perfectly, not counting romhacks/homebrew (if you want to count, go right ahead) -EmuHawk's frontend also has a firmware manager, nice overlays, and a comprehensive input mapper. We're talking keyboard and controller mapped to one emulated controller with analog support, keyboard hotkeys, controller hotkeys, and rapid fire for emulated controllers. 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. But most importantly: BizHawk is Hawk Biz. +EmuHawk's frontend also has a firmware manager, nice overlays, and a comprehensive input mapper. We're talking keyboard and controller mapped to one emulated controller, analog from analog or from digital, keyboard hotkeys, controller hotkeys, and rapid fire for emulated controllers. 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. But most importantly: BizHawk is Hawk Biz. See the *Usage* sections below for details about specific tools and config menus. From 41061b44abcaaf0134db84e89bdb84aa054e3fe4 Mon Sep 17 00:00:00 2001 From: James Groom Date: Thu, 10 Jan 2019 14:30:49 +1000 Subject: [PATCH 028/153] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9ca2cfddc3..84e6c0a858 100644 --- a/README.md +++ b/README.md @@ -33,23 +33,23 @@ Atari 2600 | ✓ | 95%? | ? Atari 7800 | ✓ | 95%? | ? Atari Lynx | ✓ | 95%? | ? ColecoVision | ✓ | 95%? | ? -Commodore 64 | ✓ | 95%? | ? -Game Boy / GBC | ✓ | 95%? | ? +Commodore 64 | ✓ | 95%? | [some](http://tasvideos.org/Bizhawk/C64.html) +GB/GBC | ✓ | 95%? | ? GBA | ✓ | 95%? | ? -Genesis | ✓ | 95%? | ? +Genesis | ✓ | 95%? | [all?](https://bitbucket.org/eke/genesis-plus-gx/src/b573cd25853f9f8b5b941fc36506835e228144c6/wiki/Features.md?at=master&fileviewer=file-view-default) IntelliVision | ✓ | 95%? | ? Master System | ✓ | 95%? | ? -N64 | ✓ | 95%? | ? -Neo Geo Pocket | ✓ | 95%? | ? +N64 | ✓ | 95%? | [all?](http://tasvideos.org/Bizhawk/N64.html) +NGP/NGPC | ✓ | 95%? | N/A NES | ✓ | 95%? | ? PSX | ✓ | 95%? | ? Saturn | ✓ | 95%? | ? SNES | ✓ | 95%? | ? -TI-83 | ✓ | 95%? | ? -TurboGrafx-16 | ✓ | 95%? | ? -Virtual Boy | ✓ | 95%? | ? -WonderSwan | ✓ | 95%? | ? -ZX Spectrum | ✓ | 95%? | ? +TI-83 | ✓ | 95%? | N/A +PC Engine / SG | ✓ | 95%? | ? +Virtual Boy | ✓ | 95%? | N/A +WonderSwan | ✓ | 95%? | N/A +ZX Spectrum | ✓ | 95%? | [common](http://tasvideos.org/Bizhawk/ZXSpectrum.html) † *approximately* what portion of games run perfectly, not counting romhacks/homebrew (if you want to count, go right ahead) From 0a41092150a2823f7d2231d6fa81c872d8b992c8 Mon Sep 17 00:00:00 2001 From: James Groom Date: Thu, 10 Jan 2019 15:01:37 +1000 Subject: [PATCH 029/153] Update README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 84e6c0a858..adeb2ab38a 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ Jump to: * [Usage (TASing)](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage-tasing) * [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) +* [Related projects](https://github.com/TASVideos/BizHawk/blob/master/README.md#related-projects) * [License](https://github.com/TASVideos/BizHawk/blob/master/README.md#license) ## Features @@ -169,6 +170,15 @@ It's a good idea to check if anyone is already working on an issue by asking on 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. +## 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 +* [Hourglass](https://github.com/TASVideos/hourglass-win32) for Windows Win32 — Windows-only, see also [rewrite project](https://github.com/Hourglass-Resurrection/Hourglass-Resurrection) +* [libTAS](https://github.com/clementgallet/libTAS) for Linux ELF — GNU+Linux-only +* [openMSX](https://openmsx.org) for MSX — cross-platform + ## License From the [full text](https://github.com/TASVideos/BizHawk/blob/master/LICENSE): From 7ab651786736565f428b6268685a0f569c0a3262 Mon Sep 17 00:00:00 2001 From: James Groom Date: Thu, 10 Jan 2019 20:28:43 +1000 Subject: [PATCH 030/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index adeb2ab38a..bef2f76dc8 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ ZX Spectrum | ✓ | 95%? | [common](http://tasvideos.org/Bizhawk/ZXSpectrum.html † *approximately* what portion of games run perfectly, not counting romhacks/homebrew (if you want to count, go right ahead) -EmuHawk's frontend also has a firmware manager, nice overlays, and a comprehensive input mapper. We're talking keyboard and controller mapped to one emulated controller, analog from analog or from digital, keyboard hotkeys, controller hotkeys, and rapid fire for emulated controllers. 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. But most importantly: BizHawk is Hawk Biz. +EmuHawk's frontend also has a firmware manager, nice overlays, and a comprehensive input mapper. We're talking keyboard and controller mapped to one emulated controller, analog from digital and digital from analog, keyboard hotkeys, controller hotkeys, and rapid fire for emulated controllers. 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. But most importantly: BizHawk is Hawk Biz. See the *Usage* sections below for details about specific tools and config menus. From 041436e5fdeee66ee47d464f80128a5e4d160248 Mon Sep 17 00:00:00 2001 From: James Groom Date: Thu, 10 Jan 2019 20:42:06 +1000 Subject: [PATCH 031/153] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index bef2f76dc8..4fe84ecb88 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # BizHawk -[![GitHub latest release](https://img.shields.io/github/release/TASVideos/BizHawk.svg?logo=github&style=flat)](https://github.com/TASVideos/BizHawk/releases/latest) [![dev builds | AppVeyor](https://img.shields.io/badge/dev_builds-AppVeyor-orange.svg?style=flat)](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history) ![unique systems emulated | 22](https://img.shields.io/badge/unique_systems_emulated-22-darkgreen.svg?style=flat) +[![GitHub latest release](https://img.shields.io/github/release/TASVideos/BizHawk.svg?logo=github&style=popout)](https://github.com/TASVideos/BizHawk/releases/latest) [![dev builds | AppVeyor](https://img.shields.io/badge/dev_builds-AppVeyor-orange.svg?style=popout)](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history) ![unique systems emulated | 22](https://img.shields.io/badge/unique_systems_emulated-22-darkgreen.svg?style=popout) 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). @@ -152,9 +152,9 @@ TODO 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.org, or ask on IRC: -[![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) +[![IRC | chat.freenode.net #bizhawk](https://img.shields.io/badge/IRC-chat.freenode.net_%23bizhawk-steelblue.svg?style=popout)](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=popout)](https://matrix.to/#/#freenode_#bizhawk:matrix.org) +[![freenode webchat | #bizhawk](https://img.shields.io/badge/freenode_webchat-%23bizhawk-lightcoral.svg?style=popout)](http://webchat.freenode.net/?channels=bizhawk) 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). @@ -164,7 +164,7 @@ BizHawk is Open Source Software, so you're free to modify it however you please, If you'd like to fix bugs, check the issue tracker here on GitHub: -[![GitHub open issues counter](https://img.shields.io/github/issues-raw/TASVideos/BizHawk.svg?logo=github&style=flat)](https://github.com/TASVideos/BizHawk/issues) +[![GitHub open issues counter](https://img.shields.io/github/issues-raw/TASVideos/BizHawk.svg?logo=github&style=popout)](https://github.com/TASVideos/BizHawk/issues) It's a good idea to check if anyone is already working on an issue by asking on IRC (see *Support* above). From b82875f33aa67f2f2fa04ec8daaf836fbe8a926c Mon Sep 17 00:00:00 2001 From: James Groom Date: Thu, 10 Jan 2019 20:50:32 +1000 Subject: [PATCH 032/153] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4fe84ecb88..e6c93191ef 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # BizHawk -[![GitHub latest release](https://img.shields.io/github/release/TASVideos/BizHawk.svg?logo=github&style=popout)](https://github.com/TASVideos/BizHawk/releases/latest) [![dev builds | AppVeyor](https://img.shields.io/badge/dev_builds-AppVeyor-orange.svg?style=popout)](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history) ![unique systems emulated | 22](https://img.shields.io/badge/unique_systems_emulated-22-darkgreen.svg?style=popout) +[![GitHub latest release](https://img.shields.io/github/release/TASVideos/BizHawk.svg?logo=github&style=popout)](https://github.com/TASVideos/BizHawk/releases/latest) [![dev builds | AppVeyor](https://img.shields.io/badge/dev_builds-AppVeyor-orange.svg?logo=appveyor&style=popout)](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history) ![unique systems emulated | 22](https://img.shields.io/badge/unique_systems_emulated-22-darkgreen.svg?logo=buffer&logoColor=white&style=popout) 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). @@ -152,9 +152,9 @@ TODO 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.org, or ask on IRC: -[![IRC | chat.freenode.net #bizhawk](https://img.shields.io/badge/IRC-chat.freenode.net_%23bizhawk-steelblue.svg?style=popout)](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=popout)](https://matrix.to/#/#freenode_#bizhawk:matrix.org) -[![freenode webchat | #bizhawk](https://img.shields.io/badge/freenode_webchat-%23bizhawk-lightcoral.svg?style=popout)](http://webchat.freenode.net/?channels=bizhawk) +[![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) 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). From ef002869fb5a386fd79f4ea4ae146860dd1f0979 Mon Sep 17 00:00:00 2001 From: James Groom Date: Thu, 10 Jan 2019 21:11:26 +1000 Subject: [PATCH 033/153] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e6c93191ef..fbcec8430f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # BizHawk -[![GitHub latest release](https://img.shields.io/github/release/TASVideos/BizHawk.svg?logo=github&style=popout)](https://github.com/TASVideos/BizHawk/releases/latest) [![dev builds | AppVeyor](https://img.shields.io/badge/dev_builds-AppVeyor-orange.svg?logo=appveyor&style=popout)](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history) ![unique systems emulated | 22](https://img.shields.io/badge/unique_systems_emulated-22-darkgreen.svg?logo=buffer&logoColor=white&style=popout) +[![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) ![unique systems emulated | 22](https://img.shields.io/badge/unique_systems_emulated-22-darkgreen.svg?logo=buffer&logoColor=333333&style=popout) 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). @@ -164,7 +164,7 @@ BizHawk is Open Source Software, so you're free to modify it however you please, If you'd like to fix bugs, check the issue tracker here on GitHub: -[![GitHub open issues counter](https://img.shields.io/github/issues-raw/TASVideos/BizHawk.svg?logo=github&style=popout)](https://github.com/TASVideos/BizHawk/issues) +[![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) It's a good idea to check if anyone is already working on an issue by asking on IRC (see *Support* above). From 9155d213d312f4841a50139363b2a10e36840b4c Mon Sep 17 00:00:00 2001 From: James Groom Date: Thu, 10 Jan 2019 23:50:46 +1000 Subject: [PATCH 034/153] Update README.md --- README.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index fbcec8430f..cd4b382c0c 100644 --- a/README.md +++ b/README.md @@ -27,30 +27,30 @@ The "core" features, common to every system core, are: * 10 savestate slots and save/load to file * more things I can't remember -System | "Core" Features | Game Coverage† | Peripherals ---:|:-:|:-:|:-: -Apple II | ✓ | 95%? | ? -Atari 2600 | ✓ | 95%? | ? -Atari 7800 | ✓ | 95%? | ? -Atari Lynx | ✓ | 95%? | ? -ColecoVision | ✓ | 95%? | ? -Commodore 64 | ✓ | 95%? | [some](http://tasvideos.org/Bizhawk/C64.html) -GB/GBC | ✓ | 95%? | ? -GBA | ✓ | 95%? | ? -Genesis | ✓ | 95%? | [all?](https://bitbucket.org/eke/genesis-plus-gx/src/b573cd25853f9f8b5b941fc36506835e228144c6/wiki/Features.md?at=master&fileviewer=file-view-default) -IntelliVision | ✓ | 95%? | ? -Master System | ✓ | 95%? | ? -N64 | ✓ | 95%? | [all?](http://tasvideos.org/Bizhawk/N64.html) -NGP/NGPC | ✓ | 95%? | N/A -NES | ✓ | 95%? | ? -PSX | ✓ | 95%? | ? -Saturn | ✓ | 95%? | ? -SNES | ✓ | 95%? | ? -TI-83 | ✓ | 95%? | N/A -PC Engine / SG | ✓ | 95%? | ? -Virtual Boy | ✓ | 95%? | N/A -WonderSwan | ✓ | 95%? | N/A -ZX Spectrum | ✓ | 95%? | [common](http://tasvideos.org/Bizhawk/ZXSpectrum.html) +System | "Core" Features | Game Coverage† | Peripherals | Debugging +--:|:-:|:-:|:-:|:-: +Apple II | ✓ | 95%? | ? | full/partial/limited +Atari 2600 | ✓ | 95%? | ? | partial/limited +Atari 7800 | ✓ | 95%? | ? | full/partial/limited +Atari Lynx | ✓ | 95%? | ? | full/partial/limited +ColecoVision | ✓ | 95%? | ? | full/partial/limited +Commodore 64 | ✓ | 95%? | [some](http://tasvideos.org/Bizhawk/C64.html) | full/partial/limited +GB/GBC | ✓ | 95%? | ? | full/partial/limited +GBA | ✓ | 95%? | ? | full/partial/limited +Genesis | ✓ | 95%? | [all?](https://bitbucket.org/eke/genesis-plus-gx/src/b573cd25853f9f8b5b941fc36506835e228144c6/wiki/Features.md?at=master&fileviewer=file-view-default) | full/partial/limited +IntelliVision | ✓ | 95%? | ? | full/partial/limited +Master System | ✓ | 95%? | ? | full/partial/limited +N64 | ✓ | 95%? | [all?](http://tasvideos.org/Bizhawk/N64.html) | full/partial/limited +NGP/NGPC | ✓ | 95%? | N/A | full/partial/limited +NES | ✓ | 95%? | ? | full/partial/limited +PSX | ✓ | 95%? | ? | full/partial/limited +Saturn | ✓ | 95%? | ? | full/partial/limited +SNES | ✓ | 95%? | ? | full/partial/limited +TI-83 | ✓ | 95%? | N/A | full/partial/limited +PC Engine / SG | ✓ | 95%? | ? | full/partial/limited +Virtual Boy | ✓ | 95%? | N/A | full/partial/limited +WonderSwan | ✓ | 95%? | N/A | full/partial/limited +ZX Spectrum | ✓ | 95%? | [common](http://tasvideos.org/Bizhawk/ZXSpectrum.html) | full/partial/limited † *approximately* what portion of games run perfectly, not counting romhacks/homebrew (if you want to count, go right ahead) From 54602ba86fcd016a54148cc11f6b23f08b18422d Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 00:12:17 +1000 Subject: [PATCH 035/153] Update README.md --- README.md | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index cd4b382c0c..aca1eaaa64 100644 --- a/README.md +++ b/README.md @@ -29,28 +29,28 @@ The "core" features, common to every system core, are: System | "Core" Features | Game Coverage† | Peripherals | Debugging --:|:-:|:-:|:-:|:-: -Apple II | ✓ | 95%? | ? | full/partial/limited -Atari 2600 | ✓ | 95%? | ? | partial/limited -Atari 7800 | ✓ | 95%? | ? | full/partial/limited -Atari Lynx | ✓ | 95%? | ? | full/partial/limited -ColecoVision | ✓ | 95%? | ? | full/partial/limited -Commodore 64 | ✓ | 95%? | [some](http://tasvideos.org/Bizhawk/C64.html) | full/partial/limited -GB/GBC | ✓ | 95%? | ? | full/partial/limited -GBA | ✓ | 95%? | ? | full/partial/limited -Genesis | ✓ | 95%? | [all?](https://bitbucket.org/eke/genesis-plus-gx/src/b573cd25853f9f8b5b941fc36506835e228144c6/wiki/Features.md?at=master&fileviewer=file-view-default) | full/partial/limited -IntelliVision | ✓ | 95%? | ? | full/partial/limited -Master System | ✓ | 95%? | ? | full/partial/limited -N64 | ✓ | 95%? | [all?](http://tasvideos.org/Bizhawk/N64.html) | full/partial/limited -NGP/NGPC | ✓ | 95%? | N/A | full/partial/limited -NES | ✓ | 95%? | ? | full/partial/limited -PSX | ✓ | 95%? | ? | full/partial/limited -Saturn | ✓ | 95%? | ? | full/partial/limited -SNES | ✓ | 95%? | ? | full/partial/limited -TI-83 | ✓ | 95%? | N/A | full/partial/limited -PC Engine / SG | ✓ | 95%? | ? | full/partial/limited -Virtual Boy | ✓ | 95%? | N/A | full/partial/limited -WonderSwan | ✓ | 95%? | N/A | full/partial/limited -ZX Spectrum | ✓ | 95%? | [common](http://tasvideos.org/Bizhawk/ZXSpectrum.html) | full/partial/limited +Apple II | ✓ | 95%? | ? | ? +Atari 2600 | ✓ | 95%? | ? | partial +Atari 7800 | ✓ | 95%? | ? | partial +Atari Lynx | ✓ | 95%? | ? | limited +ColecoVision | ✓ | 95%? | ? | partial +Commodore 64 | ✓ | 95%? | [some](http://tasvideos.org/Bizhawk/C64.html) | partial +GB/GBC | ✓ | 95%? | ? | full +GBA | ✓ | 95%? | ? | partial +Genesis | ✓ | 95%? | [all?](https://bitbucket.org/eke/genesis-plus-gx/src/b573cd25853f9f8b5b941fc36506835e228144c6/wiki/Features.md?at=master&fileviewer=file-view-default) | full +IntelliVision | ✓ | 95%? | ? | partial +Master System | ✓ | 95%? | ? | full +N64 | ✓ | 95%? | [all?](http://tasvideos.org/Bizhawk/N64.html) | partial +NGP/NGPC | ✓ | 95%? | N/A | limited +NES | ✓ | 95%? | ? | full +PSX | ✓ | 95%? | ? | ? +Saturn | ✓ | 95%? | ? | limited +SNES | ✓ | 95%? | ? | full +TI-83 | ✓ | 95%? | N/A | ? +PC Engine / SG | ✓ | 95%? | ? | full +Virtual Boy | ✓ | 95%? | N/A | ? +WonderSwan | ✓ | 95%? | N/A | partial +ZX Spectrum | ✓ | 95%? | [common](http://tasvideos.org/Bizhawk/ZXSpectrum.html) | full † *approximately* what portion of games run perfectly, not counting romhacks/homebrew (if you want to count, go right ahead) From 5e3e722858575cdfe22e5bb1cf175f5813add5c7 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 00:20:04 +1000 Subject: [PATCH 036/153] Update README.md --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index aca1eaaa64..648229524b 100644 --- a/README.md +++ b/README.md @@ -30,27 +30,27 @@ The "core" features, common to every system core, are: System | "Core" Features | Game Coverage† | Peripherals | Debugging --:|:-:|:-:|:-:|:-: Apple II | ✓ | 95%? | ? | ? -Atari 2600 | ✓ | 95%? | ? | partial -Atari 7800 | ✓ | 95%? | ? | partial -Atari Lynx | ✓ | 95%? | ? | limited -ColecoVision | ✓ | 95%? | ? | partial -Commodore 64 | ✓ | 95%? | [some](http://tasvideos.org/Bizhawk/C64.html) | partial -GB/GBC | ✓ | 95%? | ? | full -GBA | ✓ | 95%? | ? | partial -Genesis | ✓ | 95%? | [all?](https://bitbucket.org/eke/genesis-plus-gx/src/b573cd25853f9f8b5b941fc36506835e228144c6/wiki/Features.md?at=master&fileviewer=file-view-default) | full -IntelliVision | ✓ | 95%? | ? | partial -Master System | ✓ | 95%? | ? | full -N64 | ✓ | 95%? | [all?](http://tasvideos.org/Bizhawk/N64.html) | partial -NGP/NGPC | ✓ | 95%? | N/A | limited -NES | ✓ | 95%? | ? | full +Atari 2600 | ✓ | 95%? | ? | ◕ +Atari 7800 | ✓ | 95%? | ? | ◕ +Atari Lynx | ✓ | 95%? | ? | ◔ +ColecoVision | ✓ | 95%? | ? | ◕ +Commodore 64 | ✓ | 95%? | [some](http://tasvideos.org/Bizhawk/C64.html) | ◕ +GB/GBC | ✓ | 95%? | ? | ✓ +GBA | ✓ | 95%? | ? | ◕ +Genesis | ✓ | 95%? | [all?](https://bitbucket.org/eke/genesis-plus-gx/src/b573cd25853f9f8b5b941fc36506835e228144c6/wiki/Features.md?at=master&fileviewer=file-view-default) | ✓ +IntelliVision | ✓ | 95%? | ? | ◕ +Master System | ✓ | 95%? | ? | ✓ +N64 | ✓ | 95%? | [all?](http://tasvideos.org/Bizhawk/N64.html) | ◕ +NGP/NGPC | ✓ | 95%? | N/A | ◔ +NES | ✓ | 95%? | ? | ✓ PSX | ✓ | 95%? | ? | ? -Saturn | ✓ | 95%? | ? | limited -SNES | ✓ | 95%? | ? | full +Saturn | ✓ | 95%? | ? | ◔ +SNES | ✓ | 95%? | ? | ✓ TI-83 | ✓ | 95%? | N/A | ? -PC Engine / SG | ✓ | 95%? | ? | full +PC Engine / SG | ✓ | 95%? | ? | ✓ Virtual Boy | ✓ | 95%? | N/A | ? -WonderSwan | ✓ | 95%? | N/A | partial -ZX Spectrum | ✓ | 95%? | [common](http://tasvideos.org/Bizhawk/ZXSpectrum.html) | full +WonderSwan | ✓ | 95%? | N/A | ◕ +ZX Spectrum | ✓ | 95%? | [common](http://tasvideos.org/Bizhawk/ZXSpectrum.html) | ✓ † *approximately* what portion of games run perfectly, not counting romhacks/homebrew (if you want to count, go right ahead) From 200cffabc426e8daccb736b938a239dc9b07e876 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 00:30:05 +1000 Subject: [PATCH 037/153] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 648229524b..512a878444 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # BizHawk -[![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) ![unique systems emulated | 22](https://img.shields.io/badge/unique_systems_emulated-22-darkgreen.svg?logo=buffer&logoColor=333333&style=popout) +[![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) +[![unique systems emulated | 22](https://img.shields.io/badge/unique_systems_emulated-22-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](#) 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). From f1041fc764b7db7eeb575bcb905d4ade58aab3bc Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 00:30:22 +1000 Subject: [PATCH 038/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 512a878444..1318f4f666 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![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) -[![unique systems emulated | 22](https://img.shields.io/badge/unique_systems_emulated-22-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](#) +[![unique systems emulated | 22](https://img.shields.io/badge/unique_systems_emulated-22-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)]() 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). From 544b2c07484c13e8e5bf913a09044f5086d23bef Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 00:30:38 +1000 Subject: [PATCH 039/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1318f4f666..f6f34ba702 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![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) -[![unique systems emulated | 22](https://img.shields.io/badge/unique_systems_emulated-22-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)]() +[![unique systems emulated | 22](https://img.shields.io/badge/unique_systems_emulated-22-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](javascript:;) 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). From e22d10517f3dcedc527a264fd2497f2b16ef3ade Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 00:31:21 +1000 Subject: [PATCH 040/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f6f34ba702..0e45be8132 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![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) -[![unique systems emulated | 22](https://img.shields.io/badge/unique_systems_emulated-22-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](javascript:;) +[![unique systems emulated | 22](https://img.shields.io/badge/unique_systems_emulated-22-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#features) 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). From 43286f7ec37ec3120b880f93783e611a991614f9 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 00:35:54 +1000 Subject: [PATCH 041/153] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0e45be8132..3e7b2a937d 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,11 @@ Jump to: The "core" features, common to every system core, are: * rom format and region detection and a corruption check -* speed control, including frame stepping and rewinding -* input recording (making TAS movies) -* memory view/search/edit in all parts of the emulated HW * 10 savestate slots and save/load to file -* more things I can't remember +* speed control, including frame stepping and rewinding +* memory view/search/edit in all parts of the emulated HW +* input recording (making TAS movies) +* take screenshots and record video System | "Core" Features | Game Coverage† | Peripherals | Debugging --:|:-:|:-:|:-:|:-: From 746606a09d99f30d419563d92ad021d867e2bd7d Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 00:45:58 +1000 Subject: [PATCH 042/153] Update README.md --- README.md | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 3e7b2a937d..88ae2ef065 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Jump to: ## Features -The "core" features, common to every system core, are: +The BizHawk common features (across all cores) are: * rom format and region detection and a corruption check * 10 savestate slots and save/load to file * speed control, including frame stepping and rewinding @@ -29,30 +29,30 @@ The "core" features, common to every system core, are: * input recording (making TAS movies) * take screenshots and record video -System | "Core" Features | Game Coverage† | Peripherals | Debugging +System | BH Common | Accuracy† | Debugging | Peripherals --:|:-:|:-:|:-:|:-: Apple II | ✓ | 95%? | ? | ? -Atari 2600 | ✓ | 95%? | ? | ◕ -Atari 7800 | ✓ | 95%? | ? | ◕ -Atari Lynx | ✓ | 95%? | ? | ◔ -ColecoVision | ✓ | 95%? | ? | ◕ -Commodore 64 | ✓ | 95%? | [some](http://tasvideos.org/Bizhawk/C64.html) | ◕ -GB/GBC | ✓ | 95%? | ? | ✓ -GBA | ✓ | 95%? | ? | ◕ -Genesis | ✓ | 95%? | [all?](https://bitbucket.org/eke/genesis-plus-gx/src/b573cd25853f9f8b5b941fc36506835e228144c6/wiki/Features.md?at=master&fileviewer=file-view-default) | ✓ -IntelliVision | ✓ | 95%? | ? | ◕ -Master System | ✓ | 95%? | ? | ✓ -N64 | ✓ | 95%? | [all?](http://tasvideos.org/Bizhawk/N64.html) | ◕ -NGP/NGPC | ✓ | 95%? | N/A | ◔ -NES | ✓ | 95%? | ? | ✓ +Atari 2600 | ✓ | 95%? | ◕ | ? +Atari 7800 | ✓ | 95%? | ◕ | ? +Atari Lynx | ✓ | 95%? | ◔ | ? +ColecoVision | ✓ | 95%? | ◕ | ? +Commodore 64 | ✓ | 95%? | ◕ | [some](http://tasvideos.org/Bizhawk/C64.html) +GB/GBC | ✓ | 95%? | ✓ | ? +GBA | ✓ | 95%? | ◕ | ? +Genesis | ✓ | 95%? | ✓ | [all?](https://bitbucket.org/eke/genesis-plus-gx/src/b573cd25853f9f8b5b941fc36506835e228144c6/wiki/Features.md?at=master&fileviewer=file-view-default) +IntelliVision | ✓ | 95%? | ◕ | ? +Master System | ✓ | 95%? | ✓ | ? +N64 | ✓ | 95%? | ◕ | [all?](http://tasvideos.org/Bizhawk/N64.html) +NGP/NGPC | ✓ | 95%? | ◔ | N/A +NES | ✓ | 95%? | ✓ | ? PSX | ✓ | 95%? | ? | ? -Saturn | ✓ | 95%? | ? | ◔ -SNES | ✓ | 95%? | ? | ✓ -TI-83 | ✓ | 95%? | N/A | ? -PC Engine / SG | ✓ | 95%? | ? | ✓ -Virtual Boy | ✓ | 95%? | N/A | ? -WonderSwan | ✓ | 95%? | N/A | ◕ -ZX Spectrum | ✓ | 95%? | [common](http://tasvideos.org/Bizhawk/ZXSpectrum.html) | ✓ +Saturn | ✓ | 95%? | ◔ | ? +SNES | ✓ | 95%? | ✓ | ? +TI-83 | ✓ | 95%? | ? | N/A +PC Engine / SG | ✓ | 95%? | ✓ | ? +Virtual Boy | ✓ | 95%? | ? | N/A +WonderSwan | ✓ | 95%? | ◕ | N/A +ZX Spectrum | ✓ | 95%? | ✓ | [common](http://tasvideos.org/Bizhawk/ZXSpectrum.html) † *approximately* what portion of games run perfectly, not counting romhacks/homebrew (if you want to count, go right ahead) From c21422c396de399ccbbd18040f5ca485e5b7d50f Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 01:29:37 +1000 Subject: [PATCH 043/153] Update README.md --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 88ae2ef065..280247c4af 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ 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](http://tasvideos.org/Bizhawk/ReleaseHistory.html). **Don't mix versions**, copy `config.ini` to keep settings. +tl;dr: click the "latest" button above to grab it. The changelog is [here at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html). **Don't mix versions**, copy `config.ini` to keep settings. Jump to: * [Installing — Windows 7/8.1/10](https://github.com/TASVideos/BizHawk/blob/master/README.md#installing--windows-78110) @@ -66,7 +66,7 @@ Released binaries can be found right here on GitHub: [![Windows | binaries](https://img.shields.io/badge/Windows-binaries-%230078D6.svg?logo=windows&logoColor=0078D6&style=popout)](https://github.com/TASVideos/BizHawk/releases/latest) -Click `BizHawk-.zip` to download it. Also note the changelog, the full version of which is [on tasvideos.org](http://tasvideos.org/Bizhawk/ReleaseHistory.html). **Don't mix different versions** of BizHawk, keep each version in its own folder. +Click `BizHawk-.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. 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 @@ -82,7 +82,7 @@ Win7 is supported from SP1, Win8 is supported from 8.1, and Win10 is supported f ## 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](http://tasvideos.org/Bizhawk/ReleaseHistory.html). +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). [![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) [![Debian (Launchpad) | bizhawk](https://img.shields.io/badge/Debian_(Launchpad)-bizhawk-%23A81D33.svg?logo=debian&style=popout)](https://example.com/bizhawk) @@ -140,6 +140,8 @@ TODO ## Usage (TASing) +This section refers to BizHawk specifically. For resources on TASing in general, see [Welcome to TASVideos](http://tasvideos.org/WelcomeToTASVideos.html). + TODO [Commandline](http://tasvideos.org/Bizhawk/CommandLine.html) @@ -152,7 +154,7 @@ TODO ## 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+ISSUE_KEYWORDS), check the [BizHawk forum](http://tasvideos.org/forum/viewforum.php?f=64) at tasvideos.org, or ask on IRC: +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: [![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) From 577b46f350314f93518fcea045a17e61eaa7f181 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 01:43:21 +1000 Subject: [PATCH 044/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 280247c4af..284f193c3a 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ 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 at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html). **Don't mix versions**, copy `config.ini` to keep settings. +Click the "release" button above to grab the latest stable version. The changelog is [here at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html). **Never mix different versions** of BizHawk — Keep each version in its own folder. Jump to: * [Installing — Windows 7/8.1/10](https://github.com/TASVideos/BizHawk/blob/master/README.md#installing--windows-78110) From 54729d3c1533aeb435c85b9ed894db4d127710e1 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 01:48:13 +1000 Subject: [PATCH 045/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 284f193c3a..10f17bcb8d 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ 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). -Click the "release" button above to grab the latest stable version. The changelog is [here at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html). **Never mix different versions** of BizHawk — Keep each version in its own folder. +Click the "release" button above to grab the latest stable version. New users on Windows will need [this](https://github.com/TASVideos/BizHawk-Prereqs/releases/latest). The changelog is [here at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html). **Never mix different versions** of BizHawk — Keep each version in its own folder. Jump to: * [Installing — Windows 7/8.1/10](https://github.com/TASVideos/BizHawk/blob/master/README.md#installing--windows-78110) From 4bc924ebd495418824ab828ef23e5786d23c6fb6 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 01:52:05 +1000 Subject: [PATCH 046/153] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 10f17bcb8d..9b23324ae8 100644 --- a/README.md +++ b/README.md @@ -22,12 +22,12 @@ Jump to: ## Features The BizHawk common features (across all cores) are: -* rom format and region detection and a corruption check +* detection of game format and region, and corruption checking * 10 savestate slots and save/load to file * speed control, including frame stepping and rewinding * memory view/search/edit in all parts of the emulated HW * input recording (making TAS movies) -* take screenshots and record video +* screenshotting and recording video System | BH Common | Accuracy† | Debugging | Peripherals --:|:-:|:-:|:-:|:-: From 108879217f91510adf2e152fc47f44077436e4a3 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 01:53:32 +1000 Subject: [PATCH 047/153] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 9b23324ae8..24f048b28f 100644 --- a/README.md +++ b/README.md @@ -113,6 +113,10 @@ If you use GNU+Linux, there might be a `bizhawk-git` package or similar in the s TODO +powershell to come + +something something IDE is [VS Community 2017](https://visualstudio.microsoft.com/vs/community) + [Compiling](http://tasvideos.org/Bizhawk/Compiling.html) ### GNU+Linux and macOS From dd7abcd5dfe409cd99ee2b9fee43720f0fe06664 Mon Sep 17 00:00:00 2001 From: James Groom Date: Thu, 10 Jan 2019 16:06:37 +0000 Subject: [PATCH 048/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 24f048b28f..1a177fc20e 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ If you use GNU+Linux, there might be a `bizhawk-git` package or similar in the s TODO -powershell to come +powershell *should* be `C:\Windows\Microsoft.NET\Framework\v4.0.30319\msbuild.exe /p:Configuration=Release BizHawk.sln`, but getting errors w/ master something something IDE is [VS Community 2017](https://visualstudio.microsoft.com/vs/community) From e7b18c587139ffc5d473f2256becdb15c5e6d379 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 02:44:52 +1000 Subject: [PATCH 049/153] Update README.md --- README.md | 44 ++++++++++++++------------------------------ 1 file changed, 14 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 1a177fc20e..58ff76e40b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![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) -[![unique systems emulated | 22](https://img.shields.io/badge/unique_systems_emulated-22-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#features) +[![unique systems emulated | 24](https://img.shields.io/badge/unique_systems_emulated-24-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#features) 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). @@ -28,35 +28,20 @@ The BizHawk common features (across all cores) are: * memory view/search/edit in all parts of the emulated HW * input recording (making TAS movies) * screenshotting and recording video +* organised firmware +* input, framerate, and other overlays +* emulated controllers via a comprehensive input mapper +* Lua control over core and frontend (Windows only) -System | BH Common | Accuracy† | Debugging | Peripherals ---:|:-:|:-:|:-:|:-: -Apple II | ✓ | 95%? | ? | ? -Atari 2600 | ✓ | 95%? | ◕ | ? -Atari 7800 | ✓ | 95%? | ◕ | ? -Atari Lynx | ✓ | 95%? | ◔ | ? -ColecoVision | ✓ | 95%? | ◕ | ? -Commodore 64 | ✓ | 95%? | ◕ | [some](http://tasvideos.org/Bizhawk/C64.html) -GB/GBC | ✓ | 95%? | ✓ | ? -GBA | ✓ | 95%? | ◕ | ? -Genesis | ✓ | 95%? | ✓ | [all?](https://bitbucket.org/eke/genesis-plus-gx/src/b573cd25853f9f8b5b941fc36506835e228144c6/wiki/Features.md?at=master&fileviewer=file-view-default) -IntelliVision | ✓ | 95%? | ◕ | ? -Master System | ✓ | 95%? | ✓ | ? -N64 | ✓ | 95%? | ◕ | [all?](http://tasvideos.org/Bizhawk/N64.html) -NGP/NGPC | ✓ | 95%? | ◔ | N/A -NES | ✓ | 95%? | ✓ | ? -PSX | ✓ | 95%? | ? | ? -Saturn | ✓ | 95%? | ◔ | ? -SNES | ✓ | 95%? | ✓ | ? -TI-83 | ✓ | 95%? | ? | N/A -PC Engine / SG | ✓ | 95%? | ✓ | ? -Virtual Boy | ✓ | 95%? | ? | N/A -WonderSwan | ✓ | 95%? | ◕ | N/A -ZX Spectrum | ✓ | 95%? | ✓ | [common](http://tasvideos.org/Bizhawk/ZXSpectrum.html) +Supported consoles and PCs: -† *approximately* what portion of games run perfectly, not counting romhacks/homebrew (if you want to count, go right ahead) - -EmuHawk's frontend also has a firmware manager, nice overlays, and a comprehensive input mapper. We're talking keyboard and controller mapped to one emulated controller, analog from digital and digital from analog, keyboard hotkeys, controller hotkeys, and rapid fire for emulated controllers. 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. But most importantly: BizHawk is Hawk Biz. +* N64 and [all peripherals](http://tasvideos.org/Bizhawk/N64.html); Playstation (PSX); Saturn; Virtual Boy +* Game Boy Advance; Game Boy Color; Neo Geo Pocket (Color); WonderSwan (Color) +* Genesis and [all peripherals](https://bitbucket.org/eke/genesis-plus-gx/src/b573cd25853f9f8b5b941fc36506835e228144c6/wiki/Features.md?at=master&fileviewer=file-view-default); SNES; TurboGrafx / SuperGrafx +* Atari Lynx; Game Boy; Game Gear; TI-83 +* Atari 7800; Commodore 64 and [some peripherals](http://tasvideos.org/Bizhawk/C64.html); Master System; NES; ZX Spectrum and [some peripherals](http://tasvideos.org/Bizhawk/ZXSpectrum.html) +* Apple II; Atari 2600; ColecoVision; IntelliVision +* [More](http://tasvideos.org/Bizhawk/CoreRoadMap.html) coming soon..? See the *Usage* sections below for details about specific tools and config menus. @@ -183,8 +168,7 @@ If you'd like to add a feature, first search the issue tracker for it. If it's a * [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 -* [Hourglass](https://github.com/TASVideos/hourglass-win32) for Windows Win32 — Windows-only, see also [rewrite project](https://github.com/Hourglass-Resurrection/Hourglass-Resurrection) -* [libTAS](https://github.com/clementgallet/libTAS) for Linux ELF — GNU+Linux-only +* [libTAS](https://github.com/clementgallet/libTAS) for Linux ELF — GNU+Linux-only, also emulates other emulators * [openMSX](https://openmsx.org) for MSX — cross-platform ## License From 506d9e2e0c77ba0821396d0594f04b685d328d7e Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 03:00:34 +1000 Subject: [PATCH 050/153] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 58ff76e40b..26634d63c6 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ # BizHawk +[![unique systems emulated | 24](https://img.shields.io/badge/unique_systems_emulated-24-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#features) [![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) -[![unique systems emulated | 24](https://img.shields.io/badge/unique_systems_emulated-24-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#features) +[![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) 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). -Click the "release" button above to grab the latest stable version. New users on Windows will need [this](https://github.com/TASVideos/BizHawk-Prereqs/releases/latest). The changelog is [here at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html). **Never mix different versions** of BizHawk — Keep each version in its own folder. +Click the "release" button above to grab the latest stable version ([changelog at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html)). New users on Windows should click the "prereqs" button too, see *Installing* for info. **Never mix different versions** of BizHawk — Keep each version in its own folder. Jump to: * [Installing — Windows 7/8.1/10](https://github.com/TASVideos/BizHawk/blob/master/README.md#installing--windows-78110) From 5e3b2eada3164daf16254742c8db840737e201dc Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 03:04:07 +1000 Subject: [PATCH 051/153] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 26634d63c6..a5eeaae82f 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,8 @@ Jump to: ## Features The BizHawk common features (across all cores) are: -* detection of game format and region, and corruption checking +* format and region detection for game images +* image corruption warning checked against database * 10 savestate slots and save/load to file * speed control, including frame stepping and rewinding * memory view/search/edit in all parts of the emulated HW From d1f3b19c73194ceb978382fc0494f1ddb79bd3ec Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 03:05:27 +1000 Subject: [PATCH 052/153] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a5eeaae82f..1d64f7edeb 100644 --- a/README.md +++ b/README.md @@ -37,11 +37,11 @@ The BizHawk common features (across all cores) are: Supported consoles and PCs: -* N64 and [all peripherals](http://tasvideos.org/Bizhawk/N64.html); Playstation (PSX); Saturn; Virtual Boy +* N64 and [all](http://tasvideos.org/Bizhawk/N64.html) peripherals; Playstation (PSX); Saturn; Virtual Boy * Game Boy Advance; Game Boy Color; Neo Geo Pocket (Color); WonderSwan (Color) -* Genesis and [all peripherals](https://bitbucket.org/eke/genesis-plus-gx/src/b573cd25853f9f8b5b941fc36506835e228144c6/wiki/Features.md?at=master&fileviewer=file-view-default); SNES; TurboGrafx / SuperGrafx +* Genesis and [all](https://bitbucket.org/eke/genesis-plus-gx/src/b573cd25853f9f8b5b941fc36506835e228144c6/wiki/Features.md?at=master&fileviewer=file-view-default) peripherals; SNES; TurboGrafx / SuperGrafx * Atari Lynx; Game Boy; Game Gear; TI-83 -* Atari 7800; Commodore 64 and [some peripherals](http://tasvideos.org/Bizhawk/C64.html); Master System; NES; ZX Spectrum and [some peripherals](http://tasvideos.org/Bizhawk/ZXSpectrum.html) +* Atari 7800; Commodore 64 and [some](http://tasvideos.org/Bizhawk/C64.html) peripherals; Master System; NES; ZX Spectrum and [some](http://tasvideos.org/Bizhawk/ZXSpectrum.html) peripherals * Apple II; Atari 2600; ColecoVision; IntelliVision * [More](http://tasvideos.org/Bizhawk/CoreRoadMap.html) coming soon..? From 47fe7743c8964438b54bc2869fb034c3135f7228 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 03:06:17 +1000 Subject: [PATCH 053/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1d64f7edeb..d94c4c7805 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Jump to: * [Related projects](https://github.com/TASVideos/BizHawk/blob/master/README.md#related-projects) * [License](https://github.com/TASVideos/BizHawk/blob/master/README.md#license) -## Features +## Features and systems The BizHawk common features (across all cores) are: * format and region detection for game images From 56c9033ef839bcfcbc9481f24e17b499f6df79bb Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 03:17:12 +1000 Subject: [PATCH 054/153] Update README.md --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d94c4c7805..086b9f805f 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,12 @@ Click the "release" button above to grab the latest stable version ([changelog a Jump to: * [Installing — Windows 7/8.1/10](https://github.com/TASVideos/BizHawk/blob/master/README.md#installing--windows-78110) * [Installing — GNU+Linux and macOS](https://github.com/TASVideos/BizHawk/blob/master/README.md#installing--gnulinux-and-macos) -* [Building/Testing](https://github.com/TASVideos/BizHawk/blob/master/README.md#buildingtesting) +* [Building](https://github.com/TASVideos/BizHawk/blob/master/README.md#building) * [Usage (emulation)](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage-emulation) * [Usage (TASing)](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage-tasing) * [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) +* [Testing]() * [Related projects](https://github.com/TASVideos/BizHawk/blob/master/README.md#related-projects) * [License](https://github.com/TASVideos/BizHawk/blob/master/README.md#license) @@ -165,6 +166,10 @@ It's a good idea to check if anyone is already working on an issue by asking on 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. +### 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. + ## Related projects * [DeSmuME](https://desmume.org) for DS/Lite — cross-platform From a2edf3646a216fd3236f863a615e0765d0c279a4 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 03:18:42 +1000 Subject: [PATCH 055/153] Update README.md --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 086b9f805f..3ea82587b9 100644 --- a/README.md +++ b/README.md @@ -10,14 +10,15 @@ A multi-system emulator written in C#. As well as quality-of-life features for c Click the "release" button above to grab the latest stable version ([changelog at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html)). New users on Windows should click the "prereqs" button too, see *Installing* for info. **Never mix different versions** of BizHawk — Keep each version in its own folder. Jump to: -* [Installing — Windows 7/8.1/10](https://github.com/TASVideos/BizHawk/blob/master/README.md#installing--windows-78110) -* [Installing — GNU+Linux and macOS](https://github.com/TASVideos/BizHawk/blob/master/README.md#installing--gnulinux-and-macos) +* Installing + * [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) * [Building](https://github.com/TASVideos/BizHawk/blob/master/README.md#building) -* [Usage (emulation)](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage-emulation) -* [Usage (TASing)](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage-tasing) +* [Usage](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage) + * [TASing](https://github.com/TASVideos/BizHawk/blob/master/README.md#tasing) * [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) -* [Testing]() + * [Testing]() * [Related projects](https://github.com/TASVideos/BizHawk/blob/master/README.md#related-projects) * [License](https://github.com/TASVideos/BizHawk/blob/master/README.md#license) @@ -48,7 +49,9 @@ Supported consoles and PCs: See the *Usage* sections below for details about specific tools and config menus. -## Installing — Windows 7/8.1/10 +## Installing + +### Windows 7/8.1/10 Released binaries can be found right here on GitHub: @@ -68,7 +71,7 @@ BizHawk functions like a "portable" program, you may move or rename the folder c 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). -## Installing — GNU+Linux and macOS +### 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 here](http://tasvideos.org/Bizhawk/ReleaseHistory.html). @@ -126,11 +129,11 @@ Once built, see the *Installing* section, substituting the repo's `output` folde 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). -## Usage (emulation) +## Usage TODO -## Usage (TASing) +### TASing This section refers to BizHawk specifically. For resources on TASing in general, see [Welcome to TASVideos](http://tasvideos.org/WelcomeToTASVideos.html). From 4ee836982a0f4f727cb6f2f86af834e80a2bbde5 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 03:20:50 +1000 Subject: [PATCH 056/153] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 3ea82587b9..e67c4be4ee 100644 --- a/README.md +++ b/README.md @@ -179,6 +179,7 @@ Dev builds are automated with AppVeyor, every green checkmark in the [commit his * [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 * [libTAS](https://github.com/clementgallet/libTAS) for Linux ELF — GNU+Linux-only, also emulates other emulators +* [lsnes](http://tasvideos.org/Lsnes.html) for SNES — Windows-only * [openMSX](https://openmsx.org) for MSX — cross-platform ## License From 753a14ef1ec5b7b9229b9074594db111931f30e6 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 03:26:07 +1000 Subject: [PATCH 057/153] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e67c4be4ee..10121d8935 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,7 @@ Install BizHawk with your distro's package manager. The package name is given on [![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) [![Ubuntu (Launchpad) | bizhawk](https://img.shields.io/badge/Ubuntu_(Launchpad)-bizhawk-%23E95420.svg?colorA=772953&logo=ubuntu&style=popout)](https://example.com/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`). +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. Is your distro not there? Released binaries can be found right here on GitHub (same download as for Windows): @@ -94,7 +94,7 @@ Linux distros are supported if the distributor is still supporting your version, 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/Testing +## Building If you want to test the latest changes without building BizHawk yourself, grab the developer build from [AppVeyor](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history). Pick the topmost one that doesn't say "Pull request", then click "Artifacts" and download `BizHawk_Developer--#.zip`. From 4f53bb2d90dba292f1b07d13a2e73002e9ee7663 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 03:27:38 +1000 Subject: [PATCH 058/153] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 10121d8935..fcd66bb4e6 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ A multi-system emulator written in C#. As well as quality-of-life features for c Click the "release" button above to grab the latest stable version ([changelog at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html)). New users on Windows should click the "prereqs" button too, see *Installing* for info. **Never mix different versions** of BizHawk — Keep each version in its own folder. Jump to: -* Installing +* [Installing](https://github.com/TASVideos/BizHawk/blob/master/README.md#installing) * [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) * [Building](https://github.com/TASVideos/BizHawk/blob/master/README.md#building) @@ -18,7 +18,7 @@ Jump to: * [TASing](https://github.com/TASVideos/BizHawk/blob/master/README.md#tasing) * [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) - * [Testing]() + * [Testing](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) * [Related projects](https://github.com/TASVideos/BizHawk/blob/master/README.md#related-projects) * [License](https://github.com/TASVideos/BizHawk/blob/master/README.md#license) From c44aed966f276f5096add4fc61ceb548b8eb02c3 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 03:28:48 +1000 Subject: [PATCH 059/153] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fcd66bb4e6..67dd936044 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,11 @@ 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). -Click the "release" button above to grab the latest stable version ([changelog at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html)). New users on Windows should click the "prereqs" button too, see *Installing* for info. **Never mix different versions** of BizHawk — Keep each version in its own folder. +Click the "release" button above to grab the latest stable version ([changelog at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html)). + +New users on Windows should click the "prereqs" button too, see *Installing* for info. + +**Never mix different versions** of BizHawk — Keep each version in its own folder. Jump to: * [Installing](https://github.com/TASVideos/BizHawk/blob/master/README.md#installing) From ec65982893e1dd736ac8b1476b4f70ff65cf90c4 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 03:34:01 +1000 Subject: [PATCH 060/153] Update README.md --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 67dd936044..0370381083 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # BizHawk -[![unique systems emulated | 24](https://img.shields.io/badge/unique_systems_emulated-24-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#features) +[![unique systems emulated | 24](https://img.shields.io/badge/unique_systems_emulated-24-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) [![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) [![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) @@ -20,6 +20,7 @@ Jump to: * [Building](https://github.com/TASVideos/BizHawk/blob/master/README.md#building) * [Usage](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage) * [TASing](https://github.com/TASVideos/BizHawk/blob/master/README.md#tasing) + * [Cores](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) * [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) * [Testing](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) @@ -151,6 +152,12 @@ TODO [TAS movie file format](http://tasvideos.org/Bizhawk/TASFormat.html) +### 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's currently a bit of overlap in the cores BizHawk uses as noted below. + +TABLE GOES HERE + ## 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+ISSUE_KEYWORDS), check the [BizHawk forum](http://tasvideos.org/forum/viewforum.php?f=64) at TASVideos, or ask on IRC: From b62abb7f0bfef23a933534f5c2bb13acd237fa9a Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 03:39:03 +1000 Subject: [PATCH 061/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0370381083..700874c633 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Jump to: The BizHawk common features (across all cores) are: * format and region detection for game images * image corruption warning checked against database -* 10 savestate slots and save/load to file +* 10 save slots with hotkeys and ∞ named savestates * speed control, including frame stepping and rewinding * memory view/search/edit in all parts of the emulated HW * input recording (making TAS movies) From d9836e0c20aba69c3bb0f450c38de87620868b26 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 03:45:48 +1000 Subject: [PATCH 062/153] Update README.md --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 700874c633..cbdd4b170a 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ # 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 | 24](https://img.shields.io/badge/unique_systems_emulated-24-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) [![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) [![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) -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). - Click the "release" button above to grab the latest stable version ([changelog at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html)). New users on Windows should click the "prereqs" button too, see *Installing* for info. @@ -30,17 +32,17 @@ Jump to: ## Features and systems The BizHawk common features (across all cores) are: -* format and region detection for game images -* image corruption warning checked against database +* format, region, and integrity detection for game images * 10 save slots with hotkeys and ∞ named savestates * speed control, including frame stepping and rewinding -* memory view/search/edit in all parts of the emulated HW +* memory view/search/edit in all emulated hardware components * input recording (making TAS movies) * screenshotting and recording video -* organised firmware -* input, framerate, and other overlays +* 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 PCs: From c1e2d2388c33f9117920af60ed4bb4be22781c17 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 03:55:46 +1000 Subject: [PATCH 063/153] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cbdd4b170a..8c5eb40362 100644 --- a/README.md +++ b/README.md @@ -37,14 +37,14 @@ The BizHawk common features (across all cores) are: * speed control, including frame stepping and rewinding * memory view/search/edit in all emulated hardware components * input recording (making TAS movies) -* screenshotting and recording video +* 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 PCs: +Supported consoles and computers: * N64 and [all](http://tasvideos.org/Bizhawk/N64.html) peripherals; Playstation (PSX); Saturn; Virtual Boy * Game Boy Advance; Game Boy Color; Neo Geo Pocket (Color); WonderSwan (Color) From 9a9daf20d883c6b304336440d2f080532d6f125f Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 04:08:52 +1000 Subject: [PATCH 064/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8c5eb40362..7129a8d5ab 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ Is your distro not there? Released binaries can be found right here on GitHub (s 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. +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. 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. From 17a73c31e5bdb93eb31da0a560a52545902a9fab Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 04:18:34 +1000 Subject: [PATCH 065/153] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7129a8d5ab..70893026ae 100644 --- a/README.md +++ b/README.md @@ -46,11 +46,11 @@ The BizHawk common features (across all cores) are: Supported consoles and computers: -* N64 and [all](http://tasvideos.org/Bizhawk/N64.html) peripherals; Playstation (PSX); Saturn; Virtual Boy -* Game Boy Advance; Game Boy Color; Neo Geo Pocket (Color); WonderSwan (Color) -* Genesis and [all](https://bitbucket.org/eke/genesis-plus-gx/src/b573cd25853f9f8b5b941fc36506835e228144c6/wiki/Features.md?at=master&fileviewer=file-view-default) peripherals; SNES; TurboGrafx / SuperGrafx -* Atari Lynx; Game Boy; Game Gear; TI-83 -* Atari 7800; Commodore 64 and [some](http://tasvideos.org/Bizhawk/C64.html) peripherals; Master System; NES; ZX Spectrum and [some](http://tasvideos.org/Bizhawk/ZXSpectrum.html) peripherals +* N64; Playstation (PSX); Sega Saturn; Virtual Boy +* Game Boy Advance; Game Boy Color; Neo Geo Pocket / Color; WonderSwan / Color +* Sega Genesis; SNES; TurboGrafx / SuperGrafx +* Atari Lynx; Game Boy; Sega Game Gear; TI-83 +* Atari 7800; Commodore 64; Sega Master System; NES; ZX Spectrum * Apple II; Atari 2600; ColecoVision; IntelliVision * [More](http://tasvideos.org/Bizhawk/CoreRoadMap.html) coming soon..? From e60be7753c8f8108ab5e540357d0d0819867a252 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 04:32:54 +1000 Subject: [PATCH 066/153] Update README.md --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 70893026ae..2ff79d35fd 100644 --- a/README.md +++ b/README.md @@ -46,12 +46,11 @@ The BizHawk common features (across all cores) are: Supported consoles and computers: -* N64; Playstation (PSX); Sega Saturn; Virtual Boy -* Game Boy Advance; Game Boy Color; Neo Geo Pocket / Color; WonderSwan / Color -* Sega Genesis; SNES; TurboGrafx / SuperGrafx -* Atari Lynx; Game Boy; Sega Game Gear; TI-83 -* Atari 7800; Commodore 64; Sega Master System; NES; ZX Spectrum -* Apple II; Atari 2600; ColecoVision; IntelliVision +* N64; Playstation (PSX); Sega Saturn +* Game Boy; Game Boy Advance; Game Boy Color; Sega Game Gear +* Atari 2600; Atari 7800; Atari Lynx; NES; Sega Genesis; Sega Master System; SNES; Virtual Boy +* Apple II; Commodore 64; ColecoVision; IntelliVision; TurboGrafx / SuperGrafx; ZX Spectrum +* Neo Geo Pocket / Color; TI-83; WonderSwan / Color * [More](http://tasvideos.org/Bizhawk/CoreRoadMap.html) coming soon..? See the *Usage* sections below for details about specific tools and config menus. From 5200ce89c63c3d14e75105a242238bd981d36068 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 18:07:44 +1000 Subject: [PATCH 067/153] Update README.md --- README.md | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2ff79d35fd..463aeaf465 100644 --- a/README.md +++ b/README.md @@ -46,11 +46,30 @@ The BizHawk common features (across all cores) are: Supported consoles and computers: -* N64; Playstation (PSX); Sega Saturn -* Game Boy; Game Boy Advance; Game Boy Color; Sega Game Gear -* Atari 2600; Atari 7800; Atari Lynx; NES; Sega Genesis; Sega Master System; SNES; Virtual Boy -* Apple II; Commodore 64; ColecoVision; IntelliVision; TurboGrafx / SuperGrafx; ZX Spectrum -* Neo Geo Pocket / Color; TI-83; WonderSwan / Color +* Apple II +* Atari 2600 +* Atari 7800 +* Atari Lynx +* Commodore 64 +* ColecoVision +* Game Boy +* Game Boy Advance +* Game Boy Color +* IntelliVision +* N64 +* Neo Geo Pocket / Color +* NES +* Playstation (PSX) +* Sega Game Gear +* Sega Genesis +* Sega Master System +* Sega Saturn +* SNES +* TI-83 +* TurboGrafx / SuperGrafx +* Virtual Boy +* WonderSwan / Color +* ZX Spectrum * [More](http://tasvideos.org/Bizhawk/CoreRoadMap.html) coming soon..? See the *Usage* sections below for details about specific tools and config menus. @@ -191,7 +210,7 @@ Dev builds are automated with AppVeyor, every green checkmark in the [commit his * [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 * [libTAS](https://github.com/clementgallet/libTAS) for Linux ELF — GNU+Linux-only, also emulates other emulators -* [lsnes](http://tasvideos.org/Lsnes.html) for SNES — Windows-only +* [lsnes](http://tasvideos.org/Lsnes.html) for GB and SNES — cross-platform * [openMSX](https://openmsx.org) for MSX — cross-platform ## License From 79252ee41706a58f9baa12aadaa800e15c2456fc Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 18:25:16 +1000 Subject: [PATCH 068/153] Update README.md --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 463aeaf465..9bdd9c7d4e 100644 --- a/README.md +++ b/README.md @@ -127,13 +127,16 @@ If you use GNU+Linux, there might be a `bizhawk-git` package or similar in the s ### Windows 7/8.1/10 -TODO +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. -powershell *should* be `C:\Windows\Microsoft.NET\Framework\v4.0.30319\msbuild.exe /p:Configuration=Release BizHawk.sln`, but getting errors w/ master +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. -something something IDE is [VS Community 2017](https://visualstudio.microsoft.com/vs/community) - -[Compiling](http://tasvideos.org/Bizhawk/Compiling.html) +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. ### GNU+Linux and macOS From 62363e3cded9cad0976c6498bf156e61943c29cc Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 18:26:27 +1000 Subject: [PATCH 069/153] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 9bdd9c7d4e..f097779edf 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ Jump to: * [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) * [Building](https://github.com/TASVideos/BizHawk/blob/master/README.md#building) + * [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) * [Usage](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage) * [TASing](https://github.com/TASVideos/BizHawk/blob/master/README.md#tasing) * [Cores](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) From 5905dc2d7c01a55c56b62c065b746f2e0b8d50be Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 19:45:36 +1000 Subject: [PATCH 070/153] Update README.md --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f097779edf..f9e7bd7f50 100644 --- a/README.md +++ b/README.md @@ -181,7 +181,35 @@ TODO 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's currently a bit of overlap in the cores BizHawk uses as noted below. -TABLE GOES HERE +System | Core | Alt. Core | SGB +--:|:--|:--|:-- +Amstrad CPC | CPCHawk† || +Apple II | Virtu || +Atari 2600 | Atari2600Hawk || +Atari 7800 | A7800Hawk || +Atari Lynx | Handy || +Commodore 64 | C64Hawk || +ColecoVision | ColecoHawk || +Game Boy | GBHawk | Gambatte | SameBoy (on SNES with SGB) +Game Boy Advance | mGBA/VBA-Next | mGBA/VBA-Next | +Game Boy Color | GBHawk | Gambatte | SameBoy (on SNES with SGB) +IntelliVision | IntelliHawk || +N64 | Mupen64Plus || +Neo Geo Pocket / Color | NeoPop || +NES | NesHawk | QuickNes || +Playstation (PSX) | Octoshock || +Sega Game Gear | SMSHawk || +Sega Genesis | Genplus-gx || +Sega Master System | SMSHawk || +Sega Saturn | Saturnus || +SNES | BSNES/Snes9x | BSNES/Snes9x | +TI-83 | TI83Hawk || +TurboGrafx / SuperGrafx | PCEHawk || +Virtual Boy | Virtual Boyee || +WonderSwan / Color | Cygne || +ZX Spectrum | ZXHawk || + +† core is in development and unreleased ## Support and troubleshooting From 3794d0ced8063c106c6ad9918f98375c10705e5e Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 20:00:38 +1000 Subject: [PATCH 071/153] Update README.md --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f9e7bd7f50..c4ffc3f253 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,7 @@ Supported consoles and computers: * N64 * Neo Geo Pocket / Color * NES +* PC-FX * Playstation (PSX) * Sega Game Gear * Sega Genesis @@ -181,7 +182,7 @@ TODO 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's currently a bit of overlap in the cores BizHawk uses as noted below. -System | Core | Alt. Core | SGB +System | Core | Alt. Core | Special Core --:|:--|:--|:-- Amstrad CPC | CPCHawk† || Apple II | Virtu || @@ -194,10 +195,13 @@ Game Boy | GBHawk | Gambatte | SameBoy (on SNES with SGB) Game Boy Advance | mGBA/VBA-Next | mGBA/VBA-Next | Game Boy Color | GBHawk | Gambatte | SameBoy (on SNES with SGB) IntelliVision | IntelliHawk || +Magnavox Odyssey² | O2Em† || N64 | Mupen64Plus || -Neo Geo Pocket / Color | NeoPop || +Neo Geo Pocket / Color | NeoPop || Dual NeoPop (dual instance) NES | NesHawk | QuickNes || +PC-FX | T.S.T. || Playstation (PSX) | Octoshock || +PSP | PPSSPP† || Sega Game Gear | SMSHawk || Sega Genesis | Genplus-gx || Sega Master System | SMSHawk || @@ -205,6 +209,7 @@ Sega Saturn | Saturnus || SNES | BSNES/Snes9x | BSNES/Snes9x | TI-83 | TI83Hawk || TurboGrafx / SuperGrafx | PCEHawk || +Uzebox | Uzem† || Virtual Boy | Virtual Boyee || WonderSwan / Color | Cygne || ZX Spectrum | ZXHawk || From 9c397a005384c82544399eb65a708ef0511436da Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 20:02:51 +1000 Subject: [PATCH 072/153] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index c4ffc3f253..4e7a14df18 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,7 @@ Supported consoles and computers: * Sega Game Gear * Sega Genesis * Sega Master System +* Sega Pico * Sega Saturn * SNES * TI-83 @@ -206,6 +207,7 @@ Sega Game Gear | SMSHawk || Sega Genesis | Genplus-gx || Sega Master System | SMSHawk || Sega Saturn | Saturnus || +Sega Pico | PicoDrive || SNES | BSNES/Snes9x | BSNES/Snes9x | TI-83 | TI83Hawk || TurboGrafx / SuperGrafx | PCEHawk || From 48e9f731b2b12ddff2234d01ed84b52cfac18756 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 20:07:09 +1000 Subject: [PATCH 073/153] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4e7a14df18..16d0e75d4c 100644 --- a/README.md +++ b/README.md @@ -125,10 +125,6 @@ macOS is supported from 10.11 "El Capitan" (Darwin 15.6). Apple doesn't seem to ## Building -If you want to test the latest changes without building BizHawk yourself, grab the developer build from [AppVeyor](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history). Pick the topmost one that doesn't say "Pull request", then click "Artifacts" and download `BizHawk_Developer--#.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. - ### Windows 7/8.1/10 If you have WSL, Git BASH, or similar, clone the repo with: @@ -146,6 +142,8 @@ The best free C# IDE is [VS Community 2017](https://visualstudio.microsoft.com/v *Compiling* requires MSBuild and *running* requires Mono and WINE, but **BizHawk does not run under WINE** — only the bundled libraries are required. +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. + Building is as easy as: ```sh git clone https://github.com/TASVideos/BizHawk.git BizHawk_master && cd BizHawk_master @@ -244,6 +242,8 @@ If you'd like to add a feature, first search the issue tracker for it. If it's a 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. +Once you're on the build page, click "Artifacts" and download `BizHawk_Developer--#.zip`. + ## Related projects * [DeSmuME](https://desmume.org) for DS/Lite — cross-platform From 91b486e9a01eac3c709e85723f9ed922a1fb02b3 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 20:08:06 +1000 Subject: [PATCH 074/153] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 16d0e75d4c..8245f0e1b8 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,10 @@ New users on Windows should click the "prereqs" button too, see *Installing* for **Never mix different versions** of BizHawk — Keep each version in its own folder. Jump to: -* [Installing](https://github.com/TASVideos/BizHawk/blob/master/README.md#installing) +* Installing * [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) -* [Building](https://github.com/TASVideos/BizHawk/blob/master/README.md#building) +* Building * [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) * [Usage](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage) From 13704e1904c35ed4b062c682694c1ba91651c0de Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 21:58:06 +1000 Subject: [PATCH 075/153] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 8245f0e1b8..0b38029fe4 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,8 @@ BizHawk functions like a "portable" program, you may move or rename the folder c 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). +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. + ### 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 here](http://tasvideos.org/Bizhawk/ReleaseHistory.html). From 993a6d80e2ef7e57d2e72b815174f90727be89a6 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 22:08:42 +1000 Subject: [PATCH 076/153] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 0b38029fe4..ee6e8dd700 100644 --- a/README.md +++ b/README.md @@ -240,6 +240,8 @@ It's a good idea to check if anyone is already working on an issue by asking on 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. +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. + ### 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. From 0d71b4a525f03537c7838e56f8dbceaa960e75f0 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 22:10:10 +1000 Subject: [PATCH 077/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ee6e8dd700..41fc7d613d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A multi-system emulator written in C#. As well as quality-of-life features for c *** -[![unique systems emulated | 24](https://img.shields.io/badge/unique_systems_emulated-24-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) +[![unique systems emulated | 26](https://img.shields.io/badge/unique_systems_emulated-24-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) [![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) [![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) From a48c697016c0910870e07b6b446c68fb66b7c8db Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 22:11:18 +1000 Subject: [PATCH 078/153] Update README.md --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 41fc7d613d..875e9b51bd 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A multi-system emulator written in C#. As well as quality-of-life features for c *** -[![unique systems emulated | 26](https://img.shields.io/badge/unique_systems_emulated-24-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) +[![unique systems emulated | 25](https://img.shields.io/badge/unique_systems_emulated-25-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) [![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) [![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) @@ -54,9 +54,8 @@ Supported consoles and computers: * Atari Lynx * Commodore 64 * ColecoVision -* Game Boy +* Game Boy / Color * Game Boy Advance -* Game Boy Color * IntelliVision * N64 * Neo Geo Pocket / Color @@ -192,9 +191,8 @@ Atari 7800 | A7800Hawk || Atari Lynx | Handy || Commodore 64 | C64Hawk || ColecoVision | ColecoHawk || -Game Boy | GBHawk | Gambatte | SameBoy (on SNES with SGB) +Game Boy / Color | GBHawk | Gambatte | SameBoy (on SNES with SGB) Game Boy Advance | mGBA/VBA-Next | mGBA/VBA-Next | -Game Boy Color | GBHawk | Gambatte | SameBoy (on SNES with SGB) IntelliVision | IntelliHawk || Magnavox Odyssey² | O2Em† || N64 | Mupen64Plus || From 9cbf6455f86ff0cb84fc9fa0b1ee868ccf21c638 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 22:11:49 +1000 Subject: [PATCH 079/153] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 875e9b51bd..40a723442c 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ 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 | 25](https://img.shields.io/badge/unique_systems_emulated-25-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) [![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) [![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) +*** + Click the "release" button above to grab the latest stable version ([changelog at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html)). New users on Windows should click the "prereqs" button too, see *Installing* for info. From dd69df3433d0c24847657c51ed1dd9d52669b0ae Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 22:14:13 +1000 Subject: [PATCH 080/153] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 40a723442c..3112449ec4 100644 --- a/README.md +++ b/README.md @@ -124,6 +124,8 @@ Linux distros are supported if the distributor is still supporting your version, 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. +[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) + ## Building ### Windows 7/8.1/10 @@ -160,6 +162,8 @@ Once built, see the *Installing* section, substituting the repo's `output` folde 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). +[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) + ## Usage TODO @@ -216,6 +220,8 @@ ZX Spectrum | ZXHawk || † core is in development and unreleased +[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) + ## 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+ISSUE_KEYWORDS), check the [BizHawk forum](http://tasvideos.org/forum/viewforum.php?f=64) at TASVideos, or ask on IRC: @@ -246,6 +252,8 @@ Dev builds are automated with AppVeyor, every green checkmark in the [commit his Once you're on the build page, click "Artifacts" and download `BizHawk_Developer--#.zip`. +[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) + ## Related projects * [DeSmuME](https://desmume.org) for DS/Lite — cross-platform From 49fe45488177d920be59bdc992bca0f3b95d8f2d Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 11 Jan 2019 22:15:06 +1000 Subject: [PATCH 081/153] Update README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 3112449ec4..f975129b71 100644 --- a/README.md +++ b/README.md @@ -101,6 +101,8 @@ Win7 is supported from SP1, Win8 is supported from 8.1, and Win10 is supported f 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. +[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) + ### 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 here](http://tasvideos.org/Bizhawk/ReleaseHistory.html). @@ -141,6 +143,8 @@ On Windows 10, open a PowerShell window in BizHawk_master (Shift+Mouse2 in File 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. +[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) + ### 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. @@ -168,6 +172,8 @@ Again, if your distro isn't listed there, you might get an "Unknown distro" warn TODO +[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) + ### TASing This section refers to BizHawk specifically. For resources on TASing in general, see [Welcome to TASVideos](http://tasvideos.org/WelcomeToTASVideos.html). @@ -182,6 +188,8 @@ TODO [TAS movie file format](http://tasvideos.org/Bizhawk/TASFormat.html) +[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) + ### 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's currently a bit of overlap in the cores BizHawk uses as noted below. @@ -232,6 +240,8 @@ A short [FAQ](http://tasvideos.org/Bizhawk/FAQ.html) is provided on the [BizHawk 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). +[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#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. From 25115fd2937b88dc999bb16959ca45a67a2c7b03 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 00:33:19 +1000 Subject: [PATCH 082/153] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index f975129b71..ec6f8de728 100644 --- a/README.md +++ b/README.md @@ -254,6 +254,8 @@ It's a good idea to check if anyone is already working on an issue by asking on 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. Please use CRLF and tabs in new files. + 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. ### Testing From 31f28f466ad65e16e50ef60fc9effb920295e9a2 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 00:39:53 +1000 Subject: [PATCH 083/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ec6f8de728..134129c8b1 100644 --- a/README.md +++ b/README.md @@ -254,7 +254,7 @@ It's a good idea to check if anyone is already working on an issue by asking on 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. Please use CRLF and tabs in new files. +For the time being, style is not enforced in PRs, only build success. Please use CRLF, tabs, and [Allman braces](https://en.wikipedia.org/wiki/Indentation_style#Allman_style) in new files. 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. From 08fdb101ddd782e709a099f60e6f1f0d75ee2f7e Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 00:40:18 +1000 Subject: [PATCH 084/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 134129c8b1..e62a28e8bf 100644 --- a/README.md +++ b/README.md @@ -254,7 +254,7 @@ It's a good idea to check if anyone is already working on an issue by asking on 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. Please use CRLF, tabs, and [Allman braces](https://en.wikipedia.org/wiki/Indentation_style#Allman_style) in new files. +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. 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. From 99b4e7f4d8f9ed420b9e9ba9d041ffc4274f9383 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 01:45:15 +1000 Subject: [PATCH 085/153] Update README.md --- README.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e62a28e8bf..449571ddec 100644 --- a/README.md +++ b/README.md @@ -196,7 +196,6 @@ A *core* is what we call the smaller bits of software that emulate just one syst System | Core | Alt. Core | Special Core --:|:--|:--|:-- -Amstrad CPC | CPCHawk† || Apple II | Virtu || Atari 2600 | Atari2600Hawk || Atari 7800 | A7800Hawk || @@ -204,29 +203,26 @@ Atari Lynx | Handy || Commodore 64 | C64Hawk || ColecoVision | ColecoHawk || Game Boy / Color | GBHawk | Gambatte | SameBoy (on SNES with SGB) -Game Boy Advance | mGBA/VBA-Next | mGBA/VBA-Next | +Game Boy Advance | mGBA | VBA-Next | IntelliVision | IntelliHawk || -Magnavox Odyssey² | O2Em† || N64 | Mupen64Plus || Neo Geo Pocket / Color | NeoPop || Dual NeoPop (dual instance) NES | NesHawk | QuickNes || PC-FX | T.S.T. || Playstation (PSX) | Octoshock || -PSP | PPSSPP† || Sega Game Gear | SMSHawk || Sega Genesis | Genplus-gx || Sega Master System | SMSHawk || Sega Saturn | Saturnus || Sega Pico | PicoDrive || -SNES | BSNES/Snes9x | BSNES/Snes9x | +SNES | BSNES | Snes9x | TI-83 | TI83Hawk || TurboGrafx / SuperGrafx | PCEHawk || -Uzebox | Uzem† || Virtual Boy | Virtual Boyee || WonderSwan / Color | Cygne || ZX Spectrum | ZXHawk || -† core is in development and unreleased +Amstrad CPC, Magnavox Odyssey², PSP, and Uzebox emulation is a work-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 *Support* below). [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) From 6cca49f828f6413af7ae5cd72c1805bbd17b40a0 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 01:46:54 +1000 Subject: [PATCH 086/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 449571ddec..af81e69468 100644 --- a/README.md +++ b/README.md @@ -192,7 +192,7 @@ TODO ### 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's currently a bit of overlap in the cores BizHawk uses as noted below. +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 | Special Core --:|:--|:--|:-- From 73bbd688940d23812a30bb7edbee84e4a7decb33 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 01:53:13 +1000 Subject: [PATCH 087/153] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index af81e69468..001d287281 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ 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 | 25](https://img.shields.io/badge/unique_systems_emulated-25-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) +[![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) [![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) [![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) @@ -70,6 +70,7 @@ Supported consoles and computers: * SNES * TI-83 * TurboGrafx / SuperGrafx +* Uzebox * Virtual Boy * WonderSwan / Color * ZX Spectrum @@ -218,11 +219,12 @@ Sega Pico | PicoDrive || SNES | BSNES | Snes9x | TI-83 | TI83Hawk || TurboGrafx / SuperGrafx | PCEHawk || +Uzebox | Uzem || Virtual Boy | Virtual Boyee || WonderSwan / Color | Cygne || ZX Spectrum | ZXHawk || -Amstrad CPC, Magnavox Odyssey², PSP, and Uzebox emulation is a work-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 *Support* below). +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 *Support* below). [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) From 2647fcb74b7db9deb00265dc3eacb92886952754 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 01:58:20 +1000 Subject: [PATCH 088/153] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 001d287281..3d4fec96df 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ A multi-system emulator written in C#. As well as quality-of-life features for c Click the "release" button above to grab the latest stable version ([changelog at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html)). -New users on Windows should click the "prereqs" button too, see *Installing* for info. +New users on Windows need an extra download, click the "prereqs" button to get that and see [*Installing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#windows-78110) for info. **Never mix different versions** of BizHawk — Keep each version in its own folder. @@ -76,7 +76,7 @@ Supported consoles and computers: * ZX Spectrum * [More](http://tasvideos.org/Bizhawk/CoreRoadMap.html) coming soon..? -See the *Usage* sections below for details about specific tools and config menus. +See [*Usage*](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage) below for details about specific tools and config menus. ## Installing @@ -163,7 +163,7 @@ 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](https://gitlab.com/TASVideos/libblip_buf/blob/unified/README.md). -Once built, see the *Installing* section, substituting the repo's `output` folder for the download. +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. 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). @@ -224,7 +224,7 @@ Virtual Boy | Virtual Boyee || WonderSwan / Color | Cygne || ZX Spectrum | ZXHawk || -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 *Support* below). +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). [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) @@ -248,7 +248,7 @@ If you'd like to fix bugs, check the issue tracker here on GitHub: [![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) -It's a good idea to check if anyone is already working on an issue by asking on IRC (see *Support* above). +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). 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. From a6cf78a8b56ad98c0cff587b372ee2db4afb9f8c Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 02:12:24 +1000 Subject: [PATCH 089/153] Update README.md --- README.md | 52 ++++++++++++++++++++++++++++------------------------ 1 file changed, 28 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 3d4fec96df..39e34a2ad0 100644 --- a/README.md +++ b/README.md @@ -49,31 +49,35 @@ The BizHawk common features (across all cores) are: Supported consoles and computers: * Apple II -* Atari 2600 -* Atari 7800 -* Atari Lynx -* Commodore 64 -* ColecoVision -* Game Boy / Color -* Game Boy Advance -* IntelliVision -* N64 -* Neo Geo Pocket / Color -* NES -* PC-FX -* Playstation (PSX) -* Sega Game Gear -* Sega Genesis -* Sega Master System -* Sega Pico -* Sega Saturn -* SNES -* TI-83 -* TurboGrafx / SuperGrafx +* Atari + * 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 + * 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 * Uzebox -* Virtual Boy -* WonderSwan / Color -* ZX Spectrum * [More](http://tasvideos.org/Bizhawk/CoreRoadMap.html) coming soon..? See [*Usage*](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage) below for details about specific tools and config menus. From 1be46842819d63a23c6de8c528d1fb256afeecde Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 02:12:50 +1000 Subject: [PATCH 090/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 39e34a2ad0..1445e6fcdc 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ Supported consoles and computers: * PC-FX * Neo Geo Pocket + Color * Nintendo - * Famicom / Nintendo Entertainment System + * Famicom / Nintendo Entertainment System + FDS * Game Boy + Color * Game Boy Advance * Nintendo 64 From 2afb731e5e1f5503662145a0af751425f9ec72c6 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 02:13:58 +1000 Subject: [PATCH 091/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1445e6fcdc..18f242b63a 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ Supported consoles and computers: * Apple II * Atari - * 2600 + * Video Computer System / 2600 * 7800 * Lynx * Bandai WonderSwan + Color From b2386830e32010c037b3acef9943264c27d65eef Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 02:14:59 +1000 Subject: [PATCH 092/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 18f242b63a..2c03677ae0 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ A multi-system emulator written in C#. As well as quality-of-life features for c Click the "release" button above to grab the latest stable version ([changelog at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html)). -New users on Windows need an extra download, click the "prereqs" button to get that and see [*Installing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#windows-78110) for info. +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. **Never mix different versions** of BizHawk — Keep each version in its own folder. From aba7a9dde512f08f6cec81f1a6a7f82f2eafe3cc Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 02:16:55 +1000 Subject: [PATCH 093/153] Update README.md --- README.md | 57 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 29 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 2c03677ae0..5a6803cfaf 100644 --- a/README.md +++ b/README.md @@ -199,34 +199,35 @@ TODO 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 | Special Core ---:|:--|:--|:-- -Apple II | Virtu || -Atari 2600 | Atari2600Hawk || -Atari 7800 | A7800Hawk || -Atari Lynx | Handy || -Commodore 64 | C64Hawk || -ColecoVision | ColecoHawk || -Game Boy / Color | GBHawk | Gambatte | SameBoy (on SNES with SGB) -Game Boy Advance | mGBA | VBA-Next | -IntelliVision | IntelliHawk || -N64 | Mupen64Plus || -Neo Geo Pocket / Color | NeoPop || Dual NeoPop (dual instance) -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 | -TI-83 | TI83Hawk || -TurboGrafx / SuperGrafx | PCEHawk || -Uzebox | Uzem || -Virtual Boy | Virtual Boyee || -WonderSwan / Color | Cygne || -ZX Spectrum | ZXHawk || +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 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). From 4643e2302877432facb2665dccf22e6199bdfc14 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 02:24:35 +1000 Subject: [PATCH 094/153] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5a6803cfaf..9a485be01e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ 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 | 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) +[![unique systems emulated | 27](https://img.shields.io/badge/unique_systems_emulated-27-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) [![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) [![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) @@ -71,9 +71,10 @@ Supported consoles and computers: * Sega * Game Gear * Genesis + 32X + CD - * Master System + SG-1000 + * Master System * Pico * Saturn + * SG-1000 * Sinclair ZX Spectrum * Sony Playstation / PSX * Texas Instruments TI-83 From 56a834b75f562891d2a3ce0a2af35ff50df008d3 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 02:56:25 +1000 Subject: [PATCH 095/153] Update README.md --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 9a485be01e..2ae334141f 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ Jump to: * Installing * [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) +* [Testing](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) * Building * [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) @@ -27,7 +28,6 @@ Jump to: * [Cores](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) * [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) - * [Testing](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) * [Related projects](https://github.com/TASVideos/BizHawk/blob/master/README.md#related-projects) * [License](https://github.com/TASVideos/BizHawk/blob/master/README.md#license) @@ -134,6 +134,14 @@ macOS is supported from 10.11 "El Capitan" (Darwin 15.6). Apple doesn't seem to [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) +## 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. + +Once you're on the build page, click "Artifacts" and download `BizHawk_Developer--#.zip`. + +[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) + ## Building ### Windows 7/8.1/10 @@ -262,14 +270,6 @@ For the time being, style is not enforced in PRs, only build success is. Please 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. -### 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. - -Once you're on the build page, click "Artifacts" and download `BizHawk_Developer--#.zip`. - -[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) - ## Related projects * [DeSmuME](https://desmume.org) for DS/Lite — cross-platform From 119b4058ebd430a844fd9e930764b3fa19a6961c Mon Sep 17 00:00:00 2001 From: YoshiRulz Date: Sat, 12 Jan 2019 15:13:48 +1000 Subject: [PATCH 096/153] Revert "Update README.md" This reverts commit 56a834b75f562891d2a3ce0a2af35ff50df008d3. --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2ae334141f..9a485be01e 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,6 @@ Jump to: * Installing * [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) -* [Testing](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) * Building * [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) @@ -28,6 +27,7 @@ Jump to: * [Cores](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) * [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) + * [Testing](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) * [Related projects](https://github.com/TASVideos/BizHawk/blob/master/README.md#related-projects) * [License](https://github.com/TASVideos/BizHawk/blob/master/README.md#license) @@ -134,14 +134,6 @@ macOS is supported from 10.11 "El Capitan" (Darwin 15.6). Apple doesn't seem to [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) -## 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. - -Once you're on the build page, click "Artifacts" and download `BizHawk_Developer--#.zip`. - -[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) - ## Building ### Windows 7/8.1/10 @@ -270,6 +262,14 @@ For the time being, style is not enforced in PRs, only build success is. Please 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. +### 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. + +Once you're on the build page, click "Artifacts" and download `BizHawk_Developer--#.zip`. + +[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) + ## Related projects * [DeSmuME](https://desmume.org) for DS/Lite — cross-platform From 37b1d999218399bc57058ad117aeb268847c799c Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 17:40:10 +1000 Subject: [PATCH 097/153] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9a485be01e..7a268ec8f5 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Jump to: The BizHawk common features (across all cores) are: * format, region, and integrity detection for game images -* 10 save slots with hotkeys and ∞ named savestates +* 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) @@ -248,7 +248,7 @@ If there's no easy solution, what you've got is a bug. Or maybe a feature reques ## 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. +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. If you'd like to fix bugs, check the issue tracker here on GitHub: From 33ac41d8b8238e9cfd4434627cbc095cd484b490 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 17:40:26 +1000 Subject: [PATCH 098/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7a268ec8f5..33644089c5 100644 --- a/README.md +++ b/README.md @@ -248,7 +248,7 @@ If there's no easy solution, what you've got is a bug. Or maybe a feature reques ## 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. +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. If you'd like to fix bugs, check the issue tracker here on GitHub: From 5d1ca826c4735c61d6f7e8b010e1477e474f1289 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sat, 12 Jan 2019 18:06:19 +1000 Subject: [PATCH 099/153] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 33644089c5..7f48e33775 100644 --- a/README.md +++ b/README.md @@ -279,6 +279,8 @@ Once you're on the build page, click "Artifacts" and download `BizHawk_Developer * [lsnes](http://tasvideos.org/Lsnes.html) for GB and SNES — cross-platform * [openMSX](https://openmsx.org) for MSX — cross-platform +The [TASVideos org](https://github.com/TASVideos) has some forks of other emulators and plugins. + ## License From the [full text](https://github.com/TASVideos/BizHawk/blob/master/LICENSE): From f16c538872811fac88fce53855eb998ac58d4952 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sun, 13 Jan 2019 01:47:37 +1000 Subject: [PATCH 100/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7f48e33775..8085b8e439 100644 --- a/README.md +++ b/README.md @@ -279,7 +279,7 @@ Once you're on the build page, click "Artifacts" and download `BizHawk_Developer * [lsnes](http://tasvideos.org/Lsnes.html) for GB and SNES — cross-platform * [openMSX](https://openmsx.org) for MSX — cross-platform -The [TASVideos org](https://github.com/TASVideos) has some forks of other emulators and plugins. +Emulators for other systems can be found on the [EmulatorResources page](http://tasvideos.org/EmulatorResources.html) at TASVideos. The [TASVideos org](https://github.com/TASVideos) also houses other emulators and plugins where development happens sometimes, their upstreams may be of use. ## License From 40928ad5ac953f81abcb5a504192dad79e317dbb Mon Sep 17 00:00:00 2001 From: James Groom Date: Sun, 13 Jan 2019 01:57:06 +1000 Subject: [PATCH 101/153] Update README.md --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 8085b8e439..64e0ea4353 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,10 @@ Jump to: * [GNU+Linux and macOS](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux-and-macos-1) * [Usage](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage) * [TASing](https://github.com/TASVideos/BizHawk/blob/master/README.md#tasing) + * [Testing](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) * [Cores](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) * [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) - * [Testing](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) * [Related projects](https://github.com/TASVideos/BizHawk/blob/master/README.md#related-projects) * [License](https://github.com/TASVideos/BizHawk/blob/master/README.md#license) @@ -196,6 +196,16 @@ TODO [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) +### Testing + +Testing bugfixes or new features can be just as helpful as making them! If code's more your thing, see [*Contributing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#contributing) below. + +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. + +Once you're on the build page, click "Artifacts" and download `BizHawk_Developer--#.zip`. + +[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) + ### 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*. @@ -250,6 +260,8 @@ If there's no easy solution, what you've got is a bug. Or maybe a feature reques 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*](https://github.com/TASVideos/BizHawk/blob/master/README.md#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: [![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) @@ -262,14 +274,6 @@ For the time being, style is not enforced in PRs, only build success is. Please 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. -### 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. - -Once you're on the build page, click "Artifacts" and download `BizHawk_Developer--#.zip`. - -[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) - ## Related projects * [DeSmuME](https://desmume.org) for DS/Lite — cross-platform From e80a5779ce22fdf53c7c3e1897fdb8cf6e089eb6 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sun, 13 Jan 2019 02:14:51 +1000 Subject: [PATCH 102/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 64e0ea4353..558d71de2c 100644 --- a/README.md +++ b/README.md @@ -283,7 +283,7 @@ Past contrbutors to the frontend and custom-built cores are listed [here](https: * [lsnes](http://tasvideos.org/Lsnes.html) for GB and SNES — cross-platform * [openMSX](https://openmsx.org) for MSX — cross-platform -Emulators for other systems can be found on the [EmulatorResources page](http://tasvideos.org/EmulatorResources.html) at TASVideos. The [TASVideos org](https://github.com/TASVideos) also houses 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 [TASVideos GitHub page](https://github.com/TASVideos) also houses other emulators and plugins where development happens sometimes, their upstreams may be of use. ## License From 90a3053447b743127d8da33d7115061ab73f6abe Mon Sep 17 00:00:00 2001 From: James Groom Date: Sun, 13 Jan 2019 16:25:56 +1000 Subject: [PATCH 103/153] Update README.md --- README.md | 38 +++++++++++++++++++++++++------------- 1 file changed, 25 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 558d71de2c..dd2d69d194 100644 --- a/README.md +++ b/README.md @@ -145,9 +145,9 @@ git clone https://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. -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. +~~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`. On older versions, a similar Command Prompt script should work.~~ (Not sure what the right command is. Do let us know.) -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. +For anything more complicated than building, you'll need an IDE like [VS Community 2017](https://visualstudio.microsoft.com/vs/community), currently the best free C# IDE. Open `BizHawk.sln` with VS to start and use the toolbar to choose EmuHawk and build. See [Compiling at TASVideos](http://tasvideos.org/Bizhawk/Compiling.html) (somewhat outdated) for more detailed instructions. [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) @@ -176,23 +176,35 @@ Again, if your distro isn't listed there, you might get an "Unknown distro" warn ## Usage +#### Loading firmware + +You may have seen a dialog saying "You are missing the needed firmware files [...]" when trying to open a rom. Pressing "Yes" opens the Firmware Manager, or you can go to `Config` > `Firmwares...`. + +To load firmware, TODO + +#### Identifying a good rom + +TODO + +#### Rebinding keys and controllers + +TODO + +#### Changing cores + +TODO + +#### Running Lua scripts + TODO [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) ### TASing -This section refers to BizHawk specifically. For resources on TASing in general, see [Welcome to TASVideos](http://tasvideos.org/WelcomeToTASVideos.html). +~~This section refers to BizHawk specifically. For resources on TASing in general, see [Welcome to TASVideos](http://tasvideos.org/WelcomeToTASVideos.html).~~ This section hasn't been written yet. -TODO - -[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) +For now, the best way to learn how to TAS is to browse pages like [BasicTools](http://tasvideos.org/TasingGuide/BasicTools.html) on TASVideos and watch tutorials like [Sand_Knight and dwangoAC's](https://youtu.be/6tJniMaR2Ps). [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) @@ -283,7 +295,7 @@ Past contrbutors to the frontend and custom-built cores are listed [here](https: * [lsnes](http://tasvideos.org/Lsnes.html) for GB and SNES — cross-platform * [openMSX](https://openmsx.org) for MSX — 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 houses 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 [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. ## License From 3aa70ba0cf4b49a42f0aac2883020f0229c76274 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sun, 13 Jan 2019 17:22:02 +1000 Subject: [PATCH 104/153] Update README.md --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index dd2d69d194..ee2a30dc77 100644 --- a/README.md +++ b/README.md @@ -180,11 +180,14 @@ Again, if your distro isn't listed there, you might get an "Unknown distro" warn You may have seen a dialog saying "You are missing the needed firmware files [...]" when trying to open a rom. Pressing "Yes" opens the Firmware Manager, or you can go to `Config` > `Firmwares...`. -To load firmware, TODO +To load firmwares, the easiest way is to click "Import" in the menubar, navigate to the dumped firmware(s), select them all, and click "Open". It's a good idea to have them copied into the `Firmware` folder, which is nicely organised, when prompted. If you were trying to open a rom, click "Close and reload ROM" to do that. Keep in mind some firmware is optional and some have multiple versions, only one of which needs to be set. #### Identifying a good rom -TODO +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 "???" (don't remember) means you've loaded a "known bad" rom, created by incorrect dumping methods; and +* a ?-block means you've loaded something unknown, possibly a romhack or homebrew title. #### Rebinding keys and controllers @@ -192,11 +195,17 @@ TODO #### Changing cores -TODO +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*, and `N64 Video Plugin Settings`, which you shouldn't touch. #### Running Lua scripts -TODO +(Again, 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. + +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). "Remove script" stops it and removes it from the list. "Reload script" stops it and loads changes to the file, running scripts are then started again. [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) From fdc0f26ca608a65d77eefda41d7da012b8a5fcd2 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sun, 13 Jan 2019 17:23:56 +1000 Subject: [PATCH 105/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ee2a30dc77..902123e9f6 100644 --- a/README.md +++ b/README.md @@ -203,7 +203,7 @@ To change which core is used for NES, SNES, GB, or GBA, go to `Config` > `Cores` 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. -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 "⏸". +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). "Remove script" stops it and removes it from the list. "Reload script" stops it and loads changes to the file, running scripts are then started again. From 3e780919045326f3eb800e2f493267413c98837b Mon Sep 17 00:00:00 2001 From: James Groom Date: Sun, 13 Jan 2019 17:24:36 +1000 Subject: [PATCH 106/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 902123e9f6..761554e010 100644 --- a/README.md +++ b/README.md @@ -205,7 +205,7 @@ Go to `Tools` > `Lua Console`. The opened window has two parts, the loaded scrip 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). "Remove script" stops it and removes it from the list. "Reload script" stops it and loads changes to the file, running scripts are then started again. +"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. [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) From b6a0afaa1ef7a798e2c63b9ddd3e03f65e6f7ec1 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sun, 13 Jan 2019 23:41:09 +1000 Subject: [PATCH 107/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 761554e010..3dc3bccec5 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,7 @@ git clone https://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. -~~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`. On older versions, a similar Command Prompt script should work.~~ (Not sure what the right command is. Do let us know.) +Once it's downloaded and extracted, go into the repo's `Dist` folder and run `BuildAndPackage_Release.bat`. BizHawk will be build into the repo's `output` folder. For anything more complicated than building, you'll need an IDE like [VS Community 2017](https://visualstudio.microsoft.com/vs/community), currently the best free C# IDE. Open `BizHawk.sln` with VS to start and use the toolbar to choose EmuHawk and build. See [Compiling at TASVideos](http://tasvideos.org/Bizhawk/Compiling.html) (somewhat outdated) for more detailed instructions. From c1b85d0cb6a4a31b94e08ef560d9ff33feceed16 Mon Sep 17 00:00:00 2001 From: James Groom Date: Sun, 13 Jan 2019 23:43:32 +1000 Subject: [PATCH 108/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3dc3bccec5..88a9faee29 100644 --- a/README.md +++ b/README.md @@ -221,7 +221,7 @@ For now, the best way to learn how to TAS is to browse pages like [BasicTools](h Testing bugfixes or new features can be just as helpful as making them! If code's more your thing, see [*Contributing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#contributing) below. -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. +Dev builds are automated with AppVeyor, every green checkmark in the [commit history](https://github.com/TASVideos/BizHawk/commits/master) 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](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history), 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--#.zip`. From 2448cf38bd715567615a85b0411963e6a63a3edd Mon Sep 17 00:00:00 2001 From: James Groom Date: Mon, 14 Jan 2019 00:10:54 +1000 Subject: [PATCH 109/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 88a9faee29..862fec4eb7 100644 --- a/README.md +++ b/README.md @@ -201,7 +201,7 @@ To change which core is used for NES, SNES, GB, or GBA, go to `Config` > `Cores` (Again, 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. +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 "⏸️". From fefce3d9f1d4a3cc0ed6f00f15903bf028bd2b04 Mon Sep 17 00:00:00 2001 From: James Groom Date: Mon, 14 Jan 2019 00:19:37 +1000 Subject: [PATCH 110/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 862fec4eb7..a5e73a2e58 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,7 @@ git clone https://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. -Once it's downloaded and extracted, go into the repo's `Dist` folder and run `BuildAndPackage_Release.bat`. BizHawk will be build into the repo's `output` folder. +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 building, you'll need an IDE like [VS Community 2017](https://visualstudio.microsoft.com/vs/community), currently the best free C# IDE. Open `BizHawk.sln` with VS to start and use the toolbar to choose EmuHawk and build. See [Compiling at TASVideos](http://tasvideos.org/Bizhawk/Compiling.html) (somewhat outdated) for more detailed instructions. From 84d163d1cb6eb0a180c60b5d89a4d388f5b7ab32 Mon Sep 17 00:00:00 2001 From: James Groom Date: Mon, 14 Jan 2019 00:29:25 +1000 Subject: [PATCH 111/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a5e73a2e58..2c8ec241d0 100644 --- a/README.md +++ b/README.md @@ -195,7 +195,7 @@ TODO #### 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*, and `N64 Video Plugin Settings`, which you shouldn't touch. +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*, and `N64 Video Plugin Settings`, which you shouldn't touch unless you know what you're doing. #### Running Lua scripts From c6a07396bd0f4e4bdf9b0d471acde67d9851dbbe Mon Sep 17 00:00:00 2001 From: James Groom Date: Mon, 14 Jan 2019 01:37:25 +1000 Subject: [PATCH 112/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2c8ec241d0..b6199d943b 100644 --- a/README.md +++ b/README.md @@ -195,7 +195,7 @@ TODO #### 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*, and `N64 Video Plugin Settings`, which you shouldn't touch unless you know what you're doing. +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. #### Running Lua scripts From 1ae9de0921c00f70542a88c61a8b9326bd4f5618 Mon Sep 17 00:00:00 2001 From: James Groom Date: Tue, 15 Jan 2019 01:34:36 +1000 Subject: [PATCH 113/153] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b6199d943b..a4ebc4810c 100644 --- a/README.md +++ b/README.md @@ -186,8 +186,8 @@ To load firmwares, the easiest way is to click "Import" in the menubar, navigate 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 "???" (don't remember) means you've loaded a "known bad" rom, created by incorrect dumping methods; and -* a ?-block means you've loaded something unknown, possibly a romhack or homebrew title. +* 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 unknown, a romhack, or a homebrew title. #### Rebinding keys and controllers From d144479548871ea8ff7e2eb6cb4ff575d9b62a67 Mon Sep 17 00:00:00 2001 From: James Groom Date: Tue, 15 Jan 2019 01:52:29 +1000 Subject: [PATCH 114/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a4ebc4810c..e0a0e4d3ca 100644 --- a/README.md +++ b/README.md @@ -187,7 +187,7 @@ To load firmwares, the easiest way is to click "Import" in the menubar, navigate 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 unknown, a romhack, or a homebrew title. +* something else, usually a ?-block, means you've loaded something that's not in the database. #### Rebinding keys and controllers From 77d099de53a7da39d8efb76fdc6d10f487d8a2db Mon Sep 17 00:00:00 2001 From: James Groom Date: Tue, 15 Jan 2019 16:00:18 +1000 Subject: [PATCH 115/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e0a0e4d3ca..3ee6bec0fc 100644 --- a/README.md +++ b/README.md @@ -199,7 +199,7 @@ To change which core is used for NES, SNES, GB, or GBA, go to `Config` > `Cores` #### Running Lua scripts -(Again, this feature is Windows-only for now.) +(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. From 7b71703223997086dc2fc255a6a2d8a69056248d Mon Sep 17 00:00:00 2001 From: James Groom Date: Tue, 15 Jan 2019 18:39:37 +1000 Subject: [PATCH 116/153] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3ee6bec0fc..5ab4123902 100644 --- a/README.md +++ b/README.md @@ -128,7 +128,11 @@ Is your distro not there? Released binaries can be found right here on GitHub (s 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 for x86_64/amd64, and there are no updates available in your package manager. *Please* update and reboot. +Fixed release distro support: Debian from 8.0 "Jessie", Linux Mint from 19.1 "Tessa", Manjaro from 18.0.2 "Illyria", and Ubuntu (Kubuntu, etc.) from 18.04.1 LTS "Bionic". + +Rolling release distro support (please update and reboot before bothering anyone): Arch Linux from 2018.01.01. + +In general, Linux distros are supported if you're using Linux 4.9/4.14/4.19 LTS or Linux 4.20 on the x86_64/amd64 architecture, *unless* your distributor has ended support. Again, please check there are no updates available in your package manager. 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. From 3f8518e6f292ee33dc8e39440f428858b02d241b Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 16 Jan 2019 00:36:10 +1000 Subject: [PATCH 117/153] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5ab4123902..d2f411751a 100644 --- a/README.md +++ b/README.md @@ -195,12 +195,16 @@ With a core and game loaded, look in the very left of the status bar (`View` > ` #### Rebinding keys and controllers -TODO +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.) From 3aec48de7f63a9752ea230f2a315314eaf8ab181 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 16 Jan 2019 00:43:53 +1000 Subject: [PATCH 118/153] Update README.md --- README.md | 25 ++++--------------------- 1 file changed, 4 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index d2f411751a..1bb1e445a9 100644 --- a/README.md +++ b/README.md @@ -111,30 +111,13 @@ A "backport" release, [1.13.2](https://github.com/TASVideos/BizHawk/releases/tag ### 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 here](http://tasvideos.org/Bizhawk/ReleaseHistory.html). +**IMPORTANT**: The Mono "port" is a work-in-progress! It is *not* complete, does *not* look very nice and is *not* ready for anything that needs accuracy. -[![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) -[![Debian (Launchpad) | bizhawk](https://img.shields.io/badge/Debian_(Launchpad)-bizhawk-%23A81D33.svg?logo=debian&style=popout)](https://example.com/bizhawk) -[![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) -[![macOS (Homebrew) | bizhawk](https://img.shields.io/badge/macOS_(Homebrew)-bizhawk-%23999999.svg?logo=apple&style=popout)](https://example.com/bizhawk) -[![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) -[![Ubuntu (Launchpad) | bizhawk](https://img.shields.io/badge/Ubuntu_(Launchpad)-bizhawk-%23E95420.svg?colorA=772953&logo=ubuntu&style=popout)](https://example.com/bizhawk) +You'll need to either build BizHawk yourself (see [*Building*](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux-and-macos-1) below), or download a dev build (see [*Testing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) below). -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. +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). -Is your distro not there? Released binaries can be found right here on GitHub (same download as for Windows): - -[![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) - -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). - -Fixed release distro support: Debian from 8.0 "Jessie", Linux Mint from 19.1 "Tessa", Manjaro from 18.0.2 "Illyria", and Ubuntu (Kubuntu, etc.) from 18.04.1 LTS "Bionic". - -Rolling release distro support (please update and reboot before bothering anyone): Arch Linux from 2018.01.01. - -In general, Linux distros are supported if you're using Linux 4.9/4.14/4.19 LTS or Linux 4.20 on the x86_64/amd64 architecture, *unless* your distributor has ended support. Again, please check there are no updates available in your package manager. - -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. +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), Sega Master System, Atari 7800, Commodore 64, ColecoVision, IntelliVision, TurboGrafx, and ZX Spectrum. See #1430 for progress. [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) From b7fd548b73d5482d0a7de7d259e7addb26438e65 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 16 Jan 2019 00:44:47 +1000 Subject: [PATCH 119/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1bb1e445a9..697bc9c7e3 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,7 @@ A "backport" release, [1.13.2](https://github.com/TASVideos/BizHawk/releases/tag ### GNU+Linux and macOS -**IMPORTANT**: The Mono "port" is a work-in-progress! It is *not* complete, does *not* look very nice and is *not* ready for anything that needs accuracy. +**IMPORTANT**: The Mono "port" 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*](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux-and-macos-1) below), or download a dev build (see [*Testing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) below). From ba58fa356201812bf06fd08e7ba5233b37de1220 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 16 Jan 2019 00:54:42 +1000 Subject: [PATCH 120/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 697bc9c7e3..40d2a78d92 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ Supported consoles and computers: * Saturn * SG-1000 * Sinclair ZX Spectrum -* Sony Playstation / PSX +* Sony Playstation (PSX) * Texas Instruments TI-83 * Uzebox * [More](http://tasvideos.org/Bizhawk/CoreRoadMap.html) coming soon..? From d54b3778192b46f4bfcc271d558e9a9402b1fb8c Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 16 Jan 2019 01:08:39 +1000 Subject: [PATCH 121/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 40d2a78d92..89b65bf622 100644 --- a/README.md +++ b/README.md @@ -103,7 +103,7 @@ Before you start (by running `EmuHawk.exe`), you'll need the following Windows-o 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](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet). +Following [Microsoft's support lifecycle](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet), Win10 is supported from 1709 "Redstone 3", Win8 is supported from 8.1, and Win7 is supported from SP1 (ends Jan 2020, upgrade to Win10 or try [ReactOS](https://reactos.org/joining/faqs)). 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. From 81ba01371105ab65e0d80a627cab97fae919396f Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 16 Jan 2019 01:09:24 +1000 Subject: [PATCH 122/153] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 89b65bf622..8e73d7a960 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,8 @@ Supported consoles and computers: See [*Usage*](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage) below for details about specific tools and config menus. +[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) + ## Installing ### Windows 7/8.1/10 From 1ac45bbdb82c529d1ac2b0caafb4dd0a8b365528 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 16 Jan 2019 01:09:54 +1000 Subject: [PATCH 123/153] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 8e73d7a960..aefa5f6294 100644 --- a/README.md +++ b/README.md @@ -288,6 +288,8 @@ For the time being, style is not enforced in PRs, only build success is. Please 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. +[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) + ## Related projects * [DeSmuME](https://desmume.org) for DS/Lite — cross-platform From 8c7375147b8ebdf3fd248d76ab870f7973046125 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 16 Jan 2019 01:10:36 +1000 Subject: [PATCH 124/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index aefa5f6294..45c815bc8f 100644 --- a/README.md +++ b/README.md @@ -286,7 +286,7 @@ If you'd like to add a feature, first search the issue tracker for it. If it's a 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. -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. +Past contrbutors to the frontend and custom-built cores are listed [here](https://github.com/TASVideos/BizHawk/graphs/contributors). See the wiki for core authors. [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) From 08d9c0a724e57ae30cf18dd747096b189202446a Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 16 Jan 2019 01:13:20 +1000 Subject: [PATCH 125/153] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 45c815bc8f..900f1ccadc 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,10 @@ New user on Windows? Install the prerequisites first, click the "prereqs" button Jump to: * Installing * [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) + * [GNU+Linux](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux) * Building * [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) + * [GNU+Linux](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux-1) * [Usage](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage) * [TASing](https://github.com/TASVideos/BizHawk/blob/master/README.md#tasing) * [Testing](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) @@ -111,11 +111,11 @@ A "backport" release, [1.13.2](https://github.com/TASVideos/BizHawk/releases/tag [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) -### GNU+Linux and macOS +### GNU+Linux **IMPORTANT**: The Mono "port" 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*](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux-and-macos-1) below), or download a dev build (see [*Testing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) below). +You'll need to either build BizHawk yourself (see [*Building*](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux-1) below), or download a dev build (see [*Testing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) below). 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). @@ -140,7 +140,7 @@ For anything more complicated than building, you'll need an IDE like [VS Communi [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) -### GNU+Linux and macOS +### GNU+Linux *Compiling* requires MSBuild and *running* requires Mono and WINE, but **BizHawk does not run under WINE** — only the bundled libraries are required. @@ -157,7 +157,7 @@ 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](https://gitlab.com/TASVideos/libblip_buf/blob/unified/README.md). -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. +Once built, see [*Installing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux) above, 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). From 934e7edde225f86b19f134a1aa6b7e6d5f529ba4 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 16 Jan 2019 01:18:41 +1000 Subject: [PATCH 126/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 900f1ccadc..7c9c1a30a1 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,7 @@ You'll need to either build BizHawk yourself (see [*Building*](https://github.co 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). -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), Sega Master System, Atari 7800, Commodore 64, ColecoVision, IntelliVision, TurboGrafx, and ZX Spectrum. See #1430 for progress. +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), Sega Master System, Atari 7800, Commodore 64, ColecoVision, IntelliVision, TurboGrafx, and ZX Spectrum. See [#1430](https://github.com/TASVideos/BizHawk/issues/1430) for progress. [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) From 01265a2893388beadd69a7d1c957b961bf5ff3ed Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 16 Jan 2019 01:26:11 +1000 Subject: [PATCH 127/153] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 7c9c1a30a1..af97a7cac2 100644 --- a/README.md +++ b/README.md @@ -117,6 +117,8 @@ A "backport" release, [1.13.2](https://github.com/TASVideos/BizHawk/releases/tag You'll need to either build BizHawk yourself (see [*Building*](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux-1) below), or download a dev build (see [*Testing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) below). +The runtime dependencies are Mono (complete) + Mono VB.NET, WINE (just `libwine` if available), `libdl.so` (glibc), NVIDIA's `cgc` utility. LSB release info is optional for automatically setting the library location. + 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). 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), Sega Master System, Atari 7800, Commodore 64, ColecoVision, IntelliVision, TurboGrafx, and ZX Spectrum. See [#1430](https://github.com/TASVideos/BizHawk/issues/1430) for progress. From a94a970b01b217648b1cf19684c7c5ee224ab4ae Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 16 Jan 2019 01:33:55 +1000 Subject: [PATCH 128/153] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index af97a7cac2..ddd1457b35 100644 --- a/README.md +++ b/README.md @@ -173,6 +173,8 @@ You may have seen a dialog saying "You are missing the needed firmware files [.. To load firmwares, the easiest way is to click "Import" in the menubar, navigate to the dumped firmware(s), select them all, and click "Open". It's a good idea to have them copied into the `Firmware` folder, which is nicely organised, when prompted. If you were trying to open a rom, click "Close and reload ROM" to do that. Keep in mind some firmware is optional and some have multiple versions, only one of which needs to be set. +Windows users can keep the `Firmware` folder made by the firmware manager when updating, go to `Config` > `Paths...` and change "Firmware" under "Global" to point at it. + #### Identifying a good rom With a core and game loaded, look in the very left of the status bar (`View` > `Display Status Bar`): From 08c050648322d8371ad198808263c29d585c5b50 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 16 Jan 2019 03:48:09 +1000 Subject: [PATCH 129/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ddd1457b35..d89236f51c 100644 --- a/README.md +++ b/README.md @@ -117,7 +117,7 @@ A "backport" release, [1.13.2](https://github.com/TASVideos/BizHawk/releases/tag You'll need to either build BizHawk yourself (see [*Building*](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux-1) below), or download a dev build (see [*Testing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) below). -The runtime dependencies are Mono (complete) + Mono VB.NET, WINE (just `libwine` if available), `libdl.so` (glibc), NVIDIA's `cgc` utility. LSB release info is optional for automatically setting the library location. +The runtime dependencies are Mono (complete) + Mono VB.NET, WINE (just `libwine` if available), `libdl.so` (glibc), NVIDIA's `cgc` utility, and `libblip_buf.so` from the repo's `Assets` folder (copy it to `/usr/lib/libblip_buf.so.1.1.0` or equivalent). LSB release info is optional for automatically setting the library location. 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). From 054048a907d018d277b26d17eda401c7927fb296 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 18 Jan 2019 20:21:13 +1000 Subject: [PATCH 130/153] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d89236f51c..6909b3cdd5 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,9 @@ A "backport" release, [1.13.2](https://github.com/TASVideos/BizHawk/releases/tag ### GNU+Linux -**IMPORTANT**: The Mono "port" is a work-in-progress! It is *not* complete, does *not* look very nice, and is *not* ready for anything that needs accuracy. +*...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*](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux-1) below), or download a dev build (see [*Testing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) below). From 95f45da9dae0160c5f72ffa46834801593c07e19 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 18 Jan 2019 20:24:07 +1000 Subject: [PATCH 131/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6909b3cdd5..be06247a8b 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ The runtime dependencies are Mono (complete) + Mono VB.NET, WINE (just `libwine` 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). -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), Sega Master System, Atari 7800, Commodore 64, ColecoVision, IntelliVision, TurboGrafx, and ZX Spectrum. See [#1430](https://github.com/TASVideos/BizHawk/issues/1430) for progress. +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: GB + GBC (GBHawk), NES (NesHawk), SMS, Atari 7800, and some classic home computers. See [#1430](https://github.com/TASVideos/BizHawk/issues/1430) for progress. [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) From c15916d76a6f3450f8958415f044f2aaec37794f Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 18 Jan 2019 20:27:10 +1000 Subject: [PATCH 132/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index be06247a8b..0c5cf4acea 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ The runtime dependencies are Mono (complete) + Mono VB.NET, WINE (just `libwine` 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). -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: GB + GBC (GBHawk), NES (NesHawk), SMS, Atari 7800, and some classic home computers. See [#1430](https://github.com/TASVideos/BizHawk/issues/1430) for progress. +The systems that currently work are: GB + GBC (GBHawk), NES (NesHawk), SMS, Atari 7800, and some classic home computers. See [#1430](https://github.com/TASVideos/BizHawk/issues/1430) for progress. [to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) From f2938d4895ff1af819a4252c81740b0a35c231e0 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 23 Jan 2019 02:58:24 +1000 Subject: [PATCH 133/153] Update README.md --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0c5cf4acea..83d47375b1 100644 --- a/README.md +++ b/README.md @@ -171,11 +171,9 @@ Again, if your distro isn't listed there, you might get an "Unknown distro" warn #### Loading firmware -You may have seen a dialog saying "You are missing the needed firmware files [...]" when trying to open a rom. Pressing "Yes" opens the Firmware Manager, or you can go to `Config` > `Firmwares...`. +The easiest way to get BizHawk to use your firmwares is to go to `Config` > `Paths...`, and change "Firmware" in the "Global" tab to be the location of them (choose the folder where they're saved). -To load firmwares, the easiest way is to click "Import" in the menubar, navigate to the dumped firmware(s), select them all, and click "Open". It's a good idea to have them copied into the `Firmware` folder, which is nicely organised, when prompted. If you were trying to open a rom, click "Close and reload ROM" to do that. Keep in mind some firmware is optional and some have multiple versions, only one of which needs to be set. - -Windows users can keep the `Firmware` folder made by the firmware manager when updating, go to `Config` > `Paths...` and change "Firmware" under "Global" to point at it. +If your firmware is scattered, you can load them individually with the Firmware Manager. Open it by choosing "Yes" in the "You are missing the needed firmware files [...]" dialog (when trying to open a rom), or by going to `Config` > `Firmwares...`. Right-click the line of the firmware you want to load, click "", and open the file to load it. Keep in mind some firmware is optional, and some have multiple versions, only one of which needs to be set. #### Identifying a good rom From 9b145c27afd14a954ae24958f2b8e5cc23b32127 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 23 Jan 2019 16:54:07 +1000 Subject: [PATCH 134/153] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 83d47375b1..0081bf1f96 100644 --- a/README.md +++ b/README.md @@ -171,9 +171,11 @@ Again, if your distro isn't listed there, you might get an "Unknown distro" warn #### Loading firmware -The easiest way to get BizHawk to use your firmwares is to go to `Config` > `Paths...`, and change "Firmware" in the "Global" tab to be the location of them (choose the folder where they're saved). +The easiest way to get BizHawk to use your firmwares is to go to `Config` > `Paths...`, and change "Firmware" in the "Global" tab to be their location (choose the *folder* where they're saved). -If your firmware is scattered, you can load them individually with the Firmware Manager. Open it by choosing "Yes" in the "You are missing the needed firmware files [...]" dialog (when trying to open a rom), or by going to `Config` > `Firmwares...`. Right-click the line of the firmware you want to load, click "", and open the file to load it. Keep in mind some firmware is optional, and some have multiple versions, only one of which needs to be set. +If your firmware is scattered, you can load them individually with the Firmware Manager. Open it by choosing "Yes" in the "You are missing the needed firmware files [...]" dialog (when trying to open a rom), or by going to `Config` > `Firmwares...`. Right-click the line of the firmware you want to load, click "Set Customization", and choose the file in the dialog to load it. + +Keep in mind some firmware is optional, and some have multiple versions, only one of which needs to be set. #### Identifying a good rom From 21401636f124e55ac12b98500c6c08a12801a3c7 Mon Sep 17 00:00:00 2001 From: feos Date: Wed, 23 Jan 2019 13:23:25 +0300 Subject: [PATCH 135/153] Update README.md Come one, was it so hard? --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0081bf1f96..52ccf8ad61 100644 --- a/README.md +++ b/README.md @@ -171,11 +171,13 @@ Again, if your distro isn't listed there, you might get an "Unknown distro" warn #### Loading firmware -The easiest way to get BizHawk to use your firmwares is to go to `Config` > `Paths...`, and change "Firmware" in the "Global" tab to be their location (choose the *folder* where they're saved). +Put all your firmware to BizHawk's `Firmware` folder. All the needed firmware images will be automatically detected and loaded when you launch EmuHawk. File names and directory tree don't matter, because it's scanning the hashsums and picks the needed files according to its firmware database. -If your firmware is scattered, you can load them individually with the Firmware Manager. Open it by choosing "Yes" in the "You are missing the needed firmware files [...]" dialog (when trying to open a rom), or by going to `Config` > `Firmwares...`. Right-click the line of the firmware you want to load, click "Set Customization", and choose the file in the dialog to load it. +If you want to customize firmware (for example, when you need to select a specific firmware version) go to `Config` > `Firmwares...`, right-click the line of the firmware you want to change, click "Set Customization", and choose the file in the dialog to load it. Keep in mind some firmware is optional, and some have multiple versions, only one of which needs to be set. -Keep in mind some firmware is optional, and some have multiple versions, only one of which needs to be set. +You can change the folder to scan for firmware (for example, if you want several BizHawk releases to share the same firmware folder) by going to `Config` > `Paths...` and changing "Firmware" in the "Global" tab to the new location. + +If the firmware needed for a system can't be found, you will see the "You are missing the needed firmware files [...]" dialog when trying to open a game. #### Identifying a good rom From 248ed700a216a91945a29df781e6562f4e943080 Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 23 Jan 2019 20:38:05 +1000 Subject: [PATCH 136/153] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 52ccf8ad61..36c99889e9 100644 --- a/README.md +++ b/README.md @@ -171,13 +171,13 @@ Again, if your distro isn't listed there, you might get an "Unknown distro" warn #### Loading firmware -Put all your firmware to BizHawk's `Firmware` folder. All the needed firmware images will be automatically detected and loaded when you launch EmuHawk. File names and directory tree don't matter, because it's scanning the hashsums and picks the needed files according to its firmware database. +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. -If you want to customize firmware (for example, when you need to select a specific firmware version) go to `Config` > `Firmwares...`, right-click the line of the firmware you want to change, click "Set Customization", and choose the file in the dialog to load it. Keep in mind some firmware is optional, and some have multiple versions, only one of which needs to be set. +Keep in mind some firmware is optional, and some have multiple versions, only one of which needs to be set. -You can change the folder to scan for firmware (for example, if you want several BizHawk releases to share the same firmware folder) by going to `Config` > `Paths...` and changing "Firmware" in the "Global" tab to the new location. +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. -If the firmware needed for a system can't be found, you will see the "You are missing the needed firmware files [...]" dialog when trying to open a game. +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 versions to use the same folder. #### Identifying a good rom From a7518d4e32cf9be7e68537957b689bd07a95b4df Mon Sep 17 00:00:00 2001 From: James Groom Date: Wed, 23 Jan 2019 20:43:32 +1000 Subject: [PATCH 137/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 36c99889e9..2f71078672 100644 --- a/README.md +++ b/README.md @@ -177,7 +177,7 @@ Keep in mind some firmware is optional, and some have multiple versions, only on 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 versions to use the same folder. +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 From 1d6bd43532f5680c0b2f9382536eef6a38e96987 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 25 Jan 2019 21:57:04 +1000 Subject: [PATCH 138/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2f71078672..11d64e2e7c 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ 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](https://img.shields.io/badge/unique_systems_emulated-27-darkgreen.svg?logo=buffer&logoColor=333333&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) +[![unique systems emulated | 27](https://img.shields.io/badge/unique_systems_emulated-27-darkgreen.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAFqklEQVR4nO2aa6hVRRTH973XMkvEnmRc6VansvY9+8z6/Svs+UGCMqEHiKRWFPShd0bZA3tQGZplhRVRgb2MIkgyikIp0IroEtGDCOlhaGkvS8tKTa99uPvU8Tj73H2e2wvnD/Npz16zfjOzZ6+ZNUHQVltttdXW0JSkIyTNAR51zp2VtT8tUy6XGwXcK+lvSTtKys1Z+9ZsdQIXS1pbBr5D0g5gM5DL2smmyDl3MtDnAy/rhCVZ+9pQ9fb2jpX0PNA/GHyxmNnpWftdtyTtLek2YFNa8JLymaQ9smaoVR3AFGBVDeCls+DqrEGqliSAFfWAl5T148aN2z9rplSKouggSU9K2tYg+OKC+EjWbBWVy+WGS7pe0oYaITcAi4EXge89z/+RlM+a0ytJkyStrGN0l+Xz+X2L9sIw3BN4wlN3aRAEHRmi7izgGOCNOqf2r8650R7zwyR95FkQz245aLny+fy+wEOStjbg234xqR0zu9VT/8tcLje8lbyl6pJ0OfBTAxe4p5Mak3SD7x0zu6mFzAMCJgCf1DjK/cBzwJnAeEm3lCyW3wRB0OVrU9LrCTY3hmF4cEvA8/n84cDL1YSvng6YWW4XEPBH/PyBIAg6y+AvHcTmwqaCh2E4ErhH0l91TvE1QRAM87UhaUEJ0HvxlL8WWDJYhwPbzey4ZrB3mtlFwHeN+MaBN5IaMrOpg3w2K4D7JL3kGwjgvaCRv0UzOxF4vxHgJU72JbUHzEx4b6uZTS6tG0XRYZK+9tSdVjd4FEXdwLPA9kbCF0fSN1V7enr2kvRFwjv3JnTYeE/91VEU7VMTeHd39whgVnExalYBvov39R1BEATOuR5gWYX645N8TgiT76qWvcPMJkv6ppngnrI2HvWKG6UaOuBPMzs0FbmZFSS93WJwX/kKmO6c63HOHV8W+3tHFFCFTltUETzepj6mgV1V1vBrwjDczwN4R3FEgQmlzyQdAHxcoQM2JbEPA64DftsNwIvOzvA5GobhnpLWx3W2x/HAbODxwfwHfvRN94lKWGkz7oAzk0YrDohqsTmrdLqMU3IcnXkBLk7g75L0Q5X2Nki6NgiCjkDSHsA8YHPWkIN0QJ9vS2tm51dhZxvwRBRFB5WO/P01OvW7pAXAIjX4LK9CWeqcOzIIBo7TzOyytPEIsFwSvu/n1ypHoh9YaGaHlNh4sIUzoR/4A9iSsv4qYEqQFP9Xs9IDPznnTiq3EScrf4zrbJY0HzgPeK5VHePxdZOk27u7u0ckrB3/dcCjVRiem2RHA3vx14tTNNYwDWRpWgneDyzq7e0dWxG8KDM7MO1nACyuYMo7xYAzWgjf55w7ORV4mZMzUjaw3fcJDCY1//e6Nv5Ndg7mi1dxNJU2+Pmg2obM7OwmjfhmSXNzudyomsDLnJyYstG3JB1QjW1gdoPB+yW90vDLEJJeq9Dot5LODao4TooPTRbVczjqKZ82Lf8fRdHRCRHhutI0VBoBVzb40OQX4Kog4bC0YZI03zP6y2uwM61B4FuBh31b4abIOTdau24utpnZsVWa6pD0bp3wS6Mo6m0KaCXJk2AA3kyonvhHAE6tEXylc+6cJuGlUpc8WVZJk4oVcrnccOA6Se8ECZ2ggROZahbAjcCNWSYy/5OZneZxfg1wAXCJds7tX1H+fhiGIyU9kwY8PslZKGlMFqyJ0kB2Jc3I/az/Y4NOM7tQCZcZPeXdZqWr6pZzrkcp83zA55LmSPogJfhqM5sa7E63N3ySdHedK3l5+dPM7qw5M9Nqxd/ymnrB423qC6mTEbuTgOl1wn8o6ZSsOepRZ41Hz+skXRok3OYYUioUCiekzQQDW4B5CTe5hq6Ap1LAv1ooFI7K2temSNIYSRuTfoPAGVn72HTFUWBpHmC9pGs0hK+nV61CoWBmditw1ZC5kd1WW2211dau+hdChUiZwhqSBAAAAABJRU5ErkJggg==&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) [![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) [![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) From 41f464b80cc58e515928187f20800072d3a40a9b Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 25 Jan 2019 22:09:31 +1000 Subject: [PATCH 139/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 11d64e2e7c..e8979316e3 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ A multi-system emulator written in C#. As well as quality-of-life features for c Click the "release" button above to grab the latest stable version ([changelog at TASVideos](http://tasvideos.org/Bizhawk/ReleaseHistory.html)). -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. +New user on Windows? Install the prerequisites first, click the "prereqs" button to get that and see [*Installing*](#windows-78110) for info. **Never mix different versions** of BizHawk — Keep each version in its own folder. From 73366ef5afbe88cd44e9c25c36aa56ddb6a34869 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 25 Jan 2019 22:17:21 +1000 Subject: [PATCH 140/153] Update README.md --- README.md | 60 +++++++++++++++++++++++++++---------------------------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index e8979316e3..0210d637d9 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ 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](https://img.shields.io/badge/unique_systems_emulated-27-darkgreen.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAFqklEQVR4nO2aa6hVRRTH973XMkvEnmRc6VansvY9+8z6/Svs+UGCMqEHiKRWFPShd0bZA3tQGZplhRVRgb2MIkgyikIp0IroEtGDCOlhaGkvS8tKTa99uPvU8Tj73H2e2wvnD/Npz16zfjOzZ6+ZNUHQVltttdXW0JSkIyTNAR51zp2VtT8tUy6XGwXcK+lvSTtKys1Z+9ZsdQIXS1pbBr5D0g5gM5DL2smmyDl3MtDnAy/rhCVZ+9pQ9fb2jpX0PNA/GHyxmNnpWftdtyTtLek2YFNa8JLymaQ9smaoVR3AFGBVDeCls+DqrEGqliSAFfWAl5T148aN2z9rplSKouggSU9K2tYg+OKC+EjWbBWVy+WGS7pe0oYaITcAi4EXge89z/+RlM+a0ytJkyStrGN0l+Xz+X2L9sIw3BN4wlN3aRAEHRmi7izgGOCNOqf2r8650R7zwyR95FkQz245aLny+fy+wEOStjbg234xqR0zu9VT/8tcLje8lbyl6pJ0OfBTAxe4p5Mak3SD7x0zu6mFzAMCJgCf1DjK/cBzwJnAeEm3lCyW3wRB0OVrU9LrCTY3hmF4cEvA8/n84cDL1YSvng6YWW4XEPBH/PyBIAg6y+AvHcTmwqaCh2E4ErhH0l91TvE1QRAM87UhaUEJ0HvxlL8WWDJYhwPbzey4ZrB3mtlFwHeN+MaBN5IaMrOpg3w2K4D7JL3kGwjgvaCRv0UzOxF4vxHgJU72JbUHzEx4b6uZTS6tG0XRYZK+9tSdVjd4FEXdwLPA9kbCF0fSN1V7enr2kvRFwjv3JnTYeE/91VEU7VMTeHd39whgVnExalYBvov39R1BEATOuR5gWYX645N8TgiT76qWvcPMJkv6ppngnrI2HvWKG6UaOuBPMzs0FbmZFSS93WJwX/kKmO6c63HOHV8W+3tHFFCFTltUETzepj6mgV1V1vBrwjDczwN4R3FEgQmlzyQdAHxcoQM2JbEPA64DftsNwIvOzvA5GobhnpLWx3W2x/HAbODxwfwHfvRN94lKWGkz7oAzk0YrDohqsTmrdLqMU3IcnXkBLk7g75L0Q5X2Nki6NgiCjkDSHsA8YHPWkIN0QJ9vS2tm51dhZxvwRBRFB5WO/P01OvW7pAXAIjX4LK9CWeqcOzIIBo7TzOyytPEIsFwSvu/n1ypHoh9YaGaHlNh4sIUzoR/4A9iSsv4qYEqQFP9Xs9IDPznnTiq3EScrf4zrbJY0HzgPeK5VHePxdZOk27u7u0ckrB3/dcCjVRiem2RHA3vx14tTNNYwDWRpWgneDyzq7e0dWxG8KDM7MO1nACyuYMo7xYAzWgjf55w7ORV4mZMzUjaw3fcJDCY1//e6Nv5Ndg7mi1dxNJU2+Pmg2obM7OwmjfhmSXNzudyomsDLnJyYstG3JB1QjW1gdoPB+yW90vDLEJJeq9Dot5LODao4TooPTRbVczjqKZ82Lf8fRdHRCRHhutI0VBoBVzb40OQX4Kog4bC0YZI03zP6y2uwM61B4FuBh31b4abIOTdau24utpnZsVWa6pD0bp3wS6Mo6m0KaCXJk2AA3kyonvhHAE6tEXylc+6cJuGlUpc8WVZJk4oVcrnccOA6Se8ECZ2ggROZahbAjcCNWSYy/5OZneZxfg1wAXCJds7tX1H+fhiGIyU9kwY8PslZKGlMFqyJ0kB2Jc3I/az/Y4NOM7tQCZcZPeXdZqWr6pZzrkcp83zA55LmSPogJfhqM5sa7E63N3ySdHedK3l5+dPM7qw5M9Nqxd/ymnrB423qC6mTEbuTgOl1wn8o6ZSsOepRZ41Hz+skXRok3OYYUioUCiekzQQDW4B5CTe5hq6Ap1LAv1ooFI7K2temSNIYSRuTfoPAGVn72HTFUWBpHmC9pGs0hK+nV61CoWBmditw1ZC5kd1WW2211dau+hdChUiZwhqSBAAAAABJRU5ErkJggg==&style=popout)](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) +[![unique systems emulated | 27](https://img.shields.io/badge/unique_systems_emulated-27-darkgreen.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAFqklEQVR4nO2aa6hVRRTH973XMkvEnmRc6VansvY9+8z6/Svs+UGCMqEHiKRWFPShd0bZA3tQGZplhRVRgb2MIkgyikIp0IroEtGDCOlhaGkvS8tKTa99uPvU8Tj73H2e2wvnD/Npz16zfjOzZ6+ZNUHQVltttdXW0JSkIyTNAR51zp2VtT8tUy6XGwXcK+lvSTtKys1Z+9ZsdQIXS1pbBr5D0g5gM5DL2smmyDl3MtDnAy/rhCVZ+9pQ9fb2jpX0PNA/GHyxmNnpWftdtyTtLek2YFNa8JLymaQ9smaoVR3AFGBVDeCls+DqrEGqliSAFfWAl5T148aN2z9rplSKouggSU9K2tYg+OKC+EjWbBWVy+WGS7pe0oYaITcAi4EXge89z/+RlM+a0ytJkyStrGN0l+Xz+X2L9sIw3BN4wlN3aRAEHRmi7izgGOCNOqf2r8650R7zwyR95FkQz245aLny+fy+wEOStjbg234xqR0zu9VT/8tcLje8lbyl6pJ0OfBTAxe4p5Mak3SD7x0zu6mFzAMCJgCf1DjK/cBzwJnAeEm3lCyW3wRB0OVrU9LrCTY3hmF4cEvA8/n84cDL1YSvng6YWW4XEPBH/PyBIAg6y+AvHcTmwqaCh2E4ErhH0l91TvE1QRAM87UhaUEJ0HvxlL8WWDJYhwPbzey4ZrB3mtlFwHeN+MaBN5IaMrOpg3w2K4D7JL3kGwjgvaCRv0UzOxF4vxHgJU72JbUHzEx4b6uZTS6tG0XRYZK+9tSdVjd4FEXdwLPA9kbCF0fSN1V7enr2kvRFwjv3JnTYeE/91VEU7VMTeHd39whgVnExalYBvov39R1BEATOuR5gWYX645N8TgiT76qWvcPMJkv6ppngnrI2HvWKG6UaOuBPMzs0FbmZFSS93WJwX/kKmO6c63HOHV8W+3tHFFCFTltUETzepj6mgV1V1vBrwjDczwN4R3FEgQmlzyQdAHxcoQM2JbEPA64DftsNwIvOzvA5GobhnpLWx3W2x/HAbODxwfwHfvRN94lKWGkz7oAzk0YrDohqsTmrdLqMU3IcnXkBLk7g75L0Q5X2Nki6NgiCjkDSHsA8YHPWkIN0QJ9vS2tm51dhZxvwRBRFB5WO/P01OvW7pAXAIjX4LK9CWeqcOzIIBo7TzOyytPEIsFwSvu/n1ypHoh9YaGaHlNh4sIUzoR/4A9iSsv4qYEqQFP9Xs9IDPznnTiq3EScrf4zrbJY0HzgPeK5VHePxdZOk27u7u0ckrB3/dcCjVRiem2RHA3vx14tTNNYwDWRpWgneDyzq7e0dWxG8KDM7MO1nACyuYMo7xYAzWgjf55w7ORV4mZMzUjaw3fcJDCY1//e6Nv5Ndg7mi1dxNJU2+Pmg2obM7OwmjfhmSXNzudyomsDLnJyYstG3JB1QjW1gdoPB+yW90vDLEJJeq9Dot5LODao4TooPTRbVczjqKZ82Lf8fRdHRCRHhutI0VBoBVzb40OQX4Kog4bC0YZI03zP6y2uwM61B4FuBh31b4abIOTdau24utpnZsVWa6pD0bp3wS6Mo6m0KaCXJk2AA3kyonvhHAE6tEXylc+6cJuGlUpc8WVZJk4oVcrnccOA6Se8ECZ2ggROZahbAjcCNWSYy/5OZneZxfg1wAXCJds7tX1H+fhiGIyU9kwY8PslZKGlMFqyJ0kB2Jc3I/az/Y4NOM7tQCZcZPeXdZqWr6pZzrkcp83zA55LmSPogJfhqM5sa7E63N3ySdHedK3l5+dPM7qw5M9Nqxd/ymnrB423qC6mTEbuTgOl1wn8o6ZSsOepRZ41Hz+skXRok3OYYUioUCiekzQQDW4B5CTe5hq6Ap1LAv1ooFI7K2temSNIYSRuTfoPAGVn72HTFUWBpHmC9pGs0hK+nV61CoWBmditw1ZC5kd1WW2211dau+hdChUiZwhqSBAAAAABJRU5ErkJggg==&style=popout)](#cores) [![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) [![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) @@ -17,19 +17,19 @@ New user on Windows? Install the prerequisites first, click the "prereqs" button Jump to: * Installing - * [Windows 7/8.1/10](https://github.com/TASVideos/BizHawk/blob/master/README.md#windows-78110) - * [GNU+Linux](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux) + * [Windows 7/8.1/10](#windows-78110) + * [GNU+Linux](#gnulinux) * Building - * [Windows 7/8.1/10](https://github.com/TASVideos/BizHawk/blob/master/README.md#windows-78110-1) - * [GNU+Linux](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux-1) -* [Usage](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage) - * [TASing](https://github.com/TASVideos/BizHawk/blob/master/README.md#tasing) - * [Testing](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) - * [Cores](https://github.com/TASVideos/BizHawk/blob/master/README.md#cores) -* [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) -* [Related projects](https://github.com/TASVideos/BizHawk/blob/master/README.md#related-projects) -* [License](https://github.com/TASVideos/BizHawk/blob/master/README.md#license) + * [Windows 7/8.1/10](#windows-78110-1) + * [GNU+Linux](#gnulinux-1) +* [Usage](#usage) + * [TASing](#tasing) + * [Testing](#testing) + * [Cores](#cores) +* [Support and troubleshooting](#support-and-troubleshooting) +* [Contributing](#contributing) +* [Related projects](#related-projects) +* [License](#license) ## Features and systems @@ -81,9 +81,9 @@ Supported consoles and computers: * Uzebox * [More](http://tasvideos.org/Bizhawk/CoreRoadMap.html) coming soon..? -See [*Usage*](https://github.com/TASVideos/BizHawk/blob/master/README.md#usage) below for details about specific tools and config menus. +See [*Usage*](#usage) below for details about specific tools and config menus. -[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) +[to top](#bizhawk) ## Installing @@ -109,7 +109,7 @@ Following [Microsoft's support lifecycle](https://support.microsoft.com/en-us/he 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. -[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) +[to top](#bizhawk) ### GNU+Linux @@ -117,7 +117,7 @@ A "backport" release, [1.13.2](https://github.com/TASVideos/BizHawk/releases/tag **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*](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux-1) below), or download a dev build (see [*Testing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) below). +You'll need to either build BizHawk yourself (see [*Building*](#gnulinux-1) below), or download a dev build (see [*Testing*](#testing) below). The runtime dependencies are Mono (complete) + Mono VB.NET, WINE (just `libwine` if available), `libdl.so` (glibc), NVIDIA's `cgc` utility, and `libblip_buf.so` from the repo's `Assets` folder (copy it to `/usr/lib/libblip_buf.so.1.1.0` or equivalent). LSB release info is optional for automatically setting the library location. @@ -125,7 +125,7 @@ Run `EmuHawkMono.sh` to give Mono the library and executable paths — you can r The systems that currently work are: GB + GBC (GBHawk), NES (NesHawk), SMS, Atari 7800, and some classic home computers. See [#1430](https://github.com/TASVideos/BizHawk/issues/1430) for progress. -[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) +[to top](#bizhawk) ## Building @@ -142,7 +142,7 @@ Once it's downloaded and extracted, go into the repo's `Dist` folder and run `Bu For anything more complicated than building, you'll need an IDE like [VS Community 2017](https://visualstudio.microsoft.com/vs/community), currently the best free C# IDE. Open `BizHawk.sln` with VS to start and use the toolbar to choose EmuHawk and build. See [Compiling at TASVideos](http://tasvideos.org/Bizhawk/Compiling.html) (somewhat outdated) for more detailed instructions. -[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) +[to top](#bizhawk) ### GNU+Linux @@ -161,11 +161,11 @@ 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](https://gitlab.com/TASVideos/libblip_buf/blob/unified/README.md). -Once built, see [*Installing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#gnulinux) above, substituting the repo's `output` folder for the download. +Once built, see [*Installing*](#gnulinux) above, 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). -[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) +[to top](#bizhawk) ## Usage @@ -208,7 +208,7 @@ Running scripts have a "▶️" beside their name, and stopped scripts (manually "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. -[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) +[to top](#bizhawk) ### TASing @@ -216,17 +216,17 @@ Running scripts have a "▶️" beside their name, and stopped scripts (manually For now, the best way to learn how to TAS is to browse pages like [BasicTools](http://tasvideos.org/TasingGuide/BasicTools.html) on TASVideos and watch tutorials like [Sand_Knight and dwangoAC's](https://youtu.be/6tJniMaR2Ps). -[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) +[to top](#bizhawk) ### Testing -Testing bugfixes or new features can be just as helpful as making them! If code's more your thing, see [*Contributing*](https://github.com/TASVideos/BizHawk/blob/master/README.md#contributing) below. +Testing bugfixes or new features can be just as helpful as making them! If code's more your thing, see [*Contributing*](#contributing) below. Dev builds are automated with AppVeyor, every green checkmark in the [commit history](https://github.com/TASVideos/BizHawk/commits/master) 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](https://ci.appveyor.com/project/zeromus/bizhawk-udexo/history), 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--#.zip`. -[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) +[to top](#bizhawk) ### Cores @@ -264,7 +264,7 @@ ZX Spectrum | ZXHawk | 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). -[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) +[to top](#bizhawk) ## Support and troubleshooting @@ -276,19 +276,19 @@ A short [FAQ](http://tasvideos.org/Bizhawk/FAQ.html) is provided on the [BizHawk 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). -[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) +[to top](#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 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*](https://github.com/TASVideos/BizHawk/blob/master/README.md#testing) above to learn about dev builds if you'd rather help us get the next release out. +Not a programmer? Something as simple as reproducing bugs with different software versions is still very helpful! See [*Testing*](#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: [![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) -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). +It's a good idea to check if anyone is already working on an issue by asking on IRC (see [*Support*](#support-and-troubleshooting) 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. @@ -296,7 +296,7 @@ For the time being, style is not enforced in PRs, only build success is. Please Past contrbutors to the frontend and custom-built cores are listed [here](https://github.com/TASVideos/BizHawk/graphs/contributors). See the wiki for core authors. -[to top](https://github.com/TASVideos/BizHawk/blob/master/README.md#bizhawk) +[to top](#bizhawk) ## Related projects From 4f3dc6dafcfd89dfe2508f800ea127fe4e59d42d Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 25 Jan 2019 22:25:48 +1000 Subject: [PATCH 141/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0210d637d9..aa2c0cb4a9 100644 --- a/README.md +++ b/README.md @@ -302,7 +302,7 @@ Past contrbutors to the frontend and custom-built cores are listed [here](https: * [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 +* [FCEUX](http://www.fceux.com/web/home.html) for NES/Famicom — TASing is Windows-only, but it should run cross-platform * [libTAS](https://github.com/clementgallet/libTAS) for Linux ELF — GNU+Linux-only, also emulates other emulators * [lsnes](http://tasvideos.org/Lsnes.html) for GB and SNES — cross-platform * [openMSX](https://openmsx.org) for MSX — cross-platform From 50e5978144594267385f0f211eb97e4590ce0a60 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 25 Jan 2019 22:27:11 +1000 Subject: [PATCH 142/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index aa2c0cb4a9..a76982b3cc 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ Supported consoles and computers: * Uzebox * [More](http://tasvideos.org/Bizhawk/CoreRoadMap.html) coming soon..? -See [*Usage*](#usage) below for details about specific tools and config menus. +See [*Usage*](#usage) below for an introduction to basic config menus. [to top](#bizhawk) From ca42daa157654ea2d000d177c99d8d264c3af052 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 25 Jan 2019 22:31:36 +1000 Subject: [PATCH 143/153] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a76982b3cc..d614ee5ec4 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ Supported consoles and computers: * Uzebox * [More](http://tasvideos.org/Bizhawk/CoreRoadMap.html) coming soon..? -See [*Usage*](#usage) below for an introduction to basic config menus. +See [*Usage*](#usage) below for info on basic config needed to play games. [to top](#bizhawk) @@ -107,7 +107,7 @@ BizHawk functions like a "portable" program, you may move or rename the folder c Following [Microsoft's support lifecycle](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet), Win10 is supported from 1709 "Redstone 3", Win8 is supported from 8.1, and Win7 is supported from SP1 (ends Jan 2020, upgrade to Win10 or try [ReactOS](https://reactos.org/joining/faqs)). -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. +A "backport" release, [1.13.2](https://github.com/TASVideos/BizHawk/releases/tag/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](#bizhawk) From 363166fa909aa093251c5196e4f305b6f06755b5 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 25 Jan 2019 22:32:50 +1000 Subject: [PATCH 144/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d614ee5ec4..ce68dc1a22 100644 --- a/README.md +++ b/README.md @@ -262,7 +262,7 @@ Virtual Boy | Virtual Boyee | WonderSwan / Color | Cygne | ZX Spectrum | ZXHawk | -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). +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](#bizhawk) From 530790b5152c0061322d6c92b4b37c1733f83d22 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 25 Jan 2019 22:35:41 +1000 Subject: [PATCH 145/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ce68dc1a22..31ca56affb 100644 --- a/README.md +++ b/README.md @@ -270,7 +270,7 @@ Amstrad CPC, Magnavox Odyssey², and Sony PSP emulation are works-in-progress an 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: -[![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) +![IRC | chat.freenode.net #bizhawk](https://img.shields.io/badge/IRC-chat.freenode.net_%23bizhawk-steelblue.svg?style=flat) [![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) From 68575853846950ff5db32bb8c1e743c4c7fb4932 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 25 Jan 2019 22:38:42 +1000 Subject: [PATCH 146/153] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 31ca56affb..4be281cc24 100644 --- a/README.md +++ b/README.md @@ -268,9 +268,8 @@ Amstrad CPC, Magnavox Odyssey², and Sony PSP emulation are works-in-progress an ## 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+ISSUE_KEYWORDS), check the [BizHawk forum](http://tasvideos.org/forum/viewforum.php?f=64) at TASVideos, or ask on IRC: +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. Paste `ircs://chat.freenode.net:6697/bizhawk` into your address bar, connect to freenode manually with your IRC client and join `#bizhawk`, or try these: -![IRC | chat.freenode.net #bizhawk](https://img.shields.io/badge/IRC-chat.freenode.net_%23bizhawk-steelblue.svg?style=flat) [![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) From 659c80a7409d78cadb5664e8deb69a6e6c15e1e3 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 25 Jan 2019 22:39:40 +1000 Subject: [PATCH 147/153] Update README.md --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4be281cc24..afb8ef56b0 100644 --- a/README.md +++ b/README.md @@ -268,10 +268,11 @@ Amstrad CPC, Magnavox Odyssey², and Sony PSP emulation are works-in-progress an ## 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+ISSUE_KEYWORDS), check the [BizHawk forum](http://tasvideos.org/forum/viewforum.php?f=64) at TASVideos, or ask on IRC. Paste `ircs://chat.freenode.net:6697/bizhawk` into your address bar, connect to freenode manually with your IRC client and join `#bizhawk`, or try these: - -[![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) +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: +* `ircs://chat.freenode.net:6697/bizhawk` +* connect to freenode manually with your IRC client and join `#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) 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). From 24e3e46620aada30cd9edf731c2feb7dc5f93cfa Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 25 Jan 2019 22:42:13 +1000 Subject: [PATCH 148/153] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index afb8ef56b0..32a6781a18 100644 --- a/README.md +++ b/README.md @@ -271,8 +271,8 @@ Amstrad CPC, Magnavox Odyssey², and Sony PSP emulation are works-in-progress an 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: * `ircs://chat.freenode.net:6697/bizhawk` * connect to freenode manually with your IRC client and join `#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) +* connect with a Matrix client (via matrix.org's IRC bridge): [#freenode_#bizhawk:matrix.org](https://matrix.to/#/#freenode_#bizhawk:matrix.org) +* use freenode's [*webchat*](http://webchat.freenode.net/?channels=bizhawk), an IRC client in a webpage 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). From 7266cef5aab2d00b0b39555af6836d20ddc9ac9d Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 25 Jan 2019 22:44:02 +1000 Subject: [PATCH 149/153] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 32a6781a18..56f0652ccb 100644 --- a/README.md +++ b/README.md @@ -269,9 +269,8 @@ Amstrad CPC, Magnavox Odyssey², and Sony PSP emulation are works-in-progress an ## 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+ISSUE_KEYWORDS), check the [BizHawk forum](http://tasvideos.org/forum/viewforum.php?f=64) at TASVideos, or ask on IRC: -* `ircs://chat.freenode.net:6697/bizhawk` -* connect to freenode manually with your IRC client and join `#bizhawk` -* connect with a Matrix client (via matrix.org's IRC bridge): [#freenode_#bizhawk:matrix.org](https://matrix.to/#/#freenode_#bizhawk:matrix.org) +* with an IRC client, join channel `#bizhawk` on `chat.freenode.net:6697` +* connect to [#freenode_#bizhawk:matrix.org](https://matrix.to/#/#freenode_#bizhawk:matrix.org) with a Matrix client (via matrix.org's IRC bridge) * use freenode's [*webchat*](http://webchat.freenode.net/?channels=bizhawk), an IRC client in a webpage 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). From 81920d0dee90bcba059ab16acdc75d5c6a8afec6 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 25 Jan 2019 22:48:19 +1000 Subject: [PATCH 150/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 56f0652ccb..12121e3b0b 100644 --- a/README.md +++ b/README.md @@ -271,7 +271,7 @@ Amstrad CPC, Magnavox Odyssey², and Sony PSP emulation are works-in-progress an 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: * with an IRC client, join channel `#bizhawk` on `chat.freenode.net:6697` * connect to [#freenode_#bizhawk:matrix.org](https://matrix.to/#/#freenode_#bizhawk:matrix.org) with a Matrix client (via matrix.org's IRC bridge) -* use freenode's [*webchat*](http://webchat.freenode.net/?channels=bizhawk), an IRC client in a webpage +* use freenode's [web-based IRC client](http://webchat.freenode.net/?channels=bizhawk) 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). From 462a0c59897dedada120789c27d305be9408bcb1 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 25 Jan 2019 22:50:10 +1000 Subject: [PATCH 151/153] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 12121e3b0b..559f72e71a 100644 --- a/README.md +++ b/README.md @@ -268,7 +268,9 @@ Amstrad CPC, Magnavox Odyssey², and Sony PSP emulation are works-in-progress an ## 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+ISSUE_KEYWORDS), check the [BizHawk forum](http://tasvideos.org/forum/viewforum.php?f=64) at TASVideos, or ask on IRC: +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: * with an IRC client, join channel `#bizhawk` on `chat.freenode.net:6697` * connect to [#freenode_#bizhawk:matrix.org](https://matrix.to/#/#freenode_#bizhawk:matrix.org) with a Matrix client (via matrix.org's IRC bridge) * use freenode's [web-based IRC client](http://webchat.freenode.net/?channels=bizhawk) From 9791df8801ca642e8807a355a0f9f6b82c6b9143 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 25 Jan 2019 22:51:32 +1000 Subject: [PATCH 152/153] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 559f72e71a..8f6bfa0786 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ A multi-system emulator written in C#. As well as quality-of-life features for c [![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) [![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) +[![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) *** @@ -285,9 +286,7 @@ BizHawk is Open Source Software, so you're free to modify it however you please, Not a programmer? Something as simple as reproducing bugs with different software versions is still very helpful! See [*Testing*](#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: - -[![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) +If you'd like to fix bugs, check the [issue tracker](https://github.com/TASVideos/BizHawk/issues) here on GitHub. It's a good idea to check if anyone is already working on an issue by asking on IRC (see [*Support*](#support-and-troubleshooting) above). From 777d4c6a81eb00d1069108daab3f04552a4dc7b7 Mon Sep 17 00:00:00 2001 From: James Groom Date: Fri, 25 Jan 2019 22:53:45 +1000 Subject: [PATCH 153/153] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f6bfa0786..cf537dcd71 100644 --- a/README.md +++ b/README.md @@ -273,7 +273,7 @@ A short [FAQ](http://tasvideos.org/Bizhawk/FAQ.html) is provided on the [BizHawk 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: * with an IRC client, join channel `#bizhawk` on `chat.freenode.net:6697` -* connect to [#freenode_#bizhawk:matrix.org](https://matrix.to/#/#freenode_#bizhawk:matrix.org) with a Matrix client (via matrix.org's IRC bridge) +* with a Matrix client, connect to [#freenode_#bizhawk:matrix.org](https://matrix.to/#/#freenode_#bizhawk:matrix.org) (via matrix.org's IRC bridge) * use freenode's [web-based IRC client](http://webchat.freenode.net/?channels=bizhawk) 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).