From 3d56d52d8a01c5c31e8dca73506e7aeac254e7fc Mon Sep 17 00:00:00 2001
From: ElectronicsArchiver
<85485984+ElectronicsArchiver@users.noreply.github.com>
Date: Sat, 2 Apr 2022 15:26:16 -0400
Subject: [PATCH] Moved Usage Section Into Separate File
---
README.md | 144 -------------------------------------------------
docs/Usage.md | 145 ++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 145 insertions(+), 144 deletions(-)
create mode 100644 docs/Usage.md
diff --git a/README.md b/README.md
index 6405c0f..c2e08b0 100644
--- a/README.md
+++ b/README.md
@@ -61,154 +61,10 @@ When reporting bugs, please specify that you are using the beta version
---
-## 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`
-
-
-
-##### ROMs
-
-**ROMs** can be used as `zip` / `rar` / `7z` archives.
-
-
-
-##### Netplay
-
-By default **Netplay** is ***disabled***,
-to enable it, add the following:
-
-```js
-// ID in your website, required for netplay. Each game in your site should have a different ID
-EJS_gameID = 1;
-```
-
-
-
-by default, the netplay server url will be `emuserver.emulatorjs.ga`, but to default to the default `ws.emulatorjs.com` server add the following line
-
-```js
-EJS_oldEJSNetplayServer = true;
-```
-
-
-
-*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
-```
-
-
-
-##### Custom Save Filename
-
-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';
-```
-
-
-
-##### Interface Color
-
-To use a different color for the emulator interface, use:
-
-```js
-EJS_color = '#FF0000'; // Hex Color Code
-```
-
-
-
-##### Direct Start
-
-To start the emulator immediately, add this line:
-
-```js
-EJS_startOnLoaded = true;
-```
-
-*For audio to play the user still*
-*needs to interact with the page.*
-
-
-
-##### Custom Paths
-
-Paths to emulator files can be customized with:
-
-```js
-EJS_paths = {
- 'fileName' : '/somepath',
- 'emulator.js' : 'https://example.com/emulator.js',
- 'n64-asmjs.data' : '/asdfds.data'
-};
-```
-
-*If a file is not defined, the default is used.*
-
-
-
-##### Localization
-
-please see [the localization readme]
-
-
-
-##### USING MAME SYSTEM
-
-you must add the line
-
-```js
-EJS_core = 'mame';
-```
-
-and the line
-
-```js
-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`)
-[Issue]: https://github.com/ethanaobrien/emulatorjs/issues
-[This repository]: https://github.com/linuxserver/emulatorjs
-
-[Server]: https://github.com/ethanaobrien/emuserver/releases
-
-[the localization readme]: data/localization/
[NES / Famicom]: docs/NES-Famicom.md
[SNES]: docs/SNES.md
diff --git a/docs/Usage.md b/docs/Usage.md
new file mode 100644
index 0000000..05970ee
--- /dev/null
+++ b/docs/Usage.md
@@ -0,0 +1,145 @@
+## 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`
+
+
+
+##### ROMs
+
+**ROMs** can be used as `zip` / `rar` / `7z` archives.
+
+
+
+##### Netplay
+
+By default **Netplay** is ***disabled***,
+to enable it, add the following:
+
+```js
+// ID in your website, required for netplay. Each game in your site should have a different ID
+EJS_gameID = 1;
+```
+
+
+
+by default, the netplay server url will be `emuserver.emulatorjs.ga`, but to default to the default `ws.emulatorjs.com` server add the following line
+
+```js
+EJS_oldEJSNetplayServer = true;
+```
+
+
+
+*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
+```
+
+
+
+##### Custom Save Filename
+
+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';
+```
+
+
+
+##### Interface Color
+
+To use a different color for the emulator interface, use:
+
+```js
+EJS_color = '#FF0000'; // Hex Color Code
+```
+
+
+
+##### Direct Start
+
+To start the emulator immediately, add this line:
+
+```js
+EJS_startOnLoaded = true;
+```
+
+*For audio to play the user still*
+*needs to interact with the page.*
+
+
+
+##### Custom Paths
+
+Paths to emulator files can be customized with:
+
+```js
+EJS_paths = {
+ 'fileName' : '/somepath',
+ 'emulator.js' : 'https://example.com/emulator.js',
+ 'n64-asmjs.data' : '/asdfds.data'
+};
+```
+
+*If a file is not defined, the default is used.*
+
+
+
+##### Localization
+
+please see [the localization readme]
+
+
+
+##### USING MAME SYSTEM
+
+you must add the line
+
+```js
+EJS_core = 'mame';
+```
+
+and the line
+
+```js
+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`)
+
+
+
+
+[Issue]: https://github.com/ethanaobrien/emulatorjs/issues
+[Server]: https://github.com/ethanaobrien/emuserver/releases
+[the localization readme]: data/localization/