diff --git a/Building-for-Windows.md b/Building-for-Windows.md index e07f96c..249d270 100644 --- a/Building-for-Windows.md +++ b/Building-for-Windows.md @@ -4,7 +4,7 @@ ### 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: +On Windows, all library dependencies are automatically included within the `externals` folder, or can be downloaded on-demand. To build suyu, you need to install: * **[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.** * **[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. @@ -20,33 +20,27 @@ On Windows, all library dependencies are automatically included within the `exte ![4](https://i.imgur.com/x0rRs1t.png) -### Cloning yuzu with Git +### Cloning suyu with Git **Master:** ```cmd - git clone --recursive https://github.com/yuzu-emu/yuzu.git - cd yuzu - ``` - -**Mainline (no assert):** - ```cmd - git clone --recursive https://github.com/yuzu-emu/yuzu-mainline.git - cd yuzu-mainline + git clone --recursive https://git.suyu.dev/suyu/suyu + cd suyu ``` ![9](https://i.imgur.com/CcxIAht.png) -* *(Note: yuzu by default downloads to `C:\Users\\yuzu` (Master) or `C:\Users\\yuzu-mainline` (Mainline)* +* *(Note: suyu by default downloads to `C:\Users\\suyu` (Master) ### Building -* Open the CMake GUI application and point it to the `yuzu` (Master) or `yuzu-mainline` (Mainline) directory. +* Open the CMake GUI application and point it to the `suyu` (Master) ![10](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.) - ![11](https://github.com/yuzu-emu/yuzu/assets/20753089/738efcab-0da6-44ce-889d-becf3712db10) + ![11](https://git.suyu.dev/suyu-emu/suyu/assets/20753089/738efcab-0da6-44ce-889d-becf3712db10) * Click the "Configure" button and choose `Visual Studio 17 2022`, with `x64` for the optional platform. @@ -54,9 +48,9 @@ On Windows, all library dependencies are automatically included within the `exte * *(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. +* If you get an error about missing packages, enable `SUYU_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.)* + * *(You may also want to disable `SUYU_TESTS` in this case since Catch2 is not yet supported with this.)* ![13](https://user-images.githubusercontent.com/22451773/180585999-07316d6e-9751-4d11-b957-1cf57cd7cd58.png) @@ -64,11 +58,11 @@ On Windows, all library dependencies are automatically included within the `exte ![15](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 `suyu.sln` in Visual Studio 2022, which is located in the build folder. ![16](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`. +* Depending if you want a graphical user interface or not (`suyu` has the graphical user interface, while `suyu-cmd` doesn't), select `suyu` or `suyu-cmd` in the Solution Explorer, right-click and `Set as StartUp Project`. ![17](https://i.imgur.com/nPMajnn.png) ![18](https://i.imgur.com/BDMLzRZ.png) @@ -80,7 +74,7 @@ On Windows, all library dependencies are automatically included within the `exte ![20](https://i.imgur.com/CkQgOFW.png) -Feel free to ask us in the IRC channel #yuzu-emu @ [libera](https://web.libera.chat) or on [Discord](https://discord.com/invite/u77vRWY) if you have issues. +Feel free to ask us in the IRC channel #suyu-emu @ [libera](https://web.libera.chat) or on [Discord](https://discord.gg/suyu) if you have issues. ## Method II: MinGW-w64 Build with MSYS2 @@ -90,28 +84,28 @@ Feel free to ask us in the IRC channel #yuzu-emu @ [libera](https://web.libera.c * [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 yuzu dependencies for MinGW-w64 +### Install suyu dependencies for MinGW-w64 * 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-python-pip mingw-w64-x86_64-qt5 mingw-w64-x86_64-toolchain autoconf libtool automake-wrapper` * Add MinGW binaries to the PATH: `echo 'PATH=/mingw64/bin:$PATH' >> ~/.bashrc` * Add glslangValidator to the PATH: `echo 'PATH=$(readlink -e /c/VulkanSDK/*/Bin/):$PATH' >> ~/.bashrc` -### Clone the yuzu repository with Git +### Clone the suyu repository with Git ```bash - git clone --recursive https://github.com/yuzu-emu/yuzu.git - cd yuzu + git clone --recursive https://git.suyu.dev/suyu/suyu + cd suyu ``` -### Run the following commands to build yuzu (dynamically linked build) +### Run the following commands to build suyu (dynamically linked build) ```bash mkdir build && cd build -cmake -G "MSYS Makefiles" -DYUZU_USE_BUNDLED_VCPKG=ON -DYUZU_TESTS=OFF .. +cmake -G "MSYS Makefiles" -DSUYU_USE_BUNDLED_VCPKG=ON -DSUYU_TESTS=OFF .. make -j$(nproc) -# test yuzu out with -./bin/yuzu.exe +# test suyu out with +./bin/suyu.exe ``` * *(Note: This build is not a static build meaning that you need to include all of the DLLs with the .exe in order to use it!)* @@ -135,12 +129,12 @@ Doesn't require the rather large Qt dependency, but you will lack a GUI frontend ### Minimal Dependencies -To build yuzu, you need to install the following: +To build suyu, 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 suyu with CLion * Clone the Repository: @@ -166,20 +160,20 @@ To build yuzu, you need to install the following: ![5](https://user-images.githubusercontent.com/42481638/216899164-6cee8482-3d59-428f-b1bc-e6dc793c9b20.png) * 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 +* Once this process has been completed (No loading bar bottom right), you can now build suyu +* In the top right, click on the drop-down menu, select all configurations, then select suyu ![6](https://user-images.githubusercontent.com/42481638/216899226-975048e9-bc6d-4ec1-bc2d-bd8a1e15ed04.png) -* Now run by clicking the play button or pressing Shift+F10, and yuzu will auto-launch once built. +* Now run by clicking the play button or pressing Shift+F10, and suyu will auto-launch once built. ![7](https://user-images.githubusercontent.com/42481638/216899275-d514ec6a-e563-470e-81e2-3e04f0429b68.png) ## Building from the command line with MSVC ```cmd -git clone --recursive https://github.com/yuzu-emu/yuzu -cd yuzu +git clone --recursive https://git.suyu.dev/suyu/suyu +cd suyu mkdir build cd build cmake .. -G "Visual Studio 17 2022" -A x64