diff --git a/build-for-android.md b/build-for-android.md index f3e8fdc03..887c6a0e5 100644 --- a/build-for-android.md +++ b/build-for-android.md @@ -14,7 +14,7 @@ ### 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 +git clone --depth 1 --recursive https://notabug.org/litucks/torzu.git cd torzu ``` **from Torzu repo (assuming Tor is installed as a service):** diff --git a/build-for-linux.md b/build-for-linux.md index f11a3b0a5..e9d08b376 100644 --- a/build-for-linux.md +++ b/build-for-linux.md @@ -1,4 +1,37 @@ -### Dependencies +# Flatpak Build + +Install flatpak and flatpak-builder: + +* Arch / Manjaro: + - `sudo pacman -Syu --needed flatpak flatpak-builder` +* Debian / Ubuntu / Linux Mint: + - `sudo apt-get install flatpak flatpak-builder` +* Fedora: + - `sudo dnf install flatpak flatpak-builder` + +Install flatpak dependencies: + +``` +flatpak install org.kde.Sdk//5.15-23.08 io.qt.qtwebengine.BaseApp//5.15-23.08 +``` +Clone the torzu-flatpak repo and dependencies: +``` +git clone --depth 1 --recursive https://github.com/litucks/onion.torzu_emu.torzu.git +``` +Enter the cloned directory and run build script: +``` +cd onion.torzu_emu.torzu && ./build.sh +``` +Resulting `torzu.flatpak` will be in the same directory as the build script. + +To install: +``` +flatpak install torzu.flatpak +``` + +# Native Builds + +### Dependencies (copy/paste commands provided after) You'll need to download and install the following to build yuzu: @@ -33,13 +66,16 @@ If an ARM64 build is intended, export `VCPKG_FORCE_SYSTEM_BINARIES=1`. Dependencies are listed here as commands that can be copied/pasted. Of course, they should be inspected before being run. - Arch / Manjaro: + - `sudo pacman -Syu --needed base-devel boost catch2 cmake ffmpeg fmt git glslang libzip lz4 mbedtls ninja nlohmann-json openssl opus qt5 sdl2 zlib zstd zip unzip` - Building with QT Web Engine needs to be specified when running CMake with the param `-DCMAKE_CXX_FLAGS="-I/usr/include/qt/QtWebEngineWidgets"` with qt5-webengine installed. - GCC 11 or later is required. -- Ubuntu / Linux Mint / Debian: - - `sudo apt-get install autoconf cmake g++-11 gcc-11 git glslang-tools libasound2 libboost-context-dev libglu1-mesa-dev libhidapi-dev libpulse-dev libtool libudev-dev libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-render-util0 libxcb-xinerama0 libxcb-xkb1 libxext-dev libxkbcommon-x11-0 mesa-common-dev nasm ninja-build qtbase5-dev qtbase5-private-dev qtwebengine5-dev qtmultimedia5-dev libmbedtls-dev catch2 libfmt-dev liblz4-dev nlohmann-json3-dev libzstd-dev libssl-dev libavfilter-dev libavcodec-dev libswscale-dev` - - Ubuntu 22.04, Linux Mint 20, or Debian Bullseye or later is required. - - Users need to manually specify building with QT Web Engine enabled. This is done using the parameter `-DYUZU_USE_QT_WEB_ENGINE=ON` when running CMake. + +- Debian / Ubuntu / Linux Mint: + + - `sudo apt-get install autoconf cmake g++-11 gcc-11 git glslang-tools libasound2 libboost-context-dev libglu1-mesa-dev libhidapi-dev libpulse-dev libtool libudev-dev libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-render-util0 libxcb-xinerama0 libxcb-xkb1 libxext-dev libxkbcommon-x11-0 libxxhash-dev mesa-common-dev nasm ninja-build qtbase5-dev qtbase5-private-dev qttools5-dev qtwebengine5-dev qtmultimedia5-dev libmbedtls-dev catch2 libfmt-dev liblz4-dev nlohmann-json3-dev libzstd-dev libssl-dev libavfilter-dev libavcodec-dev libswscale-dev libva-dev` + - Debian 11 (Bullseye), Ubuntu 22.04, Linux Mint 20 or later is required. + - Users need to manually specify building with QT Web Engine enabled. This is done using the parameter `-DYUZU_USE_QT_WEB_ENGINE=ON` when running CMake. - Users need to manually specify building with GCC 11. This can be done by adding the parameters `-DCMAKE_C_COMPILER=gcc-11 -DCMAKE_CXX_COMPILER=g++-11` when running CMake. i.e. - Users need to manually disable building SDL2 from externals if they intend to use the version provided by their system by adding the parameters `-DYUZU_USE_EXTERNAL_SDL2=OFF` @@ -49,6 +85,7 @@ cmake .. -GNinja -DCMAKE_C_COMPILER=gcc-11 -DCMAKE_CXX_COMPILER=g++-11 ``` - Fedora: + - `sudo dnf install autoconf ccache cmake fmt-devel gcc{,-c++} glslang hidapi-devel json-devel libtool libusb1-devel libzstd-devel lz4-devel nasm ninja-build openssl-devel pulseaudio-libs-devel qt5-linguist qt5-qtbase{-private,}-devel qt5-qtwebengine-devel qt5-qtmultimedia-devel speexdsp-devel wayland-devel zlib-devel ffmpeg-devel libXext-devel` - Fedora 32 or later is required. - Due to GCC 12, Fedora 36 or later users need to install `clang`, and configure CMake to use it via `-DCMAKE_CXX_COMPILER=clang++ -DCMAKE_C_COMPILER=clang` @@ -56,7 +93,9 @@ cmake .. -GNinja -DCMAKE_C_COMPILER=gcc-11 -DCMAKE_CXX_COMPILER=g++-11 - SDL2: `-DYUZU_USE_BUNDLED_SDL2=OFF -DYUZU_USE_EXTERNAL_SDL2=OFF` - FFmpeg: `-DYUZU_USE_EXTERNAL_FFMPEG=OFF` - [RPM Fusion](https://rpmfusion.org/) (free) is required to install `ffmpeg-devel` + - Gentoo: + - **\*\*Disclaimer\*\***: this dependency list was written by a novice Gentoo user who first set it up with a DE, and then based this list off of the Fedora dependency list. This may be missing some requirements, or includes too many. Caveat emptor. - `emerge --ask app-arch/lz4 dev-libs/boost dev-libs/hidapi dev-libs/libzip dev-libs/openssl dev-qt/linguist dev-qt/qtconcurrent dev-qt/qtcore dev-util/cmake dev-util/glslang dev-vcs/git media-libs/alsa-lib media-libs/opus media-sound/pulseaudio media-video/ffmpeg net-libs/mbedtls sys-libs/zlib x11-libs/libXext` - GCC 11 or later is required. @@ -66,7 +105,7 @@ cmake .. -GNinja -DCMAKE_C_COMPILER=gcc-11 -DCMAKE_CXX_COMPILER=g++-11 **from Codeberg repo (the `--recursive` option automatically clones the required Git submodules):** ``` -git clone --depth 1 --recursive https://codeberg.org/litucks/torzu.git +git clone --depth 1 --recursive https://notabug.org/litucks/torzu.git cd torzu ``` diff --git a/build-for-macos.md b/build-for-macos.md index a7c90172d..864957f71 100644 --- a/build-for-macos.md +++ b/build-for-macos.md @@ -16,8 +16,6 @@ cmake .. -GNinja -DCMAKE_BUILD_TYPE=RelWithDebInfo -DYUZU_USE_BUNDLED_VCPKG=OFF ninja ``` -TODO: use newer vcpkg. This fixes the boost context library, and allows using the web service -TODO: figure out what's up with libusb - TODO: use newer vcpkg. This fixes the boost context library, and allows using the web service - TODO: figure out what's up with libusb diff --git a/build-for-windows.md b/build-for-windows.md index 42d3ac1e5..1e23214c8 100644 --- a/build-for-windows.md +++ b/build-for-windows.md @@ -1,58 +1,122 @@ -## Method I: MSVC Build for Windows +# Method I: MSVC Build for Windows (MS Visual Studio) -### Minimal Dependencies +### MSVC: Overview -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: + * Install Minimal Dependencies (details and setup below) + * Visual Studio Community 2022 + * CMake + * Vulkan SDK + * Python + * Git for Windows + * Build via Command Line (simplest if dependencies are installed correctly) + * (or) Build with GUI Tools (backup graphical interface) - * **[Visual Studio 2022 Community](https://visualstudio.microsoft.com/downloads/)** - **Make sure to select C++ support in the installer. Make sure to update to the latest version if already installed.** + +### MSVC: Install Minimal Dependencies + +To build torzu on Windows with Visual Studio, you need to install: + + * **[Visual Studio 2022 Community](https://visualstudio.microsoft.com/downloads/)** + * **Update to the latest version if already installed. (continued below)** ![](https://i.imgur.com/0jwV1hW.png) - * **[CMake](https://cmake.org/download/)** - Used to generate Visual Studio project files. Does not matter if either 32-bit or 64-bit version is installed. + * **Visual Studio 2022 Community (continued)** + * Be sure to select "Desktop development with C++" + * Select the MSVC components outlined in red below (**especially VS 2019 build tools**.) + + ![](https://i.imgur.com/NtSnqjm.png) + + ![](https://i.imgur.com/YLr1Qw2.png) + + * **[CMake](https://cmake.org/download/)** - Used to generate Visual Studio project files. Choose 32-bit or 64-bit according to your system. + * **If it asks to be added to your system PATH, say YES.** ![](https://i.imgur.com/7pteS6d.png) - * **[Vulkan SDK](https://vulkan.lunarg.com/sdk/home#windows)** - **Make sure to select Latest SDK.** + * **[Vulkan SDK](https://vulkan.lunarg.com/sdk/home#windows)** - Make sure to select Latest SDK. + * **If it asks to be added to your system PATH, say YES.** ![](https://i.imgur.com/aHCJxsR.png) - * **[Python](https://www.python.org/downloads/windows/)** - Select latest stable Windows installer. Does not matter if either 32-bit or 64-bit version is installed. + * **[Python](https://www.python.org/downloads/windows/)** - Select latest stable Windows installer. Choose 32-bit or 64-bit according to your system. + * **If it asks to be added to your system PATH, say YES.** ![](https://i.imgur.com/xIEuM6R.png) - * **Git** - We recommend [Git for Windows](https://gitforwindows.org). + * **[Git for Windows](https://gitforwindows.org)** - (see next step) ![](https://i.imgur.com/UeSzkBw.png) - * 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. + * When installing Git, include it in your system PATH by choosing the "**Git from the command line and also from 3rd-party software**" option. ![](https://i.imgur.com/x0rRs1t.png) -### Cloning yuzu with Git + * **REBOOT YOUR SYSTEM, to be sure all dependencies are registered before proceeding.** -**from Codeberg repo (the `--recursive` option automatically clones the required Git submodules):** +--- +--- + +## MSVC: Build from the Command Line + +* Open a command line (cmd.exe), navigate to a directory where you want to download the repo, then pick one option to clone into a subdirectory named "torzu": + +**from Notabug repo:** ``` -git clone --depth 1 --recursive https://codeberg.org/litucks/torzu.git -cd torzu +git clone --depth 1 https://notabug.org/litucks/torzu.git ``` **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 +``` + +* Assuming all dependencies were installed correctly, you should be able to continue from the above `git clone` and run the following commands to build: + +``` +cd torzu +git submodule update --init --recursive +mkdir build +cd build +cmake .. -G "Visual Studio 17 2022" -A x64 -DYUZU_TESTS=OFF +cmake --build . --config Release +``` +* You'll find the resulting files in the `build/bin/Release` folder. To make it a portable install with all AppData files local to the torzu folder, add a "user" folder: +``` +cd bin +cd Release +mkdir user +``` + +* **ERRORS:** If you get an error after running the first cmake command (such as a missing library or CMakeLists.txt), first try running `git submodule update --init --recursive` from inside "torzu" folder again. If that doesn't work, try deleting the whole "torzu" folder and recloning via git from the beginning (as sometimes submodules will be incomplete without throwing an error.) + +--- +--- + +## MSVC: Build with GUI Tools (Graphical Interface) + +* Open a command line (cmd.exe), navigate to a directory where you want to download the repo, then pick one option to clone into a subdirectory named "torzu": + +**from Notabug repo:** +``` +git clone --depth 1 https://notabug.org/litucks/torzu.git +``` +**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 +``` +then download dependencies with: +``` cd torzu git submodule update --init --recursive ``` - ![](https://i.imgur.com/CcxIAht.png) + -* *(Note: yuzu by default downloads to `C:\Users\\yuzu` (Master) or `C:\Users\\yuzu-mainline` (Mainline)* - -### Building - -* Open the CMake GUI application and point it to the `torzu` directory. +* Open the CMake GUI application and point it to the `torzu` directory (instead of `yuzu-canary`). ![](https://i.imgur.com/qOslIWv.png) -* For the build directory, use a `/build` subdirectory inside the source directory or some other directory of your choice. (Tell CMake to create it.) +* Use a `/build` subdirectory inside the `torzu` directory or some other directory of your choice. (Tell CMake to create it.) ![](https://i.imgur.com/cNnhs22.png) ![](https://github.com/yuzu-emu/yuzu/assets/20753089/738efcab-0da6-44ce-889d-becf3712db10) @@ -63,27 +127,23 @@ git submodule update --init --recursive * *(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. +* **ERRORS:** 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.)* ![](https://user-images.githubusercontent.com/22451773/180585999-07316d6e-9751-4d11-b957-1cf57cd7cd58.png) -* 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. - - ![](https://i.imgur.com/NtSnqjm.png) - - ![](https://i.imgur.com/YLr1Qw2.png) +* **ERRORS:** If you get an error "Unable to find a valid Visual Studio instance", make sure that you installed the required MSVC components displayed above (**especially VS 2019 build tools**) and then try again. * Click "Generate" to create the project files. ![](https://i.imgur.com/5LKg92k.png) -* Open the solution file `yuzu.sln` in Visual Studio 2022, which is located in the build folder. +* Open the solution file `yuzu.sln` in Visual Studio 2022, which is located in the `build` directory. ![](https://i.imgur.com/208yMml.png) -* 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 `yuzu` in the Solution Explorer, right-click and `Set as StartUp Project` (the yuzu, yuzu-cmd and yuzu-room executables will all be built.) ![](https://i.imgur.com/nPMajnn.png) ![](https://i.imgur.com/BDMLzRZ.png) @@ -95,24 +155,32 @@ git submodule update --init --recursive ![](https://i.imgur.com/CkQgOFW.png) -* After build completed you can find the Torzu executable in directory specified in output log. +* After build completed you can find the Torzu program files in a directory specified in the output log (usually `build\bin\Release`.) ![](https://i.imgur.com/h78ugDN.png) +--- +--- +--- +--- +--- -## Method II: MinGW-w64 Build with MSYS2 +# Method II: MinGW-w64 Build with MSYS2 -### Prerequisites to install +## Prerequisites to install * [MSYS2](https://www.msys2.org) * [Vulkan SDK](https://vulkan.lunarg.com/sdk/home#windows) - **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 +## Install other dependencies * Open the `MSYS2 MinGW 64-bit` (mingw64.exe) shell + +![](https://i.imgur.com/uZ33O7u.png) + * 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 +## Setup environment variables ``` export PATH=":$PATH" export VCPKG_DEFAULT_HOST_TRIPLET=x64-mingw-static @@ -121,29 +189,34 @@ 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 +## Clone the torzu repository with Git -**from NotABug repo (the `--recursive` option automatically clones the required Git submodules):** +Navigate to a directory where you want the repo, then use one option below to clone into a subdirectory named "torzu": + + + +**from NotABug repo:** ``` -git clone --depth 1 --recursive https://notabug.org/litucks/torzu.git -cd torzu -git submodule update --init --recursive +git clone --depth 1 https://notabug.org/litucks/torzu.git ``` **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 +``` +then download the submodule dependencies with: +``` cd torzu -git submodule update --init --recursive +git submodule update --init --recursive ``` -### Generating makefile +## 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 +## Build torzu ``` make -j$(nproc) yuzu ``` @@ -170,32 +243,41 @@ Please note that `-lw2_32` is already added, but the order is not correct and he 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) +## 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 +# Method III: CLion Environment Setup + +## Minimal Dependencies To build yuzu, you need to install the following: * [CLion](https://www.jetbrains.com/clion/) - This IDE is not free; for a free alternative, check Method I * [Vulkan SDK](https://vulkan.lunarg.com/sdk/home#windows) - Make sure to select the Latest SDK. -### Cloning yuzu with CLion +## Cloning yuzu with CLion * Clone the Repository: ![1](https://user-images.githubusercontent.com/42481638/216899046-0d41d7d6-8e4d-4ed2-9587-b57088af5214.png) + +* using `https://notabug.org/litucks/torzu.git` (instead of the shown yuzu repo): + ![2](https://user-images.githubusercontent.com/42481638/216899061-b2ea274a-e88c-40ae-bf0b-4450b46e9fea.png) ![3](https://user-images.githubusercontent.com/42481638/216899076-0e5988c4-d431-4284-a5ff-9ecff973db76.png) -### Building & Setup +## Building & Setup * Once Cloned, You will be taken to a prompt like the image below: @@ -220,23 +302,3 @@ To build yuzu, you need to install the following: ![7](https://user-images.githubusercontent.com/42481638/216899275-d514ec6a-e563-470e-81e2-3e04f0429b68.png) -## 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 -``` \ No newline at end of file