Pause Reference Media
The HyperOverlay pause menu shows guides, magazines, move lists, reference videos, and extras from your media override folder, next to your other custom media. You supply the files. HyperHQ never uploads or downloads them, and they work offline.
Manuals, artwork, controls, and Video Snaps keep their usual media locations. Reference videos use their own folder, separate from Video Snaps.
Categories and formats
| Pause menu section | Folder | Supported files |
|---|---|---|
| Guides | Guides | PDF, CBZ, TXT, images, page folders |
| Magazines | Magazines | PDF, CBZ, TXT, images, page folders |
| Move sheets | Move Lists | PDF, CBZ, TXT, images, page folders |
| Command lists | Move Lists/_commands | command.dat with optional PNG icons |
| Reference videos | Reference Videos | MP4, WebM |
| Extras | Reference Extras | PDF, CBZ, TXT, images, page folders, MP4, WebM |
- Images: PNG, JPG, JPEG, WebP, GIF, and BMP.
- Page folders: a subfolder of images shows as one item. Pages sort by file name, so number them
001.png,002.png, and so on. - CBZ: a ZIP archive of images. Use standard ZIP compression without a password.
- TXT: the viewer opens text files up to 1 MB.
- Video: use H.264 video with AAC audio in MP4, or VP9 video with Opus audio in WebM. Other encodings are not tested and often fail to play. Save MP4 files with the index at the start (faststart), and WebM files with cues at the start.
RAR, 7Z, CBR, and other archive formats are not supported. Convert those files to CBZ or PDF.
Add files in HyperHQ
- Open Media in HyperHQ.
- Select Pause media.
- Choose a system, then choose a game. Use the search field to filter long game lists.
- Select a category, such as Guides.
- Select Open game folder. HyperHQ creates the folder and opens the location in your file manager.
- Copy your files into the folder. For a single item, name the file after the game and put the file beside the folder instead, such as
Guides/fighter.pdf. - Select Rescan. Matched files lists each item with its format and source.
- Launch the game from HyperSpin or HyperHQ, open the pause menu, and select Media.
Use Open system defaults and Open global defaults for files shared by many games. See Defaults.
HyperOverlay reads the folders each time the pause menu opens. After you change files during a game, close the pause menu and open the menu again.
Folder layout
Pause media lives in your media override folder, in one folder per category under each system. This example uses a system named Arcade and a game with the ROM file fighter.zip:
HyperSpin/
Media/
Arcade/
Guides/
fighter.pdf
fighter/
Walkthrough.pdf
Routes.txt
default.txt
Magazines/
fighter/
Issue 01.cbz
Issue 02/
001.png
002.png
Move Lists/
fighter.pdf
_commands/
command.dat
icons/
_6.png
Reference Videos/
fighter/
Basics.webm
Default/
Reference Extras/
Cabinet layout.png
| Scope | Location |
|---|---|
| One game, one item | Media/<System>/<Category>/<Game>.<ext> |
| One game, several items | Media/<System>/<Category>/<Game>/ |
| System default | Media/<System>/<Category>/default.<ext> or default/ |
| Global default | Media/Default/<Category>/ |
A file named after the game and a folder with the same name both count. Each file and each page folder inside a game folder becomes one item. Put every magazine issue, walkthrough, and clip in its own file so you select each one separately.
- The pause menu label for a file inside a folder is the file name without the extension.
Issue 01.cbzshows as Issue 01. A single file named after the game shows the game's title. - Items sort by name.
- One category holds up to 128 items for a game. A page folder holds up to 512 pages.
HyperHQ skips these entries:
- Names starting with a dot,
_readme, or_place - Unfinished downloads ending in
.tmp,.part, or.crdownload - Shortcuts, symbolic links, and junctions
- Empty files and unsupported formats
How HyperHQ matches a game
Pause media uses the same names as the game's other override media, such as its logo or box art. Open game folder creates the folder with the same name HyperHQ gives new override files. HyperHQ also accepts these names, checked in order:
- Each ROM file name without the extension, such as
fighterforfighter.zip - The game's title, with characters Windows does not allow in file names replaced by
_ - The game's reference ID
- Folder aliases set for the game
- The game's HyperHQ ID, used by folders from earlier versions
Multi-disc games then check the main disc's names. Clones then check the parent game's names. A clone of sf2 uses Guides/sf2.pdf or Guides/sf2/ when the clone has no guides of its own.
HyperHQ uses the game's installed system, including launches from a collection.
When two games in the same system claim one name, HyperHQ skips the name and shows More than one match. Rename the file or folder to the name from Open game folder.
Windows ignores letter case in folder and file names. On Linux and case-sensitive macOS volumes, match the spelling on disk exactly. Guides/Fighter/ and Guides/fighter/ are different folders there.
Defaults
HyperHQ checks each category on its own and uses the first match with supported files:
- The game's file and folder
- The system's
defaultfile and folder (folders named_defaultsfrom earlier versions still work) - The global
Defaultfolder
Defaults fill gaps. A game with its own files replaces the defaults for the same category. A game with its own guides shows only those guides, and still shows the system's default magazines when the game has no magazines.
Where the files live
Pause reference media follows the media override folder, the same as every other override type. Change the folder in HyperHQ under Settings, Application Paths, Media overrides folder. A system with its own media override folder uses the system folder instead. The Pause media dialog shows the folder in use for the selected system.
Earlier versions had a separate Change root setting for pause media. HyperHQ no longer reads the setting. If you set a root there, the Pause media dialog shows the old location; move the files into the media override folder.
On Windows, a media override folder on a mapped drive or UNC path such as \\server\share\Media works. When the drive or share is offline, Pause media shows Folder unavailable. Reconnect the drive and select Rescan.
Command lists
Command lists show move lists parsed from a command.dat file, with optional button icons. Move sheets in PDF or image form stay available with or without a command list.
Set up the command file
HyperHQ reads these default locations for each system:
Media/<System>/Move Lists/_commands/command.datMedia/<System>/Move Lists/_commands/icons/
To use a file in another location:
- Open Pause media, choose the system and a game, and select Move Lists.
- Select Choose DAT file. Select Use default DAT to return to the default location.
- Select Choose icon folder for button icons. Select Use default icons to return to the default location.
- Choose the file encoding: UTF-8, Shift_JIS, or Windows-1252. Files saved with a UTF-8 byte order mark always read as UTF-8.
The status line shows the result for the selected game:
| Status | Meaning |
|---|---|
| No command DAT file is available. | No file exists at the default location and no file is selected. |
| A command list matched this game. | The pause menu shows a command list for this game. |
| No command list matched this game. | The file has no record for this game's names. |
| More than one command record or installed game claimed this name. | Two records or two games share the name. HyperHQ skips the record. |
| The command DAT file or settings could not be read. | Check the file and the encoding. |
File format
Each record starts with an $info= line listing ROM names separated by commas. $cmd blocks hold the move text and end with $end. Headings in the form - CHARACTER -, followed by a ruled line, split the text into sections.
$info=fighter,fighterj
$cmd
- KAI -
──────────
_6_2_3 + _A Rising Blade
$end
HyperHQ matches records with the same names used for game folders, including clone parents. The file limit is 16 MB.
Command icons
Name each icon after the token in the move text. _6.png replaces _6, and @F-button.png replaces @F-button.
For tokens with punctuation, or to keep upper and lower case tokens apart on Windows, name the file with the token's bytes in uppercase hexadecimal. 5F2B.png shows for _+.
Icons must be PNG files up to 256 by 256 pixels and 16 KB each. A missing or unreadable icon shows the token text.
Browse reference media in the pause menu
- Open the pause menu with F2 or Modifier + Start.
- Select Media.
- Choose a category, then an item.
| Action | Keyboard | Controller |
|---|---|---|
| Move or turn pages | Arrow keys | D-pad or left stick |
| Select | Enter or Space | A |
| Back | Escape | B |
| Zoom in, zoom out, reset zoom | =, -, 0 | On-screen zoom buttons |
Documents and page folders show page buttons, a page selector, zoom buttons, and Fullscreen. HyperOverlay keeps your page and scroll position for each document until the game closes. Videos stop when you leave the viewer or resume the game.
Existing manuals, artwork, and controls stay under Artwork & manuals in the same Media list.
Move files from RocketLauncher
- In HyperHQ, use Open game folder to find the new location for each game.
- Copy guides, magazines, and move sheets into the matching category. Keep the pages of one issue together in a page folder or a CBZ.
- Put manuals, artwork, and controls in their usual HyperSpin media locations.
- Convert unsupported archives and videos to the formats above.
- For command lists, copy your per-system DAT to
Move Lists/_commands/command.dat, or select the file with Choose DAT file. Rename PNG icons to match the tokens.
Copy only content you have permission to use. HyperHQ does not ship a reference library.
Troubleshooting
Pause media notices
| Notice | Fix |
|---|---|
| More than one match | Two games or systems claim the same name. Use the folder from Open game folder. |
| Folder unavailable | Reconnect the drive or share, then select Rescan. |
| Folder settings unavailable | Check the media override folder under Settings, Application Paths. |
| Linked path skipped | Move the real files into the folder. HyperHQ skips shortcuts, symbolic links, and junctions. |
| Unsupported format | Convert the file to a supported format. |
| File or folder cannot be read | Check file permissions. On Linux, give your user account read access. |
| Invalid CBZ archive | Rebuild the CBZ as a standard ZIP of images without a password. |
| Folder or archive exceeds the scan limit | Split the content. A category holds 128 items and a page folder holds 512 pages. |
| Storage is busy. Rescan when available. | Wait for other file work to finish, then select Rescan. |
A file is missing from the pause menu
- Select Rescan in Pause media and confirm the file appears under Matched files.
- Check Defaults. A game with its own files hides the defaults for the same category.
- Close the pause menu and open the menu again after changing files during a game.
A video opens but does not play
Re-encode the video as H.264 with AAC in MP4, or VP9 with Opus in WebM. Save MP4 files with faststart and WebM files with cues at the start.
A text file does not open
The viewer opens text files up to 1 MB. Split larger files or save them as PDF.