Skip to main content

Plugins

Linux plugins​

Install a plugin release matching Linux and your CPU architecture. See Linux plugin requirements. Windows access-control repair does not replace Linux ownership and executable permissions.

Plugins add optional features to HyperHQ. Use the built-in Plugins page to install and manage them.

Open Plugins​

  1. Select Plugins from the HyperHQ sidebar.
  2. Browse the available plugins.
  3. Select a plugin to read its description and requirements.

Installed plugins appear separately from plugins available for download.

Install a plugin​

  1. Open the plugin details.
  2. Review its purpose and any required software.
  3. Select Install.
  4. Follow the setup steps shown by the plugin.
  5. Wait for installation to finish.

Some plugins add a page or action after installation. Others work in the background with HyperSpin.

Configure a plugin​

Open the installed plugin and select its settings or setup action. The available choices depend on the plugin.

Common choices include:

  • A path to another program
  • A feature toggle
  • A system selection
  • A guided setup action

Save the plugin settings before leaving the page.

Accounts and setup wizards​

Use the plugin's account connection or setup action when available. Complete the wizard steps, save your choices, and reconnect if authorization expires. Available controls depend on the installed plugin manifest.

For RetroAchievements emulator sign-in:

  1. Save your RetroAchievements username and Web API key in Plugin Settings.
  2. Open RetroAchievements emulator sign-in below the account settings.
  3. Select the supported emulators found by the plugin.
  4. Select Review selected emulators and read the configuration changes.
  5. Close the selected emulators, then complete sign-in.

The host reuses verified login tokens without saving your password in plugin settings. Sign in inside DuckStation to preserve its encrypted login. Supported emulator settings also expose the same sign-in flow.

Add a plugin repository​

Configured public GitHub repositories are development-only. Production builds disable the repository controls and install path.

In a matching development build:

  1. Select the repository plus button on Plugins, or open Plugin repositories from Settings.
  2. Select Add repository and paste a public GitHub repository root URL.
  3. Read the source status, then return to Plugins and install the compatible package.
  4. Complete the plugin setup.

Automatic updates default to off for each source. Removing a repository keeps the installed plugin and settings. Use the separate plugin uninstall action to remove the installation.

Read Plugin Repositories for supported URLs, release assets, updates, and publisher requirements.

Check for updates​

Use Check for Updates from the Plugins page or an installed plugin's details. HyperHQ compares the installed version with the plugin's published release when update information is available.

Use View Changelog to review release details before updating. Select the update action from the changelog or plugin details to install the published version.

Reinstall a plugin​

Use Reinstall for a marketplace plugin when files are missing, damaged, or out of date. HyperHQ downloads a fresh copy and replaces the installed version through a recoverable transaction.

Close any program using the plugin folder before reinstalling. Open Activity to follow the current step.

Remove a plugin​

  1. Open the installed plugin.
  2. Select Remove.
  3. Confirm the action.

Removing a plugin stops its features. Library data created through the plugin might remain in HyperHQ.

Follow plugin work​

Long-running plugin work appears under Activity. Open Activity to see progress, completed tasks, or a task needing attention.

Common problems​

Installation fails​

  • Confirm the PC has enough free disk space.
  • Leave HyperHQ open during the download.
  • Open Activity for the failure reason.
  • Retry from the plugin details page.

On Windows, HyperHQ checks whether access control on the plugin folder caused the failure. If repair requires administrator access, HyperHQ shows a permission-repair prompt. Approve the prompt to repair only the selected plugin folder and resume the interrupted install or reinstall.

Canceling the prompt leaves permissions unchanged. A locked-file result means another process still holds a plugin file. Close the related program, then retry.

A plugin opens but does nothing​

Open the plugin details and complete its setup action. Confirm any required program is installed at the selected path.

A plugin disappears​

Restart HyperHQ, then check Installed again. Use Reinstall when the marketplace plugin's files were removed from the HyperSpin folder.

A plugin task stays active​

Open Activity and read the current step. Close the related external program when the plugin needs exclusive access to its files.