shadPS4/README.md

67 lines
2.3 KiB
Markdown
Raw Normal View History

2024-02-23 21:32:32 +00:00
<!--
SPDX-FileCopyrightText: 2024 shadPS4 Emulator Project
SPDX-License-Identifier: GPL-2.0-or-later
-->
2022-10-24 09:48:38 +00:00
# shadPS4
2023-06-12 08:00:30 +00:00
2023-09-29 02:50:27 +00:00
An early PS4 emulator for Windows and Linux written in C++
2023-10-27 06:45:15 +00:00
by shadow , skmp , wheremyfoodat , GPUCode
2023-06-20 12:42:36 +00:00
[Check us on twitter](https://twitter.com/shadps4 "Check us on twitter")
2023-06-12 08:00:30 +00:00
# Status
2023-10-08 07:51:48 +00:00
Early progress , a small amount of ps4 sdk demos and homebrew games working
2023-08-02 10:59:00 +00:00
2023-06-12 08:00:30 +00:00
# Why?
2023-09-29 02:50:27 +00:00
The project started as a fun project. Due to short free time, it will probably take a while since it will be able to run something decent, but I am trying to do regular small commits.
2023-06-12 08:00:30 +00:00
2023-06-23 01:48:55 +00:00
# Build
2023-06-12 08:00:30 +00:00
2023-06-23 01:48:55 +00:00
## Windows
2023-08-08 21:56:45 +00:00
Check building instructions in [windows build](https://github.com/georgemoralis/shadPS4/blob/main/documents/building-windows.md)
2023-06-23 01:48:55 +00:00
## Linux
2023-08-08 19:31:21 +00:00
Check building instructions in [linux build](https://github.com/georgemoralis/shadPS4/blob/main/documents/linux_building.md)
## Build status
2022-10-28 06:54:36 +00:00
2023-04-11 07:42:49 +00:00
|Platform|Build status|
|--------|------------|
|Windows SDL build|[![Windows-sdl](https://github.com/shadps4-emu/shadPS4/actions/workflows/windows.yml/badge.svg)](https://github.com/shadps4-emu/shadPS4/actions/workflows/windows.yml)
|Linux SDL build|[![Linux-sdl](https://github.com/shadps4-emu/shadPS4/actions/workflows/linux.yml/badge.svg)](https://github.com/shadps4-emu/shadPS4/actions/workflows/linux.yml)
2023-04-11 07:42:49 +00:00
2023-09-29 02:50:27 +00:00
To discuss the development of this emulator, please join our Discord server: [![Discord](https://img.shields.io/discord/1080089157554155590)](https://discord.gg/MyZRaBngxA)
2023-04-09 19:21:26 +00:00
2023-06-12 08:00:30 +00:00
# Who are you?
2023-07-21 23:07:46 +00: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 08:00:30 +00:00
* PCSX
* PCSX2
* PCSP
* JPCSP
* arcadeflex
2023-06-20 12:45:43 +00:00
* rpcs3 contributor
2023-06-12 08:00:30 +00:00
# Contribution
2023-09-29 02:50:27 +00:00
I currently accept any contribution, here is a list of some items that may be useful:
2023-06-12 08:00:30 +00:00
2023-09-29 02:50:27 +00:00
* PKG extractor (there was initial work on this, search project history commits).
2023-06-12 15:55:21 +00:00
* Initial GUI with imgui, SDL3 and Vulkan.
2023-06-23 01:48:55 +00:00
* to be filled...
2023-02-24 09:10:30 +00:00
2023-06-12 08:00:30 +00:00
# Documentation
2023-02-24 09:10:30 +00: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 09:10:30 +00:00
2023-08-14 17:29:16 +00:00
# Sister Projects
2023-08-14 22:02:16 +00:00
- [Panda3DS](https://github.com/wheremyfoodat/Panda3DS): An multiplatform 3DS emulator from our co-author wheremyfoodat
2023-09-29 02:50:27 +00:00
- [hydra](https://github.com/hydra-emu/hydra): An multisystem , multiplatform emulator (chip-8,GB,NES,N64) from Paris