draft 1
This commit is contained in:
James Groom
GitHub
parent
4a6a6079b0
commit
5f642845e7
89
README.md
89
README.md
|
|
@ -1,23 +1,84 @@
|
|||
# BizHawk
|
||||
|
||||
|
||||
|
||||
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:
|
||||
|
||||
[](http://github.com/TASVideos/BizHawk/releases)
|
||||
|
||||
Click `BizHawk-<version>.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).
|
||||
|
||||
[-bizhawk-%231793D1.svg?logo=arch-linux&style=popout)](https://aur.archlinux.org/packages/bizhawk)
|
||||
[](https://example.com/bizhawk)
|
||||
[-bizhawk-%23A81D33.svg?logo=debian&style=popout)](https://example.com/bizhawk)
|
||||
[](https://example.com/bizhawk)
|
||||
[](https://example.com/bizhawk)
|
||||
[](https://example.com/bizhawk)
|
||||
[](https://example.com/bizhawk)
|
||||
[-bizhawk-%2387CF3E.svg?logo=linux-mint&style=popout)](https://example.com/bizhawk)
|
||||
[-bizhawk-%23999999.svg?logo=apple&style=popout)](https://example.com/bizhawk)
|
||||
[-bizhawk-%2335BF5C.svg?logo=manjaro&style=popout)](https://aur.archlinux.org/packages/bizhawk)
|
||||
[](https://example.com/bizhawk)
|
||||
[](https://example.com/bizhawk)
|
||||
[](https://example.com/bizhawk)
|
||||
[](https://example.com/bizhawk)
|
||||
[](https://example.com/bizhawk)
|
||||
[-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:
|
||||
|
||||
[](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
|
||||
|
|
|
|||
Loading…
Reference in New Issue