Merge pull request #208 from Xphalnos/main

Adding Quickstart
2024-06-25 09:42:14 +03:00 · 2024-06-25 09:42:14 +03:00 · cee55355bf
parent 52ff825171 444e4d5336
commit cee55355bf
12 changed files with 76 additions and 31 deletions
--- a/.github/workflows/windows-qt.yml
+++ b/.github/workflows/windows-qt.yml
@ -29,13 +29,13 @@ jobs:
      uses: jurplel/install-qt-action@v4
      with:
        arch: win64_msvc2019_64
-        version: 6.7.1
+        version: 6.7.2

    - name: Configure CMake
      # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
      # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -T ClangCL -DENABLE_QT_GUI=ON
-      
+
    - name: Build
      # Build your program with the given configuration
      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} --parallel
--- a/.github/workflows/windows.yml
+++ b/.github/workflows/windows.yml
@ -23,6 +23,7 @@ jobs:
    - uses: actions/checkout@v4
      with:
          submodules: recursive
+
    - name: Configure CMake
      # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
      # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
--- a/.gitmodules
+++ b/.gitmodules
@ -51,7 +51,7 @@
 	url = https://github.com/zyantific/zydis.git
 [submodule "externals/sirit"]
 	path = externals/sirit
-	url = https://github.com/shadps4-emu/sirit
+	url = https://github.com/shadps4-emu/sirit.git
 [submodule "externals/xxhash"]
 	path = externals/xxhash
 	url = https://github.com/Cyan4973/xxHash.git
--- a/.reuse/dep5
+++ b/.reuse/dep5
@ -8,6 +8,8 @@ Files: CMakeSettings.json
       .gitmodules
       documents/changelog.txt
       documents/readme.txt
+       documents/Quickstart/1.png
+       documents/Quickstart/2.png
       documents/Screenshots/screenshot.png
       documents/Screenshots/Sonic Mania.png
       documents/Screenshots/Undertale.png
--- a/README.md
+++ b/README.md
@ -9,48 +9,42 @@ SPDX-License-Identifier: GPL-2.0-or-later
  <br>
  <b>shadPS4</b>
  <br>
+</h1>

-<p align="center">
-
+<h1 align="center">
 <a href="https://discord.gg/MyZRaBngxA">
        <img src="https://img.shields.io/discord/1080089157554155590?color=5865F2&label=shadPS4 Discord&logo=Discord&logoColor=white" width="240">
-
 <a href="https://github.com/shadps4-emu/shadPS4/releases/latest">
        <img src="https://img.shields.io/github/downloads/shadps4-emu/shadPS4/total.svg" width="140">
-
 <a href="https://shadps4.net/">
        <img src="https://img.shields.io/badge/shadPS4-website-8A2BE2" width="150">
-
 <a href="https://x.com/shadps4">
        <img src="https://img.shields.io/badge/-Join%20us-black?logo=X&logoColor=white" width="100">
-
 <a href="https://github.com/shadps4-emu/shadPS4/stargazers">
        <img src="https://img.shields.io/github/stars/shadps4-emu/shadPS4" width="120">
+</h1>

 <p align="center">
  <a href="https://shadps4.net/">
-  <img src="https://github.com/shadps4-emu/shadPS4/blob/main/documents/Screenshots/Sonic Mania.png" width="500">
-
-  <a href="https://shadps4.net/">
-  <img src="https://github.com/shadps4-emu/shadPS4/blob/main/documents/Screenshots/screenshot.png" width="500">
-
-  <a href="https://shadps4.net/">
-  <img src="https://github.com/shadps4-emu/shadPS4/blob/main/documents/Screenshots/Undertale.png" width="500">
-
-  <a href="https://shadps4.net/">
-  <img src="https://github.com/shadps4-emu/shadPS4/blob/main/documents/Screenshots/We are DOOMED.png" width="500">
+  <img src="https://github.com/shadps4-emu/shadPS4/blob/main/documents/Screenshots/Sonic Mania.png" width="400">
+  <img src="https://github.com/shadps4-emu/shadPS4/blob/main/documents/Screenshots/screenshot.png" width="400">
+  <img src="https://github.com/shadps4-emu/shadPS4/blob/main/documents/Screenshots/Undertale.png" width="400">
+  <img src="https://github.com/shadps4-emu/shadPS4/blob/main/documents/Screenshots/We are DOOMED.png" width="400">
+</p>

 # shadPS4

 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).

 Check us on [**X (twitter)**](https://x.com/shadps4) or on our [**website**](https://shadps4.net/).

 # Status

-In development, 2D games are working like [**Sonic Mania**](https://www.youtube.com/watch?v=AAHoNzhHyCU), Undertale, Momodora and others...
+In development, small games are working like [**Sonic Mania**](https://www.youtube.com/watch?v=AAHoNzhHyCU), [**Undertale**](https://youtu.be/5zIvdy65Ro4), [**Dysmantle**](https://youtu.be/b9xzhLBdESE) and others...

 # Why?

@ -78,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 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

 - [**georgemoralis**](https://github.com/georgemoralis)
--- a/documents/Quickstart/1.png
+++ b/documents/Quickstart/1.png
--- a/documents/Quickstart/2.png
+++ b/documents/Quickstart/2.png
--- a/documents/Quickstart/Quickstart.md
+++ b/documents/Quickstart/Quickstart.md
@ -0,0 +1,56 @@
+<!--
+SPDX-FileCopyrightText: 2024 shadPS4 Emulator Project
+SPDX-License-Identifier: GPL-2.0-or-later
+-->
+
+# 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.
--- a/externals/glslang
+++ b/externals/glslang
@ -1 +1 @@
-Subproject commit a92c61f8456fa9731c0b000a2c6fc52a740c2be7
+Subproject commit 2d8b71fc63578a93726c05e0565c3ef064bdc1ba
--- a/externals/vulkan-headers
+++ b/externals/vulkan-headers
@ -1 +1 @@
-Subproject commit 05fe2cc910a68c9ba5dac07db46ef78573acee72
+Subproject commit e3c37e6e184a232e10b01dff5a065ce48c047f88
--- a/externals/xxhash
+++ b/externals/xxhash
@ -1 +1 @@
-Subproject commit b0adcc54188c3130b1793e7b19c62eb1e669f7df
+Subproject commit 805c00b68fa754200ada0c207ffeaa7a4409377c
--- a/src/qt_gui/game_list_frame.cpp
+++ b/src/qt_gui/game_list_frame.cpp
@ -1,5 +1,4 @@
 // SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
-// SPDX-FileCopyrightText: Copyright 2024 shadPS4 Emulator Project
 // SPDX-License-Identifier: GPL-2.0-or-later

 #include "game_list_frame.h"