Data interchange, editor suite, and runtime re-implementations for games by Retro Studios
Go to file
Phillip Stephens a525c57278
Add ADV9
2021-06-11 23:45:27 -07:00
.github/workflows Use freetype for ImGui fonts if available 2021-06-07 13:10:55 -07:00
DataSpec Add ADV9 2021-06-11 23:45:27 -07:00
NESEmulator Rename everything 2021-04-10 01:42:06 -07:00
Runtime Add ADV9 2021-06-11 23:45:27 -07:00
Shaders Move all submodules to extern 2021-04-06 15:07:45 -04:00
assetnameparser Fix assetnameparser build 2021-04-06 15:46:02 -04:00
assets Add new screenshot + Trilogy note to 2021-06-03 10:28:39 -04:00
ci Change mac bundle id 2021-05-07 00:11:08 -07:00
extern Remove freetype2 submodule 2021-05-29 18:45:08 -04:00
gbalink gbalink: Amend code to compile with jbus changes 2019-09-04 01:56:04 -04:00
gmm Start renaming project to Metaforce 2021-04-06 18:58:11 -04:00
hecl Don't clobber the modified flag when unlocking 2021-06-06 13:37:04 -07:00
imgui Use freetype for ImGui fonts if available 2021-06-07 13:10:55 -07:00
lldb-extras Rename everything 2021-04-10 01:42:06 -07:00
metaforce-gui Fix Qt 6.1 deprectation error 2021-05-23 11:53:46 -07:00
mpcksum CActorContraption fixes, better CMake dependency handling 2019-06-11 16:05:17 -10:00
visigen Start renaming project to Metaforce 2021-04-06 18:58:11 -04:00
.clang-format Update .clang-{format,tidy} 2020-07-07 04:34:35 -04:00
.clang-tidy Resolve clang-tidy issues & update config 2021-05-29 18:45:08 -04:00
.gitignore Remove Editor & specter 2021-05-29 18:45:07 -04:00
.gitmodules Remove freetype2 submodule 2021-05-29 18:45:08 -04:00
CMakeLists.txt Reorder bintoc 2021-05-29 18:45:07 -04:00
CMakeSettings.json GitHub Actions: Use static Qt5 on Windows 2021-03-13 11:58:20 -05:00
LICENSE Start renaming project to Metaforce 2021-04-06 18:58:11 -04:00 Use freetype for ImGui fonts if available 2021-06-07 13:10:55 -07:00 Typo fix 2019-04-06 19:49:21 -10:00 Remove Editor & specter 2021-05-29 18:45:07 -04:00 Serialize CVarManager on shutdown; add build type to About 2021-05-29 18:45:08 -04:00


Formerly known as URDE

Status: Metroid Prime 1 In-Game (all retail GC & Wii versions)

Official Discord Channel:

Metaforce screenshot


Precompiled builds of the command-line extraction utility (hecl) with embedded dataspec libraries are available at This will give you intermediate dumps of original formats as blender and yaml representations.

Everything else is much too experimental to make portable/stable release builds (for now)

Platform Support

  • Windows 10 (64-bit, D3D11 / Vulkan)
  • macOS 10.15+ (Metal)
  • Linux (Vulkan)
    • Follow this guide to set up Vulkan & appropriate drivers for your distro.

Usage (GC versions)

  • Extract ISO: hecl extract [path].iso -o mp1
    • mp1 can be substituted with the directory name of your choice
  • Repackage game for Metaforce: cd mp1; hecl package
  • Run Metaforce: metaforce mp1/out

Usage (Wii versions)

IMPORTANT: Trilogy main menu currently doesn't work, and requires the --warp 1 0 command line arguments to get in-game.

NFS files dumped from Metroid Prime Trilogy on Wii U VC can be used directly without converting to ISO.

  • Extract ISO or NFS: hecl extract [path].[iso/nfs] -o mpt
    • mpt can be substituted with the directory name of your choice
  • Repackage game for Metaforce: cd mpt; hecl package MP1
    • The MP1 parameter is important here.
  • Run Metaforce: metaforce mpt/out --warp 1 0

Metaforce options (non-exhaustive)

  • -l: Enable console logging
  • --warp [worldid] [areaid]: Warp to a specific world/area. Example: --warp 2 2
  • +developer=1: Enable developer console

Build Prerequisites:

  • CMake 3.13+
    • Windows: Install CMake Tools in Visual Studio
    • macOS: brew install cmake
  • Python 3+
    • Windows: Microsoft Store
      • Verify it's added to %PATH% by typing python in cmd.
    • macOS: brew install python@3
  • LLVM development package (headers and libs)
  • [Windows] Visual Studio 2019 Community
    • Select C++ Development and verify the following packages are included:
      • Windows 10 SDK
      • CMake Tools
      • C++ Clang Compiler
      • C++ Clang-cl
  • [macOS] Xcode 11.5+
  • [Linux] recent development packages of udev, x11, xcb, xinput, glx, asound
    • Ubuntu 20.04+ packages
      build-essential curl git ninja-build llvm-dev libclang-dev clang lld zlib1g-dev libcurl4-openssl-dev \
      libglu1-mesa-dev libdbus-1-dev libvulkan-dev libxi-dev libxrandr-dev libasound2-dev libpulse-dev \
      libudev-dev libpng-dev libncurses5-dev cmake libx11-xcb-dev python3 python-is-python3 qt5-default \
    • Arch packages
      base-devel cmake ninja llvm vulkan-headers python3 qt6 clang lld alsa-lib libpulse libxrandr freetype2

Prep Directions

git clone --recursive
mkdir metaforce-build
cd metaforce-build

Update Directions

cd metaforce
git pull
git submodule update --recursive

Build Directions

For Windows, it's recommended to use Visual Studio. See below.

ninja (Windows/macOS/Linux)

cd metaforce-build
cmake -DCMAKE_BUILD_TYPE=Debug -G Ninja ../metaforce

CMake options

  • Build release optimized (better runtime performance): -DCMAKE_BUILD_TYPE=Release
  • Use clang+lld (faster linking): -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++
  • Optimize for current CPU (resulting binaries are not portable): -DMETAFORCE_VECTOR_ISA=native

CLion (Windows/macOS/Linux)

(main development / debugging IDE)

Open the repository's CMakeLists.txt.

Optionally configure CMake options via File > Settings > Build, Execution, Deployment > CMake.

Qt Creator (Windows/macOS/Linux)

Open the repository's CMakeLists.txt via File > Open File or Project.

Configure the desired CMake targets to build in the Projects area of the IDE.

Visual Studio (Windows)

Verify all required VS packages are installed from the above Build Prerequisites section.

Open the metaforce directory in Visual Studio (imports CMake configuration).

MSVC and clang-cl configurations should import automatically.

Xcode (macOS)

cmake -G Xcode ../metaforce

Then open metaforce.xcodeproj

Optional Debug Models

We provide custom debug models for use to visualize certain aspects of the game such as lighting, in order to use these models you may download them from and extract to MP1/URDE in an existing HECL project (assuming paths are relative), then run the the following command:

hecl package MP1/URDE

This will cook and package the debug models and will automatically enable rendering of lights in a debug build of Metaforce.