mirror of
https://github.com/EmulatorJS/EmulatorJS.git
synced 2024-09-20 19:06:30 +00:00
README Refactor
This commit is contained in:
ElectronicsArchiver
parent
73ff641616
commit
61ecde1a7e
1 changed files with 109 additions and 77 deletions
186
README.md
186
README.md
|
|
@ -1,3 +1,112 @@
|
||||||
|
|
||||||
|
# EmulatorJS
|
||||||
|
|
||||||
|
Self-hosted **Javascript** emulation for various system.
|
||||||
|
|
||||||
|
*If something doesn't work, please consider opening an* ***[Issue]*** <br>
|
||||||
|
*with as many details as possible, as well as the console log.*
|
||||||
|
|
||||||
|
*The* ***Screen Recording*** *option currently doesn't support* ***Audio*** *.*
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**⸢ [Example Use] ⸥ ⸢ [Emulator Demo] ⸥**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Where Did I Get This?
|
||||||
|
|
||||||
|
> So I found this website called [EmulatorJS.com][EJS] and <br>
|
||||||
|
> I went into inspect and downloaded the resources.<br>
|
||||||
|
<br>
|
||||||
|
> I removed the ad server, and made everything work within your own domain.<br>
|
||||||
|
<br>
|
||||||
|
> [This repository] may soon make it possible to use all this open source.<br>
|
||||||
|
<br>
|
||||||
|
> The emulator is not illegal - the rom is - I am not responsible <br>
|
||||||
|
> for what people decide to do with this software.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Supported Systems
|
||||||
|
|
||||||
|
| Nintendo | Sega | Atari | | |
|
||||||
|
|:--------:|:----:|:-----:|:-:|:-:|
|
||||||
|
| **[Game Boy<br>Advance][Nintendo Game Boy Advance]** | **[Master<br>System][Sega Master System]** | **[Jaguar][Atari Jaguar]** | **[TurboGrafs 16<br>PC Engine][TurboGrafs-16 / PC Engine]** | **[MSX]**
|
||||||
|
| **[Game Boy][Nintendo Game Boy]** | **[Mega<br>Drive][Sega Mega Drive]** | **[Lynx][Atari Lynx]** | **[WanderSwan<br>Color][WanderSwan / Color]** | **[3DO]**
|
||||||
|
| **[Famicom <br> NES][NES / Famicom]** | **[Game<br>Gear][Sega Game Gear]** | **[7800][Atari 7800]** | **[Neo Geo<br>Poket][Neo Geo Poket]**
|
||||||
|
| **[Virtual<br>Boy][Virtual Boy]** | **[Saturn][Sega Saturn]** | **[2600][Atari 2600]** | **[PlayStation]**
|
||||||
|
| **[SNES]** | **[32X][Sega 32X]** | | **[Arcade]**
|
||||||
|
| **[DS][Nintendo DS]** | **[CD][Sega CD]** |
|
||||||
|
| **[64][Nintendo 64]**
|
||||||
|
|
||||||
|
*If your system is not listed here, navigate to* ***[EmulatorJS.com][EJS]*** *,* <br>
|
||||||
|
*check if it's available there and if it is, simply open an* ***[Issue]*** *.*
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
*For questions please use the* ***[Issue]*** *tab.*
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
##### 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>
|
||||||
|
|
||||||
|
##### BIOS
|
||||||
|
|
||||||
|
Some **Games** and **Systems** require <br>
|
||||||
|
a `BIOS`, though most usually ***don't***.
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
##### ROMs
|
||||||
|
|
||||||
|
**ROMs** can be used as `zip` / `rar` / `7z` archives.
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
##### Custom Saves
|
||||||
|
|
||||||
|
To customize the filename of save states <br>
|
||||||
|
simply add the following lines of code.
|
||||||
|
|
||||||
|
```js
|
||||||
|
EJS_gameName = `Game Name`;
|
||||||
|
```
|
||||||
|
|
||||||
|
**➞ 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`;
|
||||||
|
```
|
||||||
|
|
||||||
|
<!----------------------------------------------------------------------------->
|
||||||
|
|
||||||
|
[Example Use]: https://coldcast.org/games/1/Super-Mario-Bros
|
||||||
|
[Emulator Demo]: https://ethanaobrien.github.io/emulatorjs/
|
||||||
|
|
||||||
|
[Issue]: issues
|
||||||
|
[This repository]: https://github.com/linuxserver/emulatorjs
|
||||||
|
|
||||||
|
[EJS]: https://www.emulatorjs.com/
|
||||||
|
|
||||||
[NES / Famicom]: docs/NES-Famicom.md
|
[NES / Famicom]: docs/NES-Famicom.md
|
||||||
[SNES]: docs/SNES.md
|
[SNES]: docs/SNES.md
|
||||||
[Nintendo 64]: docs/Nintendo%2064.md
|
[Nintendo 64]: docs/Nintendo%2064.md
|
||||||
|
|
@ -22,80 +131,3 @@
|
||||||
[TurboGrafs-16 / PC Engine]: docs/TurboGrafs%2016-PC%20Engine.md
|
[TurboGrafs-16 / PC Engine]: docs/TurboGrafs%2016-PC%20Engine.md
|
||||||
[Arcade]: docs/Arcade.md
|
[Arcade]: docs/Arcade.md
|
||||||
[Atari 2600]: docs/Atari%202600.md
|
[Atari 2600]: docs/Atari%202600.md
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# emulatorjs
|
|
||||||
|
|
||||||
A javascript emulator for nes, snes, and more!
|
|
||||||
The BEST emulator on the internet. No ads and self hosted!
|
|
||||||
|
|
||||||
Example page: https://coldcast.org/games/1/Super-Mario-Bros
|
|
||||||
|
|
||||||
<p>demo: <a href='https://ethanaobrien.github.io/emulatorjs/'>https://ethanaobrien.github.io/emulatorjs/</a></p>
|
|
||||||
|
|
||||||
## Where did I get this?
|
|
||||||
|
|
||||||
So I found this website called [emulatorjs](https://www.emulatorjs.com/) and I went into inspect and downloaded the resources. I removed the ad server, and made everything work within your own domain.
|
|
||||||
https://github.com/linuxserver/emulatorjs may soon make it possible to use all this open source
|
|
||||||
|
|
||||||
The emulator is not illegal - the rom is - I am not responsible for what people decide to do with this software.
|
|
||||||
|
|
||||||
NOTE: The screen recording option does not currently support audio! only video recording is supported at this time.
|
|
||||||
|
|
||||||
## How To
|
|
||||||
|
|
||||||
1. Download this repository (Code > Download as zip) then Extract the contents
|
|
||||||
2. Load into a web server and open localhost
|
|
||||||
|
|
||||||
If you have questions, ask me and I will clarify (use the issues tab). Please search to make sure your isuue hasnt already been asked
|
|
||||||
|
|
||||||
IF SOMETHING DOES NOT WORK - Please make an issue!! Include as many details as possible and please include a log of the console!
|
|
||||||
|
|
||||||
All roms can be zipped into a `.zip`, `.rar`, or `.7z` archive
|
|
||||||
|
|
||||||
## Supported systems!
|
|
||||||
|
|
||||||
| Supported Systems |
|
|
||||||
|:------------------:|
|
|
||||||
| [NES / Famicom] |
|
|
||||||
| [SNES] |
|
|
||||||
| [Nintendo 64] |
|
|
||||||
| [Nintendo Game Boy] |
|
|
||||||
| [Nintendo Game Boy Advance] |
|
|
||||||
| [Nintendo DS] |
|
|
||||||
| [PlayStation] |
|
|
||||||
| [Virtual Boy] |
|
|
||||||
| [Sega Mega Drive] |
|
|
||||||
| [Sega Master System] |
|
|
||||||
| [Sega CD] |
|
|
||||||
| [Atari Lynx] |
|
|
||||||
| [MSX] |
|
|
||||||
| [3DO] |
|
|
||||||
| [Sega 32X] |
|
|
||||||
| [Atari Jaguar] |
|
|
||||||
| [Neo Geo Poket] |
|
|
||||||
| [Sega Game Gear] |
|
|
||||||
| [Sega Saturn] |
|
|
||||||
| [Atari 7800] |
|
|
||||||
| [WanderSwan / Color] |
|
|
||||||
| [TurboGrafs-16 / PC Engine] |
|
|
||||||
| [Arcade] |
|
|
||||||
| [Atari 2600] |
|
|
||||||
|
|
||||||
## Tips
|
|
||||||
|
|
||||||
To customize the filename of save states, add the line of code below
|
|
||||||
|
|
||||||
```
|
|
||||||
EJS_gameName = 'name of game';
|
|
||||||
```
|
|
||||||
When the user saves a state, the state will be saved with the name `name of game.state`
|
|
||||||
|
|
||||||
<br>
|
|
||||||
|
|
||||||
To add an ad to the play now screen, add the following line to your code
|
|
||||||
|
|
||||||
```
|
|
||||||
EJS_AdUrl = ''; //path to AD page
|
|
||||||
```
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue