99 lines
3.1 KiB
Markdown
99 lines
3.1 KiB
Markdown
### Dependencies
|
|
|
|
You'll need to download and install the following to build yuzu:
|
|
|
|
* GCC v7+ (for C++17 support) & misc
|
|
* [CMake](https://www.cmake.org/) 3.6+
|
|
* [SDL2](https://www.libsdl.org/download-2.0.php)
|
|
* [Qt](https://qt-project.org/downloads)
|
|
* [Python2](https://www.python.org/download/releases/2.7/) 2.7
|
|
|
|
All other dependencies will be downloaded by [conan](https://conan.io/downloads.html) if needed:
|
|
|
|
* [Boost](https://www.boost.org/users/download/)
|
|
* [Catch2](https://github.com/catchorg/Catch2)
|
|
* [fmt](https://fmt.dev/)
|
|
* [OpenSSL](https://www.openssl.org/source/)
|
|
* [lz4](http://www.lz4.org)
|
|
* [nlohmann_json](https://github.com/nlohmann/json)
|
|
* [opus](https://opus-codec.org/downloads/)
|
|
* [ZLIB](https://www.zlib.net/)
|
|
* [zstd](https://facebook.github.io/zstd/)
|
|
|
|
| Distro | Commands
|
|
| --------------- | ----------------
|
|
| Arch | `sudo pacman -S base-devel ninja cmake sdl2 qt5 python2 python-pip boost catch2 fmt openssl lz4 mbedtls nlohmann-json opus zlib zip zstd && sudo pip install conan`
|
|
| Ubuntu / Debian | `sudo apt-get install build-essential ninja-build cmake libboost-all-dev libsdl2-2.0-0 libsdl2-dev qtbase5-dev libqt5opengl5-dev qtbase5-private-dev python2 python-pip && sudo pip install conan`
|
|
| Fedora | `sudo dnf install gcc ninja-build cmake SDL2-devel qt5-qtbase qt5-qtbase-devel python2 python-pip && sudo pip install conan`
|
|
| Gentoo | `emerge =sys-devel/gcc-7.1.0 dev-util/ninja dev-util/cmake media-libs/libsdl2 dev-qt/qtcore dev-qt/qtopengl && sudo pip install conan`
|
|
|
|
Note: Depending on your distro, the version of CMake you get may not be what's required to build yuzu. Check with `cmake --version`. Version 3.6 or greater is required for you to be able to build!
|
|
|
|
### Cloning yuzu with Git
|
|
|
|
**Master:**
|
|
|
|
```bash
|
|
git clone --recursive https://github.com/yuzu-emu/yuzu
|
|
cd yuzu
|
|
```
|
|
|
|
**Mainline (no assert):**
|
|
|
|
```bash
|
|
git clone --recursive https://github.com/yuzu-emu/yuzu-mainline
|
|
cd yuzu-mainline
|
|
```
|
|
|
|
The `--recursive` option automatically clones the required Git submodules.
|
|
|
|
### Building yuzu in Release Mode (Optimized)
|
|
|
|
```bash
|
|
mkdir build && cd build
|
|
cmake .. -GNinja
|
|
ninja
|
|
sudo ninja install # (currently doesn't work, needs to be fixed)
|
|
```
|
|
|
|
Optionally, you can use `cmake-gui ..` to adjust various options (e.g. disable the Qt GUI).
|
|
|
|
### Building yuzu in Debug Mode (Slow)
|
|
|
|
```bash
|
|
mkdir build && cd build
|
|
cmake .. -GNinja -DCMAKE_BUILD_TYPE=Debug
|
|
ninja
|
|
```
|
|
|
|
### Building with debug symbols
|
|
|
|
```bash
|
|
mkdir build && cd build
|
|
cmake .. -GNinja -DCMAKE_BUILD_TYPE=RelWithDebInfo
|
|
ninja
|
|
```
|
|
|
|
### Running without installing
|
|
|
|
After building, the binaries `yuzu` and `yuzu-cmd` (depending on your build options) will end up in `build/bin/`.
|
|
|
|
```bash
|
|
# SDL
|
|
cd build/bin/
|
|
./yuzu-cmd
|
|
|
|
# Qt
|
|
cd build/bin/
|
|
./yuzu
|
|
```
|
|
|
|
### Debugging
|
|
|
|
```bash
|
|
cd data
|
|
gdb ../build/bin/yuzu # Start GDB
|
|
(gdb) run # Run yuzu under GDB
|
|
<crash>
|
|
(gdb) bt # Print a backtrace of the entire callstack to see which codepath the crash occurred on
|
|
``` |