Documentation Index
Fetch the complete documentation index at: https://mintlify.com/legendary-gl/legendary/llms.txt
Use this file to discover all available pages before exploring further.
legendary eos-overlay manages the Epic Online Services (EOS) overlay, which provides in-game UI elements such as friend lists and notifications for EOS-enabled titles. The command handles the full lifecycle of the overlay — downloading and installing it, enabling or disabling it globally or for a specific WINE prefix, and removing it entirely when no longer needed. On Linux and macOS the overlay is wired into a WINE prefix via registry entries; the --prefix, --app, and --bottle flags give you fine-grained control over which prefix is targeted.
Usage
Actions
| Action | Description |
|---|---|
install | Download and install the EOS overlay from Epic’s CDN |
update | Update the overlay to the latest available version |
remove | Remove the overlay installation |
enable | Register the overlay in a WINE prefix so it is loaded by games |
disable | Deregister the overlay from a WINE prefix |
info | Print information about the currently installed overlay |
Options
| Flag | Description |
|---|---|
--path <path> | Path to the EOS overlay folder to install into or enable from |
--prefix <path> | WINE prefix in which to register or deregister the overlay |
--app <App Name> | Use the WINE prefix configured for this app in Legendary’s config (requires the app to have wine_prefix set) |
--bottle <bottle> | WINE bottle name to use (macOS CrossOver) |
Examples
Install the overlay for the first time:The
enable and disable actions write to or remove from the Windows registry inside the target WINE prefix. You must specify a prefix using --prefix, --app, or --bottle when running these actions, otherwise Legendary cannot determine which prefix to modify.