ShuriZma
/
bsnes
mirror of https://github.com/bsnes-emu/bsnes.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
bsnes/docs/index.md

123 lines
4.0 KiB
Markdown
Raw Normal View History

Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
higan, the multi-system emulator
================================
Spell-check the documentation. Changes include a few typos, a few capitalization changes, and a lot of hyphenation of compound words that were not as widely used as I thought.
2017-08-31 04:48:52 +00:00
higan emulates a number of classic video-game consoles of the 1980s and 1990s,
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
allowing you to play classic games on a modern general-purpose computer.
Move the link to the Quick Start section as early as practical.
2017-08-23 04:51:38 +00:00
To get started with higan right away,
see the [Quick Start](qs.md) section of the documentation.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
About higan
-----------
This documentation is now up to date as of v104.
2017-08-23 04:51:24 +00:00
As of v104,
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
higan has top-tier support for the following consoles:
- Nintendo Super Famicom/Super Nintendo Entertainment System,
Spell-check the documentation. Changes include a few typos, a few capitalization changes, and a lot of hyphenation of compound words that were not as widely used as I thought.
2017-08-31 04:48:52 +00:00
including add-on hardware:
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
- Super Game Boy
- Sufami Turbo
- Nintendo Game Boy Advance
It also includes some level of support for these consoles:
Spell-check the documentation. Changes include a few typos, a few capitalization changes, and a lot of hyphenation of compound words that were not as widely used as I thought.
2017-08-31 04:48:52 +00:00
- Satellaview add-on for the Super Famicom
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
- Nintendo Famicom/Nintendo Entertainment System
- Nintendo Game Boy
- Nintendo Game Boy Color
- Sega Master System
- Sega Game Gear
Spell-check the documentation. Changes include a few typos, a few capitalization changes, and a lot of hyphenation of compound words that were not as widely used as I thought.
2017-08-31 04:48:52 +00:00
- Sega Mega Drive/Genesis
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
- NEC PC Engine/TurboGrafx 16 (but not the CD-ROM² System/TurboGrafx-CD)
- NEC SuperGrafx
More cleanups and revision.
2017-08-24 08:34:37 +00:00
- Bandai WonderSwan
Spell-check the documentation. Changes include a few typos, a few capitalization changes, and a lot of hyphenation of compound words that were not as widely used as I thought.
2017-08-31 04:48:52 +00:00
- Bandai WonderSwan Color
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
**Note:** Some consoles were released under different names
in different geographic regions.
To avoid listing all possible names
every time such a console is mentioned,
higan uses the name from the console's region of origin.
In practice,
that means Japanese names:
Let's be consistent about quoting console names here.
2017-08-23 04:52:54 +00:00
"Famicom" and "Super Famicom" instead of "NES" and "SNES",
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
"Mega Drive" instead of "Genesis",
"PC Engine" instead of "TurboGrafx-16".
higan is actively supported on
FreeBSD 10 and above, and
Microsoft Windows 7 and above.
It also includes some level of support
for GNU/Linux and macOS.
higan is officially spelled with a lowercase "h", not a capital.
About this document
-------------------
We're kind of official docs, now.
2017-08-23 06:55:58 +00:00
This is the semi-official higan manual,
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
a community-maintained introduction and reference.
It may be out of date
by the time you read this,
and it may contain errors or omissions.
If you find something that's wrong,
or you have a suggestion,
We're kind of official docs, now.
2017-08-23 06:55:58 +00:00
post a message on the official higan forum.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
Official higan resources
------------------------
- [Official homepage](https://byuu.org/emulation/higan/)
- [Official forum](https://board.byuu.org/viewforum.php?f=4)
Unofficial higan resources
--------------------------
- [Source code repository](https://gitlab.com/higan/higan/)
archives official higan releases
and WIP snapshots
since approximately v067r21.
- [Quark shader repository](https://github.com/hizzlekizzle/quark-shaders)
collects shaders that higan can use
to add special effects like TV scanlines to its video output,
or smarter algorithms for scaling up to modern PC resolutions.
Fix all the broken links. Also, some of the text in the higan and icarus settings docs wanted to link to a discussion of why we ignore manifests by default; now we have such a thing.
2017-08-22 08:12:17 +00:00
See [Using video shaders][shaders] below for details.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
- [Mercurial Magic](https://github.com/hex-usr/Mercurial-Magic/)
is a tool for converting MSU-1 games and mods into a format
higan can use.
Fix all the broken links. Also, some of the text in the higan and icarus settings docs wanted to link to a discussion of why we ignore manifests by default; now we have such a thing.
2017-08-22 08:12:17 +00:00
See [Importing MSU-1 games][msu1] for details.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
Fix all the broken links. Also, some of the text in the higan and icarus settings docs wanted to link to a discussion of why we ignore manifests by default; now we have such a thing.
2017-08-22 08:12:17 +00:00
[shaders]: guides/shaders.md
[msu1]: guides/import.md#msu-1-games
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
There are also other projects
based on current or older versions of higan,
in whole or in part,
that you might want to check out.
- [Mednafen](https://mednafen.github.io/)
is another multi-system emulator.
Its Super Famicom emulation is based on bsnes v059,
from the time before bsnes was renamed to higan.
- [BizHawk](http://tasvideos.org/BizHawk.html)
is another multi-system emulator,
specialising in the creation of
Spell-check the documentation. Changes include a few typos, a few capitalization changes, and a lot of hyphenation of compound words that were not as widely used as I thought.
2017-08-31 04:48:52 +00:00
tool-assisted speed-runs.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
Its Super Famicom emulation is based on bsnes v087.
Add a link to the bsnes-mercury fork. Also, sort the list of forks by the version they forked from.
2017-08-18 07:20:21 +00:00
- [bsnes-plus](https://github.com/devinacker/bsnes-plus)
is a fork of bsnes v073
that adds improved support for debugging Super Famicom software.
- [bsnes-mercury](https://github.com/libretro/bsnes-mercury/)
is a fork of bsnes v094
adapted to work as a
[libretro](https://www.libretro.com/) emulation core.
Convert README docs to MkDocs format. The existing documentation was getting *way* too long to be a single document. I've just bulk moved the existing content into the new structure, but it definitely needs another pass to make the prose match, fix hyperlinks, etc. etc.
2017-07-21 09:26:47 +00:00
- [nSide](https://github.com/hex-usr/nSide)
is a fork of higan that greatly enhances
its NES emulation support,
and adds minor features to the other cores too.
It also restores the "balanced" Super Famicom emulation core
that was removed from higan in v099,
which is less CPU intensive
Spell-check the documentation. Changes include a few typos, a few capitalization changes, and a lot of hyphenation of compound words that were not as widely used as I thought.
2017-08-31 04:48:52 +00:00
than the current accuracy-focused core.