documents: improve configuration sections

Simplified the Quickstart config listing, added more technical info to the Debugging listing.
This commit is contained in:
xezrunner 2024-08-21 18:46:17 +02:00
parent 52a1062174
commit dfdc2c8d83
2 changed files with 25 additions and 3 deletions

View File

@ -1,4 +1,4 @@
# Debugging and reporting issues about shadPS4 and games # Debugging and reporting issues about shadPS4 and games
This document covers information about debugging, troubleshooting and reporting developer-side issues related to shadPS4 and games. This document covers information about debugging, troubleshooting and reporting developer-side issues related to shadPS4 and games.
@ -43,9 +43,11 @@ Launch games through **Debug > Start debugging** (F5 by default).
You can configure the emulator by editing the `config.toml` file found in the `user` folder created after starting the application. You can configure the emulator by editing the `config.toml` file found in the `user` folder created after starting the application.
Here's a list of configuration entries that are worth changing: <details>
<summary>Some configuration entries worth changing</summary>
- `[General]` - `[General]`
- `logType`: Configures logging synchronization (`sync`/`async`) - `logType`: Configures logging synchronization (`sync`/`async`)
- By default, the emulator logs messages asynchronously for better performance. Some log messages may end up being received out-of-order. - By default, the emulator logs messages asynchronously for better performance. Some log messages may end up being received out-of-order.
- It can be beneficial to set this to `sync` in order for the log to accurately maintain message order, at the cost of performance. - It can be beneficial to set this to `sync` in order for the log to accurately maintain message order, at the cost of performance.
@ -59,9 +61,24 @@ Here's a list of configuration entries that are worth changing:
- Examples: - 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 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` - If you'd like to mute everything, but still want to receive messages from Vulkan rendering: `*:Error Render.Vulkan:Info`
- `Fullscreen`: Display the game in a full screen borderless window.
- `[GPU]` - `[GPU]`
- `dumpShaders`: Dump shaders that are loaded by the emulator. Dump path: `../user/shader/dumps`
- `nullGpu`: Disables rendering.
- `screenWidth` and `screenHeight`: Configures the game window width and height. - `screenWidth` and `screenHeight`: Configures the game window width and height.
- `[Vulkan]`
- `validation`-related settings: Use when debugging Vulkan.
- `rdocEnable`: Automatically hook RenderDoc when installed. Useful for debugging shaders and game rendering.
- `rdocMarkersEnable`: Enable automatic RenderDoc event annotation
- `[LLE]`
- `libc`: Use LLE with `libc`.
</details>
## Quick analysis ## Quick analysis
This section will provide some preliminary steps to take and tips on what to do when you encounter scenarios that require debugging. This section will provide some preliminary steps to take and tips on what to do when you encounter scenarios that require debugging.

View File

@ -58,11 +58,15 @@ To install PKG files (game and updates), you will need the Qt application (with
## Configure the emulator ## Configure the emulator
You can configure the emulator by editing the `config.toml` file found in the `user` folder created after starting the application. 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).
Here's a list of configuration entries that are worth changing: Here's a list of configuration entries that are worth changing:
- `[General]` - `[General]`
- `Fullscreen`: Display the game in a full screen borderless window.
- `logType`: Configures logging synchronization (`sync`/`async`) - `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. - 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). - 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).
@ -72,5 +76,6 @@ Here's a list of configuration entries that are worth changing:
- Examples: - 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 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` - If you'd like to mute everything, but still want to receive messages from Vulkan rendering: `*:Error Render.Vulkan:Info`
- `[GPU]` - `[GPU]`
- `screenWidth` and `screenHeight`: Configures the game window width and height. - `screenWidth` and `screenHeight`: Configures the game window width and height.