Mirrors/shadPS4
1
0
Fork 0
mirror of https://github.com/shadps4-emu/shadPS4.git synced 2025-05-18 01:14:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Expand documentation on configuration and debugging (#513)

Browse source 
* documents: more info on config.toml

* documents: add Debugging

* documents: link to Debugging in README

* documents: link to main branch for Debugging

Once it's merged, it should link properly.
Quickstart already exists in main.

* documents: remove "troubleshooting" from Debugging

Not entirely relevant.

* documents: elaborate on a few points with stack traces

* documents: formatting, indentation fixup

* documents: remove unnecessary indent

* documents: fix some inline code blocks + misc

* documents: move the technical jargon out of Quickstart

* documents: improve configuration sections

Simplified the Quickstart config listing, added more technical info to the Debugging listing.

* documents: link quickstart config link to proper section

* documents: something ate my hash symbol

* documents: use *:Critical for log silencing example

* documents: add note about Start Without Debugging

* documents: use correct CUSA code in example
This commit is contained in:
Sebastian Kassai 2024-08-21 21:13:06 +02:00 • committed by GitHub
parent 132ca9c5a8
commit ba0a6ab038
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 176 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

22
documents/Quickstart/Quickstart.md
View file

@ -58,4 +58,24 @@ To install PKG files (game and updates), you will need the Qt application (with
## 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.
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.