Home

Awesome

<div align = center>

<img width = 300 src = docs/Logo-light.png#gh-dark-mode-only> <img width = 300 src = docs/Logo.png#gh-light-mode-only>

<br> <br>

Badge License

Self-hosted Javascript emulation for various system.

<br>

Button WebsiteButton Usage<br> Button Configurator<br> Button DemoButton Legacy

Button Contributors

Join our Discord server:

Join our Discord server!

Or the Matrix server (#emulatorjs:matrix.emulatorjs.org):

<a href="https://matrix.to/#/#emulatorjs:matrix.emulatorjs.org" rel="noopener" target="_blank"><img src="https://matrix.to/img/matrix-badge.svg" alt="Chat on Matrix"></a>

</div> <br>

[!NOTE]
As of EmulatorJS version 4.0, this project is no longer a reverse-engineered version of the emulatorjs.com project. It is now a complete re-write.

[!WARNING]
As of version 4.0.9 cores and minified files are no longer included in the repository. You will need to get them separately. You can get the from releases or the * new CDN (see this for more info). There is also a new version system that we will be using. (read here for more info).

The history of the project has been rewritten and force pushed. You will likely need to redo any active commits you have. Sorry for the inconvenience.

[!TIP] Cloning the repository is no longer recommended for production use. You should use releases or the CDN instead.

<br>

Ads

This project has no ads. <br> Although, the demo page currently has an ad to help fund this project. <br> Ads on the demo page may come and go depending on how many people are <br> funding this project. <br>

You can help fund this project on patreon

<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>

Versioning

There are three different version names that you need to be aware of:

  1. stable - This will be the most stable version of the emulator both code and cores will be tested before release. It will be updated every time a new version is released on GitHub. This is the default version on the Demo.
  2. latest - This will contain the latest code but use the stable cores. This will be updated every time the main branch is updated.
  3. nightly - This will contain the latest code and the latest cores. The cores will be updated every day, so this is consiterd alpha.

CDN

There is a new CDN that you can use to get any version of the emulator. The cdn is https://cdn.emulatorjs.org/. You can use this to get the stable, latest, nightly and any other main version by setting your EJS_pathtodata to https://cdn.emulatorjs.org/<version>/data/.

Extensions

GameLibrary

   A library overview for your ROM folder.

<br>

Development:

Run a local server with:

npm i
npm start
<br>

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

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

Nintendo

Game Boy Advance   |  Famicom / NES   |  Virtual Boy

Game Boy   |  SNES   |  DS   |  64

<br> <br>

Sega

Master System   |  Mega Drive   |  Game Gear

Saturn   |  32X   |  CD

<br> <br>

Atari

2600   |  5200   |  7800   |  Lynx   |  Jaguar

<br> <br>

Commodore

Commodore 64 | Commodore 128 | Commodore Amiga

Commodore PET | Commodore Plus/4 | Commodore VIC-20

<br> <br>

Other

PlayStation   |  Arcade   |  3DO

MAME 2003 | ColecoVision

</div> <br> <!-- 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 ---> <!-- 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 Extensions 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 ---> <!-- 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 Quicklinks 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 ---> <!-- 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 Systems 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 --> <!-- [TurboGrafs-16 / PC Engine]: https://emulatorjs.org/systems/TurboGrafx-16 [MSX]: https://emulatorjs.org/systems/MSX [WanderSwan / Color]: https://emulatorjs.org/systems/WonderSwan [Neo Geo Poket]: https://emulatorjs.org/systems/Neo%20Geo%20Pocket ---> <!-- 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 Badges 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 🎮 --->