Template:Config/doc: Difference between revisions

Template page
(Moved default settings to its own page as "Default Settings")
(Incorporated enable thread scheduler option and removed excess spacing)
Line 14: Line 14:
<pre>
<pre>
<!-- CPU configuration -->
<!-- CPU configuration -->
|ppu decoder                               = Interpreter (precise), Interpreter (fast), Recompiler (LLVM)
|ppu decoder                     = Interpreter (precise), Interpreter (fast), Recompiler (LLVM)
|ppu decoder notes                         =
|ppu decoder notes               =
|spu decoder                               = Interpreter (precise), Interpreter (fast), Recompiler (ASMJIT)
|spu decoder                     = Interpreter (precise), Interpreter (fast), Recompiler (ASMJIT)
|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     =
|firmware settings                         = Automatically load required libraries, Manually load selected libraries, Load automatic and   
|firmware settings               = Automatically load required libraries, Manually load selected libraries, Load automatic and   
                                            manual selection, Load liblv2.sprx only
                                    manual selection, Load liblv2.sprx only
|firmware settings notes                   = Where Manually load selected libraries or Load automatic and manual selection options are   
|firmware settings notes         = Where Manually load selected libraries or Load automatic and manual selection options are   
                                            selected, mention the list of libraries to be selected in this parameter
                                    selected, mention the list of libraries to be selected in this parameter
|bind spu threads to secondary cores      = On, Off
|enable thread scheduler          = On, Off
|bind spu threads to secondary cores 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 =
|hook static function                     = On, Off
|hook static function             = On, Off
|hook static function notes               =
|hook static function notes       =
</pre>
</pre>
'''GPU configuration'''
'''GPU configuration'''
<pre>
<pre>
<!-- GPU configuration -->
<!-- GPU configuration -->
|renderer                                 = OpenGL, Vulkan
|renderer                         = OpenGL, Vulkan
|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 used this parameter on game pages.
                                    RPCS3 when multiple eligible cards exist. Do not used this parameter on game pages.
|graphics device notes                     =
|graphics device notes           =
|aspect ratio                             = Auto, 4:3, 16:9
|aspect ratio                     = Auto, 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                       = Automatic, Disabled, 2x, 4x, 8x, 16x
|anisotropic filter               = Automatic, Disabled, 2x, 4x, 8x, 16x
|anisotropic filter notes                 =
|anisotropic filter notes         =
|anti-aliasing                             = NA
|anti-aliasing                   = NA
|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                         = Range between 50% to 800%
|resolution scale                 = Range between 50% to 800%
|resolution scale notes                   =
|resolution scale notes           =
|resolution scale threshold               = Range between 1 to 1024 in the format 16 x 16
|resolution scale threshold       = Range between 1 to 1024 in the format 16 x 16
|resolution scale threshold notes         =
|resolution scale threshold notes =
|write color buffer                       = On, Off
|write color buffer               = On, Off
|write color buffer notes                 =
|write color buffer notes         =
|use gpu texture scaling                   = On, Off
|use gpu texture scaling         = On, Off
|use gpu texture scaling notes             =
|use gpu texture scaling 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       =
</pre>
</pre>
[[Category:Templates]]
[[Category:Templates]]

Revision as of 17:29, 28 January 2018

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. Refer here for the full list of default settings used in the emulator.

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

<!-- CPU configuration -->
|ppu decoder                      = Interpreter (precise), Interpreter (fast), Recompiler (LLVM)
|ppu decoder notes                =
|spu decoder                      = Interpreter (precise), Interpreter (fast), Recompiler (ASMJIT)
|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      =
|firmware settings                = Automatically load required libraries, Manually load selected libraries, Load automatic and  
                                    manual selection, Load liblv2.sprx only
|firmware settings notes          = Where Manually load selected libraries or Load automatic and manual selection options are  
                                    selected, mention the list of libraries to be selected in this parameter
|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  =
|hook static function             = On, Off
|hook static function notes       =

GPU configuration

<!-- GPU configuration -->
|renderer                         = OpenGL, Vulkan
|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 used this parameter on game pages.
|graphics device notes            =
|aspect ratio                     = Auto, 4:3, 16:9
|aspect ratio notes               = 
|framelimit                       = Off, 59.94, 50, 60, 30, Auto
|framelimit notes                 =
|anisotropic filter               = Automatic, Disabled, 2x, 4x, 8x, 16x
|anisotropic filter notes         =
|anti-aliasing                    = NA
|anti-aliasing notes              =
|default resolution               = 1920x1080, 1280x720, 720x480, 720x576, 1600x1080, 1440x1080, 1280x1080, 960x1080
|default resolution notes         =
|resolution scale                 = Range between 50% to 800%
|resolution scale notes           =
|resolution scale threshold       = Range between 1 to 1024 in the format 16 x 16
|resolution scale threshold notes =
|write color buffer               = On, Off
|write color buffer notes         =
|use gpu texture scaling          = On, Off
|use gpu texture scaling 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       =