Template:Config/doc: Difference between revisions

Template page
(→‎Parameters: Updated option description)
(Added Accurate RSX reservation access parameter and fixed white spacing)
Line 23: Line 23:
=== CPU configuration ===
=== CPU configuration ===
<pre>
<pre>
|ppu decoder                         = Interpreter (precise), Interpreter (fast), LLVM Recompiler
|ppu decoder                           = Interpreter (precise), Interpreter (fast), LLVM Recompiler
|ppu decoder notes                   =  
|ppu decoder notes                     =  
|spu decoder                         = Interpreter (precise), Interpreter (fast), ASMJIT Recompiler, LLVM Recompiler
|spu decoder                           = Interpreter (precise), Interpreter (fast), ASMJIT Recompiler, LLVM Recompiler
|spu decoder notes                   =  
|spu decoder notes                     =  
|preferred spu threads               = Auto, Single digit between 1 to 6 (e.g. 3), Range between 1 to 6 (e.g. 1 - 3)
|preferred spu threads                 = Auto, Single digit between 1 to 6 (e.g. 3), Range between 1 to 6 (e.g. 1 - 3)
|preferred spu threads notes         =  
|preferred spu threads notes           =  
|enable thread scheduler             = On, Off
|enable thread scheduler               = On, Off
|enable thread scheduler notes       =  
|enable thread scheduler notes         =  
|lower spu thread priority           = On, Off
|lower spu thread priority             = On, Off
|lower spu thread priority notes     =  
|lower spu thread priority notes       =  
|enable spu loop detection           = On, Off
|enable spu loop detection             = On, Off
|enable spu loop detection notes     =  
|enable spu loop detection notes       =  
|spu cache                           = On, Off
|spu cache                             = On, Off
|spu cache notes                     =  
|spu cache notes                       =  
|accurate xfloat                     = On, Off
|accurate xfloat                       = On, Off
|accurate xfloat notes               =  
|accurate xfloat notes                 =  
|spu block size                     = Safe, Mega, Giga
|spu block size                       = Safe, Mega, Giga
|spu block size notes               =  
|spu block size notes                 =  
|tsx instructions                   = Enabled, Disabled, Forced
|tsx instructions                     = Enabled, Disabled, Forced
|tsx instructions notes             =  
|tsx instructions notes               =  
</pre>
</pre>


=== GPU configuration ===
=== GPU configuration ===
<pre>
<pre>
|renderer                           = OpenGL, Vulkan, Disabled
|renderer                             = OpenGL, Vulkan, Disabled
|renderer notes                     =  
|renderer notes                       =  
|graphics device                     = This option is used only with Vulkan renderer to select the graphics card to be used by  
|graphics device                       = This option is used only with Vulkan renderer to select the graphics card to be used by  
                                      RPCS3 when multiple eligible cards exist. Do not use this parameter on game pages.
                                        RPCS3 when multiple eligible cards exist. Do not use this parameter on game pages.
