metaforce/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](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.13+](https://cmake.org)
* [Python 3+](https://python.org)
* LLVM development package *(headers and libs)*
    * [Specialized Windows Package](https://axiodl.com/files/LLVM-9.0.0svn-win64.exe)
    * [macOS Package](http://releases.llvm.org/7.0.0/clang+llvm-7.0.0-x86_64-apple-darwin.tar.xz)
* **[Windows]** [Visual Studio 2017/2019 and Windows SDK](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx)
* **[macOS]** [Xcode Tools](https://developer.apple.com/xcode/download/)
* **[Linux]** recent development packages of `udev`, `x11`, `xcb`, `xinput`, `glx`, `asound`

### Prep Directions

```sh
git clone --recurse-submodules https://github.com/AxioDL/urde.git
mkdir urde-build
cd urde-build
```

### Build Directions (Debug)

#### make

```sh
cmake -DCMAKE_BUILD_TYPE=Debug ../urde
make -j$(nproc)
```

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`

#### Qt Creator
*(main development / debugging IDE)*

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

```sh
cmake -G "Visual Studio 15 2017 Win64" -DCMAKE_BUILD_TYPE=Debug ../urde
```

Then open `urde.sln`

#### Xcode

```sh
cmake -G Xcode -DCMAKE_BUILD_TYPE=Debug -DLLVM_ROOT_DIR=<path-to-llvm-dev-package> ../urde
```

Then open `urde.xcodeproj`
Update README.md 2016-03-05 00:08:46 +00:00			`## URDE`
Update status, add discord invite link 2019-08-23 01:42:47 +00:00			`Status: In-Game with 0-00 (v1.088) only`

Fix discord link (the old one expired even though I set it to never expire, grrr) 2019-08-24 21:32:59 +00:00			`Official Discord Channel: https://discord.gg/AMBVFuf`
Update README.md 2016-12-22 01:42:10 +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)`
CPuddleToadGamma and animation system fixes 2019-06-21 06:02:56 +00:00			`* macOS 10.11+`
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:`
CPuddleToadGamma and animation system fixes 2019-06-21 06:02:56 +00:00			`* [CMake 3.13+](https://cmake.org)`
Update README.md 2015-10-12 00:04:11 +00:00			`* [Python 3+](https://python.org)`
Update README.md 2016-03-12 00:50:32 +00:00			`* LLVM development package (headers and libs)`
Update file download locations 2019-07-12 08:06:23 +00:00			`* [Specialized Windows Package](https://axiodl.com/files/LLVM-9.0.0svn-win64.exe)`
Windows fixes 2019-01-29 08:28:35 +00:00			`* [macOS Package](http://releases.llvm.org/7.0.0/clang+llvm-7.0.0-x86_64-apple-darwin.tar.xz)`
CPuddleToadGamma and animation system fixes 2019-06-21 06:02:56 +00:00			`* [Windows] [Visual Studio 2017/2019 and Windows SDK](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx)`
RumbleFxTable and final FrontEnd options functions 2017-01-13 00:16:26 +00:00			`* [macOS] [Xcode Tools](https://developer.apple.com/xcode/download/)`
Windows fixes 2017-11-14 03:36:36 +00:00			* [Linux] recent development packages of `udev`, `x11`, `xcb`, `xinput`, `glx`, `asound`
Update README.md 2016-03-05 04:48:14 +00:00
Update README.md 2016-03-13 07:13:47 +00:00			`### Prep Directions`
Update README.md 2016-03-05 04:48:14 +00:00
			```sh
Update README.md 2016-08-22 04:13:38 +00:00			`git clone --recurse-submodules https://github.com/AxioDL/urde.git`
Update README.md 2016-03-05 04:48:14 +00:00			`mkdir urde-build`
Update README.md 2016-08-22 04:13:38 +00:00			`cd urde-build`
Update README.md 2016-03-13 07:13:47 +00:00			```

			`### Build Directions (Debug)`

			`#### make`

			```sh
			`cmake -DCMAKE_BUILD_TYPE=Debug ../urde`
Add URDE_VECTOR_ISA=native, update README.md with CMake options 2019-12-01 04:37:47 +00:00			`make -j$(nproc)`
Update README.md 2016-03-05 04:48:14 +00:00			```

Add URDE_VECTOR_ISA=native, update README.md with CMake options 2019-12-01 04:37:47 +00:00			`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`

Update submodules 2016-09-11 05:50:25 +00:00			`#### Qt Creator`
Update README.md 2016-03-27 06:41:02 +00:00			`(main development / debugging IDE)`
Update README.md 2016-03-13 07:13:47 +00:00
Update README.md 2016-03-13 07:19:12 +00:00			Open the repository's `CMakeLists.txt` via File > Open File or Project.
Update README.md 2016-03-13 07:13:47 +00:00
			`Configure the desired CMake targets to build in the Projects area of the IDE.`

RumbleFxTable and final FrontEnd options functions 2017-01-13 00:16:26 +00:00			`Build / Debug / Run on Windows, macOS and Linux in a unified way.`
Update README.md 2016-03-13 07:13:47 +00:00
Update README.md 2016-03-05 04:48:14 +00:00			`#### Visual Studio`

Update README.md 2016-03-05 05:11:00 +00:00			```sh
Windows build fixes and warning avoidance 2018-05-25 06:39:38 +00:00			`cmake -G "Visual Studio 15 2017 Win64" -DCMAKE_BUILD_TYPE=Debug ../urde`
Update README.md 2016-03-05 05:11:00 +00:00			```

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
Update README.md 2016-03-13 07:13:47 +00:00			`cmake -G Xcode -DCMAKE_BUILD_TYPE=Debug -DLLVM_ROOT_DIR=<path-to-llvm-dev-package> ../urde`
Update README.md 2016-03-05 05:11:00 +00:00			```

			Then open `urde.xcodeproj`