2021-12-25 00:33:00 +00:00
2022-02-14 17:21:00 +00:00
# EmulatorJS
2021-12-25 00:33:00 +00:00
2022-02-14 17:21:00 +00:00
Self-hosted **Javascript** emulation for various system.
2021-12-25 00:33:00 +00:00
2022-02-14 17:21:00 +00:00
< br >
2021-05-12 21:09:00 +00:00
2022-02-14 17:21:00 +00:00
*If something doesn't work, please consider opening an* ** *[Issue]*** < br >
*with as many details as possible, as well as the console log.*
2021-05-12 21:09:00 +00:00
2022-02-14 17:21:00 +00:00
*The* ** *Screen Recording*** *option currently doesn't support* ** *Audio*** *.*
2021-08-28 21:44:00 +00:00
2022-02-14 17:21:00 +00:00
---
2021-09-17 15:34:00 +00:00
2022-02-14 17:21:00 +00:00
**⸢ [Example Use] ⸥ ⸢ [Emulator Demo] ⸥ ⸢ [Beta] ⸥**
2022-01-11 17:00:00 +00:00
2022-02-14 17:21:00 +00:00
---
2021-05-12 21:09:00 +00:00
2022-02-14 17:21:00 +00:00
## Supported Systems
2021-05-12 21:09:00 +00:00
2022-02-14 17:21:00 +00:00
#### Nintendo
2021-05-12 21:09:00 +00:00
2022-02-14 17:21:00 +00:00
**[Game Boy Advance][Nintendo Game Boy Advance]** | ** [Famicom / NES][NES / Famicom]** | ** [Virtual Boy][Virtual Boy]** | ** [Game Boy][Nintendo Game Boy]** | ** [SNES]** | ** [DS][Nintendo DS]** | ** [64][Nintendo 64]**
2021-11-17 23:04:00 +00:00
2022-02-14 17:21:00 +00:00
#### Sega
**[Master System][Sega Master System]** | ** [Mega Drive][Sega Mega Drive]** | ** [Game Gear][Sega Game Gear]** | ** [Saturn][Sega Saturn]** | ** [32X][Sega 32X]** | ** [CD][Sega CD]**
2021-05-12 21:09:00 +00:00
2022-02-14 17:21:00 +00:00
#### Atari
2021-05-12 21:09:00 +00:00
2022-02-14 17:21:00 +00:00
**[Jaguar][Atari Jaguar]** | ** [Lynx][Atari Lynx]** | ** [7800][Atari 7800]** | ** [2600][Atari 2600]**
2021-05-12 21:09:00 +00:00
2022-02-14 17:21:00 +00:00
#### Other
2021-05-27 16:01:00 +00:00
2022-02-14 17:21:00 +00:00
**[TurboGrafs 16 PC Engine][TurboGrafs-16 / PC Engine]** | ** [WanderSwan Color][WanderSwan / Color]** | ** [Neo Geo Poket][Neo Geo Poket]** | ** [PlayStation]** | ** [Arcade]** | ** [MSX]** | ** [3DO]**
2021-05-27 16:01:00 +00:00
2022-02-14 17:21:00 +00:00
---
2022-01-11 17:00:00 +00:00
2022-02-14 17:21:00 +00:00
## Usage
2022-01-11 17:00:00 +00:00
2022-02-14 17:21:00 +00:00
*For questions please use the* ** *[Issue]*** *tab.*
2022-01-11 17:00:00 +00:00
2022-02-14 17:21:00 +00:00
< br >
2021-05-27 16:01:00 +00:00
2022-02-14 17:21:00 +00:00
##### Setup
1. Download this repository.< br >
*`Code ➞ Download As Zip`*
2. Use a **WebServer** to host the emulator.
3. Use your **Browser** to navigate to `localhost`
< br >
##### ROMs
**ROMs** can be used as `zip` / `rar` / `7z` archives.
2021-05-27 16:01:00 +00:00
2021-12-25 00:33:00 +00:00
< br >
2021-08-28 21:44:00 +00:00
2022-02-14 17:21:00 +00:00
##### Netplay
By default **Netplay** is ** *disabled***, < br >
to enable it, add the following:
2021-08-28 21:44:00 +00:00
2022-02-14 17:21:00 +00:00
```js
// ID in your website, required for netplay. Each game in your site should have a different ID
EJS_gameID = 1;
2021-08-28 21:44:00 +00:00
```
2022-02-14 17:21:00 +00:00
< br >
*I have successfully rewrote the server side portion* < br >
*of netplay, which you can now use to self host!*
1. Download the ** [Server]**.
2. Specify the servers address with:
```js
EJS_netplayUrl = 'http://localhost:3000/'; // Absolute Url To Your Netplay Server
2021-08-28 21:44:00 +00:00
```
2022-01-11 17:00:00 +00:00
< br >
2022-02-14 17:21:00 +00:00
##### Custom Saves
To customize the filename of save states < br >
simply add the following lines of code.
2022-01-11 17:00:00 +00:00
2022-02-14 17:21:00 +00:00
```js
EJS_gameName = `Game Name` ;
2022-01-11 17:00:00 +00:00
```
2022-02-14 17:21:00 +00:00
**➞ Save Filename:** `Game Name.state`
< br >
##### AD
To place an advertisement in front of the < br >
`play now` screen, include the following line:
```js
EJS_AdUrl = `URL` ;
2022-01-11 17:00:00 +00:00
```
< br >
2022-02-14 17:21:00 +00:00
##### Interface Color
2022-01-11 17:00:00 +00:00
2022-02-14 17:21:00 +00:00
To use a different color for the emulator interface, use:
```js
EJS_color = '#FF0000'; // Hex Color Code
2022-01-11 17:00:00 +00:00
```
2022-02-14 17:21:00 +00:00
< br >
##### Direct Start
To start the emulator immediately, add this line:
```js
2022-01-11 17:00:00 +00:00
EJS_startOnLoaded = true;
```
2022-02-14 17:21:00 +00:00
*For audio to play the user still* < br >
*needs to interact with the page.*
2022-01-11 17:00:00 +00:00
< br >
2022-02-14 17:21:00 +00:00
##### Custom Paths
2022-01-11 17:00:00 +00:00
2022-02-14 17:21:00 +00:00
Paths to emulator files can be customized with:
```js
2022-01-11 17:00:00 +00:00
EJS_paths = {
2022-02-14 17:21:00 +00:00
'fileName' : '/somepath',
'emulator.js' : 'https://example.com/emulator.js',
'n64-asmjs.data' : '/asdfds.data'
};
```
*If a file is not defined, the default is used.*
< br >
##### USING MAME SYSTEM
you must add the line
```
EJS_core = 'mame';
2022-01-11 17:00:00 +00:00
```
2022-02-14 17:21:00 +00:00
and the line
```
EJS_mameCore = '' // mame core options (example: '4|0')
```
set the mame core value to the mame core number (`1` - `6` ) + `|` + save states supported (`0` or `1` )
< br >
# LICENSE
Licenced under the Apache License 2.0
Read the whole license [here ](LICENSE )
<!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
[Example Use]: https://coldcast.org/games/1/Super-Mario-Bros
[Emulator Demo]: https://ethanaobrien.github.io/emulatorjs/
[Beta]: https://emulatorjs.netlify.app/
[Issue]: https://github.com/ethanaobrien/emulatorjs/issues
[This repository]: https://github.com/linuxserver/emulatorjs
[EJS]: https://www.emulatorjs.com/
[Server]: https://github.com/ethanaobrien/emuserver/releases
[NES / Famicom]: docs/NES-Famicom.md
[SNES]: docs/SNES.md
[Nintendo 64]: docs/Nintendo%2064.md
[Nintendo Game Boy]: docs/Nintendo%20Game%20Boy.md
[Nintendo Game Boy Advance]: docs/Nintendo%20Game%20Boy%20Advance.md
[Nintendo DS]: docs/Nintendo%20DS.md
[PlayStation]: docs/PlayStation.md
[Virtual Boy]: docs/Virtual%20Boy.md
[Sega Mega Drive]: docs/Sega%20Mega%20Drive.md
[Sega Master System]: docs/Sega%20Master%20System.md
[Sega CD]: docs/Sega%20CD.md
[Atari Lynx]: docs/Atari%20Lynx.md
[MSX]: docs/MSX.md
[3DO]: docs/3DO.md
[Sega 32X]: docs/Sega%2032X.md
[Atari Jaguar]: docs/Atari%20Jaguar.md
[Neo Geo Poket]: docs/Neo%20Geo%20Poket.md
[Sega Game Gear]: docs/Sega%20Game%20Gear.md
[Sega Saturn]: docs/Sega%20Saturn.md
[Atari 7800]: docs/Atari%207800.md
[WanderSwan / Color]: docs/WanderSwan-Color.md
[TurboGrafs-16 / PC Engine]: docs/TurboGrafs%2016-PC%20Engine.md
[Arcade]: docs/Arcade.md
[Atari 2600]: docs/Atari%202600.md