shadPS4/README.md

58 lines
2.0 KiB
Markdown

<!--
SPDX-FileCopyrightText: 2024 shadPS4 Emulator Project
SPDX-License-Identifier: GPL-2.0-or-later
-->
# shadPS4
shadPS4 is an early PS4 emulator for Windows and Linux written in C++
To discuss shadPS4 development or suggest ideas, join the [Discord server](https://discord.gg/MyZRaBngxA)
Check us on [twitter](https://twitter.com/shadps4)
# Status
Early progress, a small amount of PS4 SDK demos and homebrew games working.
# 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 building instructions in [Windows build](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-windows.md)
## Linux
Check building instructions in [Linux build](https://github.com/shadps4-emu/shadPS4/blob/main/documents/linux_building.md)
## Build status
|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)
# 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)
# Contribution
We currently accept any contribution, just open a PR and we will check it :)
# Sister Projects
- [Panda3DS](https://github.com/wheremyfoodat/Panda3DS): An multiplatform 3DS emulator from our co-author wheremyfoodat
- [hydra](https://github.com/hydra-emu/hydra): An multisystem, multiplatform emulator (chip-8,GB,NES,N64) from Paris