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 是一个早期的 PlayStation 4 模拟器,支持 Windows、Linux、macOS 和 FreeBSD,用 C++ 编写。它可以让你在电脑上运行真正的 PS4 游戏。
这就是我下载来玩游戏的那个程序吗?不完全是——本仓库是模拟器核心,不包含图形界面。作为普通用户,你应该下载 QtLauncher,它在核心之上提供了方便易用的界面。
我怎么把它跑起来?下载 QtLauncher 版本即可获得点击操作的图形界面,也可以直接运行核心程序,并通过 --help 参数查看所有命令。开发者还可以在 Windows、Linux 和 macOS 上从源码构建,或者在 Docker 里构建。
运行游戏需要真 PS4 上的东西吗?需要——某些固件模块(.sprx 文件)必须放到模拟器的 sysmodules 文件夹里,而且这些文件只能从你自己合法拥有的 PlayStation 4 主机上提取。
它现在能当日常玩游戏用吗?还不能——shadPS4 还处于开发早期,别指望体验完美无缺。团队会利用业余时间发布小型的定期更新。
在我的 Mac 上能运行吗?只能在运行 macOS 26.0 或更新版本的 Apple Silicon Mac 上运行——不支持 Intel Mac。Windows 和 Linux 版本没有这类限制。
在尝试之前,我怎么知道我的游戏能不能玩?有一个 shadPS4 Game Compatibility list(游戏兼容性列表),你可以在花时间折腾之前先查某个游戏运行得怎么样。
我需要 PS4 手柄吗,还是 Xbox 手柄也能用?Xbox 和 DualShock 手柄开箱即用,键盘和鼠标也默认有按键映射。按键绑定可以在设置菜单里自定义,并按游戏分别保存,每个绑定最多支持三个按键,鼠标移动也可以映射为摇杆输入。
它用什么技术来渲染 PS4 游戏?它通过 Vulkan 渲染,技术栈中使用了 SDL3,其着色器编译器是以 yuzu 的 Hades 编译器为蓝本设计的——这对模拟现代 AMD GPU 帮助很大。
作者为什么要做这个项目?这个项目一开始纯粹是为了好玩。团队空闲时间有限,所以运行更复杂的游戏还需要一段时间,但他们坚持发布小型的定期更新。
Size
73.4 MB
Stars
33.7K
Age
3y
Commits · 90 Days