Data interchange, editor suite, and runtime re-implementations for games by Retro Studios
Go to file
Phillip Stephens 7feae73855
Merge branch 'lioncash-build'
2020-04-05 05:11:50 -07:00
.idea
DataSpec TXTR: Mark constexpr functions static 2020-03-31 20:36:45 -04:00
Editor
NESEmulator
Runtime CFrontEndUI: Remove use of const_cast in Draw() 2020-04-05 07:12:07 -04:00
Shaders
amuse@9c75aeccbe Update amuse 2020-03-12 00:55:31 -07:00
assetnameparser
discord-rpc@e6390c8c41
gbalink
gmm
hecl@0b42de34d0 Refactor particle serialization to use generative meta-information 2020-03-28 21:29:27 -10:00
hecl-gui@db38d19ac3
jbus@d72163ad27
kabufuda@35e5c7c90f
lldb-extras
mpcksum
nod@f147e12356
rapidjson@66eb6067b1
sanitizers-cmake@6947cff3a9
specter@27eb476b05 Update submodules 2020-03-04 17:33:51 -08:00
visigen
.appveyor.yml Update appveyor configuration & README.md 2020-02-21 17:01:46 -05:00
.clang-format
.clang-tidy CElitePirate: Bug fixes, make member variables private, cleanup 2020-03-30 20:40:38 -04:00
.gitignore
.gitlab-ci.yml
.gitmodules
CMakeLists.txt CMakeLists: Enable several conformance flags on MSVC 2020-03-31 21:26:59 -04:00
Doxyfile
GMM-LICENSE
LICENSE
README.md README.md: Add usage, options, CMake+ninja, VS packages, CLion 2020-02-22 01:47:49 -05: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

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
  • [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:

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