Data interchange, editor suite, and runtime re-implementations for games by Retro Studios
Go to file
Luke Street 8d2d5ef5d5 COmegaPirate: MSVC runtime fix for skeleton asset IDs 2020-05-31 22:05:48 -04:00
.idea
DataSpec AssetNameMapNull: Fix MSVC build 2020-05-27 13:59:45 -04:00
Editor Fix inkscape call 2020-05-24 17:38:39 -07:00
NESEmulator
Runtime COmegaPirate: MSVC runtime fix for skeleton asset IDs 2020-05-31 22:05:48 -04:00
Shaders Shaders: Fix CFluidPlaneShaderMetal 2020-05-09 19:15:31 -04:00
amuse@70380d8fbc Update macOS build instructions 2020-05-24 12:03:33 -04:00
assetnameparser assetnameparser: Amend transposed fwrite arguments 2020-05-31 07:13:06 -04:00
assets
discord-rpc@e6390c8c41
gbalink
gmm
hecl@6265d5c05c Update macOS build instructions 2020-05-24 12:03:33 -04:00
hecl-gui@a23a15988a Update macOS build instructions 2020-05-24 12:03:33 -04:00
jbus@b8e1e4673e
kabufuda@4891a95688
lldb-extras
mpcksum
nod@2783337c36
rapidjson@66eb6067b1
sanitizers-cmake@6947cff3a9
specter@f54b6e2650
visigen
.appveyor.yml Use AXIODL-BUILDBOT instead of APOLLO 2020-05-27 08:02:35 -07:00
.clang-format
.clang-tidy
.gitignore
.gitlab-ci.yml .gitlab-ci.yml: Use low process priority for Linux 2020-05-27 15:01:43 -04:00
.gitmodules
CMakeLists.txt Replace CXX_COMPILER_ID generator expressions 2020-05-31 00:21:35 -04:00
CMakeSettings.json
Doxyfile
GMM-LICENSE
LICENSE
README.md Update macOS build instructions 2020-05-24 12:03:33 -04:00
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

URDE screenshot

Download

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.

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+ (10.15+ / Xcode 11.5+ to build)
  • 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
  • [Coming Soon] FreeBSD
    • Much multimedia functionality is in place, but not fully tested

Usage

  • 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

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+
    • 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 1.15+
  • [Linux] recent development packages of udev, x11, xcb, xinput, glx, asound

Prep Directions

git clone --recursive 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=clang -DCMAKE_CXX_COMPILER=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 ../urde

Then open urde.xcodeproj