Template:Config/doc: Difference between revisions

Template page
No edit summary
Line 67: Line 67:
This template must be present for all game pages irrespective of whether the .
This template must be present for all game pages irrespective of whether the .
=== Syntax ===
=== Syntax ===
'''<nowiki>{{config</nowiki>'''<\br>
'''<nowiki>{{config</nowiki>'''<br/>
''|parameters =''<\br>
''|parameters =''<br/>
'''}}'''
'''}}'''



Revision as of 10:06, 17 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 mentioned below are to be recorded.

Default Settings

Below is the default configuration for the emulator.

CPU configuration

Setting Option Description
PPU Decoder Recompiler (LLVM) Recompiler (LLVM): Recompiles the game's executable once before running it for the first time. By far the fastest option and should always be used. Should you face compatibility issues, fall back to one of the Interpreters and retry.
Interpreter (fast): The fastest interpreter. Trades accuracy for speed, and it very rarely breaks games even in comparison to the precise option. Try this if Recompiler (LLVM) fails.
Interpreter (precise): The most accurate Interpreter, but very slow to play games with. You may try this as a last resort if you encounter odd bugs or crashes.
SPU Decoder Recompiler (ASMJIT) Recompiler (ASMJIT): Fastest option with very good compatibility.
Interpreter (fast): Slower than the Recompiler (ASMJIT) but significantly faster than Interpreter (precise). Games rarely need this option.
Interpreter (precise): Extremely slow but may fix broken graphics in some games.
Recompiler (LLVM): Doesn't exist (yet).
Preferred SPU Threads Auto Some SPU stages are sensitive to race conditions and allowing a limited number at a time helps alleviate performance stalls. Setting this to a smaller value might improve performance and reduce stuttering in some games.
Leave this on auto if performance is negatively affected when setting a small value.
Firmware Settings Load liblv2.sprx only Load liblv2.sprx only: Closely emulates how games can load and unload system module files on a real PlayStation 3. Some games require this.
Automatically load required libraries: Automatically selects the LLE libraries to load. While this option works fine in most cases, liblv2 is the preferred option.
Manually load selected libraries: Allows the user to manually choose the LLE libraries to load. If unsure, don't use this option. Nothing will work if you use this.
Load automatic and manual selection: Automatically selects the LLE libraries to load and allows the user to choose additional libraries manually. If unsure, don't use this option.
Bind SPU Threads To Secondary Cores Off If your CPU has SMT (Hyper-Threading) SPU threads will run on these logical cores instead.
Usually faster on an i3, possibly slower or no difference on an i7 or Ryzen.
Lower SPU Thread Priority Off Runs SPU threads with lower priority than PPU threads.
Usually faster on an i3 or i5, possibly slower or no difference on an i7 or Ryzen.
Enable SPU Loop Detection On Try to detect loop conditions in SPU kernels and use them as scheduling hints.
Improves performance and reduces CPU usage. May cause severe audio stuttering in rare cases.
Hook Static Function Off Allows to hook some functions like 'memcpy' replacing them with high-level implementations.
May do nothing or break things. Experimental.

GPU configuration

Setting Option Description
Renderer OpenGL Vulkan is the fastest renderer. OpenGL is the most accurate renderer. If unsure, use Vulkan. Should you have any compatibility issues, fall back to OpenGL. DirectX 12 is deprecated and should never be used.
Graphics Device NA On multi GPU systems select which GPU to use in RPCS3 when using Vulkan or DirectX 12. This is not needed when using OpenGL.
Aspect Ratio Auto Leave this on 16:9 unless you have a 4:3 monitor. Auto also works well, especially if you use a resolution that is not 720p.
Framelimit Off Off is the best option as it performs faster. Using the frame limiter will add extra overhead and slow down the game. However, some games will crash if the framerate is too high. If that happens, set value to anything other than Off.
Anisotropic Filter Automatic Higher values increase sharpness of textures on sloped surfaces at the cost of GPU resources. Modern GPUs can handle this setting just fine even at 16x. Keep this on Automatic if you want to use the original setting used by a real PS3.
Anti-Aliasing NA Doesn't exist (yet).
Default Resolution 1280x720 This setting will be ignored if the Resolution Scale is set to anything other than 100%. Leave this on 1280x720, every PS3 game is compatible with this resolution. Only use 1920x1080 if the game supports it.
Resolution Scale 100% Scales the game's resolution by the given percentage. The base resolution is always 1280x720. Set this value to 100% if you want to use the normal Resolution options.
Resolution Scale Threshold 16 x 16 Only framebuffers greater than this size will be upscaled. Increasing this value might fix problems with missing graphics when upscaling, especially when Write Color Buffers is enabled. Do not touch this setting if you are unsure.
Write Color Buffer Off Enable this option if you get missing graphics or broken lighting ingame.
Might degrade performance and introduce stuttering in some cases.
Use GPU Texture Scaling On Small to significant performance boost in most games and rarely with side effects.
May cause texture corruption in rare cases.
Strict Rendering Mode Off Enforces strict compliance to the API specification. Might result in degraded performance in some games.
Can resolve rare cases of missing graphics and flickering. If unsure, don't use this option.
VSync Off By having this off you might obtain a higher frame rate at the cost of tearing artifacts in the game.
Stretch To Display Area Off Overrides the aspect ratio and stretches the image to the full display area.
Disable Vertex Cache Off Disables the vertex cache. Might resolve missing or flickering graphics output. May degrade performance.

Usage

This template must be present for all game pages irrespective of whether the .

Syntax

{{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
|bind spu threads to secondary cores       = On, Off
|bind spu threads to secondary cores 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                =