
linuxserver/emulatorjs started it was meant to be a simple frontend for self hosting folks to use the at the time deobfuscated code of [*] that ethanaobrien was working on. Since then EmulatorJS has evolved into it's own amazing project based on Libretro cores that have been highly optimized to function for web. This project mostly contains custom built libretro cores found here. So in general despite the naming of this project and the logo this is just a docker container with a web based backend for generating a useable self hosted emulation website and is in no way affiliated with EmulatorJS.**
This container (outside of the profile functionality) only generates a static set of files that can be hosted on any web provider even object storage. Everything runs in the client's browser and there are no dependencies on this container. To extract/copy this website it is at the path /emulatorjs/frontend inside the container. If you are happy with the catalouge you have created and no longer want to run stuff like the IPFS backend or want to upload these files to some other hosting provider you can simply copy the contents of that directory and kill off this container. This container can also be started without IPFS once you collection is set using the environment variable -e DISABLE_IPFS=true.
Mounting in existing rom directories Read Only can be achieved by using a special root path /roms, For example for NES:
-v /path/to/nes/roms:/roms/nes:ro
The folder names for systems are:
Chromium Based Browsers- This is the golden standard whether desktop or on mobile (Android) Chrome/Chromium/Brave/Edge should always be used. They have the best performance when it comes to WebAssembly.
Firefox- This will work (at reduced performance though) without tested controller support.
Safari iOS- Safari performs well and has controller support though in recent updates the amount of ram available to a single tab (~265MB) makes it impossible to run n64 emulation or anything CD based. Do not use WKWebView applications like Chrome or Firefox on iOS they will not be detected properly in the client software. Your best bet in iOS is to add the web page to your home screen from Safari and launch from there to get a full screen interface.
Edge Xbox Series X/S- This also performs well and was the basis of this project though recent console updates have knocked the ram available to a single tab from 1GB to 128MB making it impossible to run CD based games or n64.
Retroarch Menu- The Retroarch menu can be accessed using F1 on keyboard, start/select/R1/L1 at the same time on controller, or pressing the button in the top left in touch mode.
Fast Scrolling- Items in the menu can be scrolled by letter by using PgUp/PgDn on the keyboard or the R1/L1 buttons on controller. In touch mode scrolling can be sped up by touching and dragging (while holding) either up or down.
For Xbox users please click the select button a couple times after launching a game to ensure the B button does not trigger a "back" action in the browser. (official name "view button" it is the two small squares) Exiting the controller mode and back to browser controls can be triggered by holding the start button for 3 seconds. (official name "menu button" the three lines)
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
[!NOTE] Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.
yaml--- services: emulatorjs: image: lscr.io/linuxserver/emulatorjs:latest container_name: emulatorjs environment: - PUID=1000 - PGID=1000 - TZ=Etc/UTC - SUBFOLDER=/ #optional volumes: - /path/to/config:/config - /path/to/data:/data ports: - 3000:3000 - 80:80 - 4001:4001 #optional restart: unless-stopped
bashdocker run -d \ --name=emulatorjs \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=Etc/UTC \ -e SUBFOLDER=/ `#optional` \ -p 3000:3000 \ -p 80:80 \ -p 4001:4001 `#optional` \ -v /path/to/config:/config \ -v /path/to/data:/data \ --restart unless-stopped \ lscr.io/linuxserver/emulatorjs:latest
Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.
| Parameter | Function |
|---|---|
-p 3000:3000 | Rom/artwork management interface, used to generate/manage config files and download artwork |
-p 80:80 | Emulation frontend containing static web files used to browse and launch games |
-p 4001 | IPFS peering port, if you want to participate in the P2P network to distribute frontend artwork please forward this to the Internet |
-e PUID=1000 | for UserID - see below for explanation |
-e PGID=1000 | for GroupID - see below for explanation |
-e TZ=Etc/UTC | specify a timezone to use, see this list. |
-e SUBFOLDER=/ | Specify a subfolder for reverse proxies IE '/FOLDER/' |
-v /config | Path to store user profiles |
-v /data | Path to store roms/artwork |
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
bash-e FILE__MYVAR=/run/secrets/mysecretvariable
Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id your_user as below:
bashid your_user
Example output:
textuid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
Shell access whilst the container is running:
bashdocker exec -it emulatorjs /bin/bash
To monitor the logs of the container in realtime:
bashdocker logs -f emulatorjs
Container version number:
bashdocker inspect -f '{{ index .Config.Labels "build_version" }}' emulatorjs
Image version number:
bashdocker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/emulatorjs:latest
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:
Update images:
All images:
bashdocker-compose pull
Single image:
bashdocker-compose pull emulatorjs
Update containers:
All containers:
bashdocker-compose up -d
Single container:
bashdocker-compose up -d emulatorjs
You can also remove the old dangling images:
bashdocker image prune
Update the image:
bashdocker pull lscr.io/linuxserver/emulatorjs:latest
Stop the running container:
bashdocker stop emulatorjs
Delete the container:
bashdocker rm emulatorjs
Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
You can also remove the old dangling images:
bashdocker image prune
[!TIP] We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
If you want to make local modifications to these images for development purposes or just to customize the logic:
bashgit clone [***] cd docker-emulatorjs docker build \ --no-cache \ --pull \ -t lscr.io/linuxserver/emulatorjs:latest .
The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static
bashdocker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
manifest unknown 错误
TLS 证书验证失败
DNS 解析超时
410 错误:版本过低
402 错误:流量耗尽
身份认证失败错误
429 限流错误
凭证保存错误
来自真实用户的反馈,见证轩辕镜像的优质服务