catto
/
shadPS4
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Readme: improvements (#121) 

* Update README.md

* Minor fixes

* Update building-windows.md

* Update linux_building.md

* Update readme.txt

* Build status

* Add psucien
This commit is contained in:
Xphalnos 2024-05-03 20:49:13 +08:00 committed by GitHub
parent ce4bdee0aa
commit 235b6e8781
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 38 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -5,28 +5,29 @@ SPDX-License-Identifier: GPL-2.0-or-later
# shadPS4 # shadPS4
An early PS4 emulator for Windows and Linux written in C++ shadPS4 is an early PS4 emulator for Windows and Linux written in C++
by shadow , skmp , wheremyfoodat , GPUCode
[Check us on twitter](https://twitter.com/shadps4 "Check us on twitter") To discuss shadPS4 development or suggest ideas, join the [Discord server](https://discord.gg/MyZRaBngxA)
Check us on [twitter](https://twitter.com/shadps4)
# Status # Status
Early progress , a small amount of ps4 sdk demos and homebrew games working Early progress, a small amount of PS4 SDK demos and homebrew games working.
# Why? # Why?
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. 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 # Build
## Windows ## Windows
Check building instructions in [windows build](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-windows.md) Check building instructions in [Windows build](https://github.com/shadps4-emu/shadPS4/blob/main/documents/building-windows.md)
## Linux ## Linux
Check building instructions in [linux build](https://github.com/shadps4-emu/shadPS4/blob/main/documents/linux_building.md) Check building instructions in [Linux build](https://github.com/shadps4-emu/shadPS4/blob/main/documents/linux_building.md)
## Build status ## Build status
@ -35,23 +36,22 @@ Check building instructions in [linux build](https://github.com/shadps4-emu/shad
|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) |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) |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)
To discuss the development of this emulator, please join our Discord server: [![Discord](https://img.shields.io/discord/1080089157554155590)](https://discord.gg/MyZRaBngxA)
# Main team # Main team
- gmoralis (a.k.a. shadow) - [georgemoralis](https://github.com/georgemoralis)
- gpucode (a.k.a. emufan4568) - [raphaelthegreat](https://github.com/raphaelthegreat)
- skmp (a.k.a. drk||Raziel) - [psucien](https://github.com/psucien)
- wheremyfoodat (a.k.a. rodakinos) - [skmp](https://github.com/skmp)
- raziel1000 - [wheremyfoodat](https://github.com/wheremyfoodat)
- [raziel1000](https://github.com/raziel1000)
Logo is done by Xphalnos Logo is done by [Xphalnos](https://github.com/Xphalnos)
# Contribution # Contribution
We currently accept any contribution, just open a pr and we will check it :) We currently accept any contribution, just open a PR and we will check it :)
# Sister Projects # Sister Projects
- [Panda3DS](https://github.com/wheremyfoodat/Panda3DS): An multiplatform 3DS emulator from our co-author wheremyfoodat - [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 - [hydra](https://github.com/hydra-emu/hydra): An multisystem, multiplatform emulator (chip-8,GB,NES,N64) from Paris

16
documents/building-windows.md
View File

@ -3,23 +3,23 @@ SPDX-FileCopyrightText: 2024 shadPS4 Emulator Project
SPDX-License-Identifier: GPL-2.0-or-later SPDX-License-Identifier: GPL-2.0-or-later
--> -->
# How to build shadps4 in windows # Build shadps4 for Windows
## Download VStudio Community 2022 17.9.5 ## Download Visual Studio Community 2022 17.9.6
[VStudio 2022](https://visualstudio.microsoft.com/vs/) Download link: [Visual Studio 2022](https://visualstudio.microsoft.com/vs/)
## Requirements ## Requirements
Install the following ### From Visual Studio Community
- Desktop development with c++ - Desktop development with C++
### From Individual components tab install ### From individual components tab install
- C++ Clang Compiler for Windows (17.0.3) - C++ Clang Compiler for Windows (17.0.3)
- MSBuild support for LLVM (clang-cl) toolset - MSBuild support for LLVM (Clang-cl) toolset
- ## Compiling - ## Compiling
- Open vstudio and select the clang debug or clang release . It should compile just fine - Open Visual Studio and select the Clang-debug or Clang-release. It should compile just fine.

2
documents/linux_building.md
View File

@ -3,7 +3,7 @@ SPDX-FileCopyrightText: 2024 shadPS4 Emulator Project
SPDX-License-Identifier: GPL-2.0-or-later SPDX-License-Identifier: GPL-2.0-or-later
--> -->
## Linux ## Build shadPS4 for Linux
Generate the build directory in the shadPS4 directory: Generate the build directory in the shadPS4 directory:
``` ```

18
documents/readme.txt
View File

@ -1,4 +1,4 @@
shadps4 - An ps4 emulator shadPS4 - A PS4 emulator
========================= =========================
1. Intro 1. Intro
@ -8,25 +8,24 @@ shadps4 - An ps4 emulator
1.Intro 1.Intro
======= =======
shadPS4 is a ps4 emulator for windows and linux . Although atm it can't run a lot of stuff , we are working torwards to make it more compatible shadPS4 is a Play Station 4 emulator for Windows and Linux. Although atm it can't run a lot of stuff, we are working torwards to make it more compatible.
2.Current status 2.Current status
================ ================
shadps4 is a HLE emulator . Currently on a small amount of functions is emulated , which is one of the reasons compatibility is low. shadPS4 is a HLE emulator. Currently on a small amount of functions is emulated, which is one of the reasons compatibility is low.
3.Contributors 3.Contributors
============== ==============
- gmoralis (a.k.a. shadow) - georgemoralis
- gpucode (a.k.a. emufan4568) - raphaelthegreat
- skmp (a.k.a. drk||Raziel) - skmp
- wheremyfoodat (a.k.a. rodakinos) - wheremyfoodat
4.Greetings 4.Greetings
=========== ===========
I would like to thank the following people for helping me so far, with coding or moral support. I would like to thank the following people for helping me so far, with coding or moral support.
- wheremyfoodat - or @rodakinos for believed me. - wheremyfoodat - or @rodakinos for believed me
- paris - or OFFTKP for not believing me and that made me a better coder :D - paris - or OFFTKP for not believing me and that made me a better coder :D
- skmp - or kornilios for being good old friend - skmp - or kornilios for being good old friend
- PandaBad - our beloved stalker - PandaBad - our beloved stalker
@ -34,4 +33,3 @@ I would like to thank the following people for helping me so far , with coding o
- velocity - for talking 1-2 times per year on discord server. We miss you velocity - velocity - for talking 1-2 times per year on discord server. We miss you velocity
- probably more, will include in the next readme :D - probably more, will include in the next readme :D