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 rewrite.
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 it 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).
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
If something doesn't work, please consider opening an Issue
with as many details as possible, as well as the console log.
EmulatorJS itself is built to be a plugin, rather than an entire website. This is why there is no docker container of this project. However, there are several projects you can use that use EmulatorJS!
Looking for projects that integrate EmulatorJS? Check out https://emulatorjs.org/docs/3rd-party
There are three different version names 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 considered alpha.
EmulatorJS provides a CDN at https://cdn.emulatorjs.org/, allowing access to any version of the emulator.
To use it, set EJS_pathtodata to https://cdn.emulatorjs.org/<version>/data/, replacing <version> with stable, latest, nightly, or another main release.
Be sure to also update the loader.js path to:
https://cdn.emulatorjs.org/<version>/data/loader.js
Run a local server with:
-
Open a terminal in the root of the project.
-
Install the dependencies with:
-
Start the minification with:
-
Open your browser and go to
http://localhost:8080/to see the demo page.
Before pushing the script files onto your production server it is recommended to minify them to save on load times as well as bandwidth.
Read the minifying documentation for more info.
If you want to help with localization, please check out the localization documentation.
>> When reporting bugs, please specify what version you are using