metaforce/README.md

79 lines
2.4 KiB
Markdown
Raw Normal View History

2016-03-05 00:08:46 +00:00
## URDE
2015-08-22 05:41:10 +00:00
**Status:** Extract Only
2015-09-12 21:47:31 +00:00
2016-01-05 19:17:34 +00:00
### Download
2016-03-08 08:23:22 +00:00
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)
2016-01-05 19:17:34 +00:00
2015-09-12 21:47:31 +00:00
### Platform Support
* Windows 7+ (64-bit support only)
* Mac OS X 10.9+
2016-03-08 07:54:44 +00:00
* Linux
2016-03-08 08:08:52 +00:00
* Arch is known to function with [`glx` vendor setup instructions](https://wiki.archlinux.org/index.php/Category:Graphics) *(main development/testing OS)*
2016-03-08 08:23:22 +00:00
* **[WIP]** Vulkan loader detection is also integrated into the cmake for Linux
2015-09-12 21:47:31 +00:00
* **[Coming Soon]** FreeBSD
2016-03-08 08:08:52 +00:00
* Much multimedia functionality is in place, but not fully tested
2015-10-12 00:04:11 +00:00
### Build Prerequisites:
* [CMake 3+](https://cmake.org)
* [Python 3+](https://python.org)
2016-03-12 00:50:32 +00:00
* LLVM development package *(headers and libs)*
2016-09-11 01:06:30 +00:00
* [Specialized Windows Package](https://www.dropbox.com/s/vnxyzltd04xpikr/LLVM-3.9.0-win64-athena.exe?dl=1)
2015-10-12 00:04:11 +00:00
* [OS X Package](http://llvm.org/releases/3.7.0/clang+llvm-3.7.0-x86_64-apple-darwin.tar.xz)
2016-03-08 08:08:52 +00:00
* **[Windows]** [Visual Studio 2015 and Windows SDK](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx)
* **[OS X]** [Xcode Tools](https://developer.apple.com/xcode/download/)
2016-04-29 05:00:11 +00:00
* **[Linux]** recent development packages of `udev`, `x11`, `xcb`, `xinput`, `glx`, `asound`
2016-03-05 04:48:14 +00:00
2016-03-13 07:13:47 +00:00
### Prep Directions
2016-03-05 04:48:14 +00:00
```sh
2016-08-22 04:13:38 +00:00
git clone --recurse-submodules https://github.com/AxioDL/urde.git
2016-03-05 04:48:14 +00:00
mkdir urde-build
2016-08-22 04:13:38 +00:00
cd urde-build
2016-03-13 07:13:47 +00:00
```
### Build Directions (Debug)
#### make
```sh
cmake -DCMAKE_BUILD_TYPE=Debug ../urde
2016-03-05 04:48:14 +00:00
make
```
2016-03-27 06:41:02 +00:00
#### Qt Creator
*(main development / debugging IDE)*
2016-03-13 07:13:47 +00:00
2016-03-13 07:19:12 +00:00
Open the repository's `CMakeLists.txt` via File > Open File or Project.
2016-03-13 07:13:47 +00:00
Configure the desired CMake targets to build in the *Projects* area of the IDE.
Build / Debug / Run on Windows, OS X and Linux in a unified way.
2016-03-05 04:48:14 +00:00
#### Visual Studio
Using *Git Shell* with [GitHub for Windows](https://desktop.github.com/)
2016-03-13 07:13:47 +00:00
Windows 7/8 users should run:
2016-03-05 05:11:00 +00:00
```sh
2016-03-13 07:13:47 +00:00
cmake -G "Visual Studio 14 2015 Win64" -DCMAKE_BUILD_TYPE=Debug ../urde
2016-03-05 04:48:14 +00:00
```
2016-03-13 07:13:47 +00:00
Windows 10 users should run:
2016-03-05 05:11:00 +00:00
```sh
2016-03-13 07:13:47 +00:00
cmake -G "Visual Studio 14 2015 Win64" -DCMAKE_SYSTEM_VERSION=10.0 -DCMAKE_BUILD_TYPE=Debug ../urde
2016-03-05 05:11:00 +00:00
```
2016-03-05 04:48:14 +00:00
Then open `urde.sln`
2016-03-05 05:11:00 +00:00
#### Xcode
```sh
2016-03-13 07:13:47 +00:00
cmake -G Xcode -DCMAKE_BUILD_TYPE=Debug -DLLVM_ROOT_DIR=<path-to-llvm-dev-package> ../urde
2016-03-05 05:11:00 +00:00
```
Then open `urde.xcodeproj`