Skip to content

Commit

Permalink
improved documentation + better toolbar icons (shadps4-emu#1364)
Browse files Browse the repository at this point in the history
  • Loading branch information
Xphalnos authored Oct 13, 2024
1 parent cf2e617 commit f0ee391
Show file tree
Hide file tree
Showing 14 changed files with 34 additions and 54 deletions.
3 changes: 2 additions & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,5 @@
shallow = true
[submodule "externals/discord-rpc"]
path = externals/discord-rpc
url = https://github.com/shadps4-emu/ext-discord-rpc
url = https://github.com/shadps4-emu/ext-discord-rpc.git
shallow = true
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,22 +36,18 @@ SPDX-License-Identifier: GPL-2.0-or-later

**shadPS4** is an early **PlayStation 4** emulator for **Windows**, **Linux** and **macOS** 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 verify that a game works, you can look at [**shadPS4 Game Compatibility**](https://github.com/shadps4-emu/shadps4-game-compatibility).

To discuss shadPS4 development, suggest ideas or to ask for help, join our [**Discord server**](https://discord.gg/bFJxfftGW6).

To get the latest news, go to our [**X (Twitter)**](https://x.com/shadps4) or our [**website**](https://shadps4.net/).

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 verify that a game works, you can look at [**shadPS4 Game Compatibility**](https://github.com/shadps4-emu/shadps4-game-compatibility).\
To discuss shadPS4 development, suggest ideas or to ask for help, join our [**Discord server**](https://discord.gg/bFJxfftGW6).\
To get the latest news, go to our [**X (Twitter)**](https://x.com/shadps4) or our [**website**](https://shadps4.net/).\
For those who'd like to donate to the project, we now have a [**Kofi page**](https://ko-fi.com/shadps4)!

# Status

> [!IMPORTANT]
> shadPS4 is early in development, don't expect a flawless experience.
Currently, the emulator successfully runs small games like [**Sonic Mania**](https://www.youtube.com/watch?v=AAHoNzhHyCU), [**Undertale**](https://youtu.be/5zIvdy65Ro4) and it can even run [**Bloodborne**](https://www.youtube.com/watch?v=wC6s0avpQRE).
Currently, the emulator can successfully run games like [**Bloodborne**](https://www.youtube.com/watch?v=wC6s0avpQRE), [**Dark Souls Remastered**](https://www.youtube.com/watch?v=-3PA-Xwszts), [**Red Dead Redemption**](https://www.youtube.com/watch?v=Al7yz_5nLag) and many other games.

# Why

Expand Down Expand Up @@ -123,8 +119,7 @@ Logo is done by [**Xphalnos**](https://github.com/Xphalnos)

# Contributing

If you want to contribute, please look the [**CONTRIBUTING.md**](https://github.com/shadps4-emu/shadPS4/blob/main/CONTRIBUTING.md) file.

If you want to contribute, please look the [**CONTRIBUTING.md**](https://github.com/shadps4-emu/shadPS4/blob/main/CONTRIBUTING.md) file.\
Open a PR and we'll check it :)

# Contributors
Expand Down
52 changes: 18 additions & 34 deletions documents/Quickstart/Quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ SPDX-License-Identifier: GPL-2.0-or-later

## 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**](#minimum-pc-requirements)
- [**CPU**](#cpu)
- [**GPU**](#gpu)
- [**RAM**](#ram)
- [**OS**](#os)
- [**Have the latest WIP version**](#how-to-run-the-latest-work-in-progress-builds-of-shadps4)
- [**Install PKG files (Games and Updates)**](#install-pkg-files)
- [**Configure the emulator**](#configure-the-emulator)

## PC Requirements
## Minimum PC requirements

### CPU

Expand All @@ -38,41 +38,25 @@ SPDX-License-Identifier: GPL-2.0-or-later

- Windows 10 or Ubuntu 22.04

## How to run the latest Work-in-Progress builds of ShadPS4
## How to run the latest Work-in-Progress builds of shadPS4

1. Go to <https://github.com/shadps4-emu/shadPS4/releases> In the release identified as 'pre-release' click on the down arrow(Assets), select your operating system of choice (the "**qt**" versions have a user interface, which is probably the one you want. The others are SDL versions, which can only be run via command line).
![image](https://github.com/user-attachments/assets/af520c77-797c-41a0-8f67-d87f5de3e3df)

2. Once downloaded, extract to its own folder, and run ShadPS4's executable from the extracted folder.
2. Once downloaded, extract to its own folder, and run shadPS4's executable from the extracted folder.

3. Upon first launch, ShadPS4 will prompt you to select a folder to store your installed games in. Select "Browse" and then select a folder that ShadPS4 can use to install your PKG files to.
3. Upon first launch, shadPS4 will prompt you to select a folder to store your installed games in. Select "Browse" and then select a folder that shadPS4 can use to install your PKG files to.

## 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>
<img src="https://github.com/shadps4-emu/shadPS4/blob/main/documents/Quickstart/2.png" width="800">

## Configure the emulator

You can configure the emulator by editing the `config.toml` file found in the `user` folder created after starting the application.\
Some settings may be related to more technical development and debugging. For more information on those, see [Debugging](https://github.com/shadps4-emu/shadPS4/blob/main/documents/Debugging/Debugging.md#configuration).

Here's a list of configuration entries that are worth changing:

- `[General]`

- `Fullscreen`: Display the game in a full screen borderless window.

- `logType`: Configures logging synchronization (`sync`/`async`)
- It can be beneficial to set this to `sync` in order for the log to accurately maintain message order, at the cost of performance.
- Use when sending logs to developers. See more about [reporting issues](https://github.com/shadps4-emu/shadPS4/blob/main/documents/Debugging/Debugging.md#reporting-and-communicating-about-issues).
- `logFilter`: Sets the logging category for various logging classes.
- Format: `<class>:<level> ...`, `<class.*>:<level> <*:level> ...`
- Valid log levels: `Trace, Debug, Info, Warning, Error, Critical` - in this order, setting a level silences all levels preceding it and logs every level after it.
- Examples:
- If the log is being spammed with messages coming from Lib.Pad, you can use `Lib.Pad:Critical` to only log critical-level messages.
- If you'd like to mute everything, but still want to receive messages from Vulkan rendering: `*:Error Render.Vulkan:Info`

- `[GPU]`
- `screenWidth` and `screenHeight`: Configures the game window width and height.
To configure the emulator, you can go through the interface and go to "settings".

You can also configure the emulator by editing the `config.toml` file located in the `user` folder created after the application is started (Mostly useful if you are using the SDL version).
Some settings may be related to more technical development and debugging.\
For more information on this, see [**Debugging**](https://github.com/shadps4-emu/shadPS4/blob/main/documents/Debugging/Debugging.md#configuration).
2 changes: 1 addition & 1 deletion documents/changelog.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ v0.3.0 23/09/2024 - codename broamic
- New translations support (26 languages)
- Support for unlocking trophies
- Support for more controllers (Dualshock and Xbox)
- Many GUI imporovements
- Many GUI improvements
- AVplayer

v0.2.0 15/08/2024 - codename validptr
Expand Down
2 changes: 1 addition & 1 deletion externals/glslang
Submodule glslang updated 47 files
+6 −6 .github/workflows/continuous_deployment.yml
+22 −22 .github/workflows/continuous_integration.yml
+2 −2 .github/workflows/scorecard.yml
+17 −8 SPIRV/GlslangToSpv.cpp
+49 −4 SPIRV/SpvBuilder.cpp
+4 −3 SPIRV/SpvBuilder.h
+1 −1 SPIRV/SpvPostProcess.cpp
+1 −1 SPIRV/SpvTools.cpp
+1 −1 SPIRV/disassemble.cpp
+1 −1 SPIRV/doc.cpp
+14 −0 SPIRV/spirv.hpp
+9 −0 SPIRV/spvIR.h
+11 −1 StandAlone/StandAlone.cpp
+54 −54 Test/baseResults/hlsl.pp.line2.frag.out
+31 −31 Test/baseResults/hlsl.pp.line4.frag.out
+2 −2 Test/baseResults/hlsl.round.dx9.frag.out
+140 −134 Test/baseResults/hlsl.sample.dx9.frag.out
+59 −53 Test/baseResults/hlsl.sample.dx9.vert.out
+232 −0 Test/baseResults/link.crossStageOptimization.out
+623 −0 Test/baseResults/spv.debuginfo.coopmatKHR.comp.out
+942 −922 Test/baseResults/spv.debuginfo.glsl.comp.out
+903 −896 Test/baseResults/spv.debuginfo.glsl.frag.out
+299 −291 Test/baseResults/spv.debuginfo.glsl.tesc.out
+1,322 −1,114 Test/baseResults/spv.debuginfo.hlsl.comp.out
+1,225 −996 Test/baseResults/spv.debuginfo.hlsl.frag.out
+456 −370 Test/baseResults/spv.debuginfo.hlsl.geom.out
+891 −709 Test/baseResults/spv.debuginfo.hlsl.tesc.out
+572 −475 Test/baseResults/spv.debuginfo.hlsl.tese.out
+648 −531 Test/baseResults/spv.debuginfo.hlsl.vert.out
+166 −156 Test/baseResults/spv.debuginfo.implicit_br.glsl.frag.out
+9 −7 Test/baseResults/spv.debuginfo.rt_types.glsl.rgen.out
+24 −0 Test/link.crossStageOptimization.frag
+41 −0 Test/link.crossStageOptimization.vert
+7 −0 Test/runtests
+87 −0 Test/spv.debuginfo.coopmatKHR.comp
+1 −1 glslang/CInterface/glslang_c_interface.cpp
+1 −1 glslang/HLSL/hlslParseHelper.cpp
+1 −0 glslang/Include/glslang_c_shader_types.h
+50 −27 glslang/MachineIndependent/ShaderLang.cpp
+1 −1 glslang/MachineIndependent/SymbolTable.cpp
+102 −0 glslang/MachineIndependent/linkValidate.cpp
+1 −0 glslang/MachineIndependent/localintermediate.h
+2 −1 glslang/MachineIndependent/propagateNoContraction.h
+1 −0 glslang/Public/ShaderLang.h
+1 −1 gtests/Hlsl.FromFile.cpp
+1 −0 gtests/Spv.FromFile.cpp
+8 −0 gtests/TestFixture.h
2 changes: 1 addition & 1 deletion externals/toml11
Submodule toml11 updated 1 files
+33 −16 README.md
2 changes: 1 addition & 1 deletion externals/xxhash
Binary file modified src/images/pause_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/settings_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/images/stop_icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/qt_gui/main_window_ui.h
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ class Ui_MainWindow {
settingsButton = new QPushButton(centralWidget);
settingsButton->setFlat(true);
settingsButton->setIcon(QIcon(":images/settings_icon.png"));
settingsButton->setIconSize(QSize(40, 40));
settingsButton->setIconSize(QSize(44, 44));
controllerButton = new QPushButton(centralWidget);
controllerButton->setFlat(true);
controllerButton->setIcon(QIcon(":images/controller_icon.png"));
Expand Down

0 comments on commit f0ee391

Please sign in to comment.