Quickstart

This commit is contained in:
Xphalnos 2024-06-24 20:34:06 +02:00
parent c845b12990
commit 3f657b5f36
5 changed files with 55 additions and 7 deletions

View File

@ -8,6 +8,8 @@ Files: CMakeSettings.json
.gitmodules .gitmodules
documents/changelog.txt documents/changelog.txt
documents/readme.txt documents/readme.txt
documents/Quickstart/1.png
documents/Quickstart/2.png
documents/Screenshots/screenshot.png documents/Screenshots/screenshot.png
documents/Screenshots/Sonic Mania.png documents/Screenshots/Sonic Mania.png
documents/Screenshots/Undertale.png documents/Screenshots/Undertale.png

View File

@ -36,6 +36,8 @@ SPDX-License-Identifier: GPL-2.0-or-later
shadPS4 is an early PS4 emulator for Windows and Linux written in C++ shadPS4 is an early PS4 emulator for Windows and Linux written in C++
If you encounter problems or have doubts, do not hesitate to look at the [**Quickstart**](https://github.com/shadps4-emu/shadPS4/blob/main/documents/Quickstart/Quickstart.md).
To discuss shadPS4 development or suggest ideas, join the [**Discord server**](https://discord.gg/MyZRaBngxA). To discuss shadPS4 development or suggest ideas, join the [**Discord server**](https://discord.gg/MyZRaBngxA).
Check us on [**X (twitter)**](https://x.com/shadps4) or on our [**website**](https://shadps4.net/). Check us on [**X (twitter)**](https://x.com/shadps4) or on our [**website**](https://shadps4.net/).
@ -70,13 +72,6 @@ Check the build instructions for [**Linux**](https://github.com/shadps4-emu/shad
|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)
|Linux Qt Build|[![Linux-qt](https://github.com/shadps4-emu/shadPS4/actions/workflows/linux-qt.yml/badge.svg)](https://github.com/shadps4-emu/shadPS4/actions/workflows/linux-qt.yml) |Linux Qt Build|[![Linux-qt](https://github.com/shadps4-emu/shadPS4/actions/workflows/linux-qt.yml/badge.svg)](https://github.com/shadps4-emu/shadPS4/actions/workflows/linux-qt.yml)
# Executing a program
You can copy and paste the path to the CMD or drag the executable file to the application.
```
C:\Users\******\shadPS4.exe C:\******\game_eboot.bin
```
# Main team # Main team
- [**georgemoralis**](https://github.com/georgemoralis) - [**georgemoralis**](https://github.com/georgemoralis)

BIN
documents/Quickstart/1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

BIN
documents/Quickstart/2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 658 KiB

View File

@ -0,0 +1,51 @@
# shadPS4 Quickstart
## Summary
- [PC Requirements](#pc-requirements)
- [CPU](#cpu)
- [GPU](#gpu)
- [RAM](#ram)
- [OS](#os)
- [Have the latest WIP version](#have-the-latest-wip-version)
- [Install PKG files (Games and Updates)](#install-pkg-files)
- [Configure the emulator](#configure-the-emulator)
## PC Requirements
### CPU
- A processor with at least 4 cores and 6 threads
- Above 2.5 GHz frequency
### GPU
- A graphics card with at least 1GB of VRAM
- Keep your graphics drivers up to date
- Vulkan 1.3 support (required)
### RAM
- 8GB of RAM or more
### OS
- Windows 10 or Ubuntu 22.04
## Have the latest WIP version
When you go to Github Release, you have the latest major versions (e.g. v0.0.3), but if you want to have the latest Work-In-Progress version, you can go to Actions on Github to download it (Please note a Github account is required to be able to download).
<img src="https://github.com/shadps4-emu/shadPS4/blob/main/documents/Quickstart/1.png" width="800"></a>
After downloading the version suitable for you (Windows or Linux), you must unzip the file and then you can run it. Please note, there are two versions for each platform, a Qt version with user interface and one without (SDL Builds).
## Install PKG files
To install PKG files (game and updates), you will need the Qt application (with UI). You will have to go to "File" then to "Install Packages (PKG)", a window will open then you will have to select the files. You can install multiple PKG files at once. Once finished, the game should appear in the application.
<img src="https://github.com/shadps4-emu/shadPS4/blob/main/documents/Quickstart/2.png" width="800"></a>
## Configure the emulator
You can configure the emulator in the "user" folder (created after the first start of the application) then in the "config.toml" file. Here you can find lots of parameters to set with True or False.