From 61ecde1a7e64cbab080f7620903babcc1edb0ec5 Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Fri, 31 Dec 2021 12:49:03 -0500
Subject: [PATCH] README Refactor
---
README.md | 186 ++++++++++++++++++++++++++++++++----------------------
1 file changed, 109 insertions(+), 77 deletions(-)
diff --git a/README.md b/README.md
index 971a437..f16afc0 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,112 @@
+
+# EmulatorJS
+
+Self-hosted **Javascript** emulation for various system.
+
+*If something doesn't work, please consider opening an* ***[Issue]***
+*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
+> I went into inspect and downloaded the resources.
+
+> I removed the ad server, and made everything work within your own domain.
+
+> [This repository] 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.
+
+---
+
+## Supported Systems
+
+| Nintendo | Sega | Atari | | |
+|:--------:|:----:|:-----:|:-:|:-:|
+| **[Game Boy
Advance][Nintendo Game Boy Advance]** | **[Master
System][Sega Master System]** | **[Jaguar][Atari Jaguar]** | **[TurboGrafs 16
PC Engine][TurboGrafs-16 / PC Engine]** | **[MSX]**
+| **[Game Boy][Nintendo Game Boy]** | **[Mega
Drive][Sega Mega Drive]** | **[Lynx][Atari Lynx]** | **[WanderSwan
Color][WanderSwan / Color]** | **[3DO]**
+| **[Famicom
NES][NES / Famicom]** | **[Game
Gear][Sega Game Gear]** | **[7800][Atari 7800]** | **[Neo Geo
Poket][Neo Geo Poket]**
+| **[Virtual
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]*** *,*
+*check if it's available there and if it is, simply open an* ***[Issue]*** *.*
+
+---
+
+## Usage
+
+*For questions please use the* ***[Issue]*** *tab.*
+
+
+
+##### Setup
+
+1. Download this repository.
+ *`Code ➞ Download As Zip`*
+
+2. Use a **WebServer** to host the emulator.
+
+3. Use your **Browser** to navigate to `localhost`
+
+
+
+##### BIOS
+
+Some **Games** and **Systems** require
+a `BIOS`, though most usually ***don't***.
+
+
+
+##### ROMs
+
+**ROMs** can be used as `zip` / `rar` / `7z` archives.
+
+
+
+##### Custom Saves
+
+To customize the filename of save states
+simply add the following lines of code.
+
+```js
+EJS_gameName = `Game Name`;
+```
+
+**➞ Save Filename:** `Game Name.state`
+
+
+
+##### AD
+
+To place an advertisement in front of the
+`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
[SNES]: docs/SNES.md
[Nintendo 64]: docs/Nintendo%2064.md
@@ -22,80 +131,3 @@
[TurboGrafs-16 / PC Engine]: docs/TurboGrafs%2016-PC%20Engine.md
[Arcade]: docs/Arcade.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
-
-demo: https://ethanaobrien.github.io/emulatorjs/
-
-## 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`
-
-
-
-To add an ad to the play now screen, add the following line to your code
-
-```
-EJS_AdUrl = ''; //path to AD page
-```