mirror of
https://github.com/shadps4-emu/shadPS4.git
synced 2026-04-01 18:40:57 -06:00
readme
This commit is contained in:
kalaposfos13
parent
c391af4f6a
commit
46dbc4a9c5
58
README.md
58
README.md
@ -7,7 +7,7 @@ SPDX-License-Identifier: GPL-2.0-or-later
|
||||
<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>
|
||||
<b>shadBloodborne</b>
|
||||
<br>
|
||||
</h1>
|
||||
|
||||
@ -24,43 +24,43 @@ SPDX-License-Identifier: GPL-2.0-or-later
|
||||
<img src="https://img.shields.io/github/stars/shadps4-emu/shadPS4" width="120">
|
||||
</h1>
|
||||
|
||||
| Bloodborne by From Software | Hatsune Miku Project DIVA Future Tone by SEGA |
|
||||
| Bloodborne by From Software | Bloodborne by From Software |
|
||||
| :-----------------------------------------------------------: | :--------------------------------------------------------------------------------------------: |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|
||||
| Yakuza 0 by SEGA | DRIVECLUB™ by Evolution Studios |
|
||||
| Bloodborne by From Software | Bloodborne by From Software |
|
||||
| :------------------------------------------------------------------------: | :------------------------------------------------------------------: |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|
||||
# General information
|
||||
|
||||
**shadPS4** is an early **PlayStation 4** emulator for **Windows**, **Linux** and **macOS** written in C++.
|
||||
**shadBloodborne** is an early **Bloodborne** emulator for **Windows**, **Linux**, **macOS** and **FreeBSD** written in C++.
|
||||
|
||||
> [!IMPORTANT]
|
||||
> This is the emulator core, which does not include a GUI. If you just want to use the emulator as an end user, download the [**QtLauncher**](https://github.com/shadps4-emu/shadps4-qtlauncher/releases) instead.
|
||||
|
||||
If you encounter problems or have doubts, do not hesitate to look at the [**Quickstart**](https://github.com/shadps4-emu/shadPS4/wiki/I.-Quick-start-%5BUsers%5D).\
|
||||
To verify that a game works, you can look at [**shadPS4 Game Compatibility**](https://github.com/shadps4-compatibility/shadps4-game-compatibility).\
|
||||
To discuss shadPS4 development, suggest ideas or to ask for help, join our [**Discord server**](https://discord.gg/bFJxfftGW6).\
|
||||
To verify that Bloodborne works, you can look at [**bloodbornePS4 Compatibility Status**](https://github.com/shadps4-compatibility/shadps4-game-compatibility/issues?q=is%3Aissue%20state%3Aopen%20in%3Atitle%20%22bloodborne%22).\
|
||||
To discuss shadBloodborne 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/).\
|
||||
You can donate to the project via our [**Kofi page**](https://ko-fi.com/shadps4).
|
||||
|
||||
# Status
|
||||
|
||||
> [!IMPORTANT]
|
||||
> shadPS4 is early in development, don't expect a flawless experience.
|
||||
> shadBloodborne 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=5sZgWyVflFM), [**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.
|
||||
Currently, the emulator can successfully run [**Bloodborne**](https://www.youtube.com/watch?v=5sZgWyVflFM), but not every feature is fully emulated.
|
||||
|
||||
# Why
|
||||
|
||||
This project began for fun. 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.
|
||||
This project began for fun. Given our limited free time, it may take some time before shadBloodborne can do Bloodborne multiplayer, but we're committed to making small, regular updates.
|
||||
|
||||
# Building
|
||||
|
||||
## Docker
|
||||
|
||||
For building shadPS4 in a containerized environment using Docker and VSCode, check the instructions here:
|
||||
For building shadBloodborne in a containerized environment using Docker and VSCode, check the instructions here:
|
||||
[**Docker Build Instructions**](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-docker.md)
|
||||
|
||||
## Windows
|
||||
@ -76,7 +76,7 @@ Check the build instructions for [**Linux**](https://github.com/shadps4-emu/shad
|
||||
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.4 to run shadPS4. Due to GPU issues there are currently heavy bugs on Intel Macs.
|
||||
> macOS users need at least macOS 15.4 to run shadBloodborne. Due to GPU issues there are currently heavy bugs on Intel Macs.
|
||||
|
||||
# Usage examples
|
||||
|
||||
@ -87,11 +87,11 @@ To get the list of all available commands and also a more detailed description o
|
||||
|
||||
Below is a list of commonly used command patterns:
|
||||
```sh
|
||||
shadPS4 CUSA00001 # Searches for a game folder called CUSA00001 in the list of game install folders, and boots it.
|
||||
shadPS4 --fullscreen true --config-clean CUSA00001 # the game argument is always the last one,
|
||||
shadPS4 -g CUSA00001 --fullscreen true --config-clean # ...unless manually specified otherwise.
|
||||
shadPS4 /path/to/game.elf # Boots a PS4 ELF file directly. Useful if you want to boot an executable that is not named eboot.bin.
|
||||
shadPS4 CUSA00001 -- -flag1 -flag2 # Passes '-flag1' and '-flag2' to the game executable in argv.
|
||||
shadBloodborne CUSA00001 # Searches for a game folder called CUSA00001 in the list of game install folders, and boots it.
|
||||
shadBloodborne --fullscreen true --config-clean CUSA00001 # the game argument is always the last one,
|
||||
shadBloodborne -g CUSA00001 --fullscreen true --config-clean # ...unless manually specified otherwise.
|
||||
shadBloodborne /path/to/game.elf # Boots a PS4 ELF file directly. Useful if you want to boot an executable that is not named eboot.bin.
|
||||
shadBloodborne CUSA00001 -- -flag1 -flag2 # Passes '-flag1' and '-flag2' to the game executable in argv.
|
||||
```
|
||||
|
||||
# Debugging and reporting issues
|
||||
@ -145,33 +145,23 @@ Keyboard and mouse inputs can be customized in the settings menu by clicking the
|
||||
|
||||
# Firmware files
|
||||
|
||||
shadPS4 can load some PlayStation 4 firmware files.
|
||||
The following firmware modules are supported and must be placed in shadPS4's `sys_modules` folder.
|
||||
shadBloodborne can load some PlayStation 4 firmware files.
|
||||
The following firmware modules are supported and must be placed in shadBloodborne's `sys_modules` folder.
|
||||
|
||||
<div align="center">
|
||||
|
||||
| Modules | Modules | Modules | Modules |
|
||||
|-------------------------|-------------------------|-------------------------|-------------------------|
|
||||
| libSceCesCs.sprx | libSceFont.sprx | libSceFontFt.sprx | libSceFreeTypeOt.sprx |
|
||||
| libSceJpegDec.sprx | libSceJpegEnc.sprx | libSceJson.sprx | libSceJson2.sprx |
|
||||
| libSceLibcInternal.sprx | libSceNgs2.sprx | libScePngEnc.sprx | libSceRtc.sprx |
|
||||
| libSceUlt.sprx | libSceAudiodec.sprx | | |
|
||||
| Modules | Modules |
|
||||
|-------------------------|-------------------------|
|
||||
| libSceLibcInternal.sprx | libSceRtc.sprx |
|
||||
</div>
|
||||
|
||||
> [!Caution]
|
||||
> The above modules are required to run the games properly and must be dumped from your legally owned PlayStation 4 console.
|
||||
> The above modules are required to run the game properly and must be dumped from your legally owned PlayStation 4 console.
|
||||
|
||||
|
||||
|
||||
# Main team
|
||||
|
||||
- [**georgemoralis**](https://github.com/georgemoralis)
|
||||
- [**psucien**](https://github.com/psucien)
|
||||
- [**viniciuslrangel**](https://github.com/viniciuslrangel)
|
||||
- [**roamic**](https://github.com/roamic)
|
||||
- [**squidbus**](https://github.com/squidbus)
|
||||
- [**frodo**](https://github.com/baggins183)
|
||||
- [**Stephen Miller**](https://github.com/StevenMiller123)
|
||||
- [**kalaposfos13**](https://github.com/kalaposfos13)
|
||||
|
||||
Logo is done by [**Xphalnos**](https://github.com/Xphalnos)
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 1.1 MiB After Width: | Height: | Size: 440 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 1010 KiB After Width: | Height: | Size: 189 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 1.9 MiB After Width: | Height: | Size: 803 KiB |
Loading…
Reference in New Issue
Block a user