HERONITE
EN
Star181Download

Heronite docs

Install, set up and use Heronite on Linux and Windows. Can’t find something? Ask in Discussions.

Start · Install Heronite, set it up and fix what goes wrong.

  • Installation

    Install Heronite on Windows 10 and 11 or any Linux distribution: installer, portable zip, AppImage, .deb, .rpm and Arch packages, updates, removal.

  • Getting started

    Set up your game library on Linux or Windows: log in to Epic, GOG and Amazon, add other games, learn the shortcuts, organize and play.

  • FAQ

    Is Heronite free? Short answers on Steam Deck support, anti-cheat, how it differs from Heroic, Lutris and Playnite, login safety and portable use.

  • Troubleshooting

    Fix Heronite that won't start, store logins that fail, update errors and Linux games that crash, then find the logs and report a bug.

Guides · Each part of the app, explained.

  • Stores and launchers

    How Heronite handles Steam, Epic Games, GOG, Amazon Games, Battle.net, EA app, Ubisoft, Rockstar, the Microsoft Store, Heroic, Lutris and Playnite.

  • Emulation

    Emulators and ROMs in Heronite: supported emulators, default RetroArch cores, ROM folder layout, multi-disc games and RetroAchievements.

  • Wine and Proton

    Run Windows games on Linux with Heronite: Wine Manager, Proton builds, prefixes, per-game options like DXVK and gamescope, sandbox and anti-cheat.

  • Console mode

    Heronite console mode: turn it on, controller and keyboard buttons, layouts and themes, sharing themes and the in-game overlay on Linux.

  • Metadata and art

    Where Heronite gets game covers, art and details, how to add SteamGridDB and IGDB keys, and how to show Steam and RetroAchievements achievements.

  • Backups and saves

    Back up your Heronite Collection on a schedule and game saves with Ludusavi, sync Epic and GOG cloud saves, and keep one library on several PCs.

  • Sync between PCs

    Keep statuses, favourites, notes and play time the same on every PC, or on both sides of a Linux and Windows dual boot, through a shared folder or your cloud.

Reference · Shortcuts, options, files and formats.

  • Keyboard shortcuts

    Every Heronite keyboard shortcut: switching pages, the command palette, the Collection, search, settings, screenshots and the in-game overlay.

  • Command line and links

    Start Heronite from scripts: command line options like --launch, --console and --no-gui, game ids for each store, and heronite:// links.

  • Files and folders

    Where Heronite keeps its data, settings, cache, screenshots and logs on Linux and Windows, what is inside, and how the portable copy works.

  • Environment variables

    The HERONITE_* environment variables: use another data folder, point at Steam, and turn off update checks, the tray, controller input or animations.

  • Console theme format

    The .heronite-theme.json file format for console mode themes: the rules, a full example, and every field you can set by hand in the file.

Contribute · Help make Heronite better.

  • Translating

    Translate Heronite: how the JSON language files work, how to fix a translation, check your work, and add a new language by pull request.