EmulatorJS/README.md

151 lines
3.4 KiB
Markdown
Raw Normal View History

2022-02-23 15:03:52 +00:00
2022-04-15 20:37:27 +00:00
<div align = center>
<img src = docs/Logo.png width = 300>
2022-04-15 20:40:46 +00:00
2022-04-15 20:37:27 +00:00
<br>
<br>
[![Badge License]][License]
Self-hosted **Javascript** emulation for various system.
2022-03-04 03:31:38 +00:00
2022-04-15 20:37:27 +00:00
**⸢ [Website] ⸥**
**⸢ [Usage] ⸥**
2022-04-15 21:27:13 +00:00
**⸢ [Example] ⸥**
2022-04-15 21:26:01 +00:00
**⸢ [Demo] ⸥**
2022-04-15 20:37:27 +00:00
**⸢ [Beta] ⸥**
2022-03-04 03:31:38 +00:00
</div>
2021-12-20 16:30:29 +00:00
2021-12-31 17:52:21 +00:00
<br>
2022-04-15 20:37:27 +00:00
### Issues
2021-12-31 17:49:03 +00:00
*If something doesn't work, please consider opening an* ***[Issue]*** <br>
*with as many details as possible, as well as the console log.*
2021-04-05 20:37:22 +00:00
2021-12-31 17:49:03 +00:00
<br>
2021-12-21 00:35:17 +00:00
2022-04-15 20:37:27 +00:00
### Audio
2021-12-21 00:35:17 +00:00
2022-04-15 20:37:27 +00:00
*The* ***Screen Recording*** *option currently doesn't support* ***Audio*** *.*
2021-12-31 17:49:03 +00:00
<br>
2022-04-15 20:37:27 +00:00
### Beta
2021-12-31 17:49:03 +00:00
2022-04-15 20:37:27 +00:00
The **beta** of the emulator core is now available for *some* systems. <br>
To use it, please add the following line to your code.
2022-01-13 21:30:06 +00:00
```js
2022-04-15 20:37:27 +00:00
EJS_BETA = true;
2021-12-21 00:35:17 +00:00
```
2022-01-13 21:30:06 +00:00
2022-01-13 21:31:00 +00:00
<br>
2022-04-15 20:37:27 +00:00
**>>When reporting bugs, please specify that you are using the beta version**
2022-02-14 18:27:56 +00:00
<br>
2021-12-31 17:49:03 +00:00
<br>
<br>
2022-04-15 20:37:27 +00:00
<h1 align = center>Supported Systems</h1>
2021-12-31 17:49:03 +00:00
2022-01-05 18:38:25 +00:00
<br>
2022-04-15 20:37:27 +00:00
<div align = center>
2022-01-13 21:30:06 +00:00
2022-04-15 20:37:27 +00:00
### Nintendo
2022-01-05 18:38:25 +00:00
2022-04-15 20:37:27 +00:00
**[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]**
2022-01-13 21:30:06 +00:00
<br>
2022-01-05 18:38:25 +00:00
<br>
2022-04-15 20:37:27 +00:00
### Sega
2022-01-13 21:30:06 +00:00
2022-04-15 20:37:27 +00:00
**[Master System][Sega Master System]**|
**[Mega Drive][Sega Mega Drive]**|
**[Game Gear][Sega Game Gear]**
**[Saturn][Sega Saturn]**|
**[32X][Sega 32X]**|
**[CD][Sega CD]**
2022-01-23 22:36:31 +00:00
<br>
2022-02-14 18:27:56 +00:00
<br>
2022-04-15 20:37:27 +00:00
### Atari
2022-01-23 22:36:31 +00:00
2022-04-15 20:37:27 +00:00
**[Jaguar][Atari Jaguar]**|
**[Lynx][Atari Lynx]**|
**[7800][Atari 7800]**|
**[2600][Atari 2600]**
2022-01-23 22:36:31 +00:00
2022-04-15 20:37:27 +00:00
<br>
2022-01-23 22:36:31 +00:00
<br>
2022-01-13 21:30:06 +00:00
2022-04-15 20:37:27 +00:00
### Other
**[TurboGrafs 16 PC Engine][TurboGrafs-16 / PC Engine]**|
**[WanderSwan Color][WanderSwan / Color]**|
**[Neo Geo Poket][Neo Geo Poket]**
**[PlayStation]**|
**[Arcade]**|
**[MSX]**|
**[3DO]**
</div>
2022-01-15 22:36:20 +00:00
2022-04-15 20:37:27 +00:00
<br>
2022-02-14 18:27:56 +00:00
2022-04-15 20:37:27 +00:00
<!----------------------------------------------------------------------------->
2022-03-01 02:22:55 +00:00
2022-04-15 20:37:27 +00:00
[Badge License]: https://img.shields.io/badge/License-GPLv3-blue.svg
2022-01-15 22:36:20 +00:00
2022-04-15 20:37:27 +00:00
[License]: LICENSE
[Issue]: https://github.com/ethanaobrien/emulatorjs/issues
2022-01-15 22:36:20 +00:00
2021-12-31 17:49:03 +00:00
2022-04-15 20:37:27 +00:00
[Example]: https://coldcast.org/games/1/Super-Mario-Bros
[Website]: https://emulatorjs.ga/
[Usage]: docs/Usage.md
[Demo]: https://emulatorjs.ga/demo/
2022-03-01 15:46:54 +00:00
[Beta]: https://emulatorjs.ga/beta/
2021-12-31 17:49:03 +00:00
2022-04-15 20:37:27 +00:00
[NES / Famicom]: docs/Systems/NES-Famicom.md
[SNES]: docs/Systems/SNES.md
[Nintendo 64]: docs/Systems/Nintendo%2064.md
[Nintendo Game Boy]: docs/Systems/Nintendo%20Game%20Boy.md
[Nintendo Game Boy Advance]: docs/Systems/Nintendo%20Game%20Boy%20Advance.md
[Nintendo DS]: docs/Systems/Nintendo%20DS.md
[PlayStation]: docs/Systems/PlayStation.md
[Virtual Boy]: docs/Systems/Virtual%20Boy.md
[Sega Mega Drive]: docs/Systems/Sega%20Mega%20Drive.md
[Sega Master System]: docs/Systems/Sega%20Master%20System.md
[Sega CD]: docs/Systems/Sega%20CD.md
[Atari Lynx]: docs/Systems/Atari%20Lynx.md
[MSX]: docs/Systems/MSX.md
[3DO]: docs/Systems/3DO.md
[Sega 32X]: docs/Systems/Sega%2032X.md
[Atari Jaguar]: docs/Systems/Atari%20Jaguar.md
[Neo Geo Poket]: docs/Systems/Neo%20Geo%20Poket.md
[Sega Game Gear]: docs/Systems/Sega%20Game%20Gear.md
[Sega Saturn]: docs/Systems/Sega%20Saturn.md
[Atari 7800]: docs/Systems/Atari%207800.md
[WanderSwan / Color]: docs/Systems/WanderSwan-Color.md
[TurboGrafs-16 / PC Engine]: docs/Systems/TurboGrafs%2016-PC%20Engine.md
[Arcade]: docs/Systems/Arcade.md
[Atari 2600]: docs/Systems/Atari%202600.md