|graphics device notes               =  
|graphics device notes                 =  
|aspect ratio                       = 4:3, 16:9
|aspect ratio                         = 4:3, 16:9
|aspect ratio notes                 =  
|aspect ratio notes                   =  
|framelimit                         = Off, 59.94, 50, 60, 30, Auto
|framelimit                           = Off, 59.94, 50, 60, 30, Auto
|framelimit notes                   =  
|framelimit notes                     =  
|anisotropic filter                 = Auto, 2x, 4x, 8x, 16x
|anisotropic filter                   = Auto, 2x, 4x, 8x, 16x
|anisotropic filter notes           =  
|anisotropic filter notes             =  
|anti-aliasing                       = Auto, Disabled
|anti-aliasing                         = Auto, Disabled
|anti-aliasing notes                 =  
|anti-aliasing notes                   =  
|default resolution                 = 1920x1080, 1280x720, 720x480, 720x576, 1600x1080, 1440x1080, 1280x1080, 960x1080
|default resolution                   = 1920x1080, 1280x720, 720x480, 720x576, 1600x1080, 1440x1080, 1280x1080, 960x1080
|default resolution notes           =  
|default resolution notes             =  
|resolution scale                   = Value between 50% to 800%
|resolution scale                     = Value between 50% to 800%
|resolution scale notes             =  
|resolution scale notes               =  
|resolution scale threshold         = Value between 1 to 1024 in the format 16 x 16
|resolution scale threshold           = Value between 1 to 1024 in the format 16 x 16
|resolution scale threshold notes   =  
|resolution scale threshold notes     =  
|write color buffers                 = On, Off
|write color buffers                   = On, Off
|write color buffers notes           =  
|write color buffers notes             =  
|strict rendering mode               = On, Off
|strict rendering mode                 = On, Off
|strict rendering mode notes         =  
|strict rendering mode notes           =  
|vsync                               = On, Off
|vsync                                 = On, Off
|vsync notes                         =  
|vsync notes                           =  
|stretch to display area             = On, Off
|stretch to display area               = On, Off
|stretch to display area notes       =  
|stretch to display area notes         =  
|disable vertex cache               = On, Off
|disable vertex cache                 = On, Off
|disable vertex cache notes         =  
|disable vertex cache notes           =  
|multithreaded rsx                   = On, Off
|multithreaded rsx                     = On, Off
|multithreaded rsx notes             =  
|multithreaded rsx notes               =  
|disable async shader compiler       = On, Off
|disable async shader compiler         = On, Off
|disable async shader compiler notes =  
|disable async shader compiler notes =  
</pre>
</pre>
Line 84: Line 84:
=== Audio configuration ===
=== Audio configuration ===
<pre>
<pre>
|audio out windows                   = XAudio2, OpenAL, Disabled
|audio out windows                     = XAudio2, OpenAL, Disabled
|audio out windows notes             =  
|audio out windows notes               =  
|audio out linux                     = OpenAL, PulseAudio, ALSA, Disabled
|audio out linux                       = OpenAL, PulseAudio, ALSA, Disabled
|audio out linux notes               =  
|audio out linux notes                 =  
|dump to file                       = On, Off
|dump to file                         = On, Off
|dump to file notes                 =  
|dump to file notes                   =  
|convert to 16-bit                   = On, Off
|convert to 16-bit                     = On, Off
|convert to 16-bit notes             =  
|convert to 16-bit notes               =  
|downmix to stereo                   = On, Off
|downmix to stereo                     = On, Off
|downmix to stereo notes             =  
|downmix to stereo notes               =  
|volume                             = Value between 0% to 200%
|volume                               = Value between 0% to 200%
|volume notes                       =  
|volume notes                         =  
|enable buffering                   = On, Off
|enable buffering                     = On, Off
|enable buffering notes             =  
|enable buffering notes               =  
|audio buffer duration               = Value between 20ms to 250ms
|audio buffer duration                 = Value between 20ms to 250ms
|audio buffer duration notes         =  
|audio buffer duration notes           =  
|enable time stretching             = On, Off
|enable time stretching               = On, Off
|enable time stretching notes       =  
|enable time stretching notes         =  
|time stretching threshold           = Value between 0% to 100%
|time stretching threshold             = Value between 0% to 100%
|time stretching threshold notes     =  
|time stretching threshold notes       =  
|microphone type                     = Disabled, Standard, SingStar, Real SingStar, Rocksmith
|microphone type                       = Disabled, Standard, SingStar, Real SingStar, Rocksmith
|microphone type notes               =  
|microphone type notes                 =  
</pre>
</pre>


=== I/O configuration ===
=== I/O configuration ===
<pre>
<pre>
|keyboard handler                   = Null, Basic
|keyboard handler                     = Null, Basic
|keyboard handler notes             =  
|keyboard handler notes               =  
|mouse handler                       = Null, Basic
|mouse handler                         = Null, Basic
|mouse handler notes                 =  
|mouse handler notes                   =  
|camera input                       = Unknown, EyeToy, PS Eye, UVC 1.1
|camera input                         = Unknown, EyeToy, PS Eye, UVC 1.1
|camera input notes                 =  
|camera input notes                   =  
|camera settings                     = Null, Fake
|camera settings                       = Null, Fake
|camera settings notes               =  
|camera settings notes                 =  
|move handler                       = Null, Fake, Mouse
|move handler                         = Null, Fake, Mouse
|move handler notes                 =  
|move handler notes                   =  
</pre>
</pre>


