shadPS4/README.md
Sebastian Kassai ba0a6ab038
Expand documentation on configuration and debugging (#513)
* documents: more info on config.toml

* documents: add Debugging

* documents: link to Debugging in README

* documents: link to main branch for Debugging

Once it's merged, it should link properly.
Quickstart already exists in main.

* documents: remove "troubleshooting" from Debugging

Not entirely relevant.

* documents: elaborate on a few points with stack traces

* documents: formatting, indentation fixup

* documents: remove unnecessary indent

* documents: fix some inline code blocks + misc

* documents: move the technical jargon out of Quickstart

* documents: improve configuration sections

Simplified the Quickstart config listing, added more technical info to the Debugging listing.

* documents: link quickstart config link to proper section

* documents: something ate my hash symbol

* documents: use *:Critical for log silencing example

* documents: add note about Start Without Debugging

* documents: use correct CUSA code in example
2024-08-21 22:13:06 +03:00

6.1 KiB



shadPS4

shadPS4

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 or suggest ideas, join the Discord server.

To get the latest news, go to our X (twitter) or our website.

Status

In development, small games are working like Sonic Mania, Undertale, Dysmantle and others...

Why

The project started as a fun project. Due to limited free time, it will probably take a while before shadPS4 is able to run anything decent, but we're trying to make small, regular commits.

Build

Windows

Check the build instructions for Windows.

Linux

Check the build instructions for Linux.

Build 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

Controller button Keyboard
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