Skip to content

docs: add nightly CDN disclaimer for EmulatorJS netplay #64

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
gantoine merged 3 commits into from
Mar 10, 2026
Merged

docs: add nightly CDN disclaimer for EmulatorJS netplay #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e06164a
Initial plan
Copilot Mar 10, 2026
bff60fe
docs: add nightly CDN disclaimer for netplay in EmulatorJS documentation
Copilot Mar 10, 2026
1e5a94d
run fmt
gantoine Mar 10, 2026
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
14 changes: 9 additions & 5 deletions docs/Getting-Started/Configuration-File.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ Fine-tune which ROMs or files are excluded.
Applies to ROMs that are single files (not in subfolders).

- **extensions**: Exclude files by extension
- Defaults to `["db", "ini", "tmp", "bak", "lock", "log", "cache", "crdownload"]`
- Defaults to `["db", "ini", "tmp", "bak", "lock", "log", "cache", "crdownload"]`
- **names**: Exclude files by name or pattern (supports Unix wildcards)
- Defaults to `[".DS_Store", ".localized", ".Trashes", ".stfolder", "@SynoResource", "gamelist.xml"]`
- Defaults to `[".DS_Store", ".localized", ".Trashes", ".stfolder", "@SynoResource", "gamelist.xml"]`

```yaml
exclude:
Expand All @@ -44,11 +44,11 @@ exclude:
Applies to ROMs stored as folders (multi-disc, with DLC, etc.).

- **names**: Exclude entire folders by name
- Defaults to `["@eaDir", "__MACOSX", "$RECYCLE.BIN", ".Trash-*", ".stfolder", ".Spotlight-V100", ".fseventsd", ".DocumentRevisions-V100", "System Volume Information"]`
- Defaults to `["@eaDir", "__MACOSX", "$RECYCLE.BIN", ".Trash-*", ".stfolder", ".Spotlight-V100", ".fseventsd", ".DocumentRevisions-V100", "System Volume Information"]`
- **parts.names**: Exclude files by name or pattern from within multi-file ROM folders
- Defaults to `[".DS_Store", ".localized", ".Trashes", ".stfolder", "@SynoResource", "gamelist.xml"]`
- Defaults to `[".DS_Store", ".localized", ".Trashes", ".stfolder", "@SynoResource", "gamelist.xml"]`
- **parts.extensions**: Exclude files by extension from within multi-file ROM folders
- Defaults to `["db", "ini", "tmp", "bak", "lock", "log", "cache", "crdownload"]`
- Defaults to `["db", "ini", "tmp", "bak", "lock", "log", "cache", "crdownload"]`

```yaml
exclude:
Expand Down Expand Up @@ -285,6 +285,10 @@ emulatorjs:
credential: "openrelayproject"
```

<!-- prettier-ignore -->
!!! note
When netplay is enabled, EmulatorJS loads some assets (including localization files) from the nightly CDN (`https://cdn.emulatorjs.org/nightly/...`). This differs from stable mode, which uses local/bundled assets. Occasional temporary issues (e.g., 404 errors or untranslated UI elements) can occur if the nightly CDN has mismatches, but these usually resolve with the next EmulatorJS stable release integrated into RomM.

### Settings

Configure core-specific settings. Use `default` to apply settings to all cores.
Expand Down
4 changes: 4 additions & 0 deletions docs/Platforms-and-Players/EmulatorJS-Player.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ emulatorjs:

To host a game, start it, then hit the 🌐 icon in botton bar. Set your name, create a room (password optional), and other players should be able to see and join your room. **All players need access to your RomM server to join a room and play together.**

<!-- prettier-ignore -->
!!! note
When netplay is enabled, EmulatorJS loads some assets (including localization files) from the nightly CDN (`https://cdn.emulatorjs.org/nightly/...`). This differs from stable mode, which uses local/bundled assets. Occasional temporary issues (e.g., 404 errors or untranslated UI elements) can occur if the nightly CDN has mismatches, but these usually resolve with the next EmulatorJS stable release integrated into RomM.

### Supported systems

Note that only the following systems are currently supported:
Expand Down