EmulatorJS/README.md
2022-04-02 15:26:16 -04:00

92 lines
3 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[![Badge License]][License]
<p align = 'center'>
<img src = 'docs/Emulatorjs%20Logo.png' width = '300px'>
<br>
<br>
<a href = './LICENSE'>
<img src = 'https://img.shields.io/badge/License-GPLv3-blue.svg'>
</a>
<br>
</p>
<p align = 'center'>
Self-hosted <b>Javascript</b> emulation for various system.
</p>
---
<p align = 'center'>
<a href = 'https://emulatorjs.ga/'><b>EmulatorJS Website</b></a> ⸥ 
<a href = 'https://coldcast.org/games/1/Super-Mario-Bros'><b>Example Use</b></a> ⸥ 
<a href = 'https://emulatorjs.ga/demo/'><b>Emulator Demo</b></a> ⸥ 
<a href = 'https://emulatorjs.ga/beta/'><b>Beta</b></a>
</p>
---
*If something doesn't work, please consider opening an* ***[Issue]*** <br>
*with as many details as possible, as well as the console log.*
*The* ***Screen Recording*** *option currently doesn't support* ***Audio*** *.*
The **beta** version of the emulator core files are now avaliable. (For limited systems) <br>
If you would like to use it, please add the following line to your code.
```js
EJS_BETA = true;
```
When reporting bugs, please specify that you are using the beta version
---
## Supported Systems
#### Nintendo
**[Game Boy Advance][Nintendo Game Boy Advance]**|**[Famicom / NES][NES / Famicom]**|**[Virtual Boy][Virtual Boy]**|**[Game Boy][Nintendo Game Boy]**|**[SNES]**|**[DS][Nintendo DS]**|**[64][Nintendo 64]**
#### Sega
**[Master System][Sega Master System]**|**[Mega Drive][Sega Mega Drive]**|**[Game Gear][Sega Game Gear]**|**[Saturn][Sega Saturn]**|**[32X][Sega 32X]**|**[CD][Sega CD]**
#### Atari
**[Jaguar][Atari Jaguar]**|**[Lynx][Atari Lynx]**|**[7800][Atari 7800]**|**[2600][Atari 2600]**
#### Other
**[TurboGrafs 16 PC Engine][TurboGrafs-16 / PC Engine]**|**[WanderSwan Color][WanderSwan / Color]**|**[Neo Geo Poket][Neo Geo Poket]**|**[PlayStation]**|**[Arcade]**|**[MSX]**|**[3DO]**
---
<!----------------------------------------------------------------------------->
[NES / Famicom]: docs/NES-Famicom.md
[SNES]: docs/SNES.md
[Nintendo 64]: docs/Nintendo%2064.md
[Nintendo Game Boy]: docs/Nintendo%20Game%20Boy.md
[Nintendo Game Boy Advance]: docs/Nintendo%20Game%20Boy%20Advance.md
[Nintendo DS]: docs/Nintendo%20DS.md
[PlayStation]: docs/PlayStation.md
[Virtual Boy]: docs/Virtual%20Boy.md
[Sega Mega Drive]: docs/Sega%20Mega%20Drive.md
[Sega Master System]: docs/Sega%20Master%20System.md
[Sega CD]: docs/Sega%20CD.md
[Atari Lynx]: docs/Atari%20Lynx.md
[MSX]: docs/MSX.md
[3DO]: docs/3DO.md
[Sega 32X]: docs/Sega%2032X.md
[Atari Jaguar]: docs/Atari%20Jaguar.md
[Neo Geo Poket]: docs/Neo%20Geo%20Poket.md
[Sega Game Gear]: docs/Sega%20Game%20Gear.md
[Sega Saturn]: docs/Sega%20Saturn.md
[Atari 7800]: docs/Atari%207800.md
[WanderSwan / Color]: docs/WanderSwan-Color.md
[TurboGrafs-16 / PC Engine]: docs/TurboGrafs%2016-PC%20Engine.md
[Arcade]: docs/Arcade.md
[Atari 2600]: docs/Atari%202600.md