mirror of https://github.com/EmulatorJS/EmulatorJS.git synced 2024-09-19 18:36:25 +00:00

A web-based frontend for RetroArch

atari2600 atari7800 atari-lynx ds emulation emulator emulatorjs gameboy n64 nes nintendo nintendo-game-boy playstation retroarch retroarch-wasm sega-cd sega-mega-drive sega-saturn snes virtualboy

Find a file

Ethan O'Brien a7b59f19a3 Some checks are pending Make Latest Folder On EmulatorJS CDN / run (push) Waiting to run Details Add missing change		2024-08-19 11:53:17 -05:00
.github	update script path	2024-07-30 08:35:03 -06:00
data	Version 4.1.1	2024-08-19 11:47:13 -05:00
docs	Update Docs and Contributors (#859 )	2024-07-21 17:32:22 -05:00
.gitignore	add emulatorjs to npm (#775 )	2024-02-12 21:58:10 -06:00
CHANGES.md	Add missing change	2024-08-19 11:53:17 -05:00
CODE_OF_CONDUCT.md	Add repo docs	2023-07-18 10:56:27 -05:00
CONTRIBUTING.md	Create CONTRIBUTING.md	2023-09-13 06:13:51 -06:00
index.html	Support File objects (#873 )	2024-08-11 23:10:03 -05:00
LICENSE	EmulatorJS about page	2023-07-03 12:56:04 -05:00
package.json	Update package.json	2024-03-26 18:41:47 -05:00
README.md	Fix Broken links and add new systems in README (#872 )	2024-08-07 10:18:23 -05:00

README.md

Self-hosted Javascript emulation for various system.

Join our Discord server:

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

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.

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

You can help fund this project on patreon

Issues

If something doesn't work, please consider opening an Issue
with as many details as possible, as well as the console log.

Versioning

There are 3 different version name that you need to be aware of:

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.
latest - This will contain the latest code but use the stable cores. This will be updated every time the main branch is updated.
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/.