ethanaobrien/EmulatorJS
1
0
Fork 0
mirror of https://github.com/EmulatorJS/EmulatorJS.git synced 2024-09-20 10:56:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update readme

Browse source
This commit is contained in:
Ethan O'Brien 2022-02-14 12:27:56 -06:00 committed by GitHub
parent 0709829a11
commit f48ea92172
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -10,6 +10,15 @@ Self-hosted **Javascript** emulation for various system.
*The* ***Screen Recording*** *option currently doesn't support* ***Audio*** *.*
The **beta** version of the emulator core files are now avaliable. (For limited systems) <br>
If you would like to use it, please add the following line to your code.
```js
EJS_BETA = true;
```
When reporting bugs, please specify that you are using the beta version
---
**⸢ [Example Use] ⸥ ⸢ [Emulator Demo] ⸥ ⸢ [Beta] ⸥**
@ -71,8 +80,15 @@ EJS_gameID = 1;
<br>
*I have successfully rewrote the server side portion* <br>
*of netplay, which you can now use to self host!*
by default, the netplay server url will be `emulatorjs.herokuapp.com`, but to default to the default `ws.emulatorjs.com` server add the following line
```js
EJS_oldEJSNetplayServer = true;
```
<br>
*To self host:*
1. Download the **[Server]**.
@ -84,13 +100,13 @@ EJS_netplayUrl = 'http://localhost:3000/'; // Absolute Url To Your Netplay Serve
<br>
##### Custom Saves
##### Custom Save Filename
To customize the filename of save states <br>
simply add the following lines of code.
```js
EJS_gameName = `Game Name`;
EJS_gameName = 'Game Name';
```
**➞ Save Filename:** `Game Name.state`
@ -103,7 +119,7 @@ To place an advertisement in front of the <br>
`play now` screen, include the following line:
```js
EJS_AdUrl = `URL`;
EJS_AdUrl = 'URL';
```
<br>
@ -147,17 +163,23 @@ EJS_paths = {
<br>
##### Localization
please see [data/localization/readme.md](the localization readme)
<br>
##### 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`)
@ -168,6 +190,8 @@ set the mame core value to the mame core number (`1` - `6`) + `|` + save states
Licenced under the Apache License 2.0
Please state changes and the licence when re-distributing
Read the whole license [here](LICENSE)