Merge pull request #64 from rommapp/copilot/update-documentation-netplay-cdn

docs: add nightly CDN disclaimer for EmulatorJS netplay
This commit is contained in:
Georges-Antoine Assi
2026-03-09 23:08:18 -04:00
committed by GitHub
2 changed files with 13 additions and 5 deletions
+9 -5
View File
@@ -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:
@@ -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:
@@ -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.
@@ -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: