2016-03-04 16:08:46 -08:00
## URDE
2020-06-25 17:57:21 -07:00
**Status:** Metroid Prime 1 In-Game (all retail GC versions)
2019-08-22 18:42:47 -07:00
2019-08-24 14:32:59 -07:00
**Official Discord Channel:** https://discord.gg/AMBVFuf
2016-12-21 17:42:10 -08:00
2020-04-14 13:14:02 -07:00
![URDE screenshot ](assets/urde-screen1.png )
2016-01-05 11:17:34 -08:00
### Download
2020-04-11 00:45:45 -07:00
Precompiled builds of the command-line extraction utility (`hecl`) with embedded dataspec libraries are available at https://releases.axiodl.com. This will give you intermediate dumps of original formats as *blender* and *yaml* representations.
2016-03-08 00:23:22 -08:00
Everything else is much too experimental to make portable/stable release builds (for now)
2016-01-05 11:17:34 -08:00
2015-09-12 14:47:31 -07:00
### Platform Support
2020-06-25 17:57:21 -07:00
* Windows 10 (64-bit, D3D11 / Vulkan)
* macOS 10.15+ (Metal)
* Linux (Vulkan)
2016-03-08 00:08:52 -08:00
* Arch is known to function with [`glx` vendor setup instructions ](https://wiki.archlinux.org/index.php/Category:Graphics ) *(main development/testing OS)*
2020-06-25 17:57:21 -07:00
* Other distros with reasonably up-to-date packages will work (specific packages TBD)
2020-02-21 22:47:49 -08:00
### Usage
2020-04-11 00:45:45 -07:00
* Extract ISO: `hecl extract [path].iso -o mp1`
* `mp1` can be substituted with the directory name of your choice
* Repackage game for URDE: `cd mp1; hecl package`
* Run URDE: `urde mp1/out`
2020-02-21 22:47:49 -08:00
#### URDE 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
2015-10-11 17:04:11 -07:00
### Build Prerequisites:
2019-06-20 23:02:56 -07:00
* [CMake 3.13+ ](https://cmake.org )
2020-05-24 09:03:33 -07:00
* Windows: Install `CMake Tools` in Visual Studio
* macOS: `brew install cmake`
2015-10-11 17:04:11 -07:00
* [Python 3+ ](https://python.org )
2020-05-24 09:03:33 -07:00
* Windows: [Microsoft Store ](https://go.microsoft.com/fwlink?linkID=2082640 )
* Verify it's added to `%PATH%` by typing `python` in `cmd` .
* macOS: `brew install python@3`
2016-03-11 16:50:32 -08:00
* LLVM development package *(headers and libs)*
2020-06-25 17:17:25 -07:00
* [Specialized Windows Package ](https://axiodl.com/files/LLVM-9.0.1-win64-lld.exe )
2020-05-24 09:03:33 -07:00
* macOS: `brew install --force-bottle llvm`
2020-04-11 00:45:45 -07:00
* **[Windows]** [Visual Studio 2019 Community ](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx )
2020-02-21 22:47:49 -08:00
* Select `C++ Development` and verify the following packages are included:
* `Windows 10 SDK`
* `CMake Tools`
* `C++ Clang Compiler`
* `C++ Clang-cl`
2020-05-24 09:03:33 -07:00
* **[macOS]** [Xcode 1.15+ ](https://developer.apple.com/xcode/download/ )
2017-11-13 19:36:36 -08:00
* **[Linux]** recent development packages of `udev` , `x11` , `xcb` , `xinput` , `glx` , `asound`
2016-03-04 20:48:14 -08:00
2016-03-12 23:13:47 -08:00
### Prep Directions
2016-03-04 20:48:14 -08:00
```sh
2020-04-11 00:45:45 -07:00
git clone --recursive https://github.com/AxioDL/urde.git
2016-03-04 20:48:14 -08:00
mkdir urde-build
2016-08-21 21:13:38 -07:00
cd urde-build
2016-03-12 23:13:47 -08:00
```
2020-06-25 17:57:21 -07:00
### Update Directions
```sh
cd urde
git pull
git submodule update --recursive
```
2020-02-21 22:47:49 -08:00
### Build Directions
2016-03-12 23:13:47 -08:00
2020-06-25 17:57:21 -07:00
For Windows, it's recommended to use Visual Studio. See below.
#### ninja (Windows/macOS/Linux)
2016-03-12 23:13:47 -08:00
```sh
2020-06-25 17:57:21 -07:00
cd urde-build
2020-02-21 22:47:49 -08:00
cmake -DCMAKE_BUILD_TYPE=Debug -G Ninja ../urde
ninja
2016-03-04 20:48:14 -08:00
```
2020-02-21 22:47:49 -08:00
#### CMake options
2019-11-30 20:37:47 -08:00
- Build release optimized (better runtime performance): `-DCMAKE_BUILD_TYPE=Release`
2020-04-11 00:45:45 -07:00
- Use clang+lld (faster linking): `-DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++`
2019-11-30 20:37:47 -08:00
- Optimize for current CPU (resulting binaries are not portable): `-DURDE_VECTOR_ISA=native`
2020-06-25 17:57:21 -07:00
#### CLion (Windows/macOS/Linux)
2016-03-26 23:41:02 -07:00
*(main development / debugging IDE)*
2016-03-12 23:13:47 -08:00
2020-02-21 22:47:49 -08:00
Open the repository's `CMakeLists.txt` .
2020-06-25 17:57:21 -07:00
Optionally configure CMake options via `File` > `Settings` > `Build, Execution, Deployment` > `CMake` .
2020-02-21 22:47:49 -08:00
2020-06-25 17:57:21 -07:00
#### Qt Creator (Windows/macOS/Linux)
2020-02-21 22:47:49 -08:00
2016-03-12 23:19:12 -08:00
Open the repository's `CMakeLists.txt` via File > Open File or Project.
2016-03-12 23:13:47 -08:00
Configure the desired CMake targets to build in the *Projects* area of the IDE.
2020-06-25 17:57:21 -07:00
#### Visual Studio (Windows)
2016-03-04 20:48:14 -08:00
2020-02-21 22:47:49 -08:00
Verify all required VS packages are installed from the above **Build Prerequisites** section.
2020-06-25 17:57:21 -07:00
Open the `urde` directory in Visual Studio (imports CMake configuration).
2016-03-04 21:11:00 -08:00
2020-06-25 17:57:21 -07:00
MSVC and clang-cl configurations should import automatically.
2016-03-04 21:11:00 -08:00
2020-06-25 17:57:21 -07:00
#### Xcode (macOS)
2016-03-04 21:11:00 -08:00
```sh
2020-06-25 17:57:21 -07:00
cmake -G Xcode ../urde
2016-03-04 21:11:00 -08:00
```
Then open `urde.xcodeproj`