diff --git a/I.-Quick-start-[Users].md b/I.-Quick-start-[Users].md index 1ce25a8..965686d 100644 --- a/I.-Quick-start-[Users].md +++ b/I.-Quick-start-[Users].md @@ -3,7 +3,8 @@ #### This guide gives you the basics for installing the emulator in the best possible conditions, including all the pre-requisites for launching a game. > [!WARNING] -> The emulator is still experimental, so many errors and impossibility to play are possible. +> shadPS4 is still early in development. Many games do not work, and the few that do work usually face various emulation issues. +
You can view the official compatibility list at https://shadps4.net/compatibility/ --- ## 1. Requirements @@ -21,7 +22,7 @@ #### GPU -- A graphics card with at least 1GB of VRAM +- A graphics card with at least 2GB of VRAM - Vulkan 1.3 with the `VK_KHR_swapchain` and `VK_KHR_push_descriptor` extensions #### RAM @@ -34,15 +35,18 @@ ### 1.2 Required Drivers -Before proceeding, update your drivers: +Before proceeding, ensure your drivers are up to date: 1. Find out which brand of graphics card you use. 2. Download the appropriate one for your operating system: - **Nvidia: https://www.nvidia.com/en-us/drivers** - **AMD: https://www.amd.com/en/support/download/drivers.html** - **Intel: https://www.intel.com/content/www/us/en/download-center/home.html** -3. You should also check that your iGPU is up to date using the links above. -4. For Windows user: Don't trust Windows update especially for iGPU. + +> [!TIP] +> Make sure to update the drivers for all graphics cards in your computer, including any integrated graphics cards. +
Outdated drivers, even for a graphics card you aren't using, can interfere with shadPS4. + --- ## 2. Installation @@ -50,26 +54,26 @@ Before proceeding, update your drivers: ### 2.1 Download shadPS4 > [!TIP] -> For a quick start, we will use the **QT** version. QT means that the emulator comes with a GUI that makes it easy to use and configure. ->
The other way is SDL but we will not use it for now. +> For a quick start, we will use the **Qt** version. The Qt version of shadPS4 comes with a GUI that makes it easier to use and configure. +
There are also SDL builds, which run through the command line. These builds are less user-friendly, so using Qt builds is recommended for newer users. 1. Follow this link: **https://github.com/shadps4-emu/shadPS4/releases** 2. You can decide between two release version: -- `Pre-release-xxx` (Also known as "Nightly", this is the last release) -- `Release` (Latest major release, eg 0.5.0) -3. Click on `⏵ Asserts`, you're going to see a lot of differents versions you need to locate the one containing your OS (`win64`, `linux`, `macos`) and the word `QT`. -
For example, if you want the latest version for Windows, click on `shadps4-win64-qt-xxxx-xx-xx-xxxxxxx.zip`. +- `Pre-release-xxx` (These are unstable builds with the most recent development changes) +- `Release` (Latest stable release, eg 0.10.0) +3. Click on `⏵ Assets`, and find a file with your OS (`win64`, `linux`, `macos`) and the word `Qt` in the name. + - For example, if you want the latest version for Windows, click on `shadps4-win64-qt-xxxx-xx-xx-xxxxxxx.zip`. +4. Extract the downloaded archive to your preferred location. +> [!WARNING] +> Do not extract shadPS4, or set any of it's user-selected directories into a folder that requires privilages to access! +
This can cause various weird emulation issues, or prevent shadPS4 from running entirely. +--- -### 2.2 Move & Extract it - -1. Move your newly downloaded archive to the folder of your choice. _It can be everywhere_ -2. Extract it (Using built-in app or app like winrar, 7z, etc...) **For Windows:** 1. First, you will need **Microsoft Visual C++ 2022** to run it. -
Download it from here: **https://aka.ms/vs/17/release/vc_redist.x64.exe** and install it before next step + - Download it from here: **https://aka.ms/vs/17/release/vc_redist.x64.exe** and install it before next step 2. Open the folder newly extracted and run shadPS4.exe. -
The first time, Windows will maybe ask you about security, you can agree. **For Linux:** 1. Open the folder newly extracted. @@ -86,30 +90,32 @@ Before proceeding, update your drivers: ## 3. Install games and updates > [!CAUTION] -> **Games and its updates are copyrighted content and must be dumped from your \*own\* copy of the game.** +> **Games and game updates are copyrighted content and must be dumped from your own copy of the game.** The emulator is now started. Now you want to install your first game(s). 1. Use a dumper tool (app/payload) on your jailbroken PS4 to extract your game to a external media storage. ItemzFlow is recommended for dumping both games and updates. 2. Prepare your game dump by making sure the folder has the right name format: `CUSAxxxxx` (where `xxxxx` is the game's serial). -
Most dumping payloads already do this, if the folder name already has this format, skip to step 3. + - If you're using ItemzFlow, your game folder will already have the correct name. 3. Find the game installation folder provided on first boot. This can be found on the settings. -4. Take your dump and copy it to the game installation folder. +4. Take your game dump and copy it to the game installation folder. 5. Once finished, the game should appear in the UI. The process for installing updates is the same: 1. Prepare your dump of the game update by making sure the folder has the right name format: `CUSAxxxxx-patch`/`CUSAxxxxx-UPDATE` -
Most dumping payloads already do this, if the folder name already has this format, skip to step 2. -2. Once finished, the update should be recognized in the UI. + - If you're using ItemzFlow, your update folder will already have the correct name. +2. Copy the game update to your game installation folder. +3. Once finished, the game should show the installed update version in the UI. --- -## 4. Adding modules +## 4. Dumping firmware modules shadPS4 can load some modules in: * `LLE mode`: Low Level Emulation: Using the firmware files of the console directly; * `HLE mode`: High Level Emulation: Providing a reimplementation for the original module in the emulator source code. -For some of the modules, it is necessary to process them in **HLE**. For others, they can be replaced by these supported modules and must be placed under `user/sys_modules` folder. Tested FW modules are from **11.00**. -Some of the firmware libraries have to be emulated, some of them not necessarily have to, but already have a full HLE implementation, but some libraries don't have working reimplementations yet, but can be loaded LLE. The modules below can be dumped from your console and added to shadPS4 to greatly increase game compatibility, and make emulation better. The goal is to eventually not have to rely on firmware modules at all, but there's still a long way to go to achieve that. +While several modules are reimplemented, there are still some modules we haven't implemented yet. The modules below can be dumped from your console and added to shadPS4 to increase game compatibility. These modules need to be added to your shadPS4 user folder, which you can find by right clicking on a game, choosing `Open Folder -> Open Log Folder`, and backing out to the previous folder. + +The following is a list of the currently supported firmware modules:
@@ -121,11 +127,15 @@ Some of the firmware libraries have to be emulated, some of them not necessarily
- -To dump your system modules, enable an FTP Server on your PS4, open an FTP Client on your computer (like FileZilla), connect to your PS4 by adding its IP Address and the port to the FTP server, then navigate to ``/system/common/lib/``. Now dump the modules on your PC. It is recommended to dump all modules in the folder in case some are supported in the future, but you can also dump only the ones listed below. Once they're dumped you can place them in the ``sys_modules`` folder located either in your user folder in your shadPS4 install or in your operating system's default config folder. +To dump your firmware modules, enable an FTP Server on your PS4, open an FTP Client on your computer (like FileZilla), connect to your PS4 by adding its IP Address and the port to the FTP server, then navigate to ``/system/common/lib/``. Now dump the modules on your PC. It is recommended to dump all modules in the folder in case some are supported in the future. Once they're dumped you can place them in the ``sys_modules`` folder located either in your user folder in your shadPS4 install or in your operating system's default config folder. --- -## 5. Configure the emulator +## 5. Dumping the trophy key +To dump the trophy key, use the FTP setup from the prior step, navigate to ``/system/vsh``, and copy the file named `SceShellCore.elf` to your device. Then, using [tropy_key_export.zip](https://github.com/user-attachments/files/21354959/tropy_key_export.zip) through a command prompt, input your dumped `SceShellCore.elf` and it will output the trophy key. Just copy the key into shadPS4's trophy key setting, or directly into your shadPS4 config.toml, and shadPS4 can now extract and unlock trophies as you play. + +The trophy key dumper is only designed for Windows. There currently isn't a native Linux or Mac program for dumping the trophy key. + +## 6. Configure the emulator Congratulations, your emulator has all the files needed to run your games!
You can now start to configure the emulator settings [**here**](https://github.com/shadps4-emu/shadPS4/wiki/II.-Setting-up-shadPS4-%5BUsers%5D). \ No newline at end of file