EmulatorJS/README.md

<div align = center>
    
<img src = docs/Logo.png width = 300>
    
<br>
<br>
    
[![Badge License]][License]
    
<br>
    
Self-hosted **Javascript** emulation for various system.

<br>

[![Badge Website]][Website] 
[![Badge Usage]][Usage]<br>
[![Badge Configurator]][Configurator]<br>
[![Badge Demo]][Demo] 
[![Badge Legacy]][Legacy] 
[![Badge Beta]][Beta] 
    
</div>

<br>

### Issues

*If something doesn't work, please consider opening an* ***[Issue]*** <br>
*with as many details as possible, as well as the console log.*

<br>

### Audio

*The **Screen Recording** option currently doesn't support **Audio** .*

<br>

### Extensions

 **[GameLibrary]**

   *A library overview for your **ROM** folder.*

<br>

### Beta

The **beta** of the emulator core is now available for *some* systems. <br>
To use it, please add the following line to your code.

```js
EJS_BETA = true;
```

<br>

**>> When reporting bugs, please specify that you are using the beta version**

<br>
<br>
<br>

<h1 align = center>Supported Systems</h1>

<br>

<div align = center>

### 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]**

<br>
<br>

### 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]**
    
<br>
<br>

### Atari

**[Jaguar][Atari Jaguar]**   | 
**[Lynx][Atari Lynx]**   | 
**[7800][Atari 7800]**   | 
**[2600][Atari 2600]**

<br>
<br>

### Other

**[TurboGrafs 16 PC Engine][TurboGrafs-16 / PC Engine]**   | 
**[WanderSwan Color][WanderSwan / Color]**   | 
**[Neo Geo Poket][Neo Geo Poket]**
    
**[PlayStation]**   | 
**[Arcade]**   | 
**[MSX]**   | 
**[3DO]**
    
</div>

<br>


<!-- 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 --->

[License]: LICENSE
[Issue]: https://github.com/ethanaobrien/emulatorjs/issues


<!-- 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮   Extensions   🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 --->

[GameLibrary]: https://github.com/Ramaerel/emulatorjs-GameLibrary


<!-- 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮   Quicklinks   🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 --->

[Configurator]: https://emulatorjs.ga/codehelper
[Website]: https://emulatorjs.ga/
[Legacy]: https://coldcast.org/games/1/Super-Mario-Bros
[Usage]: docs/Usage.md
[Demo]: https://emulatorjs.ga/demo/
[Beta]: https://emulatorjs.ga/beta/


<!-- 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮  Systems  🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 -->

[Nintendo Game Boy Advance]: docs/Systems/Nintendo%20Game%20Boy%20Advance.md
[Nintendo Game Boy]: docs/Systems/Nintendo%20Game%20Boy.md
[Nintendo 64]: docs/Systems/Nintendo%2064.md
[Nintendo DS]: docs/Systems/Nintendo%20DS.md

[Sega Master System]: docs/Systems/Sega%20Master%20System.md
[Sega Mega Drive]: docs/Systems/Sega%20Mega%20Drive.md
[Sega Game Gear]: docs/Systems/Sega%20Game%20Gear.md
[Sega Saturn]: docs/Systems/Sega%20Saturn.md
[Sega 32X]: docs/Systems/Sega%2032X.md
[Sega CD]: docs/Systems/Sega%20CD.md

[Atari Jaguar]: docs/Systems/Atari%20Jaguar.md
[Atari Lynx]: docs/Systems/Atari%20Lynx.md
[Atari 7800]: docs/Systems/Atari%207800.md
[Atari 2600]: docs/Systems/Atari%202600.md

[NES / Famicom]: docs/Systems/NES-Famicom.md
[SNES]: docs/Systems/SNES.md

[TurboGrafs-16 / PC Engine]: docs/Systems/TurboGrafs%2016-PC%20Engine.md
[WanderSwan / Color]: docs/Systems/WanderSwan-Color.md
[Neo Geo Poket]: docs/Systems/Neo%20Geo%20Poket.md
[PlayStation]: docs/Systems/PlayStation.md
[Virtual Boy]: docs/Systems/Virtual%20Boy.md
[Arcade]: docs/Systems/Arcade.md
[MSX]: docs/Systems/MSX.md
[3DO]: docs/Systems/3DO.md


<!-- 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮  Badges  🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 --->

[Badge License]: https://img.shields.io/badge/License-GPLv3-blue.svg?style=for-the-badge

[Badge Configurator]: https://img.shields.io/badge/Configurator-992cb3?style=for-the-badge
[Badge Website]: https://img.shields.io/badge/Website-736e9b?style=for-the-badge
[Badge Legacy]: https://img.shields.io/badge/Legacy-ab910b?style=for-the-badge
[Badge Usage]: https://img.shields.io/badge/Usage-2478b5?style=for-the-badge
[Badge Demo]: https://img.shields.io/badge/Demo-528116?style=for-the-badge
[Badge Beta]: https://img.shields.io/badge/Beta-bb044f?style=for-the-badge