=== Advanced configuration ===
=== Advanced configuration ===
<pre>
<pre>
|debug console mode                 = On, Off
|debug console mode                   = On, Off
|debug console mode notes           =  
|debug console mode notes             =  
|silence all logs                   = On, Off
|silence all logs                     = On, Off
|silence all logs notes             =  
|silence all logs notes               =  
|sleep timers accuracy               = As Host, Usleep Only, All Timers
|sleep timers accuracy                 = As Host, Usleep Only, All Timers
|sleep timers accuracy notes         =  
|sleep timers accuracy notes           =  
|maximum spurs threads               = Unlimited, Single digit between 0 to 5 (e.g. 3)
|maximum spurs threads                 = Unlimited, Single digit between 0 to 5 (e.g. 3)
|maximum spurs threads notes         =  
|maximum spurs threads notes           =  
|firmware settings                   = Manually load selected libraries, Load automatic and manual selection, Load liblv2.sprx only,  
|firmware settings                     = Manually load selected libraries, Load automatic and manual selection, Load liblv2.sprx only,  
                                      Load liblv2.sprx and manual selection, Load liblv2.sprx and strict selection
                                        Load liblv2.sprx and manual selection, Load liblv2.sprx and strict selection
|firmware settings notes             = Where libraries are manually selected, mention the list of libraries to be selected here
|firmware settings notes               = Where libraries are manually selected, mention the list of libraries to be selected here
|read depth buffers                 = On, Off
|read depth buffers                   = On, Off
|read depth buffers notes           =  
|read depth buffers notes             =  
|write depth buffers                 = On, Off
|write depth buffers                   = On, Off
|write depth buffers notes           =  
|write depth buffers notes             =  
|read color buffers                 = On, Off
|read color buffers                   = On, Off
|read color buffers notes           =  
|read color buffers notes             =  
|disable on-disk shader cache       = On, Off
|disable on-disk shader cache         = On, Off
|disable on-disk shader cache notes =  
|disable on-disk shader cache notes   =  
|relaxed zcull sync                 = On, Off
|relaxed zcull sync                   = On, Off
|relaxed zcull sync notes           =  
|relaxed zcull sync notes             =  
|driver wake-up delay               = Value between 0 to 7000
|driver wake-up delay                 = Value between 0 to 7000
|driver wake-up delay notes         =  
|driver wake-up delay notes           =  
|vblank rate                         = Value between 1 to 500
|vblank rate                           = Value between 1 to 500
|vblank rate notes                   =  
|vblank rate notes                     =  
|clocks scale                       = Value between 10 to 1000
|clocks scale                         = Value between 10 to 1000
|clocks scale notes                 =  
|clocks scale notes                   =  
</pre>
</pre>


=== Debug configuration ===
=== Debug configuration ===
<pre>
<pre>
|force cpu blit emulation           = On, Off
|force cpu blit emulation             = On, Off
|force cpu blit emulation notes     =  
|force cpu blit emulation notes       =  
|use gpu texture scaling             = On, Off
|use gpu texture scaling               = On, Off
|use gpu texture scaling notes       =  
|use gpu texture scaling notes         =  
|accurate getllar                   = On, Off
|accurate getllar                     = On, Off
|accurate getllar notes             =  
|accurate getllar notes               =  
|accurate putlluc                   = On, Off
|accurate putlluc                     = On, Off
|accurate putlluc notes             =  
|accurate putlluc notes               =
|hook static functions               = On, Off
|accurate rsx reservation access      = On, Off
|hook static functions notes         =  
|accurate rsx reservation access notes =  
|hook static functions                 = On, Off
|hook static functions notes           =  
</pre>
</pre>


Line 172: Line 174:
{{config
{{config
<!-- CPU configuration -->
<!-- CPU configuration -->
|preferred spu threads               = 3 - 4
|preferred spu threads                 = 3 - 4
<!-- GPU configuration -->
<!-- GPU configuration -->
|renderer                           = Vulkan
|renderer                             = Vulkan
|write color buffers                 = On
|write color buffers                   = On
}}
}}
</pre>
</pre>
{{config
{{config
<!-- CPU configuration -->
<!-- CPU configuration -->
|preferred spu threads               = 3 - 4
|preferred spu threads                 = 3 - 4
<!-- GPU configuration -->
<!-- GPU configuration -->
|renderer                           = Vulkan
|renderer                             = Vulkan
|write color buffers                 = On
|write color buffers                   = On
}}
}}



