mirror of https://github.com/bsnes-emu/bsnes.git
General tidying and tightening of docs.
This commit is contained in:
parent
a4483339e5
commit
b308661fa3
docs
|
@ -12,11 +12,12 @@ for [common functions games require][bios],
|
||||||
often called a "BIOS"
|
often called a "BIOS"
|
||||||
by analogy with the Basic Input/Output System
|
by analogy with the Basic Input/Output System
|
||||||
used in IBM PC compatibles.
|
used in IBM PC compatibles.
|
||||||
|
Although the GBA BIOS is required
|
||||||
For the same legal reasons that commercial games
|
in order to emulate GBA games,
|
||||||
cannot be distributed with emulators,
|
it cannot be distributed with higan
|
||||||
the GBA BIOS cannot be distributed with higan,
|
for the same legal reasons that commercial games
|
||||||
but is required for GBA software to run.
|
cannot be distributed with higan,
|
||||||
|
so you'll need to obtain a copy of the BIOS for yourself.
|
||||||
|
|
||||||
If you have a real GBA and a flashcart,
|
If you have a real GBA and a flashcart,
|
||||||
the Internet contains many tools
|
the Internet contains many tools
|
||||||
|
@ -24,7 +25,7 @@ that will extract the BIOS image so it can be copied
|
||||||
to your desktop computer.
|
to your desktop computer.
|
||||||
The correct GBA BIOS file is exactly 16384 bytes long,
|
The correct GBA BIOS file is exactly 16384 bytes long,
|
||||||
and has the SHA-256 hash
|
and has the SHA-256 hash
|
||||||
fd2547724b505f487e6dcb29ec2ecff3af35a841a77ab2e85fd87350abd36570.
|
`fd2547724b505f487e6dcb29ec2ecff3af35a841a77ab2e85fd87350abd36570`.
|
||||||
|
|
||||||
Once you have the correct BIOS file:
|
Once you have the correct BIOS file:
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,8 @@ Compiling from source on Linux
|
||||||
|
|
||||||
You will need a copy of the higan source-code.
|
You will need a copy of the higan source-code.
|
||||||
If you download an official release from the higan homepage,
|
If you download an official release from the higan homepage,
|
||||||
you will need [7-zip][7z] or a compatible tool to extract it.
|
you will need [7-zip](http://www.7-zip.org)
|
||||||
|
or a compatible tool to extract it.
|
||||||
Alternatively,
|
Alternatively,
|
||||||
you may obtain higan source code from
|
you may obtain higan source code from
|
||||||
[the unofficial git repo](https://gitlab.com/higan/higan/)
|
[the unofficial git repo](https://gitlab.com/higan/higan/)
|
||||||
|
@ -29,7 +30,8 @@ for the following libraries:
|
||||||
- OpenAL
|
- OpenAL
|
||||||
- udev
|
- udev
|
||||||
|
|
||||||
On a Debian-derived Linux distribution,
|
On a Debian-derived Linux distribution
|
||||||
|
(including Ubuntu and Mint),
|
||||||
you can install everything you need with a command like:
|
you can install everything you need with a command like:
|
||||||
|
|
||||||
sudo apt-get install build-essential libgtk2.0-dev libpulse-dev \
|
sudo apt-get install build-essential libgtk2.0-dev libpulse-dev \
|
||||||
|
@ -121,7 +123,13 @@ as installed by the above instructions:
|
||||||
4. Type `make -C higan uninstall` and press Enter
|
4. Type `make -C higan uninstall` and press Enter
|
||||||
|
|
||||||
To remove higan's configuration,
|
To remove higan's configuration,
|
||||||
delete the directory `~/.config/higan` as well.
|
you should also delete the following directories
|
||||||
|
if they exist:
|
||||||
|
|
||||||
|
- `~/.config/higan/`
|
||||||
|
- `~/.config/hiro/`
|
||||||
|
- `~/.local/share/higan/`
|
||||||
|
- `~/.local/share/hiro/`
|
||||||
|
|
||||||
To remove the games imported into higan's library
|
To remove the games imported into higan's library
|
||||||
(including in-game saves and save-states),
|
(including in-game saves and save-states),
|
||||||
|
|
|
@ -1,13 +1,12 @@
|
||||||
Installing an official release on Windows
|
Installing an official release on Windows
|
||||||
-----------------------------------------
|
-----------------------------------------
|
||||||
|
|
||||||
Official higan releases are distributed in [7-zip][7z] archives.
|
Official higan releases are distributed in
|
||||||
You will need to install 7-zip,
|
[7-zip](http://www.7-zip.org/)
|
||||||
or another compatible archiving tool,
|
archives.
|
||||||
|
You will need to install 7-zip
|
||||||
|
(or another compatible archiving tool)
|
||||||
to install higan.
|
to install higan.
|
||||||
|
|
||||||
[7z]: http://www.7-zip.org/
|
|
||||||
|
|
||||||
Once you have a suitable archiving tool,
|
Once you have a suitable archiving tool,
|
||||||
extract the contents of the higan archive into a new folder.
|
extract the contents of the higan archive into a new folder.
|
||||||
|
|
||||||
|
@ -15,8 +14,7 @@ When you're done,
|
||||||
the new folder should contain `higan.exe` and `icarus.exe`
|
the new folder should contain `higan.exe` and `icarus.exe`
|
||||||
along with other assorted files and folders
|
along with other assorted files and folders
|
||||||
that describe the systems higan emulates.
|
that describe the systems higan emulates.
|
||||||
|
You may put that new folder wherever you like.
|
||||||
You may put that folder wherever you like.
|
|
||||||
|
|
||||||
To run higan, open the `higan.exe` file.
|
To run higan, open the `higan.exe` file.
|
||||||
|
|
||||||
|
@ -34,20 +32,17 @@ To remove higan's configuration:
|
||||||
3. Delete the subfolders named `icarus` and `higan`
|
3. Delete the subfolders named `icarus` and `higan`
|
||||||
if they exist.
|
if they exist.
|
||||||
|
|
||||||
You might also want to remove the games imported into higan's library
|
You might also want to remove
|
||||||
(including in-game saves and save-states):
|
[higan's game library](../concepts/game-library.md#where-is-the-game-library)
|
||||||
|
(including in-game saves and save-states).
|
||||||
1. Press Win+R to open the Run dialog
|
|
||||||
2. Type `%USERPROFILE%` and press Enter
|
|
||||||
to open the folder where higan keeps its game library
|
|
||||||
3. Delete the folder named `Emulation` if it exists
|
|
||||||
|
|
||||||
Compiling from source on Windows
|
Compiling from source on Windows
|
||||||
--------------------------------
|
--------------------------------
|
||||||
|
|
||||||
You will need a copy of the higan source-code.
|
You will need a copy of the higan source-code.
|
||||||
If you download an official release from the higan homepage,
|
If you download an official release from the higan homepage,
|
||||||
you will need [7-zip][7z] or a compatible tool to extract it.
|
you will need [7-zip](http://www.7-zip.org/)
|
||||||
|
or a compatible tool to extract it.
|
||||||
Alternatively,
|
Alternatively,
|
||||||
you may obtain higan source code from
|
you may obtain higan source code from
|
||||||
[the unofficial git repo](https://gitlab.com/higan/higan/)
|
[the unofficial git repo](https://gitlab.com/higan/higan/)
|
||||||
|
@ -77,25 +72,27 @@ See the higan forum
|
||||||
[for](https://board.byuu.org/viewtopic.php?p=41977#p41977)
|
[for](https://board.byuu.org/viewtopic.php?p=41977#p41977)
|
||||||
[details](https://board.byuu.org/viewtopic.php?p=42253#p42253).
|
[details](https://board.byuu.org/viewtopic.php?p=42253#p42253).
|
||||||
|
|
||||||
Once you've installed mingw-w64,
|
Once you've installed the compiler,
|
||||||
open a command-prompt window,
|
open a command-prompt window,
|
||||||
type `g++ --version`
|
type `g++ --version`
|
||||||
then press Enter
|
then press Enter
|
||||||
to check it's installed correctly.
|
to check it's installed correctly.
|
||||||
You should see a message like
|
You should see a message like
|
||||||
|
|
||||||
|
```text
|
||||||
g++ 1.2.3 20010101
|
g++ 1.2.3 20010101
|
||||||
Copyright (C) 2001 Free Software Foundation, Inc.
|
Copyright (C) 2001 Free Software Foundation, Inc.
|
||||||
This is free software; see the source for copying conditions. There is NO
|
This is free software; see the source for copying conditions. There is NO
|
||||||
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
||||||
|
```
|
||||||
|
|
||||||
...except it should mention the version of mingw that you installed
|
...except it should mention the compiler version that you installed
|
||||||
and the corresponding dates.
|
and the corresponding dates.
|
||||||
If you see an error message like "command not found"
|
If you see an error message like "command not found"
|
||||||
or "bad command or filename",
|
or "bad command or filename",
|
||||||
you may need to add mingw's "bin" folder
|
you may need to add the compiler's "bin" folder
|
||||||
to your computer's `%PATH%`.
|
to your computer's `%PATH%`.
|
||||||
See the mingw documentation for help with that.
|
See the compiler's documentation for help with that.
|
||||||
|
|
||||||
Once mingw is installed and available from the command prompt:
|
Once mingw is installed and available from the command prompt:
|
||||||
|
|
||||||
|
|
|
@ -63,7 +63,7 @@ In the future,
|
||||||
if you want to play this game again,
|
if you want to play this game again,
|
||||||
you can choose "Load ROM File ..." as you did before,
|
you can choose "Load ROM File ..." as you did before,
|
||||||
or you can choose the appropriate console name
|
or you can choose the appropriate console name
|
||||||
from [the Library menu](interface/higan.md#the-library-menu),
|
from the Library menu,
|
||||||
which will list all the games for that console
|
which will list all the games for that console
|
||||||
in the Game Library.
|
in the Game Library.
|
||||||
|
|
||||||
|
@ -96,7 +96,7 @@ like the Game Boy and WonderSwan,
|
||||||
since the "controller" is always connected.
|
since the "controller" is always connected.
|
||||||
This *does* apply to the Famicom,
|
This *does* apply to the Famicom,
|
||||||
even though the Famicom's controllers are hard-wired,
|
even though the Famicom's controllers are hard-wired,
|
||||||
because higan uses "Famicom"
|
because higan uses the name "Famicom"
|
||||||
to mean Nintendo's 8-bit home console
|
to refer to Nintendo's 8-bit home console
|
||||||
in all territories,
|
in all territories,
|
||||||
including the Nintendo Entertainment System.
|
including the Nintendo Entertainment System.
|
||||||
|
|
Loading…
Reference in New Issue