Skip to content

Commit

Permalink
add notes and chown commands to allow users to mount in rom dirs
Browse files Browse the repository at this point in the history
  • Loading branch information
thelamer committed Jan 25, 2022
1 parent ac1f119 commit 6873c04
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,42 @@ Mobile browsers will function, just keep in mind compatibility will be reduced e

**We know about most of the oddities like crackling sound for some emulators, rendering issues, and games unreliably auto launching to fullscreen. In general full CD games on the Xbox web browser do not seem to work due to their size if you have a chd/pbp less than 450 megs it will run. Edge on Xbox has some kind of undocumented ram limitation of about a gigabyte. Until all emulators are transitioned to libretro cores the oddities of using self hosted EmulatorJS will not be something that can or should be solved using hacky workarounds interacting with obfuscated code. Just keep in mind these are full blown machine emulators running in Javascript in a browser, do not expect bare metal performance.**

Mounting in existing rom directories can be achieved by pointing to the default folder structure, IE lets say you would like to mount your NES library:

`-v /path/to/nes/roms:/data/nes/roms`

The folder names are:
* 3do
* arcade
* atari2600
* atari7800
* colecovision
* doom
* gb
* gba
* gbc
* jaguar
* lynx
* msx
* n64
* nds
* nes
* ngp
* odyssey2
* pce
* psx
* sega32x
* segaCD
* segaGG
* segaMD
* segaMS
* segaSaturn
* segaSG
* snes
* vb
* vectrex
* ws

## Usage

Here are some example snippets to help you get started creating a container.
Expand Down Expand Up @@ -246,6 +282,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64

## Versions

* **25.01.22:** - Allow users to mount in existing rom directories.
* **14.01.22:** - Add profile paths and rebase to Alpine 3.15.
* **04.01.22:** - Add headers needed for Threaded emulators.
* **29.11.21:** - Add wasm mime type to NGINX.
Expand Down
37 changes: 37 additions & 0 deletions readme-vars.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,45 @@ app_setup_block: |
**We know about most of the oddities like crackling sound for some emulators, rendering issues, and games unreliably auto launching to fullscreen. In general full CD games on the Xbox web browser do not seem to work due to their size if you have a chd/pbp less than 450 megs it will run. Edge on Xbox has some kind of undocumented ram limitation of about a gigabyte. Until all emulators are transitioned to libretro cores the oddities of using self hosted EmulatorJS will not be something that can or should be solved using hacky workarounds interacting with obfuscated code. Just keep in mind these are full blown machine emulators running in Javascript in a browser, do not expect bare metal performance.**
Mounting in existing rom directories can be achieved by pointing to the default folder structure, IE lets say you would like to mount your NES library:
`-v /path/to/nes/roms:/data/nes/roms`
The folder names are:
* 3do
* arcade
* atari2600
* atari7800
* colecovision
* doom
* gb
* gba
* gbc
* jaguar
* lynx
* msx
* n64
* nds
* nes
* ngp
* odyssey2
* pce
* psx
* sega32x
* segaCD
* segaGG
* segaMD
* segaMS
* segaSaturn
* segaSG
* snes
* vb
* vectrex
* ws
# changelog
changelogs:
- { date: "25.01.22:", desc: "Allow users to mount in existing rom directories." }
- { date: "14.01.22:", desc: "Add profile paths and rebase to Alpine 3.15." }
- { date: "04.01.22:", desc: "Add headers needed for Threaded emulators." }
- { date: "29.11.21:", desc: "Add wasm mime type to NGINX." }
Expand Down
11 changes: 11 additions & 0 deletions root/etc/cont-init.d/20-config
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,14 @@ cp /defaults/mime.types /etc/nginx/mime.types

# nginx body cache
chown -R abc:root /var/lib/nginx

# allow users to mount in rom dirs
DIRS='3do atari2600 atari7800 colecovision doom gba lynx n64 nes odyssey2 psx segaCD segaMD segaSaturn snes vb ws arcade atari5200 gb gbc jaguar msx nds ngp pce sega32x segaGG segaMS segaSG vectrex'
for DIR in ${DIRS}; do
if [ -d "/data/${DIR}" ]; then
chown abc:abc "/data/${DIR}"
fi
if [ -d "/data/${DIR}/roms" ]; then
chown abc:abc "/data/${DIR}/roms"
fi
done

0 comments on commit 6873c04

Please sign in to comment.