Repository files navigation

Self-hostedJavascript emulation for various systems.

Join our Discord server:

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 onpatreon

If something doesn't work, please consider opening anIssue
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 outhttps://emulatorjs.org/docs/3rd-party

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 themain 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 considered alpha.

EmulatorJS provides a CDN athttps://cdn.emulatorjs.org/, allowing access to any version of the emulator.

To use it, setEJS_pathtodata tohttps://cdn.emulatorjs.org/<version>/data/, replacing<version> withstable,latest,nightly, or another main release.

Be sure to also update theloader.js path to:https://cdn.emulatorjs.org/<version>/data/loader.js

Run a local server with:

1. Open a terminal in the root of the project.

2. Install the dependencies with:

   npm i

3. Start the minification with:

   node start

4. Open your browser and go tohttp://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 theminifying documentation for more info.

If you want to help with localization, please check out thelocalization documentation.

>> When reporting bugs, please specify what version you are using