metaforce/README.md

## URDE
**Status:** Extract Only

### 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)
* Mac OS X 10.9+
* Linux
    * Arch is known to function with [`glx` vendor setup instructions](https://wiki.archlinux.org/index.php/Category:Graphics) *(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

### Build Prerequisites:
* [CMake 3+](https://cmake.org)
* [Python 3+](https://python.org)
* LLVM
    * [Specialized Windows Package](https://www.dropbox.com/s/4u0rckvh3d3tvr1/LLVM-3.7.0-win64.exe)
    * [OS X Package](http://llvm.org/releases/3.7.0/clang+llvm-3.7.0-x86_64-apple-darwin.tar.xz)
* **[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/)
* **[Linux]** recent development packages of `udev`, `xorg+xcb`, `xinput`, `glx`, `asound`

### Build Directions (Release)

#### make

```sh
git clone https://github.com/AxioDL/urde.git
mkdir urde-build
cd urde
git submodule update --init --recursive
cd ../urde-build
cmake -DCMAKE_BUILD_TYPE=Release ../urde
make
```

#### Visual Studio

Using *Git Shell* with [GitHub for Windows](https://desktop.github.com/)

```sh
git clone https://github.com/AxioDL/urde.git
mkdir urde-build
cd urde
git submodule update --init --recursive
cd ../urde-build
```
Windows 7/8 users should then run:

```sh
cmake -G "Visual Studio 14 2015 Win64" -DCMAKE_BUILD_TYPE=Release ../urde
```

Windows 10 users should then run:

```sh
cmake -G "Visual Studio 14 2015 Win64" -DCMAKE_SYSTEM_VERSION=10.0 -DCMAKE_BUILD_TYPE=Release ../urde
```

Then open `urde.sln`

#### Xcode

```sh
git clone https://github.com/AxioDL/urde.git
mkdir urde-build
cd urde
git submodule update --init --recursive
cd ../urde-build
cmake -G Xcode -DCMAKE_BUILD_TYPE=Release -DLLVM_ROOT_DIR=<path-to-llvm-dev-lib-package> ../urde
```

Then open `urde.xcodeproj`
Update README.md 2016-03-05 00:08:46 +00:00			`## URDE`
Create README.md 2015-08-22 05:41:10 +00:00			`Status: Extract Only`
Update README.md 2015-09-12 21:47:31 +00:00
Community Concensus MIT LICENSE revert 2016-01-05 19:17:34 +00:00			`### Download`
Update README.md 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)`
Community Concensus MIT LICENSE revert 2016-01-05 19:17:34 +00:00
Update README.md 2015-09-12 21:47:31 +00:00			`### Platform Support`
			`* Windows 7+ (64-bit support only)`
			`* Mac OS X 10.9+`
Update README.md 2016-03-08 07:54:44 +00:00			`* Linux`
Update README.md 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)
Update README.md 2016-03-08 08:23:22 +00:00			`* [WIP] Vulkan loader detection is also integrated into the cmake for Linux`
Update README.md 2015-09-12 21:47:31 +00:00			`* [Coming Soon] FreeBSD`
Update README.md 2016-03-08 08:08:52 +00:00			`* Much multimedia functionality is in place, but not fully tested`
Update README.md 2015-10-12 00:04:11 +00:00
			`### Build Prerequisites:`
			`* [CMake 3+](https://cmake.org)`
			`* [Python 3+](https://python.org)`
			`* LLVM`
			`* [Specialized Windows Package](https://www.dropbox.com/s/4u0rckvh3d3tvr1/LLVM-3.7.0-win64.exe)`
			`* [OS X Package](http://llvm.org/releases/3.7.0/clang+llvm-3.7.0-x86_64-apple-darwin.tar.xz)`
Update README.md 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/)`
			* [Linux] recent development packages of `udev`, `xorg+xcb`, `xinput`, `glx`, `asound`
Update README.md 2016-03-05 04:48:14 +00:00
			`### Build Directions (Release)`

			`#### make`

			```sh
			`git clone https://github.com/AxioDL/urde.git`
			`mkdir urde-build`
			`cd urde`
			`git submodule update --init --recursive`
			`cd ../urde-build`
			`cmake -DCMAKE_BUILD_TYPE=Release ../urde`
			`make`
			```

			`#### Visual Studio`

			`Using Git Shell with [GitHub for Windows](https://desktop.github.com/)`

			```sh
			`git clone https://github.com/AxioDL/urde.git`
			`mkdir urde-build`
			`cd urde`
			`git submodule update --init --recursive`
			`cd ../urde-build`
Update README.md 2016-03-05 05:11:00 +00:00			```
			`Windows 7/8 users should then run:`

			```sh
Update README.md 2016-03-05 04:48:14 +00:00			`cmake -G "Visual Studio 14 2015 Win64" -DCMAKE_BUILD_TYPE=Release ../urde`
			```

Update README.md 2016-03-05 05:11:00 +00:00			`Windows 10 users should then run:`

			```sh
			`cmake -G "Visual Studio 14 2015 Win64" -DCMAKE_SYSTEM_VERSION=10.0 -DCMAKE_BUILD_TYPE=Release ../urde`
			```

Update README.md 2016-03-05 04:48:14 +00:00			Then open `urde.sln`
Update README.md 2016-03-05 05:11:00 +00:00
			`#### Xcode`

			```sh
			`git clone https://github.com/AxioDL/urde.git`
			`mkdir urde-build`
			`cd urde`
			`git submodule update --init --recursive`
			`cd ../urde-build`
Update README.md 2016-03-11 01:52:10 +00:00			`cmake -G Xcode -DCMAKE_BUILD_TYPE=Release -DLLVM_ROOT_DIR=<path-to-llvm-dev-lib-package> ../urde`
Update README.md 2016-03-05 05:11:00 +00:00			```

			Then open `urde.xcodeproj`