shadPS4 README

The project's README from github.com/shadps4-emu/shadPS4. As one markdown file: README.md.



shadPS4

Bloodborne by From Software Hatsune Miku Project DIVA Future Tone by SEGA
Bloodborne screenshot Project DIVA screenshot
Yakuza 0 by SEGA DRIVECLUB™ by Evolution Studios
Yakuza screenshot DRIVECLUB screenshot

General information

shadPS4 is an early PlayStation 4 emulator for Windows, Linux and macOS written in C++.

[!IMPORTANT] This is the emulator core, which does not include a GUI. If you just want to use the emulator as an end user, download the QtLauncher instead.

If you encounter problems or have doubts, do not hesitate to look at the Quickstart.
To verify that a game works, you can look at shadPS4 Game Compatibility.
To discuss shadPS4 development, suggest ideas or to ask for help, join our Discord server.
To get the latest news, go to our X (Twitter) or our website.
You can donate to the project via our Kofi page.

Status

[!IMPORTANT] shadPS4 is early in development, don't expect a flawless experience.

Currently, the emulator can successfully run games like Bloodborne, Dark Souls Remastered, Red Dead Redemption, and many other games.

Why

This project began for fun. Given our limited free time, it may take some time before shadPS4 can run more complex games, but we're committed to making small, regular updates.

Building

Docker

For building shadPS4 in a containerized environment using Docker and VSCode, check the instructions here:
Docker Build Instructions

Windows

Check the build instructions for Windows.

Linux

Check the build instructions for Linux.

macOS

Check the build instructions for macOS.

[!IMPORTANT] macOS users need at least macOS 26.0 to run shadPS4. Intel Macs are not supported.

Usage examples

[!IMPORTANT] For a user-friendly GUI, download the QtLauncher.

To get the list of all available commands and also a more detailed description of what each command does, please refer to the --help flag's output.

Below is a list of commonly used command patterns:

shadPS4 CUSA00001 # Searches for a game folder called CUSA00001 in the list of game install folders, and boots it.
shadPS4 --fullscreen true --config-clean CUSA00001    # the game argument is always the last one,
shadPS4 -g CUSA00001 --fullscreen true --config-clean # ...unless manually specified otherwise.
shadPS4 /path/to/game.elf # Boots a PS4 ELF file directly. Useful if you want to boot an executable that is not named eboot.bin.
shadPS4 CUSA00001 -- -flag1 -flag2 # Passes '-flag1' and '-flag2' to the game executable in argv.

Debugging and reporting issues

For more information on how to test, debug and report issues with the emulator or games, read the Debugging documentation.

Keyboard and Mouse Mappings

[!NOTE] Some keyboards may also require you to hold the Fn key to use the F* keys. Mac users should use the Command key instead of Control, and need to use Command+F11 for full screen to avoid conflicting with system key bindings.

Button Function
F10 FPS Counter
Ctrl+F10 Video Debug Info
F11 Fullscreen
F12 Trigger RenderDoc Capture (or game-only screenshot if RenderDoc is unavailable)
Alt+F12 Capture screenshot including HUD/dialog overlays

[!NOTE] Xbox and DualShock controllers work out of the box.

Controller button Keyboard equivalent
LEFT AXIS UP W
LEFT AXIS DOWN S
LEFT AXIS LEFT A
LEFT AXIS RIGHT D
RIGHT AXIS UP I
RIGHT AXIS DOWN K
RIGHT AXIS LEFT J
RIGHT AXIS RIGHT L
TRIANGLE Numpad 8 or C
CIRCLE Numpad 6 or B
CROSS Numpad 2 or N
SQUARE Numpad 4 or V
PAD UP UP
PAD DOWN DOWN
PAD LEFT LEFT
PAD RIGHT RIGHT
OPTIONS RETURN
BACK BUTTON / TOUCH PAD SPACE
L1 Q
R1 U
L2 E
R2 O
L3 X
R3 M

Keyboard and mouse inputs can be customized in the settings menu by clicking the Controller button, and further details and help on controls are also found there. Custom bindings are saved per-game. Inputs support up to three keys per binding, mouse buttons, mouse movement mapped to joystick input, and more.

Firmware files

shadPS4 can load some PlayStation 4 firmware files. The following firmware modules are supported and must be placed in shadPS4's sys_modules folder.

