|
| 1 | +# ShadPS4 is an expoerimental Sony Playstation 4 Emulator. |
| 2 | + |
| 3 | + |
| 4 | +Website: [https://shadps4.net/](https://shadps4.net/) |
| 5 | + |
| 6 | +FAQ: [https://shadps4.net/index.php/faq/](https://shadps4.net/index.php/faq/) |
| 7 | + |
| 8 | +GitHub: [https://github.com/shadps4-emu/shadPS4](https://github.com/shadps4-emu/shadPS4) |
| 9 | + |
| 10 | +Compatibility List: [https://github.com/shadps4-emu/shadps4-game-compatibility](https://github.com/shadps4-emu/shadps4-game-compatibility) |
| 11 | + |
| 12 | +shadps4 Wiki: [https://wiki.shadps4.net/index.php?title=Main_Page](https://shadps4.net/compatibility) |
| 13 | + |
| 14 | +*** |
| 15 | + |
| 16 | +## shadps4 Table of Contents |
| 17 | + |
| 18 | +1. [Getting Started with shadps4](#getting-started-with-shadps4) |
| 19 | + - [Configuration](#shadps4-configuration) |
| 20 | + - [shadps4 Folder Locations](#shadps4-folder-locations) |
| 21 | + - [How to Update shadps4](#how-to-update-shadps4) |
| 22 | + - [How to Launch shadps4 in Desktop Mode](#how-to-launch-shadps4-in-desktop-mode) |
| 23 | + - [File Formats](#shadps4-file-formats) |
| 24 | + - [PKG and RAP File Format](#pkg-and-rap-file-format) |
| 25 | + - [Steam ROM Manager Parsers](#steam-rom-manager-parsers) |
| 26 | + |
| 27 | +*** |
| 28 | + |
| 29 | +## Getting Started with shadps4 |
| 30 | +[Back to the Top](#shadps4-table-of-contents) |
| 31 | + |
| 32 | +In order to play a game on shadps4, you need to the games through the shadps4 UI. In desktop mode, open shadps4, either in the application menu or through its shortcut in `Emulation/tools/launchers/shadps4.sh`. In shadps4, click File, click Install Packages(PKG) and select your game, this will install it to Emulation/storage/shadps4/games |
| 33 | + |
| 34 | +Read the [Configuration](#shadps4-configuration) section to learn more about shadps4 and its folder locations. |
| 35 | + |
| 36 | +To launch your ROMs in game mode, use Steam ROM Manager and use one of the following parsers to play your Playstation 4 ROMs: |
| 37 | + |
| 38 | +* `ES-DE` |
| 39 | + * To play PS4 games in ES-DE, see [How to Configure shadps4 to Work With ES-DE and Pegasus](#how-to-configure-shadps4-to-work-with-es-de-and-pegasus) |
| 40 | +* `Sony PlayStation 4 - ShadPS4 (Shortcut)` |
| 41 | + * Read the [File Formats](#shadps4-file-formats) section to learn more about these various file formats |
| 42 | +* `Emulators` |
| 43 | + |
| 44 | +*** |
| 45 | + |
| 46 | +### shadps4 Configuration |
| 47 | +[Back to the Top](#shadps4-table-of-contents) |
| 48 | + |
| 49 | +* Type of Emulator: AppImage |
| 50 | +* Config Location: `/home/deck/Applications/shadps4-qt.AppImage` |
| 51 | +* Storage Location: `Emulation/storage/shadps4/games` |
| 52 | +* DLC Location: `Emulation/storage/shadps4/dlc` |
| 53 | +* ROM Location: `Emulation/roms/ps4` |
| 54 | +* Saves: |
| 55 | + * Folder: `Emulation/saves/shadps4/saves` |
| 56 | + |
| 57 | +* Your game will not show in the shadps4 UI until you add it manually through the `Install Packages(PKG)` option under `File` in the top left. |
| 58 | + |
| 59 | +#### Works With |
| 60 | +* Steam ROM Manager |
| 61 | +* ES-DE |
| 62 | +* Pegasus |
| 63 | + |
| 64 | +*** |
| 65 | + |
| 66 | +### shadps4 Folder Locations |
| 67 | +[Back to the Top](#shadps4-table-of-contents) |
| 68 | + |
| 69 | +These file locations apply regardless of where you chose to install EmuDeck (to your internal SSD, to your SD Card, or elsewhere). Some emulator configuration files will be located on the internal SSD as listed below. |
| 70 | + |
| 71 | +??? info "The Basics" |
| 72 | + |
| 73 | + {{ home }} |
| 74 | + |
| 75 | + {{ emulation }} |
| 76 | + |
| 77 | + {{ hiddenfolders }} |
| 78 | + |
| 79 | + |
| 80 | + |
| 81 | +`~/.config/shadps4` |
| 82 | + |
| 83 | +`~/.local/share/shadps4` |
| 84 | + |
| 85 | +`Emulation/storage/shadps4` |
| 86 | + |
| 87 | +``` |
| 88 | +shadps4/ |
| 89 | +└── games |
| 90 | +└── dlc |
| 91 | +``` |
| 92 | + |
| 93 | +*** |
| 94 | + |
| 95 | +### How to Update shadps4 |
| 96 | +[Back to the Top](#shadps4-table-of-contents) |
| 97 | + |
| 98 | +* Through the `Update your Emulators` section on the `Manage Emulators` page in the `EmuDeck` application |
| 99 | +* Through `binupdate.sh` in `Emulation/tools/binupdate`, double click to launch |
| 100 | + |
| 101 | +*** |
| 102 | + |
| 103 | +### How to Launch shadps4 in Desktop Mode |
| 104 | +[Back to the Top](#shadps4-table-of-contents) |
| 105 | + |
| 106 | +* Launch `ShadPS4 AppImage` from the Applications Launcher (Steam Deck icon in the bottom left of the taskbar) |
| 107 | +* Launch the script from `Emulation/tools/launchers`, `shadps4.sh` |
| 108 | +* Launch the emulator from `Steam` after adding it via the `Emulators` parser in `Steam ROM Manager` |
| 109 | + |
| 110 | + |
| 111 | +*** |
| 112 | + |
| 113 | +### shadps4 File Formats |
| 114 | +[Back to the Top](#shadps4-table-of-contents) |
| 115 | + |
| 116 | +- [PKG Format](#pkg-and-rap-file-format) |
| 117 | + |
| 118 | +#### PKG and RAP File Format |
| 119 | +[Back to the Top](#shadps4-file-formats) |
| 120 | + |
| 121 | +Install `.pkg` files directly through the shadps4 GUI. `.pkg` files are installed to `Emulation/storage/shadps4/games/`. |
| 122 | + |
| 123 | +After that right click on the installed game and select "Create Desktop", copy the new .desktop file you'll find in your Desktop to `Emulation/roms/ps4/shortcuts/` |
| 124 | + |
| 125 | +*** |
| 126 | + |
| 127 | +### Steam ROM Manager Parsers |
| 128 | +[Back to the Top](#shadps4-table-of-contents) |
| 129 | + |
| 130 | +* PKG Format: Use the `Sony PlayStation 4 - ShadPS4 (Shortcut)` parser |
| 131 | + |
| 132 | +*** |
| 133 | + |
| 134 | +### How to Configure shadps4 to Work With ES-DE and Pegasus |
| 135 | +[Back to the Top](#shadps4-table-of-contents) |
| 136 | + |
| 137 | +## AppImage |
| 138 | + |
| 139 | +1. In `Desktop Mode`, open shadps4 |
| 140 | +2. Skip this step if you have already added your games to shadps4: |
| 141 | + * Either: |
| 142 | + * In the top left click, `File`, click `Install Packages (PKG)`, and install your PKG |
| 143 | + * For more information, read the [File Formats](#shadps4-file-formats) section |
| 144 | +3. Right click your game, click `Create Shortcut`, click `Create Desktop Shortcut` |
| 145 | +4. On your desktop, you should see an icon for your game. Move this icon to `Emulation/roms/ps4/shortcuts` |
| 146 | + * If your desktop shortcut contains special icons any special symbols (Ex: the copyright symbol, `©`), rename the desktop file to remove these symbols. |
| 147 | + * For example, rename `God Of War® Collection.desktop` to `God Of War Collection.desktop`, removing the `©` after `War` |
| 148 | +5. (Optional) If the desktop file is opening shadps4 instead of the game: |
| 149 | + * In Desktop Mode, right click the desktop file |
| 150 | + * Click `Properties` |
| 151 | + * On the `General` tab, click `Change` to the right of the `Open With` line |
| 152 | + * Under `Application Preference Order`, click `shadps4` |
| 153 | + * Click `Remove` on the right |
| 154 | + * Click `Apply` in the bottom left and click `OK` |
| 155 | + * The desktop file will not work in Desktop Mode, but will launch the game directly either through a terminal or through ES-DE |
| 156 | +6. Your game should now show up in and launch directly from ES-DE and Pegasus |
| 157 | + |
| 158 | +If you get an `Invalid file or folder` error message, you will need to change the `Alternative Emulator` in ES-DE for PlayStation 4 to `shadps4 Shortcut [Standalone]`. |
| 159 | + |
| 160 | +You may also do this on a per-game basis if you are using a mix of folders and PKGs. On a game, press the `select ` button, scroll down and select `EDIT THIS GAME'S METADATA`, scroll down and select `ALTERNATIVE EMULATOR`, select PS4 and select the corresponding format. |
| 161 | + |
| 162 | +Refer to [https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#sony-playstation-4](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#sony-playstation-4), for additional information. |
| 163 | + |
| 164 | +*** |
0 commit comments