136 lines
5.2 KiB
Markdown
136 lines
5.2 KiB
Markdown
<!--
|
|
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>
|
|
|
|
# shadPS4
|
|
|
|
shadPS4 is an early PS4 emulator for Windows and Linux 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 or suggest ideas, join the [**Discord server**](https://discord.gg/MyZRaBngxA).
|
|
|
|
Check us on [**X (twitter)**](https://x.com/shadps4) or on our [**website**](https://shadps4.net/).
|
|
|
|
# Status
|
|
|
|
In development, small games are working like [**Sonic Mania**](https://www.youtube.com/watch?v=AAHoNzhHyCU), [**Undertale**](https://youtu.be/5zIvdy65Ro4), [**Dysmantle**](https://youtu.be/b9xzhLBdESE) 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**](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).
|
|
|
|
## Build status
|
|
|
|
|Windows|Build status|
|
|
|--------|------------|
|
|
|Windows SDL Build|[](https://github.com/shadps4-emu/shadPS4/actions/workflows/windows.yml)
|
|
|Windows Qt Build|[](https://github.com/shadps4-emu/shadPS4/actions/workflows/windows-qt.yml)
|
|
|
|
|Linux|Build status|
|
|
|--------|------------|
|
|
|Linux SDL Build|[](https://github.com/shadps4-emu/shadPS4/actions/workflows/linux.yml)
|
|
|Linux Qt Build|[](https://github.com/shadps4-emu/shadPS4/actions/workflows/linux-qt.yml)
|
|
|
|
# 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
|
|
|
|
- [**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)
|
|
|
|
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 :)
|
|
|
|
# Contributors
|
|
|
|
<a href="https://github.com/shadps4-emu/shadPS4/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=shadps4-emu/shadPS4&max=15" />
|
|
</a>
|
|
|
|
# Sister Projects
|
|
|
|
- [**Panda3DS**](https://github.com/wheremyfoodat/Panda3DS): A multiplatform 3DS emulator from our co-author wheremyfoodat.
|
|
- [**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) |