Home

Awesome

<!-- SPDX-FileCopyrightText: 2024 shadPS4 Emulator Project SPDX-License-Identifier: GPL-2.0-or-later --> <h1 align="center"> <br> <a href="https://shadps4.net/"><img src="https://github.com/shadps4-emu/shadPS4/blob/main/.github/shadps4.png" width="220"></a> <br> <b>shadPS4</b> <br> </h1> <h1 align="center"> <a href="https://discord.gg/MyZRaBngxA"> <img src="https://img.shields.io/discord/1080089157554155590?color=5865F2&label=shadPS4 Discord&logo=Discord&logoColor=white" width="240"> <a href="https://github.com/shadps4-emu/shadPS4/releases/latest"> <img src="https://img.shields.io/github/downloads/shadps4-emu/shadPS4/total.svg" width="140"> <a href="https://shadps4.net/"> <img src="https://img.shields.io/badge/shadPS4-website-8A2BE2" width="150"> <a href="https://x.com/shadps4"> <img src="https://img.shields.io/badge/-Join%20us-black?logo=X&logoColor=white" width="100"> <a href="https://github.com/shadps4-emu/shadPS4/stargazers"> <img src="https://img.shields.io/github/stars/shadps4-emu/shadPS4" width="120"> </h1> <p align="center"> <a href="https://shadps4.net/"> <img src="https://github.com/shadps4-emu/shadPS4/blob/main/documents/Screenshots/Sonic Mania.png" width="400"> <img src="https://github.com/shadps4-emu/shadPS4/blob/main/documents/Screenshots/Bloodborne.png" width="400"> <img src="https://github.com/shadps4-emu/shadPS4/blob/main/documents/Screenshots/Undertale.png" width="400"> <img src="https://github.com/shadps4-emu/shadPS4/blob/main/documents/Screenshots/We are DOOMED.png" width="400"> </p>

General information

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

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.

Status

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

Currently, the emulator successfully runs small games like Sonic Mania, Undertale and it can even somewhat run Bloodborne.

Why

This project began as a fun project. 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

Windows

Check the build instructions for Windows.

Linux

Check the build instructions for Linux.

macOS

Check the build instructions for macOS.

Note that macOS users need at least macOS 15 on an Apple Silicon Mac, or at least macOS 11 on an Intel Mac.

Building status

<details> <summary><b>Windows</b></summary>
WindowsBuild status
Windows SDL BuildWindows-sdl
Windows Qt BuildWindows-qt
</details> <details> <summary><b>Linux</b></summary>
LinuxBuild status
Linux SDL BuildLinux-sdl
Linux Qt BuildLinux-qt
</details> <details> <summary><b>macOS</b></summary>
macOSBuild status
macOS SDL BuildmacOS-sdl
macOS Qt BuildmacOS-qt
</details>

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 mapping

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

Controller buttonKeyboard equivelant
LEFT AXIS UPW
LEFT AXIS DOWNS
LEFT AXIS LEFTA
LEFT AXIS RIGHTD
RIGHT AXIS UPI
RIGHT AXIS DOWNK
RIGHT AXIS LEFTJ
RIGHT AXIS RIGHTL
TRIANGLENumpad 8
CIRCLENumpad 6
CROSSNumpad 2
SQUARENumpad 4
PAD UPUP
PAD DOWNDOWN
PAD LEFTLEFT
PAD RIGHTRIGHT
OPTIONSRETURN
TOUCH PADSPACE
L1Q
R1U
L2E
R2O
L3X
R3M

Main team

Logo is done by Xphalnos

Contributing

If you want to contribute, please look the CONTRIBUTING.md file.

Open a PR and we'll check it :)

Contributors

<a href="https://github.com/shadps4-emu/shadPS4/graphs/contributors"> <img src="https://contrib.rocks/image?repo=shadps4-emu/shadPS4&max=15"> </a>

Special Thanks

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

Sister Projects

License