shadPS4/README.md
Plínio Larrubia cf9ec6548c
docs: fix sdl and qt steps for MSYS2
- Add required dependencies
- Add Qt steps
- Fix README typo
2024-09-02 21:31:41 -03:00

6.3 KiB



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.

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.

Building status

Windows
Windows Build status
Windows SDL Build Windows-sdl
Windows Qt Build Windows-qt
Linux
Linux Build status
Linux SDL Build Linux-sdl
Linux Qt Build Linux-qt
macOS
macOS Build status
macOS SDL Build macOS-sdl
macOS Qt Build macOS-qt

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 button Keyboard equivelant
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
CIRCLE Numpad 6
CROSS Numpad 2
SQUARE Numpad 4
PAD UP UP
PAD DOWN DOWN
PAD LEFT LEFT
PAD RIGHT RIGHT
OPTIONS RETURN
TOUCH PAD SPACE
L1 Q
R1 U
L2 E
R2 O
L3 X
R3 M

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

Sister Projects

  • Panda3DS: A multiplatform 3DS emulator from our co-author wheremyfoodat.
  • hydra: A multisystem, multiplatform emulator (chip-8, GB, NES, N64) from Paris.

License