DOCSEARCHbyAlgolia
Submit Docs

HyperHQ Documentation

website·Indexed 31 days ago

https://docs.hyperai.io

Developer and user guides for HyperHQ, featuring documentation on plugin development using Python and C#, the HyperTheme builder for creating animations and 3D projections, and setup guides for HyperSpin and Linux environments.

Tokens
103K
Snippets
206
Records
792
Agent score
52%

What's inside HyperHQ

  1. Overview of Theme Builder Shader Categories

    Shaders are GPU-accelerated programs used to create complex visual effects. In the editor browser, these are organized into the following categories:

    1. Transform Shaders: Movement and deformation (e.g., Flag).
    2. Color Shaders: Color manipulation (e.g., Grayscale, Color Replace, Adjustment).
    3. Blur & Focus Shaders: Blur effects (e.g., Blur, Gaussian, Tilt Shift).
    4. Style Shaders: Artistic styles (e.g., ASCII, Cross Hatch, Outline, Bevel).
    5. Effect Shaders: Visual effects (e.g., Bloom, Ripple, Stripes, Circles, Rays).
    6. Transition Shaders: Reveal and wipe effects (e.g., Swipe, Reveal Left/Right/Top/Bottom).
    7. Preset Filters: Pre-configured combinations (e.g., CRT, Old Film, RGB Split, Tilt Shift).

  2. Overview of HyperHQ Plugins

    HyperHQ plugins are self-contained add-ons used to extend the application's functionality without modifying the core installer. They are typically used for game platform integrations, emulator workflows, achievement syncing, hardware support (LEDs, controllers), and automation hooks. Plugins consist of a plugin.json manifest and optional settings or actions, communicating with HyperHQ via a local channel.

  3. Overview of HyperTheme for HyperSpin

    HyperTheme is a browser-based editor used to create animated themes for HyperSpin. It allows developers to build layouts on a visual canvas, organize media as layers, and control motion via a timeline. It supports themes for systems, games, collections, and shared fallback layouts, incorporating elements such as background media, logos, metadata fields, shapes, visual effects, and audio layers.

  4. Overview of HyperTheme 3D Projection

    3D Projection in HyperTheme allows developers to transform flat 2D layers into elements that simulate 3D perspective and depth. It is a 2D transformation that mimics 3D space by distorting layers; it is not true 3D modeling and does not support full 3D rotation, lighting, or shadows. It is ideal for perspective text (e.g., Star Wars-style crawls), simulated 3D panels, floor reflections, and stylized artistic distortions. It is not recommended for realistic 3D objects, complex 3D scenes, or very small text that may become illegible when distorted.

  5. Overview of HyperHQ plugin architecture

    HyperHQ supports JavaScript plugins and executable plugins. Executable plugins communicate using stdin/stdout or authenticated Socket.IO. The plugin's behavior, entry point, settings, actions, and permissions are defined in a plugin.json manifest file. Plugins run in separate processes to ensure that a plugin crash does not affect the main HyperHQ application.

  6. Overview of HyperHQ for HyperSpin

    HyperHQ is the management interface for HyperSpin builds. It allows users to manage systems, games, media, controls, and cabinet extras through a GUI instead of editing configuration files manually. It supports both desktop setups and arcade cabinets.

  7. HyperHQ Plugin Overview and Types

    A HyperHQ plugin is a folder located in the plugins/ directory of a HyperSpin installation, identified by a plugin.json manifest file. There are two supported plugin types:

    1. Executable: A separate process that communicates via stdio or Socket.IO. These run with the signed-in user's privileges. This is the preferred method for independent integrations.
    2. JavaScript: JavaScript code loaded by a renderer compatibility runner with simulated isolation and limited host APIs.

  8. Set up HyperSpin systems on Linux

    The system wizard on Linux is identical to other platforms, with the following specific requirements:

    • Platform Selection: Choose a platform release that matches both Linux and your specific CPU architecture. Use Manual setup if no matching download is available in the catalog.
    • ROM Paths: Use standard Linux paths (e.g., /home/user/Games/Arcade). Ensure filename case matches and external drives are mounted before importing.
    • Flatpak Emulators: You must manually grant the emulator access to the required ROM, BIOS, and save folders.
    • Verification: Always test the game inside the emulator first before attempting to launch it via HyperHQ.

  9. HyperSpin Linux System Requirements

    To run HyperSpin on Linux (currently in alpha), the following requirements must be met:

    • Operating System: Bazzite, SteamOS Desktop Mode (on Steam Deck), or Ubuntu Desktop.
    • Processor: x64 architecture (including Steam Deck). All apps, native helpers, and plugins must match this architecture.
    • Desktop: A working graphical session (X11 or Wayland). Note that Steam Gaming Mode requires separate testing.
    • Graphics: A working GPU driver with accelerated rendering for HyperSpin and HyperTheme.
    • Storage: A writable HyperSpin folder, space for media/extraction, and an executable filesystem for apps and plugins.
    • Accounts/Network: A HyperSpin account and internet access for sign-in, downloads, and connected services.
    • Games: Linux emulator builds or a configured compatibility runtime for each platform.
    • Controls/Sound: Linux-recognized devices with appropriate user access and working audio output.

  10. Manage assets in the Theme Builder Library

    The Library is located in the left panel (Library tab) and serves as the asset browser and manager for the theme. It stores all uploaded images, audio files, video files, and imports. Note that text layers, shapes, and dynamic metadata elements created in-app are not stored in the Library.

  11. Choose a Linux distribution for HyperSpin

    HyperSpin's Linux alpha targets x64 architectures. While Bazzite is recommended for a quick start on gaming PCs or cabinets due to pre-shipped gaming tools and KDE, other distributions are supported. The primary supported paths are Bazzite, Ubuntu Desktop, and SteamOS Desktop Mode on Steam Deck.

  12. Install and manage HyperHQ plugins on Linux

    HyperHQ plugins add optional features and are managed via the built-in Plugins page. When installing, ensure the plugin release matches your Linux distribution and CPU architecture. To install a plugin: 1. Select 'Plugins' from the sidebar. 2. Browse and select a plugin to review its description and requirements. 3. Select 'Install' and follow the provided setup steps. 4. Wait for the installation to complete. Installed plugins are listed separately from available downloads.