torzu/build-for-windows.md

Method I: MSVC Build for Windows

Minimal Dependencies

On Windows, all library dependencies are automatically included within the externals folder, or can be downloaded on-demand. To build yuzu, you need to install:

• Visual Studio 2022 Community - Make sure to select C++ support in the installer. Make sure to update to the latest version if already installed.

• CMake - Used to generate Visual Studio project files. Does not matter if either 32-bit or 64-bit version is installed.

• Vulkan SDK - Make sure to select Latest SDK.

• Python - Select latest stable Windows installer. Does not matter if either 32-bit or 64-bit version is installed.

• Git - We recommend Git for Windows.

• While installing Git Bash, you should tell it to include Git in your system path. (Choose the "Git from the command line and also from 3rd-party software" option.) If you missed that, don't worry, you'll just have to manually tell CMake where your git.exe is, since it's used to include version info into the built executable.

Cloning yuzu with Git

from Codeberg repo (the --recursive option automatically clones the required Git submodules):

git clone --depth 1 --recursive https://codeberg.org/litucks/torzu.git
cd torzu

from Torzu repo (assuming Tor is installed as a service):

git -c http.proxy=socks5h://127.0.0.1:9050 clone --depth 1 http://vub63vv26q6v27xzv2dtcd25xumubshogm67yrpaz2rculqxs7jlfqad.onion/torzu-emu/torzu.git
cd torzu
git submodule update --init --recursive

• (Note: yuzu by default downloads to C:\Users\<user-name>\yuzu (Master) or C:\Users\<user-name>\yuzu-mainline (Mainline)

Building

• Open the CMake GUI application and point it to the torzu directory.

• For the build directory, use a /build subdirectory inside the source directory or some other directory of your choice. (Tell CMake to create it.)

• Click the "Configure" button and choose Visual Studio 17 2022, with x64 for the optional platform.

• (Note: If you used GitHub's own app to clone, run git submodule update --init --recursive to get the remaining dependencies)

• If you get an error about missing packages, enable YUZU_USE_BUNDLED_VCPKG, and then click Configure again.

  • (You may also want to disable YUZU_TESTS in this case since Catch2 is not yet supported with this.)

• If you get an error "Unable to find a valid Visual Studio instance", make sure that you installed following MSVC components (especially VS 2019 build tools.) and then try again.

• Click "Generate" to create the project files.

• Open the solution file yuzu.sln in Visual Studio 2022, which is located in the build folder.

• Depending if you want a graphical user interface or not (yuzu has the graphical user interface, while yuzu-cmd doesn't), select yuzu or yuzu-cmd in the Solution Explorer, right-click and Set as StartUp Project.

• Select the appropriate build type, Debug for debug purposes or Release for performance (in case of doubt choose Release).

• Right-click the project you want to build and press Build in the submenu or press F5.

• After build completed you can find the Torzu executable in directory specified in output log.

Method II: MinGW-w64 Build with MSYS2

Prerequisites to install

• MSYS2
• Vulkan SDK - Make sure to select Latest SDK.
• Make sure to follow the instructions and update to the latest version by running pacman -Syu as many times as needed.

Install other dependencies

• Open the MSYS2 MinGW 64-bit (mingw64.exe) shell
• Download and install all dependencies using: pacman -Syu git make mingw-w64-x86_64-SDL2 mingw-w64-x86_64-cmake mingw-w64-x86_64-qt5 mingw-w64-x86_64-toolchain

Setup environment variables

export PATH="<Absolute path to the Bin folder in Vulkan SDK>:$PATH"
export VCPKG_DEFAULT_HOST_TRIPLET=x64-mingw-static
export VCPKG_DEFAULT_TRIPLET=x64-mingw-static

We have to manually set some VCPKG variables for some reason. This issue probably already exists in the original Yuzu.

Clone the yuzu repository with Git

from NotABug repo (the --recursive option automatically clones the required Git submodules):

git clone --depth 1 --recursive https://notabug.org/litucks/torzu.git
cd torzu
git submodule update --init --recursive

from Torzu repo (assuming Tor is installed as a service):

git -c http.proxy=socks5h://127.0.0.1:9050 clone --depth 1 http://vub63vv26q6v27xzv2dtcd25xumubshogm67yrpaz2rculqxs7jlfqad.onion/torzu-emu/torzu.git
cd torzu
git submodule update --init --recursive 

Generating makefile

mkdir build && cd build
cmake -G "MSYS Makefiles" -DYUZU_USE_BUNDLED_VCPKG=ON -DYUZU_TESTS=OFF -DVCPKG_TARGET_TRIPLET=x64-mingw-static ..

DVCPKG_TARGET_TRIPLET has to be overriden to x64-mingw-static here to generate a static build that doesn't require extra DLLs to be packaged.

Build yuzu

make -j$(nproc) yuzu

The reason we are not using make all is that linker will fail. This is because Yuzu developer didn't set linker flags properly in their CMakeLists.txt for some reason. So we have add something manually.

VERBOSE=1 make yuzu

This will shows the exact link command, should be something like:

cd ***/src/yuzu && /mingw64/bin/c++.exe -O3 -DNDEBUG -Wl,--subsystem,windows -Wl,--whole-archive ...

Copy the command line and add the following arguments:

-static-libstdc++ -lws2_32 -s -Wl,--Map,../../bin/yuzu.map

Explanation of the extra arguments:

• -static-libstdc++: Force usage of static libstdc++, without this argument the binary will have no entrypoint.
• -lws2_32: Link the ws2_32.a provided by mingw.
• -s: Optional, strip the symbols from the output binary.
• -Wl,--Map,../../bin/yuzu.map: Optional, output a separated linker map to ../../bin/yuzu.map Please note that -lw2_32 is already added, but the order is not correct and hence cause linking fails.

Now the built executable should work properly. Repeating step 4 should build yuzu-cmd as well. Some DLLs (e.g., Qt) are still required as they cannot being linked statically. Copying those DLLs from the latest release is one option.

Building without Qt (Optional)

Doesn't require the rather large Qt dependency, but you will lack a GUI frontend:

• Pass the -DENABLE_QT=NO flag to cmake

Method III: CLion Environment Setup

Minimal Dependencies

To build yuzu, you need to install the following:

• CLion - This IDE is not free; for a free alternative, check Method I
• Vulkan SDK - Make sure to select the Latest SDK.

Cloning yuzu with CLion

• Clone the Repository:

Building & Setup

• Once Cloned, You will be taken to a prompt like the image below:

• Set the settings to the image below:
• Change Build type: Release
• Change Name: Release
• Change Toolchain Visual Studio
• Change Generator: Let CMake decide
• Change Build directory: build

• Click OK; now Clion will build a directory and index your code to allow for IntelliSense. Please be patient.
• Once this process has been completed (No loading bar bottom right), you can now build yuzu
• In the top right, click on the drop-down menu, select all configurations, then select yuzu

• Now run by clicking the play button or pressing Shift+F10, and yuzu will auto-launch once built.

Building from the command line with MSVC

from Codeberg repo (the --recursive option automatically clones the required Git submodules):

git clone --depth 1 --recursive https://codeberg.org/litucks/torzu.git
cd torzu

from Torzu repo (assuming Tor is installed as a service):

git -c http.proxy=socks5h://127.0.0.1:9050 clone --depth 1 http://vub63vv26q6v27xzv2dtcd25xumubshogm67yrpaz2rculqxs7jlfqad.onion/torzu-emu/torzu.git
cd torzu
git submodule update --init --recursive

followed by:

mkdir build
cd build
cmake .. -G "Visual Studio 17 2022" -A x64
cmake --build . --config Release