Skip to content

docs: add nightly CDN disclaimer for EmulatorJS netplay#64

Merged
gantoine merged 3 commits intomainfrom
copilot/update-documentation-netplay-cdn
Mar 10, 2026
Merged

docs: add nightly CDN disclaimer for EmulatorJS netplay#64
gantoine merged 3 commits intomainfrom
copilot/update-documentation-netplay-cdn

Conversation

Copy link
Contributor

Copilot AI commented Mar 10, 2026

When netplay is enabled, EmulatorJS loads assets (including localization files) from the nightly CDN (https://cdn.emulatorjs.org/nightly/...) rather than local/bundled assets — an implementation detail that has caused user confusion and 404 errors in the past.

Changes

  • Platforms-and-Players/EmulatorJS-Player.md — Added a note admonition at the end of the Netplay section explaining the nightly CDN behavior and potential temporary issues.
  • Getting-Started/Configuration-File.md — Added the same note admonition after the netplay YAML block in the config reference.

Both notes read:

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.

Original prompt

This section details on the original issue you should resolve

<issue_title>[Other] Documentation should mention using EmulatorJS nightly CDN when netplay is enabled.</issue_title>
<issue_description>### Describe the request / problem
The RomM documentation (EmulatorJS player section and config.yml reference) explains how to enable netplay. However, it doesn't mention that enabling netplay causes EmulatorJS to load certain assets, such as localization files, from the nightly CDN (https://cdn.emulatorjs.org/nightly/...) instead of the bundled/local assets used when netplay is disabled.

This is an implementation detail that isn't obvious to users. It led to confusion and 404 errors on localization files in the past (see closed issue rommapp/romm#2855), due to filename mismatches/changes on the EmulatorJS nightly CDN (e.g., from lang_country.json to lang.json or similar). Even after fixes or stable releases, users might still encounter temporary issues, console errors, or missing translations without knowing the cause.

Suggested change

A simple disclaimer to help avoid future confusion and issues such as:

"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."
</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI changed the title [WIP] Update documentation to mention nightly CDN with netplay docs: add nightly CDN disclaimer for EmulatorJS netplay Mar 10, 2026
@gantoine gantoine marked this pull request as ready for review March 10, 2026 03:05
@gantoine gantoine merged commit 609678a into main Mar 10, 2026
2 checks passed
@gantoine gantoine deleted the copilot/update-documentation-netplay-cdn branch March 10, 2026 03:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants