19cfb92d5d
We can use nullptr here instead of typing out the name of the type. |
||
---|---|---|
.idea | ||
DataSpec | ||
Editor | ||
NESEmulator | ||
Runtime | ||
Shaders | ||
amuse@9c75aeccbe | ||
assetnameparser | ||
discord-rpc@e6390c8c41 | ||
gbalink | ||
gmm | ||
hecl@0b42de34d0 | ||
hecl-gui@db38d19ac3 | ||
jbus@d72163ad27 | ||
kabufuda@35e5c7c90f | ||
lldb-extras | ||
mpcksum | ||
nod@f147e12356 | ||
rapidjson@66eb6067b1 | ||
sanitizers-cmake@6947cff3a9 | ||
specter@27eb476b05 | ||
visigen | ||
.appveyor.yml | ||
.clang-format | ||
.clang-tidy | ||
.gitignore | ||
.gitlab-ci.yml | ||
.gitmodules | ||
CMakeLists.txt | ||
Doxyfile | ||
GMM-LICENSE | ||
LICENSE | ||
README.md | ||
README.msan.md | ||
version.h.in |
README.md
URDE
Status: In-Game with 0-00 (v1.088) only
Official Discord Channel: https://discord.gg/AMBVFuf
Download
Precompiled builds of the command-line extraction utility (hecl
) with embedded dataspec libraries are available at https://github.com/AxioDL/urde/releases. 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 7+ (64-bit support only)
- macOS 10.11+
- Linux
- Arch is known to function with
glx
vendor setup instructions (main development/testing OS) - [WIP] Vulkan loader detection is also integrated into the cmake for Linux
- Arch is known to function with
- [Coming Soon] FreeBSD
- Much multimedia functionality is in place, but not fully tested
Usage
- Extract ISO:
hecl extract [path].iso
- Repackage game for URDE:
cd [extracted dir]; hecl package
- Run URDE:
urde [path to hecl dir]/out
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
Build Prerequisites:
- CMake 3.13+
- For Windows: Install
CMake Tools
in Visual Studio
- For Windows: Install
- Python 3+
- For Windows: Microsoft Store
- Verify it's added to
%PATH%
by typingpython
incmd
.
- LLVM development package (headers and libs)
- [Windows] Visual Studio 2017/2019 Community
- Select
C++ Development
and verify the following packages are included:Windows 10 SDK
CMake Tools
C++ Clang Compiler
C++ Clang-cl
- Select
- [macOS] Xcode Tools
- [Linux] recent development packages of
udev
,x11
,xcb
,xinput
,glx
,asound
Prep Directions
git clone --recurse-submodules https://github.com/AxioDL/urde.git
mkdir urde-build
cd urde-build
Build Directions
ninja
cmake -DCMAKE_BUILD_TYPE=Debug -G Ninja ../urde
ninja
CMake options
- Build release optimized (better runtime performance):
-DCMAKE_BUILD_TYPE=Release
- Use clang+lld (faster linking):
-DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++
- Optimize for current CPU (resulting binaries are not portable):
-DURDE_VECTOR_ISA=native
CLion
(main development / debugging IDE)
Open the repository's CMakeLists.txt
.
Configure CMake options via File
> Settings
> Build, Execution, Deployment
> CMake
.
It's recommended to create a new Toolchain
with clang
/clang++
and configure the CMake profiles to use it.
Qt Creator
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.
Build / Debug / Run on Windows, macOS and Linux in a unified way.
Visual Studio
Verify all required VS packages are installed from the above Build Prerequisites section.
Open the urde
directory in Visual Studio (automatically imports CMake configuration).
Follow these instructions to use clang-cl. The build will not work with the normal VS compiler!
Xcode
cmake -G Xcode -DCMAKE_BUILD_TYPE=Debug -DLLVM_ROOT_DIR=<path-to-llvm-dev-package> ../urde
Then open urde.xcodeproj