shadPS4/README.md

69 lines
2.2 KiB
Markdown
Raw Normal View History

2022-10-24 11:48:38 +02:00
# shadPS4
2023-06-12 10:00:30 +02:00
2023-06-23 03:48:55 +02:00
An early PS4 emulator for Windows and Linux
2023-06-12 10:00:30 +02:00
2023-06-20 14:42:36 +02:00
[Check us on twitter](https://twitter.com/shadps4 "Check us on twitter")
2023-06-12 10:00:30 +02:00
# Status
2023-06-23 03:48:55 +02:00
Currently it can only load PS4 ELF files.
2023-06-12 10:00:30 +02:00
2023-08-02 12:59:00 +02:00
Progress is focus on videoout_basic.elf from sdk demos , currently it can load and run a few HLE calls. Others probably won't run since they might not be able to relocate all neccesary functions
2023-06-12 15:28:20 +02:00
![](https://geps.dev/progress/60) Elf Loader
![](https://geps.dev/progress/20) Logging system
2023-08-02 12:59:00 +02:00
![](https://geps.dev/progress/10) Everything else
2023-06-12 15:28:20 +02:00
2023-06-12 10:00:30 +02:00
# Why?
2023-06-12 17:55:21 +02:00
The project started as a fun project. Due to short amount of free time probably it will take a while since it will be able to run something decent but I am trying to do regular small commits.
2023-06-12 10:00:30 +02:00
2023-06-23 03:48:55 +02:00
# Build
2023-06-12 10:00:30 +02:00
2023-06-23 03:48:55 +02:00
## Windows
2023-07-24 11:19:01 +02:00
Check building instructions in [windows build](https://github.com/georgemoralis/shadPS4/edit/main/documents/building-windows.md)
2023-06-23 03:48:55 +02:00
## Linux
2023-08-08 21:31:21 +02:00
Check building instructions in [linux build](https://github.com/georgemoralis/shadPS4/blob/main/documents/linux_building.md)
## Build status
2022-10-28 08:54:36 +02:00
2023-04-11 09:42:49 +02:00
|Platform|Build status|
|--------|------------|
2023-04-11 12:58:02 +02:00
|Windows build|[![Windows](https://github.com/georgemoralis/shadPS4/actions/workflows/windows.yml/badge.svg)](https://github.com/georgemoralis/shadPS4/actions/workflows/windows.yml)
|Linux build|[![Linux](https://github.com/georgemoralis/shadPS4/actions/workflows/linux.yml/badge.svg)](https://github.com/georgemoralis/shadPS4/actions/workflows/linux.yml)
2023-04-11 09:42:49 +02:00
To discuss this emulator please join our Discord server: [![Discord](https://img.shields.io/discord/1080089157554155590)](https://discord.gg/MyZRaBngxA)
2023-04-09 21:21:26 +02:00
2023-06-12 10:00:30 +02:00
# Who are you?
2023-07-22 01:07:46 +02:00
Old emulator fans and devs can recognize me as "shadow". I was the founder and coder for a lot of emulation projects:
2023-06-12 10:00:30 +02:00
* PCSX
* PCSX2
* PCSP
* JPCSP
* arcadeflex
2023-06-20 14:45:43 +02:00
* rpcs3 contributor
2023-06-12 10:00:30 +02:00
# Contribution
2023-06-23 03:48:55 +02:00
I currently accept any kind of contribution, here is a list of some items that may be useful:
2023-06-12 10:00:30 +02:00
2023-06-23 03:48:55 +02:00
* PKG extractor (there was an initial work on this, just search project history commits).
2023-06-12 17:55:21 +02:00
* Initial GUI with imgui, SDL3 and Vulkan.
2023-06-23 03:48:55 +02:00
* Better logging system with spdlog.
* to be filled...
2023-02-24 10:10:30 +01:00
2023-06-12 10:00:30 +02:00
# Documentation
2023-02-24 10:10:30 +01:00
Wiki has some documentation for PS4 PKG format
[PKG PS4 File Format](https://github.com/georgemoralis/shadPS4/wiki/PKG-Information "PKG PS4 File Format")
2023-02-24 10:10:30 +01:00