Skip to content

Commit 609678a

Browse files
authored
Merge pull request #64 from rommapp/copilot/update-documentation-netplay-cdn
docs: add nightly CDN disclaimer for EmulatorJS netplay
2 parents 310dbc6 + 1e5a94d commit 609678a

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

docs/Getting-Started/Configuration-File.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ Fine-tune which ROMs or files are excluded.
2727
Applies to ROMs that are single files (not in subfolders).
2828
2929
- **extensions**: Exclude files by extension
30-
- Defaults to `["db", "ini", "tmp", "bak", "lock", "log", "cache", "crdownload"]`
30+
- Defaults to `["db", "ini", "tmp", "bak", "lock", "log", "cache", "crdownload"]`
3131
- **names**: Exclude files by name or pattern (supports Unix wildcards)
32-
- Defaults to `[".DS_Store", ".localized", ".Trashes", ".stfolder", "@SynoResource", "gamelist.xml"]`
32+
- Defaults to `[".DS_Store", ".localized", ".Trashes", ".stfolder", "@SynoResource", "gamelist.xml"]`
3333

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

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

5353
```yaml
5454
exclude:
@@ -285,6 +285,10 @@ emulatorjs:
285285
credential: "openrelayproject"
286286
```
287287

288+
<!-- prettier-ignore -->
289+
!!! note
290+
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.
291+
288292
### Settings
289293

290294
Configure core-specific settings. Use `default` to apply settings to all cores.

docs/Platforms-and-Players/EmulatorJS-Player.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@ emulatorjs:
6868

6969
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.**
7070

71+
<!-- prettier-ignore -->
72+
!!! note
73+
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.
74+
7175
### Supported systems
7276

7377
Note that only the following systems are currently supported:

0 commit comments

Comments
 (0)