AxioDL
/
metaforce
mirror of https://github.com/AxioDL/metaforce.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

README.md: Add usage, options, CMake+ninja, VS packages, CLion

This commit is contained in:
Luke Street 2020-02-22 01:47:49 -05:00
parent 07bc020441
commit 768e9016fe
1 changed files with 40 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@ -17,13 +17,33 @@ Everything else is much too experimental to make portable/stable release builds
* **[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:
* [CMake 3.13+](https://cmake.org)
* For Windows: Install `CMake Tools` in Visual Studio
* [Python 3+](https://python.org)
* For Windows: [Microsoft Store](https://go.microsoft.com/fwlink?linkID=2082640)
* Verify it's added to `%PATH%` by typing `python` in `cmd`.
* LLVM development package *(headers and libs)*
* [Specialized Windows Package](https://axiodl.com/files/LLVM-9.0.1-win64.exe)
* [Specialized macOS Package](https://axiodl.com/files/LLVM-9.0.1-Darwin.tar.xz)
* **[Windows]** [Visual Studio 2017/2019 and Windows SDK](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx)
* **[Windows]** [Visual Studio 2017/2019 Community](https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx)
* Select `C++ Development` and verify the following packages are included:
* `Windows 10 SDK`
* `CMake Tools`
* `C++ Clang Compiler`
* `C++ Clang-cl`
* **[macOS]** [Xcode Tools](https://developer.apple.com/xcode/download/)
* **[Linux]** recent development packages of `udev`, `x11`, `xcb`, `xinput`, `glx`, `asound`
@ -35,23 +55,31 @@ mkdir urde-build
cd urde-build
```
### Build Directions (Debug)
### Build Directions
#### make
#### ninja
```sh
cmake -DCMAKE_BUILD_TYPE=Debug ../urde
make -j$(nproc)
cmake -DCMAKE_BUILD_TYPE=Debug -G Ninja ../urde
ninja
```
CMake options:
#### 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
#### 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.
@ -60,9 +88,12 @@ Build / Debug / Run on Windows, macOS and Linux in a unified way.
#### Visual Studio
Open the `urde` directory in Visual Studio (automatically imports CMake configuration)
Verify all required VS packages are installed from the above **Build Prerequisites** section.
Follow these instructions to use clang-cl for the build process https://docs.microsoft.com/en-us/cpp/build/clang-support-cmake?view=vs-2019
Open the `urde` directory in Visual Studio (automatically imports CMake configuration).
Follow [these instructions to use clang-cl](https://docs.microsoft.com/en-us/cpp/build/clang-support-cmake?view=vs-2019).
The build will **not** work with the normal VS compiler!
#### Xcode