Other languages | Status | How to build | How it works | Want to help? | Credits | License | Discord
Leonida is a static recompilation project. The Xbox Series CPU is x86-64 like a PC, so the game's code is loaded and run natively, and the console's system software is reimplemented. The console's precompiled RDNA2 GPU programs are translated to SPIR-V for Vulkan. The game's models, textures and audio are read from your package. All of this happens on your PC, from your own copy of the game.
Important
This repository does not contain the game, keys or an executable, and it does not explain how to get them. You need your own copy, with its files already readable on disk. Nothing here decrypts or works around any protection. Everything the build creates (the generated shaders, extracted assets, the runtime folder and your saves) comes from your game and stays on your PC. Never share those files.
Discord: https://discord.gg/rexed
Early. The game does not boot yet. Everything that can be done without the game's executable is in place, so work on booting can start as soon as one is available to a developer.
| What | Status |
|---|---|
| Booting, story mode, anything playable | ❌ No |
| Finding and checking your copy (Xbox Series 1.0.2.1) | ✅ Works |
| Shaders: carve, unpack native RDNA2 code, disassemble | ✅ All 26,503 |
| Shaders: RDNA2 → SPIR-V translation | ✅ All 26,503 translated: 2,236 VS, 12,101 PS, 2,689 CS, 9,282 mesh, 195 geometry, with a per-shader metadata index for pipeline creation. All 26,503 passed spirv-val in the LLVM 23.1.5 Linux run at c432cdc. A full-corpus run at 43d4703 also validated all 26,503 after dcd8ecf fixed the SPIR-V ID bound; the intervening dedd75c run was 26,501. --wave64-emulate, on by default there); cross-half wave ops in vertex, pixel and geometry shaders are still approximate |
| Shaders: RDNA2 → SPIR-V translation | ✅ 26,503 / 26,503 translated: 2,236 VS, 12,101 PS, 2,689 CS, 9,282 mesh, 195 geometry, with a per-shader metadata index for pipeline creation. The LLVM 23.1.5 Linux rerun at c432cdc and the LLVM 23.1.3 Windows rerun at 43d0015 both translated all 26,503 (Linux, Windows). Translation and SPIR-V validation are separate steps; validation results are listed below. --wave64-emulate, on by default there); cross-half wave ops in vertex, pixel and geometry shaders are still approximate |
SPIR-V validation (spirv-val) |
✅ 26,503 / 26,503 passed in the LLVM 23.1.5 Linux rerun at c432cdc and in the full-corpus rerun at 43d4703, after dcd8ecf fixed the SPIR-V ID-bound error (Linux rerun, full-corpus rerun). On Windows at 43d0015, all 26,503 translated but 26,501 passed validation; the two ID-bound failures were fixed by dcd8ecf. The intermediate dedd75c run also passed 26,501. |
| Shader translator checked on a real GPU | LEONIDA_W64_EMULATE=1. These are small test shaders: the game's own shaders are checked by spirv-val and by driver pipeline creation (vk_pipeline_check), not by their output |
| Models (OBJ with real names, UVs, material references) | ✅ Exported. A ten-archive scan at decoder pin e293917 recovered 382,781 models with zero readback decode failures. This includes 343,327 models from levels.rpf. A full OBJ export of that archive is pending. See recount and export scope. |
| Texture dictionaries and world texture pools (DDS) | ✅ Exported. Pool entries stored as BCPack are still skipped by the export; a clean-room decoder (tools/bcpack.py) rebuilds BC1, BC3, BC4, BC5, BC6H and BC7 (most BC6H/BC7 chunks need a local history table, which the repo does not ship), and is not wired into rpf9dump yet (notes) |
| Audio banks (AWC: Opus, XMA2) | ✅ Exported whole. Opus repackaged losslessly as Ogg Opus; PCM (codec 0/2) as WAV; XMA2 decoded with ffmpeg. --wav adds 16-bit PCM WAV (notes) |
| Music/radio config | ? Measured. 1,589 audio-config records with exact durations and AWC stream ids; station grouping and content-id lists; no per-track start offsets (notes) |
| PE loader and import shims | gta6rt --run: CRT startup, statics, heap, files, threads, GDK imports through the shims, exit code back). Controllers through a GameInput shim on SDL3 (any controller SDL supports, rumble, DualSense trigger effects and lightbar; built when SDL3 is installed or with -DLEONIDA_SDL3_FETCH=ON, notes). --trace-d3d12 logs every D3D12 call and its outcome for the first boot. Untested against the real executable |
| Xbox D3D12 → Vulkan | |
| Ray tracing (BVH) | BuildRaytracingAccelerationStructure builds BLASes and TLASes on the GPU in the console's XDXR BVH4 layout (the default; LEONIDA_RT_AS=khr uses Vulkan's own acceleration structures instead), which the translated shaders walk themselves through image_bvh_intersect_ray (all four triangle node types, TRI0-TRI3, with the barycentric remap byte); the GPU builder writes TRI0 leaves. Updates refit instead of rebuilding, and clone, compaction and the compacted/current postbuild sizes work; checked against a CPU reference on synthetic scenes. The build descriptions are recovered from the package's XboxBvhBuilder.dll (notes). The game's *_bvh4.rpf packs are measured: offline-built, dehydrated BLASes that rehydrate through that DLL with their geometry from the drawables in levels.rpf (measured on 8 of the 10 sampled BLAS; notes). Not done in the builder: TRI1 pairing, BOX16 nodes, serialization. Open: whether the game rehydrates the packs or rebuilds them (#313) |
The table above is written by hand. To measure it on your own checkout (unit and runtime tests, which rows of
the translator contract were confirmed on a GPU, measured imports, your corpus counts and, with --github, CI
and the D3D- items), run python -I tools/progress_dashboard.py --out <folder outside the repo> and open
progress.html (notes).
Nothing is playable on any platform yet (see Project status). What runs where today:
| Platform | Today |
|---|---|
| Windows | Everything: make_game.py, the tools, and the runtime (gta6rt and the D3D12 → Vulkan layer) with its tests. |
| Linux | The translator, the asset tools and the Vulkan GPU test tools build and run natively (tested on RADV and NVIDIA). The runtime is Windows code: it cross-compiles with clang-cl and xwin, and its tests run under Wine or Proton (The Windows runtime on Linux, under Wine or Proton below). The game is meant to run the same way, under Wine or Proton with the D3D12 layer on native Vulkan (#217). |
| macOS (Apple Silicon) | The Python tools and the Vulkan test tools run natively, on MoltenVK (Homebrew) or KosmicKrisp. The runtime is Windows code and runs as on Linux, under Wine: CrossOver, arm64 with FEX or x86-64 under Rosetta (#1706, #1707, #1924; #3119 fixes the last loader tests there). Known gaps: no geometry stage and no VK_EXT_mesh_shader (those tests are skipped), 32-wide subgroups (wave64 shaders run emulated), and MoltenVK's float handling (PerVertexKHR, NaN compares, -0, the cost of NoContraction); docs/testing.md lists each (#2947). |
| AMD RDNA1 (RX 5000) | A supported target: close to the console's RDNA2, and its 64-wide subgroups run the wave64 shaders natively. RX 5700 XT results pass the GPU test suite (#146); on RADV, pixel shaders without fragment barycentrics have a known difference (Known problems in docs/testing.md) (#330). |
GPU results from every platform are collected in #166; how to run the tests is in docs/testing.md.
The port isn't downloaded ready-made. It's built on your PC from your own copy.
The easy way:
- Install the prerequisites below.
- Download this project with its submodule:
git clone --recursive https://github.com/ItsNotRexed/Leonida. A "Download ZIP" from GitHub leaves outthird_party/rpf9-explorer. The build fetches it ifgitis installed, and otherwise tells you what to do. - Double-click
Build.bat.
It finds your copy of the game by itself: it looks in Downloads, Desktop, Documents (also where Windows keeps them,
such as in OneDrive), Games, your home folder and the top of every drive, two folders deep. It recognises the
version from a few file sizes, without reading anything large. If you have more than one copy it asks which one, and if it finds none it asks you to paste the
folder. Before starting it checks that everything below is installed and that there is enough free space, and it
lists anything missing in one go. The result goes to Documents\Leonida. A stopped build continues where it left
off.
Your game folder is the one that holds MicrosoftGame.Config and the .rpf archives, as plain files.
Prerequisites:
- Your own copy of the Xbox Series package, version 1.0.2.1.
- Windows 10/11 x64, with about 350 GB free for work files. They can go on another drive with
--work. - Python 3.12+ (tick "Add python.exe to PATH").
- .NET 8 SDK.
- Vulkan SDK, for
spirv-as/spirv-val. - LLVM 21+ with the AMDGPU target for
llvm-mc. The official Windows build has no AMDGPU target. On Windows,scripts\build_llvm_mc.ps1builds a nativellvm-mc.exewith it (no WSL; needs git and the Visual Studio C++ tools below) and setsLLVM_MC; it takes about 20-40 minutes. A faster way, if you use conda:conda install -c conda-forge llvm-tools(its Windows build includes the AMDGPU target; docs/testing.md used version 23.1.6), then setLLVM_MCto the full path of thellvm-mc.exeit installs (where llvm-mcshows it once the environment is active). Or installllvm-21in WSL and setLLVM_MCto the whole command,LLVM_MC="wsl -d Ubuntu -e /usr/lib/llvm-21/bin/llvm-mc"(see docs/design.md). On Linux,llvm-mcon PATH is enough. - Visual Studio 2022 with Desktop development with C++ and the Windows SDK 10.0.26100 or newer, for the runtime stage (the runtime uses version 1.2 root signatures, which older SDKs don't declare).
- ffmpeg on PATH (optional: decodes the XMA2 streams, and required for
--wav).
Low disk space: the ~350 GB figure is for the full build. To run the port, --stages check,shaders,runtime
needs about 30 GB; the assets stage (~300 GB) is only for the asset tools, and --wav adds several times the
Ogg Opus size (the preflight prints this choice when the assets stage is what does not fit). --work and --out
can sit on another drive. The runtime maps the package in place, so a read-only package drive needs
gta6rt --overlay <writable folder>; --overlay is a gta6rt option, not a make_game.py one. Leave the .s
files in work/shaders/dxbc/disasm in place: deleting them, along with the translated
work/shaders/spirv/index.json, can leave the shaders stage looking finished with zero shaders. A disasm
folder that is a symlink is refused when the stage has to clear it.
From a terminal, with the same behaviour and more control:
python -I make_game.py --find # list the copies found on this PC
python -I make_game.py --pick # choose the game folder in a folder dialog
python -I make_game.py --check # check your copy, build nothing
python -I make_game.py --check --full-check # also compare SHA-256 of every file (slow)
python -I make_game.py --game "D:\path\to\your\package" --out "D:\Games\Leonida" --work "E:\leonida-work"
python -I make_game.py --stages shaders,assets # only some stages
python -I make_game.py --game "D:\path\to\your\package" --wav # also decode Opus to PCM WAV (large)
python -I make_game.py --wave64-emulate off # auto (default), on or off; see below--wave64-emulate decides whether wave64 compute and mesh shaders are translated to be exact on any subgroup size
(see "Wave64 emulation" in docs/design.md). NVIDIA and Intel GPUs have 32-wide subgroups and need
it. The default, auto, asks vulkaninfo (part of the Vulkan SDK) and turns emulation on if any GPU lacks 64-wide
subgroups or its subgroup size is unknown. It also checks whether the runtime's GPU can run compute and mesh
shaders 64-wide. With --mesh-compute, only compute subgroup support is needed.
On AMD's Windows driver, auto uses native wave64 on RDNA1 and RDNA2 when the runtime's GPU supports it, even
if another GPU is 32-wide or vulkaninfo is unavailable. That driver can crash on emulated LDS code (#857).
For RDNA1 cards without mesh support, the decision uses the compute stage, which can run wave64 without native
mesh support.
The mode is saved next to the translated shaders, and changing it translates them again. auto can normally
reuse previously emulated shaders. The AMD Windows workaround rebuilds those shaders in native mode.
Use --wave64-emulate on to force emulation or --wave64-emulate off to force native wave64.
Four fallback flags are forwarded to the translator the same way, saved next to the translated shaders, and changing
them translates them again: --no-float-controls (drop SignedZeroInfNanPreserve, for devices whose pipeline check
skips a shader without shaderSignedZeroInfNanPreserveFloat32; needs PR #664's translator flag), --bary-fallback
(read raw barycentrics from an interpolated input, for devices without VK_KHR_fragment_shader_barycentric),
--texel-offset-fallback (fold image_sample*_o offsets into the coordinate, for devices without
VK_KHR_maintenance8) and --mesh-compute (mesh shaders as compute, for devices without VK_EXT_mesh_shader).
Each is documented in docs/design.md.
The build records which llvm-mc command and version produced the disassembly. Changing either, or reusing a work folder that predates this record, reruns disassembly and translation while keeping the extracted shader inputs.
The build records which translator sources produced the shaders. A change to those files reruns translation using the saved disassembly. Older work folders need one translation after upgrading to record this information.
The build also records which decoder (the third_party/rpf9-explorer commit and the tools/rpf9dump sources) exported
each archive's models and textures. When it changes, the assets stage removes that export and makes it again. Older
work folders have no record, so their models and textures are exported once more after upgrading.
Stages run in order: check, shaders, assets, runtime, pipelines (creates every translated shader on your
GPU driver and checks that it compiles, reports any it has to skip, and saves a pipeline cache to
pipeline_cache.bin in --out; the runtime doesn't load that cache yet, so it doesn't speed up the first boot). The
shader translation is the longest step: it runs on --jobs processes (half the CPU threads by default).
--wav is off by default because 16-bit PCM WAV is several times larger than Ogg Opus. It decodes the repackaged Ogg
Opus streams to work\assets\audio\wav after the audio bank step; existing WAV files are skipped when a build resumes.
With CMake 3.24+, a C++20 compiler, and Vulkan development headers and loader installed:
cmake -S runtime -B runtime/build/linux
cmake --build runtime/build/linux --parallel
./runtime/build/linux/vk_pipeline_check /path/to/spirvPass the directory containing index.json and the translated SPIR-V files to vk_pipeline_check.
make_game.py runs on Linux too. The pipelines stage uses the vk_pipeline_check built above
(runtime/build/linux, or runtime/build), and builds it there itself before any other work if it is missing.
The loader is a Windows program and runs under Wine or Proton; CI runs its tests under Wine on every change to
runtime/ (the wine job of the Runtime workflow). On Linux the runtime stage cross-builds it into
runtime/build/windows with clang-cl and lld-link (LLVM 19+, but not 22.1.7 or 22.1.8, see docs/testing.md; plain names, or all five LLVM tools with one version
suffix such as clang-cl-21) against the MSVC CRT and Windows SDK that
xwin lays out, in XWIN_DIR or ~/.local/share/xwin-sdk
(docs/testing.md has the one-time xwin
command). Without them the stage is left out of the default stages, and asking for it lists what is missing before
any work starts. A Windows build made elsewhere works too, such as the runtime-windows artifact of that workflow's
windows job, unzipped:
python3 -I make_game.py --runtime-build ~/Downloads/runtime-windowsEither way it copies gta6rt.exe and gta6rt_tls_host.dll into --out and writes gta6rt.sh next to them, which
starts gta6rt.exe with wine, or with the Wine named by WINE (for Proton, its files/bin/wine). The same option
skips the build on Windows.
| Piece | What it does | Where |
|---|---|---|
| Version check | Every package file's name, size and SHA-256 for each supported version | game/, make_game.py |
| Shader pipeline | Carves DXBC containers from shaders.rpf without its encrypted table of contents. Unpacks the XBCH → FSSM native RDNA2 program, disassembles it with LLVM (gfx1013) and translates it to SPIR-V |
tools/shader_carve.py, fssm_unpack.py, shader_disasm.py, rdna2spirv.py |
| Asset export | Finds validated resources inside RPF9 archives and the loose .ttpf texture pools |
tools/rpf9dump (on rpf9-explorer's Core) |
| Runtime | Maps the PE image, resolves imports to shims (GDK, XMem, d3d12_xs) |
runtime/ |
| Research tools | PE/RTTI inspection, raw carving, texture tiling probes, GPU test harnesses | tools/, runtime/test/ |
| Progress dashboard | One offline page of what passes, what changed since it last passed and what blocks next, built from test results and the docs' own tables; nothing is written inside the repo | tools/progress_dashboard.py |
The translator's runtime contract (user SGPRs, push constants, memory model, bindless images, vertex fetch, system values) and all the format notes are in docs/design.md; the format, asset, runtime and validation notes are indexed in docs/README.md. The Xbox D3D12 plan is in docs/d3d12_vulkan.md. Audio bank formats and the export tools are in docs/audio.md; docs/related_projects.md records the prior art we may read and the licence limits on it.
The biggest open pieces:
- Shader translator on hardware: compute, mesh and geometry now translate (see the translator contract in
docs/design.md); still open are the vertex-shader input layout (
v0=VertexIndexis unverified if the console runs VS as NGG) and wave64 cross-half code in VS/PS/GS on 32-wide subgroups. - Xbox D3D12 → Vulkan: the
d3d12_xscommand list and descriptor heap model. - Model recovery: investigate the 71 unrecovered fragment candidates in
levels.rpf.
See CONTRIBUTING.md. Never attach game files, extracted assets or generated shaders to issues or pull requests.
- rpf9-explorer by breadbbbb: the RPF9 model, texture-pool and AWC
decoders used by
tools/rpf9dump(git submodule). - Mesa (MIT): GFX10 resource-descriptor layout (
tools/gfx10_formats.json), and the ACO/RADV rules used as reference for 16-bit results and shader system registers. - libHttpClient (MIT) by Microsoft: the XTaskQueue/XAsync implementation
in
third_party/xtaskqueue, used by the offlinexgameruntimeshim. - LLVM: AMDGPU disassembler.
- Logo: "Grand Theft Auto VI" icon by SlyDevil on SteamGridDB.
- SPIRV-Tools: assembly and validation.
Grand Theft Auto and all related names are trademarks of their owners. This project is not affiliated with or endorsed by them.
GPLv3 (or any later version). See LICENSE. Third-party code keeps its own license.
