Skip to content

docs: refresh alternate UI documentation #94

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 1 commit into from
Jul 14, 2026
Merged

docs: refresh alternate UI documentation #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion docs/Navigation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ search:
- [RetroAchievements](using/retroachievements.md)
- [ROM Patcher](using/rom-patcher.md)
- [Netplay](using/netplay.md)
- [Console Mode](using/console-mode.md)
- [Account & Profile](using/account-and-profile.md)
- [Languages](using/languages.md)
- Platforms & Players
Expand Down
6 changes: 3 additions & 3 deletions docs/developers/architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ rommapp/romm
│ ├── tasks/ # RQ jobs: scheduled/ and manual/
│ ├── alembic/ # 80+ DB migrations
│ └── config/ # Env vars + YAML config.json manager
├── frontend/ # Vue 3 + Vuetify SPA (main UI + Console Mode)
├── frontend/ # Vue 3 + Vuetify SPA (main UI + alternate UI)
│ └── src/
│ ├── views/ # Page-level components
│ ├── components/ # ~168 components, organised by feature
│ ├── console/ # Console Mode SPA (own router, layout, input bus)
│ ├── console/ # Alternate UI SPA (own router, layout, input bus)
│ ├── stores/ # 18 Pinia stores
│ ├── services/ # Axios API modules + socket.io + browser cache
│ └── __generated__/# TS types generated from the backend OpenAPI spec
Expand Down Expand Up @@ -109,7 +109,7 @@ Three layouts cover the routes:

Permission-protected routes follow the scope model from [Users & Roles](../administration/users-and-roles.md): `/scan` and `/library-management` require `platforms.write`, `/client-api-tokens` requires `me.write`, and `/administration` requires `users.write`.

### Console Mode
### Alternate TV and gamepad UI

A second SPA bundle aimed at TVs and gamepads is kept under `frontend/src/console/`. The input system is a stack-based bus with grid-based spatial navigation, gamepad polling runs in `requestAnimationFrame`, and the sound effects are synthesised on the fly through the Web Audio API rather than shipped as audio assets.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ RomM (ROM Manager) lets you scan, enrich, organise, and play your game collectio

***

Library, collections, saves & states, Console Mode, ROM Patcher, Netplay.
Library, collections, saves & states, ROM Patcher, Netplay.

[Using RomM →](using/index.md)

Expand Down
2 changes: 0 additions & 2 deletions docs/reference/glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ Every term the docs, UI, and API use consistently, with foundational concepts ge

**Collection**: a named grouping of ROMs (see [Collections](../using/collections.md)).

**Console Mode**: separate `/console` UI optimised for gamepads and TV displays: spatial navigation, bigger hit targets, SFX, no mouse required. Same instance, same data (see [Console Mode](../using/console-mode.md)).

**Device**: a registered endpoint that syncs with RomM, such as a handheld running Grout, an Android phone running Argosy, or a SteamDeck running DeckRommSync. Devices pull saves and states, and some push them back after a session (see [Device Sync Protocol](../developers/device-sync-protocol.md)).

**EmulatorJS**: the bundled in-browser retro emulator. Handles NES, SNES, N64, PSX, Saturn, and 20+ more cores (see [In-Browser Play → EmulatorJS](../using/in-browser-play/emulatorjs.md)).
Expand Down
33 changes: 0 additions & 33 deletions docs/using/console-mode.md
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions docs/using/in-browser-play/emulatorjs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ description: Play retro games in your browser
Older or less-powerful devices may struggle, especially with demanding cores (Dreamcast, Saturn, PSP). Try a different browser or device before filing a bug.

<!-- prettier-ignore -->
!!! note "Some cores don't work in Console Mode"
PSP (`ppsspp`) and MS-DOS (`dosbox-pure`) aren't supported in [Console Mode](../console-mode.md).
!!! warning "PSP requires HTTPS"
PSP games use the `SharedArrayBuffer` API through the `ppsspp` core. Browsers only expose this API in secure, cross-origin-isolated contexts, so RomM must be served over `https://` for PSP games to run. See the [SharedArrayBuffer browser requirements](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) and use a [reverse proxy with TLS](../../install/reverse-proxy.md) if needed.

<!-- prettier-ignore -->
!!! note "Zip bundles for multi-file firmware"
Expand Down
4 changes: 0 additions & 4 deletions docs/using/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,6 @@ description: Browse, play, collect, patch, and share from the UI
- **[RetroAchievements](retroachievements.md)**
- **[Account & Profile](account-and-profile.md)**

## Special modes

- **[Console Mode](console-mode.md)**

## Tools

- **[ROM Patcher](rom-patcher.md)**
Expand Down
Loading