Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shadps4-emu/shadps4

PlayStation 4 emulator for Windows, Linux and macOS written in C++
https://github.com/shadps4-emu/shadps4

cpp cpp20 emulation emulator imgui linux macos playstation4 ps4 sdl3 vulkan windows

Last synced: 6 days ago
JSON representation

PlayStation 4 emulator for Windows, Linux and macOS written in C++

Host: GitHub
URL: https://github.com/shadps4-emu/shadps4
Owner: shadps4-emu
License: gpl-2.0
Created: 2022-10-24T09:48:37.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2025-01-10T09:04:30.000Z (about 1 month ago)
Last Synced: 2025-01-10T16:54:23.779Z (about 1 month ago)
Topics: cpp, cpp20, emulation, emulator, imgui, linux, macos, playstation4, ps4, sdl3, vulkan, windows
Language: C++
Homepage: https://shadps4.net/
Size: 30.6 MB
Stars: 12,944
Watchers: 136
Forks: 861
Open Issues: 113
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        



  


  

  


  shadPS4

  






 

        

 

        

 

        

 

        

 

        







  

  

  

  

  



# 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**](https://github.com/shadps4-emu/shadPS4/blob/main/documents/Quickstart/Quickstart.md).\

To verify that a game works, you can look at [**shadPS4 Game Compatibility**](https://github.com/shadps4-emu/shadps4-game-compatibility).\

To discuss shadPS4 development, suggest ideas or to ask for help, join our [**Discord server**](https://discord.gg/bFJxfftGW6).\

To get the latest news, go to our [**X (Twitter)**](https://x.com/shadps4) or our [**website**](https://shadps4.net/).\

For those who'd like to donate to the project, we now have a [**Kofi page**](https://ko-fi.com/shadps4)!

# Status

> [!IMPORTANT]

> shadPS4 is early in development, don't expect a flawless experience.

Currently, the emulator can successfully run games like [**Bloodborne**](https://www.youtube.com/watch?v=wC6s0avpQRE), [**Dark Souls Remastered**](https://www.youtube.com/watch?v=-3PA-Xwszts), [**Red Dead Redemption**](https://www.youtube.com/watch?v=Al7yz_5nLag) and many other games.

# 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

> [!IMPORTANT]

> If you want to use shadPS4 to play your games, you don't have to follow the build instructions, you can simply download the emulator from either the [**release tab**](https://github.com/shadps4-emu/shadPS4/releases) or the [**action tab**](https://github.com/shadps4-emu/shadPS4/actions).

## Windows

Check the build instructions for [**Windows**](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-windows.md).

## Linux

Check the build instructions for [**Linux**](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-linux.md).

## macOS

Check the build instructions for [**macOS**](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-macos.md).

> [!IMPORTANT]

> macOS users need at least macOS 15 on Apple Silicon-based Mac devices and at least macOS 14 on Intel-based Mac devices.

# Debugging and reporting issues

For more information on how to test, debug and report issues with the emulator or games, read the [**Debugging documentation**](https://github.com/shadps4-emu/shadPS4/blob/main/documents/Debugging/Debugging.md).

# 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

> [!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.

# Main team

- [**georgemoralis**](https://github.com/georgemoralis)

- [**raphaelthegreat**](https://github.com/raphaelthegreat)

- [**psucien**](https://github.com/psucien)

- [**skmp**](https://github.com/skmp)

- [**wheremyfoodat**](https://github.com/wheremyfoodat)

- [**raziel1000**](https://github.com/raziel1000)

- [**viniciuslrangel**](https://github.com/viniciuslrangel)

- [**roamic**](https://github.com/vladmikhalin)

- [**poly**](https://github.com/polybiusproxy)

- [**squidbus**](https://github.com/squidbus)

- [**frodo**](https://github.com/baggins183)

Logo is done by [**Xphalnos**](https://github.com/Xphalnos)

# Contributing

If you want to contribute, please look the [**CONTRIBUTING.md**](https://github.com/shadps4-emu/shadPS4/blob/main/CONTRIBUTING.md) file.\

Open a PR and we'll check it :)

# Translations

If you want to translate shadPS4 to your language we use [**crowdin**](https://crowdin.com/project/shadps4-emulator).

# Contributors



  



# Special Thanks

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

- [**Panda3DS**](https://github.com/wheremyfoodat/Panda3DS): A multiplatform 3DS emulator from our co-author wheremyfoodat. They have been incredibly helpful in understanding and solving problems that came up from natively executing the x64 code of PS4 binaries

- [**fpPS4**](https://github.com/red-prig/fpPS4): The fpPS4 team has assisted massively with understanding some of the more complex parts of the PS4 operating system and libraries, by helping with reverse engineering work and research.

- **yuzu**: Our shader compiler has been designed with yuzu's Hades compiler as a blueprint. This allowed us to focus on the challenges of emulating a modern AMD GPU while having a high-quality optimizing shader compiler implementation as a base.

- [**hydra**](https://github.com/hydra-emu/hydra): A multisystem, multiplatform emulator (chip-8, GB, NES, N64) from Paris.

# License

- [**GPL-2.0 license**](https://github.com/shadps4-emu/shadPS4/blob/main/LICENSE)