Skip to content

WebRcade Integration [DEPRECATED]

Georges-Antoine Assi edited this page Nov 17, 2024 · 2 revisions

⚠️ Support for webRcade will be removed in version 3.0 in favor the built-in EmulatorJS player ⚠️

WebRcade is a platform that enables playing games entirely within the context of the browser across a wide variety of platforms, with support for game pads (Bluetooth and USB) for both front-end navigation and in-game.

RomM exposes an API endpoint that serves a compatible JSON feed of supported platforms and games. Since webRcade runs within the context of your browser, you RomM instances does not need to be exposed to the web. Further documentation can be found in the User Guide.

IMPORTANT: You must set the ROMM_HOST environment variable to your host ip or domain name (including http(s)://, subdomain and port if needed).

IMPORTANT: Due to limitations with webRcade, RomM authentication must be DISABLED for the integration to work.

Some notes and limitations before starting

  • Save & state files cannot be exported from webRcade
  • The JSON feed does not currently support BIOS files
  • Local feeds will not stay up-to-date with your RomM library
  • A bug in the latest release causes the game covers not to load if RomM is not accessible to the internet

Loading the RomM feed

Head to the main page and after hovering over "Categories" click "Show Feeds". Hit the "Add Feed" button at the bottom, select "URL" and paste the following URL, replacing host with the URL of your RomM instance: https://<host>/api/platforms/webrcade/feed.

Home page Feeds Feed URL
Screenshot 2023-12-27 at 11 24 26 PM Screenshot 2023-12-27 at 11 24 41 PM Screenshot 2023-12-27 at 11 25 01 PM

At this point webRcade should automatically load your library; if it doesn't, head back to the Feeds list, select "RomM Feed" at the bottom and click "Load".

Customizing the feed

WebRcade also boasts an editor that can identify supported games and download custom assets. You can leverage this editor to enhance your RomM feed by loading content served by the API and saving the modified feed locally. In the editor, click "Import", paste the RomM feed URL (as above) and hit "Ok". The page should refresh with the contents of the RomM feed.

Editor Import
Screenshot 2023-12-27 at 11 23 56 PM Screenshot 2023-12-27 at 10 39 24 PM

Now select one of the platforms (or all of them) and, under the 3-dot menu, hit "Analyze". A window will appear displaying the progress of the analysis; webRcade is fetching assets from webrcade-assets.

Analyze Progress
Screenshot 2023-12-27 at 11 27 11 PM Screenshot 2023-12-27 at 11 27 34 PM

When you've finished analyzing your library (and making any edits), hit "Save" in the sidebar. A local feed will then be created and stored in the browser's cache, which you can export with the "Export" option in the sidebar. Back in the main window, the local should now appear in your Feed list.

Screenshot

Screenshot 2023-12-27 at 11 28 14 PM