Install: X-Plane

X-Plane is the E3X’s primary integration: a companion plugin inside the sim starts and stops the E3X with your flight and feeds it live aircraft data. Once installed, there is nothing to launch by hand — start X-Plane and the display comes up with it.

Download the package for your OS from your account page after purchase.

Windows

Run EmreliaE3X-<version>-win-x64-setup.exe. It installs per-user — no administrator prompt — and walks you through four things:

1. Components. The core and display are always installed. Leave the X-Plane plugin, Start-menu shortcuts, and bundled browser engine components checked (without the bundled engine, an installed Chrome or Edge is used instead). If your installer includes the navigation and chart data pack component, it downloads the pack (several GB) during setup — see Data Packs.

2. Your X-Plane folder. The installer finds X-Plane 12 automatically from the X-Plane installer’s own record. If you keep more than one copy, or you’re installing for X-Plane 11, point it at the right folder.

3. “Render inside the 3D cockpit” (optional, unchecked by default): draws the E3X directly on the panel of a generated, E3X-equipped Cessna 172. Requires X-Plane 12.1 or later; leave it unchecked to use the normal display window.

4. Your license key. Paste the key from your purchase email to activate this machine during install. Leave the field empty to install in demo mode (the built-in demo and replay data sources run without a license); you can activate any time later:

   g3x-core license activate <KEY>

   run from the install folder. See License & Activation.

The program installs to %LOCALAPPDATA%\Programs\EmreliaE3X. Your data — settings, activation record, data pack, flight plans — lives separately under %LOCALAPPDATA%\EmreliaE3X\data.

Linux

The Linux build ships as a tarball. Unpack it anywhere and run the installer script inside:

tar xzf emrelia-e3x-<version>-linux-x64.tar.gz
cd emrelia-e3x-<version>-linux-x64
./install.sh

install.sh copies the tree to ~/.local/opt/emrelia-e3x, runs a doctor health check, wires up the X-Plane plugin, adds a desktop entry, and prompts for your license key (press Enter to install in demo mode). Useful flags:

Flag	Effect
--prefix DIR	Install somewhere other than ~/.local/opt/emrelia-e3x
--xplane DIR	Point at a specific X-Plane folder (else auto-detected); --no-xplane skips the plugin
--cockpit	Enable in-cockpit rendering (X-Plane 12.1+)
--key KEY	Activate without the interactive prompt
--data-pack FILE	Install a downloaded g3x-data-*.tar.zst data pack
--yes	Never prompt (for scripted installs)

If the health check reports missing shared libraries for the bundled browser engine, the script prints the exact apt / dnf install line for your distribution. Your data lives under ~/.local/share/emrelia-e3x/data.

What the install wires up

The installer places the companion plugin at <X-Plane>/Resources/plugins/g3x_companion/ and writes its configuration file, g3x_companion.cfg, pointing back at the installed program — the program tree is not copied into X-Plane. You can redo this step any time (after moving X-Plane, say) with:

g3x-core install xplane --root "<X-Plane folder>"

It’s safe to re-run; it rewrites the config in place. It refuses to run while X-Plane is open.

First launch

1. Start X-Plane and load a flight.
2. The plugin starts the E3X, and the display window opens on its own — with the bundled browser engine, or your installed Chrome/Edge as a fallback.
3. Quitting X-Plane closes the E3X with it.

Move and size the window however you like — placement is remembered between flights. Then fly the First Flight walkthrough.

To run the display at your desk without the sim, use the Emrelia E3X (demo, no simulator) Start-menu shortcut (Windows) or desktop entry (Linux).

If something doesn’t come up, run g3x-core doctor from the install folder — it checks the install, plugin wiring, data pack, license, and browser engine in one shot — and see Troubleshooting.

Updating

Run the new installer (or install.sh from the new tarball) over the existing install. Your settings, activation, and data pack live in the data directory and carry over untouched; the license key page is skipped when the machine is already activated.

Uninstall

Windows: use Uninstall Emrelia E3X from the Start menu (or Windows Apps). Linux: run ~/.local/opt/emrelia-e3x/uninstall.sh.

Both remove the program and the X-Plane plugin wiring, and both first check that the simulator is fully closed — if it isn’t, nothing is removed and you’re asked to close it and retry.

You’re then asked two questions, both defaulting to keep:

• Release this machine’s license activation? Keep it if you plan to reinstall — the key stays bound to this machine and a reinstall picks it straight up. Release it if the machine is going away, or free the slot later from your account page.
• Delete the data folder? This removes the downloaded data pack (several GB, slow to re-download) and your settings, activation record, panel layout, and flight plans. Keeping it makes a future reinstall seamless.