Skip to content

Use descriptive text links and add keyboard markup in 3.getting-started.md #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 8, 2025
Merged

Use descriptive text links and add keyboard markup in 3.getting-started.md #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions content/1.docs/3.getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

## Prerequisites

* A web server like NGINX or the Apache server included in [XAMPP](https://www.apachefriends.org/)
* Alternatively, for a simpler server use [this](https://github.com/terreng/simple-web-server)
* A website behing hosted on that server, or at its most basic, create an empty file named "index.html" (save for later)
* Or you can use the built-in server [here](#built-in-server-optional)
* A web server like NGINX or the Apache server included in [XAMPP](https://www.apachefriends.org/).
* Alternatively, for a simpler server use [simple-web-server](https://github.com/terreng/simple-web-server).
* A website behing hosted on that server, or at its most basic, create an empty file named "index.html" (save for later).
* Or you can use the [built-in server](#built-in-server-optional).

## Setup

Expand Down Expand Up @@ -41,14 +41,14 @@ If you're using [React or Single Page Apps](/docs/embed#react-single-page-apps),

A [Code Editor](/editor) feature is included on this website. It's a wizard that will create this html web code for you.

1) Select a System
1) Select a System.
2) Fill out the details:
* Upload game rom
* Enter name of the game
* Enter an ad URL (optional)
* Upload bios file (if required)
* Upload custom save state to be loaded on start (optional)
3) Generate out file
3) Generate out file.

It will then give you the download link for a zip folder that will include the rom & an index.html file that has your code ready to be copy & pasted into your website.

Expand Down Expand Up @@ -76,7 +76,7 @@ All major browsers are currently supported!

In this example, we will use Google Chrome:

1) Right click on Chrome and click "Send to" then "Desktop (create shortcut)"
1) Right click on Chrome and click "Send to" then "Desktop (create shortcut)".
2) Now right click on the new shortcut and in the "Target" field, add this to the end:

::terminal
Expand All @@ -85,23 +85,23 @@ content:
- C:\Program Files (x86)\Google\Chrome\Application\chrome.exe" --kiosk "http://192.168.1.120/
---
::
3) Lastly, rename the shortcut to "EmulatorJS"
3) Lastly, rename the shortcut to "EmulatorJS".

To exit 'Kiosk' mode, hit ctrl+W
To exit 'Kiosk' mode, hit <kbd>Ctrl</kbd> + <kbd>W</kbd>

### Android/iOS

1) Open your browser and go to the server ip address (example: http://192.168.1.120/)
1) Open your browser and go to the server ip address (example: http://192.168.1.120/).
2) After EmulatorJS has loaded in, open your browser settings and click "Add to Home Screen" or something similar.
3) Click through any other prompts that may come up, but you should be left with a shortcut on your phone's home screen that acts like an app.

### Steam Deck

The process is similar as that of the Windows setup:

1) Enter Desktop mode
2) Right click on Chrome and add to Steam
3) Right click on the Chrome shortcut in Steam and click "Properties"
1) Enter Desktop mode.
2) Right click on Chrome and add to Steam.
3) Right click on the Chrome shortcut in Steam and click "Properties".
4) Under the "Shortcut" options, find the "Launch Options" text box.
5) Add this to the end:

Expand Down