Revision as of 09:54, 31 March 2020

This template is used on all game pages under the ==Configuration== sub-header. The purpose of the template is to capture deviations in configurations from the default settings to be used for the emulator for each game. Hence, while using this template in the game pages, only options which deviate from the default settings are to be recorded.

Mandatory vs. recommendatory settings

Before using this is template, it is imperative to understand the distinction between mandatory settings and recommendatory settings.

  • Mandatory settings - Settings without which the game would not work (for example, write color buffers for Demon's Souls and PPU Interpreter (precise) for The Elder Scrolls IV: Oblivion) or will significantly degrade performance.
  • Recommendatory settings - User specific settings which will improve the overall gaming experience based on the hardware available. For example, a higher option can be used for Anisotropic Filter and Resolution Scale if the user's hardware is capable of handling the additional load whereas settings such as Lower SPU Thread Priority should be used for better performance with weaker CPUs.

Given the nature of the options available, it is not feasible to capture all permutations of settings for each game using this template. Hence, only mandatory settings shall be listed in the game pages using this template. To know which recommendatory setting would be most appropriate, kindly read the guidance available for each setting in the default settings page. RPCS3 is alpha stage emulator and hence user will have to experiment with the recommendatory settings to optimise their gameplay experience.

An exception to the above rule would be Preferred SPU Threads where a value or range can be provided to identify the optimal option for each user.

Syntax

Below is the syntax of the template. This template must be present for all game pages irrespective of whether any non-default configurations are necessary. Where the game only requires default settings, the template should simply be used without any parameters.

{{config
|parameters =
}}

Parameters

The following are the only valid parameters accepted by this template. Unless mentioned otherwise, choose only one of the options mentioned for each setting. For any setting which deviates from the default configuration, an additional note may be given if required using the notes extension to highlight any necessary information.

CPU configuration

|ppu decoder                           = Interpreter (precise), Interpreter (fast), LLVM Recompiler
|ppu decoder notes                     = 
|spu decoder                           = Interpreter (precise), Interpreter (fast), ASMJIT Recompiler, LLVM Recompiler
|spu decoder notes                     = 
|preferred spu threads                 = Auto, Single digit between 1 to 6 (e.g. 3), Range between 1 to 6 (e.g. 1 - 3)
|preferred spu threads notes           = 
|enable thread scheduler               = On, Off
|enable thread scheduler notes         = 
|lower spu thread priority             = On, Off
|lower spu thread priority notes       = 
|enable spu loop detection             = On, Off
|enable spu loop detection notes       = 
|spu cache                             = On, Off
|spu cache notes                       = 
|accurate xfloat                       = On, Off
|accurate xfloat notes                 = 
|spu block size                        = Safe, Mega, Giga
|spu block size notes                  = 
|tsx instructions                      = Enabled, Disabled, Forced
|tsx instructions notes                = 

GPU configuration

|renderer                              = OpenGL, Vulkan, Disabled
|renderer notes                        = 
|graphics device                       = This option is used only with Vulkan renderer to select the graphics card to be used by 
                                         RPCS3 when multiple eligible cards exist. Do not use this parameter on game pages.
|graphics device notes                 = 
|aspect ratio                          = 4:3, 16:9
|aspect ratio notes                    = 
|framelimit                            = Off, 59.94, 50, 60, 30, Auto
|framelimit notes                      = 
|anisotropic filter                    = Auto, 2x, 4x, 8x, 16x
|anisotropic filter notes              = 
|anti-aliasing                         = Auto, Disabled
|anti-aliasing notes                   = 
|default resolution                    = 1920x1080, 1280x720, 720x480, 720x576, 1600x1080, 1440x1080, 1280x1080, 960x1080
|default resolution notes              = 
|resolution scale                      = Value between 50% to 800%
|resolution scale notes                = 
|resolution scale threshold            = Value between 1 to 1024 in the format 16 x 16
|resolution scale threshold notes      = 
|write color buffers                   = On, Off
|write color buffers notes             = 
|strict rendering mode                 = On, Off
|strict rendering mode notes           = 
|vsync                                 = On, Off
|vsync notes                           = 
|stretch to display area               = On, Off
|stretch to display area notes         = 
|disable vertex cache                  = On, Off
|disable vertex cache notes            = 
|multithreaded rsx                     = On, Off
|multithreaded rsx notes               = 
|disable async shader compiler         = On, Off
|disable async shader compiler notes = 

Audio configuration

|audio out windows                     = XAudio2, OpenAL, Disabled
|audio out windows notes               = 
|audio out linux                       = OpenAL, PulseAudio, ALSA, Disabled
|audio out linux notes                 = 
|dump to file                          = On, Off
|dump to file notes                    = 
|convert to 16-bit                     = On, Off
|convert to 16-bit notes               = 
|downmix to stereo                     = On, Off
|downmix to stereo notes               = 
|volume                                = Value between 0% to 200%
|volume notes                          = 
|enable buffering                      = On, Off
|enable buffering notes                = 
|audio buffer duration                 = Value between 20ms to 250ms
|audio buffer duration notes           = 
|enable time stretching                = On, Off
|enable time stretching notes          = 
|time stretching threshold             = Value between 0% to 100%
|time stretching threshold notes       = 
|microphone type                       = Disabled, Standard, SingStar, Real SingStar, Rocksmith
|microphone type notes                 = 

I/O configuration

|keyboard handler                      = Null, Basic
|keyboard handler notes                = 
|mouse handler                         = Null, Basic
|mouse handler notes                   = 
|camera input                          = Unknown, EyeToy, PS Eye, UVC 1.1
|camera input notes                    = 
|camera settings                       = Null, Fake
|camera settings notes                 = 
|move handler                          = Null, Fake, Mouse
|move handler notes                    = 

Advanced configuration

|debug console mode                    = On, Off
|debug console mode notes              = 
|silence all logs                      = On, Off
|silence all logs notes                = 
|sleep timers accuracy                 = As Host, Usleep Only, All Timers
|sleep timers accuracy notes           = 
|maximum spurs threads                 = Unlimited, Single digit between 0 to 5 (e.g. 3)
|maximum spurs threads notes           = 
|firmware settings                     = Manually load selected libraries, Load automatic and manual selection, Load liblv2.sprx only, 
                                         Load liblv2.sprx and manual selection, Load liblv2.sprx and strict selection
|firmware settings notes               = Where libraries are manually selected, mention the list of libraries to be selected here
|read depth buffers                    = On, Off
|read depth buffers notes              = 
|write depth buffers                   = On, Off
|write depth buffers notes             = 
|read color buffers                    = On, Off
|read color buffers notes              = 
|disable on-disk shader cache          = On, Off
|disable on-disk shader cache notes    = 
|relaxed zcull sync                    = On, Off
|relaxed zcull sync notes              = 
|driver wake-up delay                  = Value between 0 to 7000
|driver wake-up delay notes            = 
|vblank rate                           = Value between 1 to 500
|vblank rate notes                     = 
|clocks scale                          = Value between 10 to 1000
|clocks scale notes                    = 

Debug configuration

|force cpu blit emulation              = On, Off
|force cpu blit emulation notes        = 
|use gpu texture scaling               = On, Off
|use gpu texture scaling notes         = 
|accurate getllar                      = On, Off
|accurate getllar notes                = 
|accurate putlluc                      = On, Off
|accurate putlluc notes                = 
|accurate rsx reservation access       = On, Off
|accurate rsx reservation access notes = 
|hook static functions                 = On, Off
|hook static functions notes           = 

Examples

Demon's Souls - Standard

{{config
<!-- CPU configuration -->
|preferred spu threads                 = 3 - 4
<!-- GPU configuration -->
|renderer                              = Vulkan
|write color buffers                   = On
}}

Only options that deviate from the default configuration to ensure best performance are listed below. The full list of default options is available here.

CPU configuration

Setting Option Notes
Preferred SPU threads 3 - 4

GPU configuration

Setting Option Notes
Renderer Vulkan
Write color buffers On


Find a game that does this - When the game only uses default settings

{{config
}}

No options that deviate from the default configuration are recommended for this title. The full list of default options is available here.

Attribution and re-use

This template (along with its documentation template) has been adapted from Dolphin Emulator Wiki released under the Creative Commons Attribution-ShareAlike 3.0 License.