- JavaScript 90.3%
- CSS 6.4%
- HTML 3.3%
|
|
||
|---|---|---|
| .github | ||
| .vscode | ||
| data | ||
| docs | ||
| minify | ||
| .gitattributes | ||
| .gitignore | ||
| .npmignore | ||
| build.js | ||
| CHANGES.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| eslint.config.js | ||
| index.html | ||
| jsconfig.json | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| update.js | ||
Self-hosted JavaScript emulation for various systems.
Join our Discord server:
Getting Started
Supported Systems
EmulatorJS supports a wide variety of legacy consoles and arcade machines. For the complete list of supported cores, please visit our Cores Documentation.
Versioning Guide
We use a specific versioning system to help you choose the right build for your needs:
- Stable - The most current release. Both code and cores are tested before release. Updated when new versions are released on GitHub. This is the default version on the Demo.
- Latest - Contains the latest code but uses stable cores. Updated whenever the
mainbranch is updated. This version will often be more broken than nightly - Nightly - Contains the latest code and the latest cores. Cores are updated daily. This version is not recommended for production use as it is the main development branch.
CDN Integration
EmulatorJS provides a public CDN at https://cdn.emulatorjs.org/. You can access any version by setting the data path and loader.js accordingly.
// Example Configuration
const EJS_pathToData = 'https://cdn.emulatorjs.org/<version>/data/';
// Replace <version> with: stable, latest, nightly, etc.
Development
To run the project locally for development:
- Open a terminal in the root directory.
- Install dependencies:
npm i - Start the server/minification:
npm run start - Open
http://localhost:8080/to view the demo.
Note: Minify your script files before deploying to a production server to optimize load times and bandwidth. See Minification Docs.
Community & Support
3rd Party Integrations
EmulatorJS is built as a library/plugin, not a standalone website (therefore, no Docker container). For projects that utilize EmulatorJS, check out our 3rd Party Integration List.
Issues & Reporting
If you encounter an issue, please open an Issue on GitHub. Include as many details as possible, including your browser console logs.
When reporting bugs, please specify the version you are using (Stable/Latest/Nightly).
Support the Project
This project is free and ad-free. The demo page may show occasional ads to help with hosting costs, but you can support development directly via Patreon.