Modules Modules Modules Modules
libSceAt9Enc.sprx libSceAudiodec.sprx libSceAudiodecCpu.sprx libSceAudiodecCpuDdp.sprx
libSceAudiodecCpuDtsHdLbr.sprx libSceAudiodecCpuHevag.sprx libSceAudiodecCpuM4aac.sprx libSceAvPlayer.sprx
libSceAvPlayerStreaming.sprx libSceBeisobmf.sprx libSceBemp2sys.sprx libSceCesCs.sprx
libSceFont.sprx libSceFontFt.sprx libSceFreeTypeOl.sprx libSceFreeTypeOptOl.sprx
libSceFreeTypeOt.sprx libSceJpegDec.sprx libSceJpegEnc.sprx libSceJson.sprx
libSceJson2.sprx libSceLibcInternal.sprx libSceNgs2.sprx libScePngEnc.sprx
libScePsmKitSystem.sprx libSceRtc.sprx libSceRudp.sprx libSceSystemGesture.sprx
libSceUlt.sprx libSceWkFontConfig.sprx libSceXml.sprx libSceDepth.sprx
libScePadTracker.sprx libSceMoveTracker.sprx

[!Caution] The above modules are required to run the games properly and must be dumped from your legally owned PlayStation 4 console.

Main team

Logo is done by Xphalnos

Contributing

If you want to contribute, please read the CONTRIBUTING.md file.
Open a PR and we'll check it :)

Special Thanks

A few noteworthy teams/projects who've helped us along the way are:

License

shadPS4 (shadps4-emu/shadPS4)

Searching Database…

33.7K ·GitHub
ShadPS4
Что это такое?shadPS4 — это ранний эмулятор PlayStation 4 для Windows, Linux, macOS и FreeBSD, написанный на C++. Он позволяет запускать настоящие игры для PS4 на компьютере.
Это та самая программа, которую я скачаю и буду играть?Не совсем — этот репозиторий содержит ядро эмулятора без графического интерфейса. Обычному пользователю стоит скачать QtLauncher, который добавляет поверх этого ядра удобный интерфейс.
Как его запустить?Возьмите сборку QtLauncher с интерфейсом «наведи и кликни» или запустите ядро напрямую и посмотрите вывод с флагом --help, где перечислены все команды. Разработчики также могут собрать проект из исходников на Windows, Linux и macOS или внутри Docker.
Мне что-нибудь нужно с настоящей PS4, чтобы играть?Да — определённые модули прошивки (файлы .sprx) нужно положить в папку sysmodules эмулятора, и снять их (сделать дамп) можно только со своей собственной консоли PlayStation 4, приобретённой легально.
Уже можно спокойно играть каждый день?Пока нет — shadPS4 находится на ранней стадии разработки, и безупречного опыта ждать не стоит. Команда выпускает небольшие регулярные обновления, как позволяет время.
Он пойдёт на моём Mac?Только на Mac с чипом Apple Silicon под управлением macOS 26.0 или новее — Mac на процессорах Intel не поддерживаются. У сборок для Windows и Linux таких ограничений нет.
Как узнать заранее, пойдёт ли моя игра, не пробуя её?Есть список совместимости игр shadPS4 Game Compatibility, где можно проверить, насколько хорошо идёт конкретная игра, прежде чем тратить на неё время.
Мне нужен геймпад от PS4 или мой геймпад от Xbox подойдёт?Геймпады Xbox и DualShock работают сразу из коробки, а клавиатура и мышь настроены по умолчанию. Привязки кнопок можно менять в меню настроек, настройки сохраняются для каждой игры отдельно, на одну привязку можно назначить до трёх клавиш, а движение мыши можно привязать к стику.
Какая технология используется для отрисовки игр с PS4?Графика выводится через Vulkan с SDL3 в связке, а компилятор шейдеров был создан по образцу Hades из эмулятора yuzu — это сильно помогло при эмуляции современной видеокарты AMD.
Почему авторы это сделали?Проект начинался просто ради удовольствия. У команды мало свободного времени, поэтому запуск более сложных игр потребует времени, но авторы намерены выпускать небольшие регулярные обновления.
What are similar projects?KytyPS5, rpcs3, gow3_pc, sharpemu, ps2-web-recomp, dolphin, mocktail, TheSimpsonsGameRecomp
Which topics is it in?cpp23, imgui, sdl3, emulation, emulator, freebsd, vulkan, firmware, gplv2, graphics, gaming, reverse-engineering
Creator
shadps4-emu
Size
73.4 MB
Stars
33.7K
Updated
CommitOct 17Releasev.0.20.0Oct 14
Age
3y
Commits · 90 Days