Getting Started

Getting Started

ReyEngine is a desktop editor for League of Legends maps, characters and other assets — you point it at your game install and a project folder, and it edits copies of the game's own files (.bin, mapgeo, textures) without ever touching the game itself. This page gets a fresh install running: downloading it, the first-run wizard, and where to open your first project.

Install

Every release on the Releases page ships two files:

File	What it is
ReyEngine-vX.Y.Z-win-x64.msi	An installer for the current Windows user. It puts ReyEngine under %LocalAppData%\Programs\ReyEngine, adds a Start menu entry (and a desktop shortcut if you leave the box ticked), needs no administrator rights, and upgrades in place. Uninstall from Windows' Installed apps.
ReyEngine-vX.Y.Z-win-x64.zip	The same build as a portable folder. Unzip anywhere and run ReyEngine.App.exe. Uninstall by deleting the folder.

Both are self-contained; there is no .NET runtime to install. The installer is not code-signed yet, so Windows SmartScreen may ask once on first run.

The installer's options page has one question that matters: Install new releases automatically. Ticked, ReyEngine downloads and installs a new release by itself and restarts; unticked, it shows the release notes and asks first. A scripted install can set the same choice with msiexec /i ReyEngine-vX.Y.Z-win-x64.msi AUTOUPDATE=0. Whatever the installer chose, the setting under Edit ▸ Preferences… ▸ General ▸ Updates wins once you change it there.

Updates

ReyEngine checks GitHub for a newer release when it starts (and on Help ▸ Check for Updates…). When one exists, a dialog shows the release's own notes under What changed and offers Update now, Later or the Download page. After the update, Help ▸ What's New… lists what arrived. Three modes are available under Preferences ▸ General ▸ Updates:

• Ask me — show the changelog, you decide. The default.
• Install automatically — download, install and restart without asking.
• Manual — only open the download page, as older versions did.

An MSI install updates through the new .msi; a zip install replaces its own folder and restarts. In both cases your projects and settings are untouched.

The setup wizard

The first start opens the setup wizard (Help ▸ Setup Wizard… brings it back at any time). Every step is optional and everything can be changed later in Preferences:

1. League of Legends install — the game folder. ReyEngine accepts the install root, the Game folder, or Game/DATA/FINAL and finds the WADs from any of them. This matters more than it looks: a mod project usually ships only the files it changes; everything else — base textures, meshes, skin bins — resolves from the installed game as a read-only fallback. Without a game folder, assets your project does not carry simply appear missing.
2. File-name hashes (recommended) — League stores file paths as 64-bit hashes. Without a hash database, files show up as hex strings like 0x3c8a1d2b9e4f7a01 instead of assets/maps/.../ground.dds. The wizard downloads the CommunityDragon lists; later, Tools ▸ Hashes & Names ▸ Sync Hashes (CommunityDragon) refreshes them (do that after big game patches). Sync Hash Tables (Mimir) reads the native .hashdb format, so hash tables no longer arrive as hundreds of megabytes of text.
3. Audio decoder (vgmstream) — needed to play sounds in the Audio editor and the character preview.
4. Dominion preview map (optional) — a small map to try the editor on without a project of your own.

The game folder can also be set later under Project ▸ Set Game Folder….

Open something

• File ▸ Import .fantome… — turn an existing mod package into an editable project. See Projects.
• File ▸ New Project… — start from a template.
• File ▸ Open Project… / Open Project Folder… / Open Recent — existing projects.
• File ▸ Open WAD (inspect)… — look inside any .wad.client without creating a project.
• File ▸ Open Legacy Map (NVR)… — view a pre-mapgeo era map. See Legacy Maps.
• Tools ▸ Character Editor… — pick a champion straight from the installed game. See Character Editor.

Once a project with a map is open, the mapgeo loads into the viewport automatically. From there, Maps and Viewport is the tour.

A note on audio names

Wwise audio events also live as hashes. Tools ▸ Hashes & Names ▸ Rebuild Wwise Name Index recovers real event names by scanning the game's own bins, which makes the Audio editor show Play_sfx_... names instead of numeric ids.