Self-hosted **JavaScript** emulation for various systems. [![License: GPLv3][Badge License]][Link License] [![Website][Badge Website]][Link Website] [![Usage Docs][Badge Usage]][Link Usage] [![Configurator][Badge Configurator]][Link Configurator] [![Live Demo][Badge Demo]][Link Demo] [![Contributors][Badge Contributors]][Link Contributors] Join our Discord server: [![Discord Badge](https://invidget.switchblade.xyz/6akryGkETU)](https://discord.gg/6akryGkETU)

--- ## 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](https://emulatorjs.org/docs4devs/cores). ### Versioning Guide We use a specific versioning system to help you choose the right build for your needs: 1. **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. 2. **Latest** - Contains the latest code but uses stable cores. Updated whenever the `main` branch is updated. **This version will often be more broken than nightly** 3. **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. ```javascript // Example Configuration const EJS_pathToData = 'https://cdn.emulatorjs.org//data/'; // Replace with: stable, latest, nightly, etc. ``` ### Development To run the project locally for development: 1. Open a terminal in the root directory. 2. Install dependencies: ```sh npm i ``` 3. Start the server/minification: ```sh npm run start ``` 4. 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](minify/README.md). --- ## 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](https://emulatorjs.org/docs/3rd-party). ### Issues & Reporting If you encounter an issue, please open an [Issue](https://github.com/EmulatorJS/EmulatorJS/issues) 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][Link Patreon]. --- ## Star History

[Badge License]: https://img.shields.io/badge/License-GPLv3-blue.svg?style=for-the-badge&logo=opensourceinitiative [Badge Website]: https://img.shields.io/badge/Website-736e9b?style=for-the-badge [Badge Usage]: https://img.shields.io/badge/Usage-2478b5?style=for-the-badge [Badge Configurator]: https://img.shields.io/badge/Config-992cb3?style=for-the-badge [Badge Demo]: https://img.shields.io/badge/Demo-528116?style=for-the-badge [Badge Contributors]: https://img.shields.io/badge/Contributors-54b7dd?style=for-the-badge [Discord Badge]: https://invidget.switchblade.xyz/6akryGkETU [Link License]: LICENSE [Link Website]: https://emulatorjs.org/ [Link Usage]: https://emulatorjs.org/docs/ [Link Configurator]: https://emulatorjs.org/editor [Link Demo]: https://demo.emulatorjs.org/ [Link Contributors]: docs/contributors.md [Link Issue]: https://github.com/emulatorjs/emulatorjs/issues [Link Patreon]: https://patreon.com/EmulatorJS