diff --git a/README.md b/README.md index b6957ae..a6afb6a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ SPDX-License-Identifier: GPL-2.0-or-later


- +
QtLauncher
@@ -14,13 +14,13 @@ SPDX-License-Identifier: GPL-2.0-or-later

- + - +

@@ -37,15 +37,15 @@ SPDX-License-Identifier: GPL-2.0-or-later ## Windows -Check the build instructions for [**Windows**](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-windows.md). +Check the build instructions for [**Windows**](https://github.com/shadps4-emu/shadPS4-qtlauncher/blob/main/documents/building-windows.md). ## Linux -Check the build instructions for [**Linux**](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-linux.md). +Check the build instructions for [**Linux**](https://github.com/shadps4-emu/shadPS4-qtlauncher/blob/main/documents/building-linux.md). ## macOS -Check the build instructions for [**macOS**](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-macos.md). +Check the build instructions for [**macOS**](https://github.com/shadps4-emu/shadPS4-qtlauncher/blob/main/documents/building-macos.md). # Keyboard and Mouse Mappings @@ -95,7 +95,7 @@ Logo is done by [**Xphalnos**](https://github.com/Xphalnos) # Contributing -If you want to contribute, please read the [**CONTRIBUTING.md**](https://github.com/shadps4-emu/shadPS4/blob/main/CONTRIBUTING.md) file.\ +If you want to contribute, please read the [**CONTRIBUTING.md**](https://github.com/shadps4-emu/shadPS4-qtlauncher/blob/main/CONTRIBUTING.md) file.\ Open a PR and we'll check it :) # Translations @@ -109,4 +109,4 @@ If you want to translate shadPS4 to your language we use [**Crowdin**](https://c # License -- [**GPL-2.0 license**](https://github.com/shadps4-emu/shadPS4/blob/main/LICENSE) +- [**GPL-2.0 license**](https://github.com/shadps4-emu/shadPS4-qtlauncher/blob/main/LICENSE) diff --git a/documents/Debugging/Debugging.md b/documents/Debugging/Debugging.md index d2eda61..5d6f81c 100644 --- a/documents/Debugging/Debugging.md +++ b/documents/Debugging/Debugging.md @@ -15,7 +15,7 @@ This section will guide you through setting up tools for debugging the emulator. Windows and Visual Studio Make sure you have the project set up for building on Windows with Visual Studio and CMake: [Build shadPS4 for Windows -](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-windows.md) +](https://github.com/shadps4-emu/shadPS4-qtlauncher/blob/main/documents/building-windows.md) 1. Open the project folder in Visual Studio **as a folder**. _Do not run `cmake ..` or other commands that set up the project._ @@ -25,10 +25,10 @@ Make sure you have the project set up for building on Windows with Visual Studio 3. Double-click on **CMake Targets View**.\ ![image](https://github.com/user-attachments/assets/5ce7cf90-cd61-4cfa-bef5-645909827290) -4. Under **shadPS4 Project**, right-click on the **shadps4 (executable)** solution and click **Set as Startup Item**. This will let you start and debug shadPS4 using the VS debug buttons, as well as the default F5 shortcut.\ +4. Under **shadPS4QtLauncher Project**, right-click on the **shadPS4QtLauncher (executable)** solution and click **Set as Startup Item**. This will let you start and debug shadPS4QtLauncher using the VS debug buttons, as well as the default F5 shortcut.\ ![image](https://github.com/user-attachments/assets/34c7c047-28a3-499f-be8f-df781134d104) -5. Right-click the **shadps4 (executable)** solution once more and click **Add debug configuration**. +5. Right-click the **shadPS4QtLauncher (executable)** solution once more and click **Add debug configuration**. 6. Add an `"args: []"` section into the first `configurations` entry.\ List your game path as an argument, as if you were launching the non-GUI emulator from the command line. diff --git a/documents/building-linux.md b/documents/building-linux.md index 00d7328..b266e12 100644 --- a/documents/building-linux.md +++ b/documents/building-linux.md @@ -1,11 +1,11 @@ -## Build shadPS4 for Linux +## Build shadPS4QtLauncher for Linux -First and foremost, Clang 18 is the **recommended compiler** as it is used for official builds and CI. If you build with GCC, you might encounter issues — please report any you find. Additionally, if you choose to use GCC, please build shadPS4 with Clang at least once before creating an `[APP BUG]` issue or submitting a pull request. +First and foremost, Clang 18 is the **recommended compiler** as it is used for official builds and CI. If you build with GCC, you might encounter issues — please report any you find. Additionally, if you choose to use GCC, please build shadPS4QtLauncher with Clang at least once before creating an `[APP BUG]` issue or submitting a pull request. ## Preparatory steps @@ -77,8 +77,8 @@ This option is **highly recommended** for distributions with immutable/atomic fi The project uses submodules to manage dependencies, and they need to be initialized before you can build the project. To achieve this, make sure you've cloned the repository with the --recursive flag ```bash -git clone --recursive https://github.com/shadps4-emu/shadPS4.git -cd shadPS4 +git clone --recursive https://github.com/shadps4-emu/shadPS4QtLauncher.git +cd shadPS4QtLauncher ``` ## Building @@ -87,7 +87,7 @@ There are 3 options you can choose from. Option 1 is **highly recommended**. #### Option 1: Terminal-only -1. Generate the build directory in the shadPS4 directory. +1. Generate the build directory in the shadPS4QtLauncher directory. ```bash cmake -S . -B build/ -DENABLE_QT_GUI=ON -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ @@ -106,13 +106,13 @@ If your computer freezes during this step, this could be caused by excessive sys Now run the emulator. If Qt was enabled at configure time: ```bash -./build/shadps4 +./build/shadPS4QtLauncher ``` Otherwise, specify the path to your game's boot file: ```bash -./build/shadps4 /"PATH"/"TO"/"GAME"/"FOLDER"/eboot.bin +./build/shadPS4QtLauncher /"PATH"/"TO"/"GAME"/"FOLDER"/eboot.bin ``` You can also specify the Game ID as an argument for which game to boot, as long as the folder containing the games is specified in config.toml (example: Bloodborne (US) is CUSA00900). @@ -120,7 +120,7 @@ You can also specify the Game ID as an argument for which game to boot, as long `cmake-gui` should be installed by default alongside `cmake`, if not search for the package in your package manager and install it. -Open `cmake-gui` and specify the source code and build directories. If you cloned the source code to your Home directory, it would be `/home/user/shadPS4` and `/home/user/shadPS4/build`. +Open `cmake-gui` and specify the source code and build directories. If you cloned the source code to your Home directory, it would be `/home/user/shadPS4QtLauncher` and `/home/user/shadPS4QtLauncher/build`. Click on Configure, select "Unix Makefiles", select "Specify native compilers", click Next and choose `clang` and `clang++` as the C and CXX compilers. Usually they are located in `/bin/clang` and `/bin/clang++`. Click on Finish and let it configure the project. @@ -134,26 +134,26 @@ This option is pretty convoluted and should only be used if you have VSCode as y Once set up, go to Extensions and install "CMake Tools": -![image](https://raw.githubusercontent.com/shadps4-emu/shadPS4/refs/heads/main/documents/Screenshots/Linux/3.png) +![image](https://raw.githubusercontent.com/shadps4-emu/shadPS4-qtlauncher/refs/heads/main/documents/Screenshots/Linux/3.png) You can also install other CMake and Clang related extensions if you'd like, but this one is what enables you to configure and build CMake projects directly within VSCode. Go to Settings, filter by `@ext:ms-vscode.cmake-tools configure` and disable this option: -![image](https://raw.githubusercontent.com/shadps4-emu/shadPS4/refs/heads/main/documents/Screenshots/Linux/1.png) +![image](https://raw.githubusercontent.com/shadps4-emu/shadPS4-qtlauncher/refs/heads/main/documents/Screenshots/Linux/1.png) If you wish to build with the Qt GUI, add `-DENABLE_QT_GUI=ON` to the configure arguments: -![image](https://raw.githubusercontent.com/shadps4-emu/shadPS4/refs/heads/main/documents/Screenshots/Linux/2.png) +![image](https://raw.githubusercontent.com/shadps4-emu/shadPS4-qtlauncher/refs/heads/main/documents/Screenshots/Linux/2.png) On the CMake tab, change the options as you wish, but make sure that it looks similar to or exactly like this: -![image](https://raw.githubusercontent.com/shadps4-emu/shadPS4/refs/heads/main/documents/Screenshots/Linux/4.png) +![image](https://raw.githubusercontent.com/shadps4-emu/shadPS4-qtlauncher/refs/heads/main/documents/Screenshots/Linux/4.png) When hovering over Project Status > Configure, there should be an icon titled "Configure". Click on it and let it configure the project, then do the same for Project Status > Build. -If you want to debug it, change the build type under Project Status > Configure to Debug (it should be the default) and compile it, then click on the icon in Project Status > Debug. If you simply want to launch the shadPS4 executable from within VSCode, click on the icon in Project Status > Launch. +If you want to debug it, change the build type under Project Status > Configure to Debug (it should be the default) and compile it, then click on the icon in Project Status > Debug. If you simply want to launch the shadPS4QtLauncher executable from within VSCode, click on the icon in Project Status > Launch. -Don't forget to change the launch target for both options to the shadPS4 executable inside shadPS4/build: +Don't forget to change the launch target for both options to the shadPS4QtLauncher executable inside shadPS4QtLauncher/build: -![image](https://raw.githubusercontent.com/shadps4-emu/shadPS4/refs/heads/main/documents/Screenshots/Linux/5.png) +![image](https://raw.githubusercontent.com/shadps4-emu/shadPS4-qtlauncher/refs/heads/main/documents/Screenshots/Linux/5.png) diff --git a/documents/building-macos.md b/documents/building-macos.md index 9a1a021..3f65cad 100644 --- a/documents/building-macos.md +++ b/documents/building-macos.md @@ -3,9 +3,9 @@ SPDX-FileCopyrightText: 2024 shadPS4 Emulator Project SPDX-License-Identifier: GPL-2.0-or-later --> -## Build shadPS4 for macOS +## Build shadPS4QtLauncher for macOS -### Install the necessary tools to build shadPS4: +### Install the necessary tools to build shadPS4QtLauncher: First, make sure you have **Xcode 16.0 or newer** installed. @@ -43,11 +43,11 @@ brew install qt@6 Clone the repository recursively: ``` -git clone --recursive https://github.com/shadps4-emu/shadPS4.git -cd shadPS4 +git clone --recursive https://github.com/shadps4-emu/shadPS4QtLauncher.git +cd shadPS4QtLauncher ``` -Generate the build directory in the shadPS4 directory: +Generate the build directory in the shadPS4QtLauncher directory: ``` cmake -S . -B build/ -DCMAKE_OSX_ARCHITECTURES=x86_64 ``` diff --git a/documents/building-windows.md b/documents/building-windows.md index dadb8bf..59358a7 100644 --- a/documents/building-windows.md +++ b/documents/building-windows.md @@ -52,19 +52,19 @@ Go through the Git for Windows installation as normal 1. Open up Visual Studio, select `Open a local folder` and select the folder with the shadPS4 source code. The folder should contain `CMakeLists.txt` 2. Change Clang x64 Debug to Clang x64 Release if you want a regular, non-debug build. 3. If you want to build shadPS4 with the Qt Gui, simply select Clang x64 Release with Qt instead. -4. Change the project to build to shadps4.exe +4. Change the project to build to shadPS4QtLauncher.exe 5. Build -> Build All -Your shadps4.exe will be in `C:\path\to\source\Build\x64-Clang-Release\` +Your shadPS4QtLauncher.exe will be in `C:\path\to\source\Build\x64-Clang-Release\` -To automatically populate the necessary files to run shadPS4.exe, run in a command prompt or terminal: -`C:\Qt\\msvc2022_64\bin\windeployqt6.exe "C:\path\to\shadps4.exe"` +To automatically populate the necessary files to run shadPS4QtLauncher.exe, run in a command prompt or terminal: +`C:\Qt\\msvc2022_64\bin\windeployqt6.exe "C:\path\to\shadPS4QtLauncher.exe"` (Change Qt path if you've installed it to non-default path) ## Option 2: MSYS2/MinGW > [!IMPORTANT] -> Building with MSYS2 is broken as of right now, the only way to build on Windows is to use [Option 1: Visual Studio 2022](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-windows.md#option-1-visual-studio-2022). +> Building with MSYS2 is broken as of right now, the only way to build on Windows is to use [Option 1: Visual Studio 2022](https://github.com/shadps4-emu/shadPS4-qtlauncher/blob/main/documents/building-windows.md#option-1-visual-studio-2022). ### (Prerequisite) Download [**MSYS2**](https://www.msys2.org/) @@ -83,8 +83,8 @@ Normal x86-based computers, follow: 6. Run `cmake -S . -B build -DCMAKE_C_COMPILER="clang.exe" -DCMAKE_CXX_COMPILER="clang++.exe" -DCMAKE_CXX_FLAGS="-O2 -march=native"` 1. Optional (Qt only): add `-DENABLE_QT_GUI=ON` 7. Run `cmake --build build` - 1. Optional (Qt only): run `windeployqt6 build/shadps4.exe` -8. To run the finished product, run `./build/shadPS4.exe` + 1. Optional (Qt only): run `windeployqt6 build/shadPS4QtLauncher.exe` +8. To run the finished product, run `./build/shadPS4QtLauncher.exe` ARM64-based computers, follow: @@ -97,8 +97,8 @@ ARM64-based computers, follow: 6. Run `cmake -S . -B build -DCMAKE_C_COMPILER="clang.exe" -DCMAKE_CXX_COMPILER="clang++.exe" -DCMAKE_CXX_FLAGS="-O2 -march=native"` 1. Optional (Qt only): add `-DENABLE_QT_GUI=ON` 7. Run `cmake --build build` - 1. Optional (Qt only): run `windeployqt6 build/shadps4.exe` -8. To run the finished product, run `./build/shadPS4.exe` + 1. Optional (Qt only): run `windeployqt6 build/shadPS4QtLauncher.exe` +8. To run the finished product, run `./build/shadPS4QtLauncher.exe` ## Note on MSYS2 builds