improved documentation + better toolbar icons (#1364)

.gitmodules

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

README.md

@@ -36,14 +36,10 @@ 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).
+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 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/).\
-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
@@ -51,7 +47,7 @@ For those who'd like to donate to the project, we now have a [**Kofi page**](htt
 > [!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
 
@@ -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

documents/Quickstart/Quickstart.md

@@ -7,16 +7,16 @@ SPDX-License-Identifier: GPL-2.0-or-later
 
 ## Summary
 
-- [PC Requirements](#pc-requirements)
+- [**PC Requirements**](#minimum-pc-requirements)
-   - [CPU](#cpu)
+   - [**CPU**](#cpu)
-   - [GPU](#gpu)
+   - [**GPU**](#gpu)
-   - [RAM](#ram)
+   - [**RAM**](#ram)
-   - [OS](#os)
+   - [**OS**](#os)
-- [Have the latest WIP version](#have-the-latest-wip-version)
+- [**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)
+- [**Install PKG files (Games and Updates)**](#install-pkg-files)
-- [Configure the emulator](#configure-the-emulator)
+- [**Configure the emulator**](#configure-the-emulator)
 
-## PC Requirements
+## Minimum PC requirements
 
 ### CPU
 
@@ -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.\
+To configure the emulator, you can go through the interface and go to "settings".
-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:
+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.\
-- `[General]`
+For more information on this, see [**Debugging**](https://github.com/shadps4-emu/shadPS4/blob/main/documents/Debugging/Debugging.md#configuration).
-
-  - `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.

documents/changelog.txt

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

externals/glslang

@@ -1 +1 @@
-Subproject commit 46ef757e048e760b46601e6e77ae0cb72c97bd2f
+Subproject commit e61d7bb3006f451968714e2f653412081871e1ee

externals/toml11

@@ -1 +1 @@
-Subproject commit d050c6b137199666cae75c2628a75d63b49b1c22
+Subproject commit f925e7f287c0008813c2294798cf9ca167fd9ffd

externals/vulkan-headers

@@ -1 +1 @@
-Subproject commit 29f979ee5aa58b7b005f805ea8df7a855c39ff37
+Subproject commit d91597a82f881d473887b560a03a7edf2720b72c

externals/xbyak

@@ -1 +1 @@
-Subproject commit ccdf68421bc8eb85693f573080fc0a5faad862db
+Subproject commit d067f0d3f55696ae8bc9a25ad7012ee80f221d54

externals/xxhash

@@ -1 +1 @@
-Subproject commit 3e321b4407318ac1348c0b80fb6fbae8c81ad5fa
+Subproject commit d4ad85e4afaad5c780f54db1dc967fff5a869ffd

externals/zydis

@@ -1 +1 @@
-Subproject commit bd73bc03b0aacaa89c9c203b9b43cd08f1b1843b
+Subproject commit 9d298eb8067ff62a237203d1e1470785033e185c

src/qt_gui/main_window_ui.h

@@ -190,7 +190,7 @@ public:
         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"));