Progress Continues
We've already had 21453 updates since Dolphin 5.0. Keep up with Dolphin's continuing progress through the Dolphin Blog: August, September, and October 2023 Progress Report.
User-info.png The Dolphin Emulator Wiki needs your help!
Dolphin can play thousands of games, and changes are happening all the time. Help us keep up! Join in and help us make this the best resource for Dolphin.

Template:Config: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
m (Fixed category setting error, mah bad)
(add XAudio2 audio backend to deprecated)
(169 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<includeonly>{{#if:{{{dualcore|}}}
<includeonly>{{#if:
{{{idleskipping|}}}
    <!-- GENERAL -->
{{{framelimit|}}}
    {{{dualcore|}}}
{{{limitbyfps|}}}
    {{{speedlimit|}}}
{{{cpuengine|}}}
    {{{ntscj|}}}
{{{lockthreadstocore|}}}
    {{{panichandlers|}}}
{{{ntscj|}}}
    {{{skipbios|}}}
{{{panichandlers|}}}
    {{{cpuengine|}}}
{{{skipbios|}}}
    {{{cpuclock|}}}
    <!-- GRAPHICS -->
{{{gfxbackend|}}}
    {{{gfxbackend|}}}
{{{fullres|}}}
    {{{fullres|}}}
{{{aspectratio|}}}
    {{{aspectratio|}}}
{{{vsync|}}}
    {{{vsync|}}}
{{{startfull|}}}
    {{{startfull|}}}
{{{rendertomain|}}}
    {{{rendertomain|}}}
{{{internalres|}}}
    {{{shadercomp|}}}
{{{antialiasing|}}}
    {{{compilefirst|}}}
{{{anisotropic|}}}
    {{{internalres|}}}
{{{pixellighting|}}}
    {{{antialiasing|}}}
{{{forcefilter|}}}
    {{{anisotropic|}}}
{{{3dvision|}}}
    {{{efbscaledcopy|}}}
{{{cpuefbaccess|}}}
    {{{pixellighting|}}}
{{{formatchanges|}}}
    {{{forcefilter|}}}
{{{efbcopy|}}}
    {{{widescreenhack|}}}
{{{xfb|}}}
    {{{disablefog|}}}
{{{dlistcaching|}}}
    {{{arbmipmap|}}}
{{{disablelighting|}}}
    {{{skipcpuefbaccess|}}}
{{{disablefog|}}}
    {{{formatchanges|}}}
{{{pixeldepth|}}}
    {{{efb2texonly|}}}
{{{disablealpha|}}}
    {{{deferefb|}}}
{{{opencl|}}}
    {{{accuratetexturecache|}}}
{{{openmp|}}}
    {{{gputexdecode|}}}
{{{widescreenhack|}}}
    {{{xfb2texonly|}}}
{{{progressivescan|}}}
    {{{xfbimmediate|}}}
    {{{fastdepth|}}}
{{{dspengine|}}}
    {{{boundingbox|}}}
{{{dtkmusic|}}}
    {{{vertexrounding|}}}
{{{dsplleonthread|}}}
    {{{crop|}}}
{{{audiothrottle|}}}
    {{{progressivescan|}}}
{{{audiobackend|}}}
    <!-- AUDIO -->
{{{samplerate|}}}
    {{{dspengine|}}}
    {{{audiobackend|}}}
{{{screensaver|}}}
    <!-- WII -->
{{{pal60|}}}
    {{{pal60|}}}
{{{sdcard|}}}
    {{{screensaver|}}}
{{{usbkeyboard|}}}
    {{{sdcard|}}}
    {{{usbkeyboard|}}}
{{{hacks|}}}
    {{{systemlang|}}}
{{{patches|}}}
    <!-- WII REMOTE -->
{{{mmu|}}}
    {{{enablespeakerdata|}}}
{{{bat|}}}
    {{{wiimotemotor|}}}
{{{mmuhack|}}}
    <!-- GAME PROPERTIES -->
{{{vbeamhack|}}}
    {{{mmu|}}}
{{{fastdisc|}}}
    {{{fprf|}}}
{{{blockmerging|}}}
    {{{syncgputhread|}}}
{{{dsphle|}}}
    {{{fastdisc|}}}
{{{ztphack|}}}
    {{{patches|}}}|
{{{projectionhack|}}}|
    Only configuration options for the best compatibility where they deviate from defaults are listed.
Only configuration options for the best compatibility are listed. Please see the [[performance guide]] for an overview of performance related settings.
<!-- GENERAL -->{{#if:
 
    {{{dualcore|}}}
A full list of options is available at [[Template:Config/doc]]
    {{{speedlimit|}}}
<!-- GENERAL -->
    {{{ntscj|}}}
{{#if: {{{dualcore|}}}
    {{{panichandlers|}}}
{{{idleskipping|}}}
    {{{skipbios|}}}
{{{framelimit|}}}
    {{{cpuengine|}}}
{{{limitbyfps|}}}
    {{{cpuclock|}}}|
{{{cpuengine|}}}
    <h3> General </h3>
{{{lockthreadstocore|}}}
    {{{!}}class="wikitable" style="font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
{{{ntscj|}}}
    !Config!!Setting!!Notes
{{{panichandlers|}}}
    {{!}}-
{{{skipbios|}}}|
    {{#if:{{{dualcore|}}}|{{!}}[[Category:Enable Dual Core (Config Required)]]{{Hover|Creates two threads, one for graphics and one for CPU, allowing better use of more than one processor core (On, Off)|'''Enable Dual Core'''}}{{!!}}{{{dualcore|}}}{{!!}}{{{dualcorenotes|}}}}}
===General===
    {{!}}-
{{{!}}class="wikitable" style="font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
    {{#if:{{{speedlimit|}}}|{{!}}[[Category:Speed Limit (Config Required)]]{{Hover|Limits the speed of emulation (10-200% or Unlimited)|'''Speed Limit'''}}{{!!}}{{{speedlimit|}}}{{!!}}{{{speedlimitnotes|}}}}}
!Config!!Setting!!Notes
    {{!}}-
{{!}}-
    {{#if:{{{ntscj|}}}|{{!}}[[Category:Force Console as NTSC-J (Config Required)]]{{Hover|(On, Off)|'''Force Console as NTSC-J'''}}{{!!}}{{{ntscj|}}}{{!!}}{{{ntscjnotes|}}}}}
{{#if:{{{dualcore|}}}|{{!}}'''Enable Dual Core'''{{!!}}{{{dualcore|}}}{{!!}}{{{dualcorenotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{panichandlers|}}}|{{!}}[[Category:Use Panic Handlers (Config Required)]]{{Hover|Shows a pop-up when an error or a panic condition is encountered (On, Off)|'''Use Panic Handlers'''}}{{!!}}{{{panichandlers|}}}{{!!}}{{{panichandlersnotes|}}}}}
{{#if:{{{idleskipping|}}}|{{!}}'''Enable Idle Skipping'''{{!!}}{{{idleskipping|}}}{{!!}}{{{idleskippingnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{skipbios|}}}|{{!}}[[Category:Skip GC BIOS (Config Required)]]{{Hover|Skip loading of GameCube BIOS before booting the game when the IPL dumps are present on User\GC (On, Off)|'''Skip GC BIOS'''}}{{!!}}{{{skipbios|}}}{{!!}}{{{skipbiosnotes|}}}}}
{{#if:{{{framelimit|}}}|{{!}}'''Framelimit'''{{!!}}{{{framelimit|}}}{{!!}}{{{framelimitnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{cpuengine|}}}|{{!}}[[Category:CPU Emulator Engine (Config Required)]]{{Hover|Sets which CPU Emulator Engine should be used (Interpreter, Cached Interpreter, JIT)|'''CPU Emulator Engine'''}}{{!!}}{{{cpuengine|}}}{{!!}}{{{cpuenginenotes|}}}}}
{{#if:{{{limitbyfps|}}}|{{!}}'''Limit by FPS'''{{!!}}{{{limitbyfps|}}}{{!!}}{{{limitbyfpsnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{cpuclock|}}}|{{!}}[[Category:CPU Clock Override (Config Required)]]{{Hover|Sets the CPU clock speed (6-400%)|'''CPU Clock Override'''}}{{!!}}{{{cpuclock|}}}{{!!}}{{{cpuclocknotes|}}}}}
{{#if:{{{cpuengine|}}}|{{!}}'''CPU Emulator Engine'''{{!!}}{{{cpuengine|}}}{{!!}}{{{cpuenginenotes|}}}}}
    {{!}}-
{{!}}-
    {{!}}}
{{#if:{{{lockthreadstocore|}}}|{{!}}'''Lock Threads to Cores'''{{!!}}{{{lockthreadstocore|}}}{{!!}}{{{lockthreadstocorenotes|}}}}}
}}<!-- GRAPHICS -->{{#if:
{{!}}-
    {{{gfxbackend|}}}
{{#if:{{{ntscj|}}}|{{!}}'''Force Console as NTSC-J'''{{!!}}{{{ntscj|}}}{{!!}}{{{ntscjnotes|}}}}}
    {{{fullres|}}}
{{!}}-
    {{{aspectratio|}}}
{{#if:{{{panichandlers|}}}|{{!}}'''Use Panic Handlers'''{{!!}}{{{panichandlers|}}}{{!!}}{{{panichandlersnotes|}}}}}
    {{{vsync|}}}
{{!}}-
    {{{startfull|}}}
{{#if:{{{skipbios|}}}|{{!}}'''Skip GC BIOS'''{{!!}}{{{skipbios|}}}{{!!}}{{{skipbiosnotes|}}}}}
    {{{rendertomain|}}}
{{!}}-
    {{{shadercomp|}}}
{{!}}}
    {{{compilefirst|}}}
}}
    {{{internalres|}}}
<!-- GRAPHICS -->
    {{{antialiasing|}}}
{{#if: {{{gfxbackend|}}}
    {{{anisotropic|}}}
{{{fullres|}}}
    {{{efbscaledcopy|}}}
{{{aspectratio|}}}
    {{{pixellighting|}}}
{{{vsync|}}}
    {{{forcefilter|}}}
{{{startfull|}}}
    {{{widescreenhack|}}}
{{{rendertomain|}}}
    {{{disablefog|}}}
{{{internalres|}}}
    {{{arbmipmap|}}}
{{{antialiasing|}}}
    {{{skipcpuefbaccess|}}}
{{{anisotropic|}}}
    {{{formatchanges|}}}
{{{pixellighting|}}}
    {{{efb2texonly|}}}
{{{forcefilter|}}}
    {{{deferefb|}}}
{{{3dvision|}}}
    {{{accuratetexturecache|}}}
{{{cpuefbaccess|}}}
    {{{gputexdecode|}}}
{{{formatchanges|}}}
    {{{xfb2texonly|}}}
{{{efbcopy|}}}
    {{{xfbimmediate|}}}
{{{xfb|}}}
    {{{fastdepth|}}}
{{{dlistcaching|}}}
    {{{boundingbox|}}}
{{{disablelighting|}}}
    {{{vertexrounding|}}}
{{{disablefog|}}}
    {{{crop|}}}
{{{pixeldepth|}}}
    {{{progressivescan|}}}|
{{{disablealpha|}}}
    <h3> Graphics </h3>
{{{opencl|}}}
    {{{!}}class="wikitable" style="font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
{{{openmp|}}}
    !Config!!Setting!!Notes
{{{widescreenhack|}}}
    {{!}}-
{{{progressivescan|}}}|
    {{#if:{{{gfxbackend|}}}|{{!}}[[Category:Video Back End (Config Required)]]{{Hover|Selects which graphical API interface should be used for display rendering (OpenGL, Direct3D11, Direct3D12, Vulkan, Software)|'''Video Back End'''}}{{!!}}{{{gfxbackend|}}}{{!!}}{{{gfxbackendnotes|}}}}}
===Graphics===
    {{!}}-
{{{!}}class="wikitable" style="font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
    {{#if:{{{fullres|}}}|{{!}}[[Category:Fullscreen Resolution (Config Required)]]{{Hover|Selects what the monitor resolution should be set to for fullscreen mode.|'''Fullscreen Resolution'''}}{{!!}}{{{fullres|}}}{{!!}}{{{fullresnotes|}}}}}
!Config!!Setting!!Notes
    {{!}}-
{{!}}-
    {{#if:{{{aspectratio|}}}|{{!}}[[Category:Aspect Ratio (Config Required)]]{{Hover|Selects what aspect ratio the monitor should display the game in (Auto, Force 16:9, Force 4:3)|'''Aspect Ratio'''}}{{!!}}{{{aspectratio|}}}{{!!}}{{{aspectrationotes|}}}}}
{{#if:{{{gfxbackend|}}}|{{!}}'''Video Backend'''{{!!}}{{{gfxbackend|}}}{{!!}}{{{gfxbackendnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{vsync|}}}|{{!}}[[Category:V-Sync (Config Required)]]{{Hover|Synchronizes Dolphin's framerate with your monitor's refresh rate (On, Off)|'''V-Sync'''}}{{!!}}{{{vsync|}}}{{!!}}{{{vsyncnotes|}}}}}
{{#if:{{{fullres|}}}|{{!}}'''Fullscreen Resolution'''{{!!}}{{{fullres|}}}{{!!}}{{{fullresnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{startfull|}}}|{{!}}[[Category:Use Fullscreen (Config Required)]]{{Hover|Goes to fullscreen by default when a game is started (On, Off)|'''Use Fullscreen'''}}{{!!}}{{{startfull|}}}{{!!}}{{{startfullnotes|}}}}}
{{#if:{{{aspectratio|}}}|{{!}}'''Aspect Ratio'''{{!!}}{{{aspectratio|}}}{{!!}}{{{aspectrationotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{rendertomain|}}}|{{!}}[[Category:Render to Main Window (Config Required)]]{{Hover|Displays games in the main window instead of a separate one (On, Off)|'''Render to Main Window'''}}{{!!}}{{{rendertomain|}}}{{!!}}{{{rendertomainnotes|}}}}}
{{#if:{{{vsync|}}}|{{!}}'''V-Sync'''{{!!}}{{{vsync|}}}{{!!}}{{{vsyncnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{shadercomp|}}}|{{!}}[[Category:Shader Compilation (Config Required)]]{{Hover|Sets whether specialized shaders or ubershaders are used (Synchronous, Synchronous (Ubershaders), Asynchronous (Ubershaders), Asynchronous (Skip Drawing))|'''Shader Compilation'''}}{{!!}}{{{shadercomp|}}}{{!!}}{{{shadercompnotes|}}}}}
{{#if:{{{startfull|}}}|{{!}}'''Use Fullscreen'''{{!!}}{{{startfull|}}}{{!!}}{{{startfullnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{compilefirst|}}}|{{!}}[[Category:Compile Shaders Before Starting (Config Required)]]{{Hover|Waits for all shaders to finish compiling before starting a game (On, Off)|'''Compile Shaders Before Starting'''}}{{!!}}{{{compilefirst|}}}{{!!}}{{{compilefirstnotes|}}}}}
{{#if:{{{rendertomain|}}}|{{!}}'''Render to Main Window'''{{!!}}{{{rendertomain|}}}{{!!}}{{{rendertomainnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{internalres|}}}|{{!}}[[Category:Internal Resolution (Config Required)]]{{Hover|Sets the resolution the game will be rendered at behind-the-scenes (Window Size, Multiple of 640x528, 1x, 1.5x, 2x, 2.5x, 3x, 4x)|'''Internal Resolution'''}}{{!!}}{{{internalres|}}}{{!!}}{{{internalresnotes|}}}}}
{{#if:{{{internalres|}}}|{{!}}'''Internal Resolution'''{{!!}}{{{internalres|}}}{{!!}}{{{internalresnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{antialiasing|}}}|{{!}}[[Category:Anti-Aliasing (Config Required)]]{{Hover|Corrects aliasing along lines and edges (Many choices depending on Video Back End)|'''Anti-Aliasing'''}}{{!!}}{{{antialiasing|}}}{{!!}}{{{antialiasingnotes|}}}}}
{{#if:{{{antialiasing|}}}|{{!}}'''Anti-Aliasing'''{{!!}}{{{antialiasing|}}}{{!!}}{{{antialiasingnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{anisotropic|}}}|{{!}}[[Category:Anisotropic Filtering (Config Required)]]{{Hover|Reduces distortion when viewing textures at an angle (1x, 2x, 4x, 8x, 16x)|'''Anisotropic Filtering'''}}{{!!}}{{{anisotropic|}}}{{!!}}{{{anisotropicnotes|}}}}}
{{#if:{{{anisotropic|}}}|{{!}}'''Anisotropic Filtering'''{{!!}}{{{anisotropic|}}}{{!!}}{{{anisotropicnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{efbscaledcopy|}}}|{{!}}[[Category:Scaled EFB Copy (Config Required)]]{{Hover|Greatly increase the quality of textures generated using render-to-texture effects (On, Off)|'''Scaled EFB Copy'''}}{{!!}}{{{efbscaledcopy|}}}{{!!}}{{{efbscaledcopynotes|}}}}}
{{#if:{{{pixellighting|}}}|{{!}}'''Per-Pixel Lighting'''{{!!}}{{{pixellighting|}}}{{!!}}{{{pixellightingnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{pixellighting|}}}|{{!}}[[Category:Per-Pixel Lighting (Config Required)]]{{Hover|Calculate lighting of 3D graphics per-pixel rather than per-vertex (On, Off)|'''Per-Pixel Lighting'''}}{{!!}}{{{pixellighting|}}}{{!!}}{{{pixellightingnotes|}}}}}
{{#if:{{{forcefilter|}}}|{{!}}'''Force Texture Filtering'''{{!!}}{{{forcefilter|}}}{{!!}}{{{forcefilternotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{forcefilter|}}}|{{!}}[[Category:Force Texture Filtering (Config Required)]]{{Hover|Forces texture filtering even if the game specifically disables it (On, Off)|'''Force Texture Filtering'''|}}{{!!}}{{{forcefilter|}}}{{!!}}{{{forcefilternotes|}}}}}
{{#if:{{{3dvision|}}}|{{!}}'''3D Vision'''{{!!}}{{{3dvision|}}}{{!!}}{{{3dvisionnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{widescreenhack|}}}|{{!}}[[Category:Widescreen Hack (Config Required)]]{{Hover|Force GameCube games to output graphics for widescreen resolutions (On, Off)|'''Widescreen Hack'''}}{{!!}}{{{widescreenhack|}}}{{!!}}{{{widescreenhacknotes|}}}}}
{{#if:{{{cpuefbaccess|}}}|{{!}}'''Skip EFB Access from CPU'''{{!!}}{{{cpuefbaccess|}}}{{!!}}{{{cpuefbaccessnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{disablefog|}}}|{{!}}[[Category:Disable Fog (Config Required)]]{{Hover|Disables the fog used in some games to hide far-away objects (On, Off)|'''Disable Fog'''}}{{!!}}{{{disablefog|}}}{{!!}}{{{disablefognotes|}}}}}
{{#if:{{{formatchanges|}}}|{{!}}'''Ignore Format Changes'''{{!!}}{{{formatchanges|}}}{{!!}}{{{formatchangesnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{arbmipmap|}}}|{{!}}[[Category:Arbitrary Mipmap Detection (Config Required)]]{{Hover|Enables detection of arbitrary mipmaps, which some games use for special distance-based effects (On, Off)|'''Arbitrary Mipmap Detection'''}}{{!!}}{{{arbmipmap|}}}{{!!}}{{{arbmipmapnotes|}}}}}
{{#if:{{{efbcopy|}}}|{{!}}'''EFB Copies'''{{!!}}{{{efbcopy|}}}{{!!}}{{{efbcopynotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{skipcpuefbaccess|}}}|{{!}}[[Category:Skip EFB Access from CPU (Config Required)]]{{Hover|Prevents the CPU from accessing the External Frame Buffer (On, Off)|'''Skip EFB Access from CPU'''}}{{!!}}{{{skipcpuefbaccess|}}}{{!!}}{{{skipcpuefbaccessnotes|}}}}}
{{#if:{{{xfb|}}}|{{!}}'''External Frame Buffer'''{{!!}}{{{xfb|}}}{{!!}}{{{xfbnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{formatchanges|}}}|{{!}}[[Category:Ignore Format Changes (Config Required)]]{{Hover|Ignore any changes to the External Frame Buffer format (On, Off)|'''Ignore Format Changes'''}}{{!!}}{{{formatchanges|}}}{{!!}}{{{formatchangesnotes|}}}}}
{{#if:{{{dlistcaching|}}}|{{!}}'''Cache Display Lists'''{{!!}}{{{dlistcaching|}}}{{!!}}{{{dlistcachingnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{efb2texonly|}}}|{{!}}[[Category:Store EFB Copies to Texture Only (Config Required)]]{{Hover|Stores EFB Copies exclusively on the GPU, bypassing system memory (On, Off)|'''Store EFB Copies to Texture Only'''}}{{!!}}{{{efb2texonly|}}}{{!!}}{{{efb2texonlynotes|}}}}}
{{#if:{{{disablelighting|}}}|{{!}}'''Disable Lighting'''{{!!}}{{{disablelighting|}}}{{!!}}{{{disablelightingnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{deferefb|}}}|{{!}}[[Category:Defer EFB Copies to RAM (Config Required)]]{{Hover|Wait to store EFB Copies providing performance improvements (On, Off)|'''Defer EFB Copies to RAM'''}}{{!!}}{{{deferefb|}}}{{!!}}{{{deferefbnotes|}}}}}
{{#if:{{{disablefog|}}}|{{!}}'''Disable Fog'''{{!!}}{{{disablefog|}}}{{!!}}{{{disablefognotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{accuratetexturecache|}}}|{{!}}[[Category:Texture Cache Accuracy (Config Required)]]{{Hover|(Position 1 (Safe), Position 2 (Medium), Position 3 (Fast))|'''Texture Cache Accuracy'''}}{{!!}}{{{accuratetexturecache|}}}{{!!}}{{{accuratetexturecachenotes|}}}}}
{{#if:{{{pixeldepth|}}}|{{!}}'''Disable Per-Pixel Depth'''{{!!}}{{{pixeldepth|}}}{{!!}}{{{pixeldepthnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{gputexdecode|}}}|{{!}}[[Category:GPU Texture Decoding (Config Required)]]{{Hover|Enables texture decoding using the GPU instead of the CPU (On, Off)|'''GPU Texture Decoding'''}}{{!!}}{{{gputexdecode|}}}{{!!}}{{{gputexdecodenotes|}}}}}
{{#if:{{{disablealpha|}}}|{{!}}'''Skip Dest. Alpha Pass'''{{!!}}{{{disablealpha|}}}{{!!}}{{{disablealphanotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{xfb2texonly|}}}|{{!}}[[Category:Store XFB Copies to Texture Only (Config Required)]]{{Hover|Stores XFB Copies exclusively on the GPU, bypassing system memory (On, Off)|'''Store XFB Copies to Texture Only'''}}{{!!}}{{{xfb2texonly|}}}{{!!}}{{{xfb2texonlynotes|}}}}}
{{#if:{{{opencl|}}}|{{!}}'''OpenCL Texture Decoder'''{{!!}}{{{opencl|}}}{{!!}}{{{openclnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{xfbimmediate|}}}|{{!}}[[Category:Immediately Present XFB (Config Required)]]{{Hover|Displays the XFB Copies as soon as they are created, without waiting for scanout (On, Off)|'''Immediately Present XFB'''}}{{!!}}{{{xfbimmediate|}}}{{!!}}{{{xfbimmediatenotes|}}}}}
{{#if:{{{openmp|}}}|{{!}}'''OpenMP Texture Decoder'''{{!!}}{{{openmp|}}}{{!!}}{{{openmpnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{fastdepth|}}}|{{!}}[[Category:Fast Depth Calculation (Config Required)]]{{Hover|Uses a less accurate method of depth calculation for a speedup (On, Off)|'''Fast Depth Calculation'''}}{{!!}}{{{fastdepth|}}}{{!!}}{{{fastdepthnotes|}}}}}
{{#if:{{{widescreenhack|}}}|{{!}}'''Widescreen Hack'''{{!!}}{{{widescreenhack|}}}{{!!}}{{{widescreenhacknotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{boundingbox|}}}|{{!}}[[Category:Disable Bounding Box (Config Required)]]{{Hover|Disables a niche GC/Wii GPU feature for a speedup. A very small number of games will break with this. (On/Off)|'''Disable Bounding Box'''}}{{!!}}{{{boundingbox|}}}{{!!}}{{{boundingboxnotes|}}}}}
{{#if:{{{progressivescan|}}}|{{!}}'''Enable Progressive Scan'''{{!!}}{{{progressivescan|}}}{{!!}}{{{progressivescannotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{vertexrounding|}}}|{{!}}[[Category:Vertex Rounding Hack (Config Required)]]{{Hover|Round 2d vertices to whole pixels (On, Off)|'''Vertex Rounding Hack'''}}{{!!}}{{{vertexrounding|}}}{{!!}}{{{vertexroundingnotes|}}}}}
{{!}}}
    {{!}}-
}}
    {{#if:{{{crop|}}}|{{!}}[[Category:Crop (Config Required)]]{{Hover|Crop the picture from it's native aspect ratio to 4:3 or 16:9. (On, Off)|'''Crop'''}}{{!!}}{{{crop|}}}{{!!}}{{{cropnotes|}}}}}
<!-- AUDIO -->
    {{!}}-
{{#if: {{{dspengine|}}}
    {{#if:{{{progressivescan|}}}|{{!}}[[Category:Enable Progressive Scan (Config Required)]]{{Hover|Enables progressive scan if your game supports it (On, Off)|'''Enable Progressive Scan'''}}{{!!}}{{{progressivescan|}}}{{!!}}{{{progressivescannotes|}}}}}
{{{dtkmusic|}}}
    {{!}}-
{{{dsplleonthread|}}}
    {{!}}}
{{{audiothrottle|}}}
}}<!-- AUDIO -->{{#if:
{{{audiobackend|}}}
    {{{dspengine|}}}
{{{samplerate|}}}|
    {{{audiobackend|}}}|
===Audio===
    <h3> Audio </h3>
{{{!}}class="wikitable" style="font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
    {{{!}}class="wikitable" style="font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
!Config!!Setting!!Notes
    !Config!!Setting!!Notes
{{!}}-
    {{!}}-
{{#if:{{{dspengine|}}}|{{!}}'''DSP Emulator Engine'''{{!!}}{{{dspengine|}}}{{!!}}{{{dspenginenotes|}}}}}
    {{#if:{{{dspengine|}}}|{{!}}[[Category:DSP Emulator Engine (Config Required)]]{{Hover|Use High-Level audio Emulation (HLE) or Low-Level audio Emulation (LLE); LLE audio emulation is more accurate, but uses more CPU power|'''DSP Emulator Engine'''}}{{!!}}{{{dspengine|}}}{{!!}}{{{dspenginenotes|}}}}}
{{!}}-
    {{!}}-
{{#if:{{{dtkmusic|}}}|{{!}}'''Enable DTK Music'''{{!!}}{{{dtkmusic|}}}{{!!}}{{{dtkmusicnotes|}}}}}
    {{#if:{{{audiobackend|}}}|{{!}}[[Category:Audio Back End (Config Required)]]{{Hover|Select the audio back-end API library (No Audio Output, Cubeb, OpenAL)|'''Audio Back End'''}}{{!!}}{{{audiobackend|}}}{{!!}}{{{audiobackendnotes|}}}}}
{{!}}-
    {{!}}-
{{#if:{{{dsplleonthread|}}}|{{!}}'''DSP LLE on thread'''{{!!}}{{{dsplleonthread|}}}{{!!}}{{{dsplleonthreadnotes|}}}}}
    {{!}}}
{{!}}-
}}<!-- WII -->{{#if:
{{#if:{{{audiothrottle|}}}|{{!}}'''Enable Audio Throttle'''{{!!}}{{{audiothrottle|}}}{{!!}}{{{audiothrottlenotes|}}}}}
    {{{pal60|}}}
{{!}}-
    {{{screensaver|}}}
{{#if:{{{audiobackend|}}}|{{!}}'''Audio Backend'''{{!!}}{{{audiobackend|}}}{{!!}}{{{audiobackendnotes|}}}}}
    {{{sdcard|}}}
{{!}}-
    {{{usbkeyboard|}}}
{{#if:{{{samplerate|}}}|{{!}}'''Sample Rate'''{{!!}}{{{samplerate|}}}{{!!}}{{{samplerate notes|}}}}}
    {{{systemlang|}}}|
{{!}}-
    <h3> Wii </h3>
{{!}}}
    {{{!}}class="wikitable" style="font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
}}
    !Config!!Setting!!Notes
<!-- WII -->
    {{!}}-
{{#if: {{{screensaver|}}}
    {{#if:{{{pal60|}}}|{{!}}[[Category:Use PAL60 Mode (EuRGB60) (Config Required)]]{{Hover|(On, Off)|'''Use PAL60 Mode (EuRGB60)'''}}{{!!}}{{{pal60|}}}{{!!}}{{{pal60notes|}}}}}
{{{pal60|}}}
    {{!}}-
{{{sdcard|}}}
    {{#if:{{{screensaver|}}}|{{!}}[[Category:Enable Screen Saver (Config Required)]]{{Hover|(On, Off)|'''Enable Screen Saver'''}}{{!!}}{{{screensaver|}}}{{!!}}{{{screensavernotes|}}}}}
{{{usbkeyboard|}}}|
    {{!}}-
===Wii===
    {{#if:{{{sdcard|}}}|{{!}}[[Category:Insert SD Card (Config Required)]]{{Hover|(On, Off)|'''Insert SD Card'''}}{{!!}}{{{sdcard|}}}{{!!}}{{{sdcardnotes|}}}}}
{{{!}}class="wikitable" style="font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
    {{!}}-
!Config!!Setting!!Notes
    {{#if:{{{usbkeyboard|}}}|{{!}}[[Category:Connect USB Keyboard (Config Required)]]{{Hover|(On, Off)|'''Connect USB Keyboard'''}}{{!!}}{{{usbkeyboard|}}}{{!!}}{{{usbkeyboardnotes|}}}}}
{{!}}-
    {{!}}-
{{#if:{{{screensaver|}}}|{{!}}'''Enable Screen Saver (burn-in reduction)'''{{!!}}{{{screensaver|}}}{{!!}}{{{screensavernotes|}}}}}
    {{#if:{{{systemlang|}}}|{{!}}[[Category:System Language (Config Required)]]{{Hover|(Japanese, English, German, French, Spanish, Italian, Dutch, Simplified Chinese, Traditional Chinese, Korean)|'''System Language'''}}{{!!}}{{{systemlang|}}}{{!!}}{{{systemlangnotes|}}}}}
{{!}}-
    {{!}}-
{{#if:{{{pal60|}}}|{{!}}'''Use EuRGB60 Mode (PAL60)'''{{!!}}{{{pal60|}}}{{!!}}{{{pal60notes|}}}}}
    {{!}}}
{{!}}-
}}<!-- WII REMOTE -->{{#if:
{{#if:{{{sdcard|}}}|{{!}}'''Insert SD Card'''{{!!}}{{{sdcard|}}}{{!!}}{{{sdcardnotes|}}}}}
    {{{enablespeakerdata|}}}
{{!}}-
    {{{wiimotemotor|}}}|
{{#if:{{{usbkeyboard|}}}|{{!}}'''Connect USB Keyboard'''{{!!}}{{{usbkeyboard|}}}{{!!}}{{{usbkeyboardnotes|}}}}}
    <h3> Wii Remote </h3>
{{!}}-
    {{{!}}class="wikitable" style="font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
{{!}}}
    !Config!!Setting!!Notes
}}
    {{!}}-
<!-- GAME PROPERTIES -->
    {{#if:{{{enablespeakerdata|}}}|{{!}}[[Category:Enable Speaker Data (Config Required)]]{{Hover|Controls if sounds come from the Wii Remote speaker of Real Wii Remotes (On, Off)|'''Enable Speaker Data'''}}{{!!}}{{{enablespeakerdata|}}}{{!!}}{{{enablespeakerdatanotes|}}}}}
{{#if: {{{hacks|}}}
    {{!}}-
{{{patches|}}}
    {{#if:{{{wiimotemotor|}}}|{{!}}[[Category:Wii Remote Motor (Config Required)]]{{Hover|(On, Off)|'''Wii Remote Motor'''}}{{!!}}{{{wiimotemotor|}}}{{!!}}{{{wiimotemotornotes|}}}}}
{{{mmu|}}}
    {{!}}-
{{{bat|}}}
    {{!}}}
{{{mmuhack|}}}
}}<!-- GAME PROPERTIES -->{{#if:
{{{vbeamhack|}}}
    {{{mmu|}}}
{{{fastdisc|}}}
    {{{fprf|}}}
{{{blockmerging|}}}
    {{{syncgputhread|}}}
{{{dsphle|}}}
    {{{fastdisc|}}}
{{{ztphack|}}}
    {{{patches|}}}|
{{{projectionhack|}}}|
    <h3> Game Properties </h3>
===Game Properties===
    {{{!}}class="wikitable" style="font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
{{{!}}class="wikitable" style="font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
    !Config!!Setting!!Notes
!Config!!Setting!!Notes
    {{!}}-
{{!}}-
    {{#if:{{{mmu|}}}|{{!}}[[Category:Enable MMU (Config Required)]]{{Hover|Enable Memory Management Unit (On, Off)|'''Enable MMU'''}}{{!!}}{{{mmu|}}}{{!!}}{{{mmunotes|}}}}}
{{#if:{{{hacks|}}}|{{!}}'''Hacks'''{{!!}}{{{hacks|}}}{{!!}}{{{hacksnotes|}}}}}
    {{!}}-
{{!}}-
    {{#if:{{{fprf|}}}|{{!}}[[Category:Enable FPRF (Config Required)]]{{Hover|Floating Point Result Flag support (On, Off)|'''Enable FPRF'''}}{{!!}}{{{fprf|}}}{{!!}}{{{fprfnotes|}}}}}
{{#if:{{{patches|}}}|{{!}}'''Patches'''{{!!}}{{{patches|}}}{{!!}}{{{patchesnotes|}}}}}
    {{!}}-
{{!}}- {{#if:{{{mmu|}}}|{{!}}'''Enable MMU'''{{!!}}{{{mmu|}}}{{!!}}{{{mmunotes|}}}}}
    {{#if:{{{syncgputhread|}}}|{{!}}[[Category:Synchronize GPU Thread (Config Required)]]{{Hover|Synchronizes CPU and GPU threads, allowing dual core to work in games where it has problems otherwise (On, Off)|'''Synchronize GPU Thread'''}}{{!!}}{{{syncgputhread|}}}{{!!}}{{{syncgputhreadnotes|}}}}}
{{!}}-
    {{!}}-
{{#if:{{{bat|}}}|{{!}}'''Enable BAT'''{{!!}}{{{bat|}}}{{!!}}{{{batnotes|}}}}}
    {{#if:{{{fastdisc|}}}|{{!}}[[Category:Speed up Disc Transfer Rate (Config Required)]]{{Hover|Enables fast disc access (On, Off)|'''Speed up Disc Transfer Rate'''}}{{!!}}{{{fastdisc|}}}{{!!}}{{{fastdiscnotes|}}}}}
{{!}}-
    {{!}}-
{{#if:{{{mmuhack|}}}|{{!}}'''MMU Speed Hack'''{{!!}}{{{mmuhack|}}}{{!!}}{{{mmuhacknotes|}}}}}
    {{#if:{{{patches|}}}|{{!}}[[Category:Patches (Config Required)]]'''Patches'''{{!!}}{{{patches|}}}{{!!}}{{{patchesnotes|}}}}}
{{!}}-
    {{!}}-
{{#if:{{{vbeamhack|}}}|{{!}}'''Accurate VBeam emulation'''{{!!}}{{{vbeamhack|}}}{{!!}}{{{vbeamhacknotes|}}}}}
    {{!}}}
{{!}}-
}}|{{#ifeq:{{ratings/{{PAGENAME}}}}|5|This {{#ifpageincat:Wii Channels|channel|title}} does not need non-default settings to run properly.|No configuration changes are known to affect compatibility for this {{#ifpageincat:Wii Channels|channel|title}}.}}}}{{#if:
{{#if:{{{fastdisc|}}}|{{!}}'''Speed up Disc Transfer Rate'''{{!!}}{{{fastdisc|}}}{{!!}}{{{fastdiscnotes|}}}}}
    {{{graphicsplugin|}}}
{{!}}-
    {{{graphicspluginnotes|}}}
{{#if:{{{blockmerging|}}}|{{!}}'''Enable Block Merging'''{{!!}}{{{blockmerging|}}}{{!!}}{{{blockmergingnotes|}}}}}
    {{{hletheipl|}}}
{{!}}-
    {{{hletheiplnotes|}}}
{{#if:{{{dsphle|}}}|{{!}}'''DSP HLE emulation'''{{!!}}{{{dsphle|}}}{{!!}}{{{dsphlenotes|}}}}}
    {{{realxfb|}}}
{{!}}-
    {{{realxfbnotes|}}}
{{#if:{{{ztphack|}}}|{{!}}'''ZTP hack'''{{!!}}{{{ztphack|}}}{{!!}}{{{ztphacknotes|}}}}}
    {{{recompiler|}}}
{{!}}-
    {{{recompilernotes|}}}
{{#if:{{{projectionhack|}}}|{{!}}'''Custom Projection Hack'''{{!!}}{{{projectionhack|}}}{{!!}}{{{projectionhacknotes|}}}}}
    {{{safetexturecache|}}}
{{!}}-
    {{{safetexturecachenotes|}}}
{{!}}}
    {{{winsize|}}}
}}|This {{#if:{{{type|}}}|{{{type|}}}|game}} doesn't need specific settings to run properly. If you want to get an overview about settings related to performance, please see the [[performance guide]].
    {{{winsizenotes|}}}
 
    {{{dspplugin|}}}
A full list of options is available at [[Template:Config/doc]]}}
    {{{dsppluginnotes|}}}
 
    {{{panichandler|}}}
{{#if: {{{graphicsplugin|}}}
    {{{panichandlernotes|}}}
{{{graphicspluginnotes|}}}
    {{{nativemipmaps|}}}
{{{hletheipl|}}}
    {{{nativemipmapsnotes|}}}
{{{hletheiplnotes|}}}
    {{{fpsforlimit|}}}
{{{realxfb|}}}
    {{{fpsforlimitnotes|}}}
{{{realxfbnotes|}}}
    {{{cpuefbaccess|}}}
{{{recompiler|}}}
    {{{cpuefbaccessnotes|}}}
{{{recompilernotes|}}}
    {{{hacks|}}}
{{{safetexturecache|}}}
    {{{hacksnotes|}}}
{{{safetexturecachenotes|}}}
    {{{dsphle|}}}
{{{winsize|}}}
    {{{dsphlenotes|}}}
{{{winsizenotes|}}}
    {{{audiothrottle|}}}
{{{dspplugin|}}}
    {{{audiothrottlenotes|}}}
{{{dsppluginnotes|}}}
    {{{dtkmusic|}}}
{{{panichandler|}}}
    {{{dtkmusicnotes|}}}
{{{panichandlernotes|}}}
    <!-- Since 3.0-710 -->
{{{nativemipmaps|}}}
    {{{fastmipmaps|}}}
{{{nativemipmapsnotes|}}}
    {{{fastmipmapsnotes|}}}
{{{fpsforlimit|}}}
    {{{disablelighting|}}}
{{{fpsforlimitnotes|}}}|
    {{{disablelightingnotes|}}}
{{{efbscaledcopy|}}}
    <!-- Since 3.0-918 -->
{{{efbscaledcopynotes|}}}
    {{{lockthreadstocore|}}}
{{{accuratetexturecache|}}}
    {{{lockthreadstocorenotes|}}}
{{{accuratetexturecachenotes|}}}
    <!-- Since 3.5-146 -->
{{{fastmipmaps|}}}
    {{{pixeldepth|}}}
{{{fastmipmapsnotes|}}}
    {{{pixeldepthnotes|}}}
|[[Category:Pages with deprecated config template parameters]]}}
    <!-- Since 3.5-367 -->
</includeonly>
    {{{altwiimotetiming|}}}
<noinclude>
    {{{altwiimotetimingnotes|}}}
{{documentation}}
    <!-- Since 4.0-155 -->
</noinclude>
    {{{3dvision|}}}
    {{{3dvisionnotes|}}}
    <!-- Since 4.0-520 -->
    {{{opencl|}}}
    {{{openclnotes|}}}
    <!-- Since 4.0-615 -->
    {{{hackedbuffer|}}}
    {{{hackedbuffernotes|}}}
    <!-- Since 4.0-647 -->
    {{{ztphack|}}}
    {{{ztphacknotes|}}}
    <!-- Since 4.0-758 -->
    {{{dlistcaching|}}}
    {{{dlistcachingnotes|}}}
    <!-- Since 4.0-2356 -->
    {{{projectionhack|}}}
    {{{projectionhacknotes|}}}
    <!-- Since 4.0-3631 -->
    {{{mmuhack|}}}
    {{{mmuhacknotes|}}}
    <!-- Since 4.0-4087 -->
    {{{openmp|}}}
    {{{openmpnotes|}}}
    <!-- Since 4.0-4488 -->
    {{{dsponthread|}}}
    {{{dsponthreadnotes|}}}
    {{{dsplleonthread|}}}
    {{{dsplleonthreadnotes|}}}
    <!-- Since 4.0-5432 -->
    {{{vbeamhack|}}}
    {{{vbeamhacknotes|}}}
    <!-- Since 4.0-5496 -->
    {{{bat|}}}
    {{{batnotes|}}}
    <!-- Since 4.0-5656 -->
    {{{efbcopy|}}}
    {{{efbcopynotes|}}}
    {{{efbcopycache|}}}
    {{{efbcopycachenotes|}}}
    <!-- Since 4.0-7666 -->
    {{{disablealpha|}}}
    {{{disablealphanotes|}}}
    <!-- Since 4.0-??? -->
    {{{limitbyfps|}}}
    {{{limitbyfpsnotes|}}}
    {{{samplerate|}}}
    {{{sampleratenotes|}}}
    {{{blockmerging|}}}
    {{{blockmergingnotes|}}}
    <!-- Since 5.0-??? -->
    {{{idleskipping|}}}
    {{{idleskippingnotes|}}}
    {{{framelimit|}}}
    {{{framelimitnotes|}}}
    {{#regex:{{{cpuengine}}}|/.*[iI][lL].*/}}
    {{{ubershaders|}}}
    {{{ubershadersnotes|}}}
    <!-- Since 5.0-5874 -->
    {{{xfb|}}}
    {{{xfbnotes|}}}
    <!-- Since 5.0-10950 -->
    {{#regex:{{{audiobackend}}}|/XAudio2/}}
    |[[Category:Pages with deprecated config template parameters]]}}</includeonly><noinclude>{{documentation}}</noinclude>

Revision as of 08:34, 19 November 2019

[edit] [purge] Template documentation

This template outputs a standardized set of configuration information.

Example

{{Config
|dualcore               = Off
|dualcorenotes          = Show File Select menus properly
}}

Produces

Only configuration options for the best compatibility where they deviate from defaults are listed.

General

Config Setting Notes
Enable Dual Core Off Show File Select menus properly

Parameters

The following lists a complete set of current config template settings: 

== Configuration ==
{{Config
<!-- General -->
|dualcore                   =
|dualcorenotes              =
|speedlimit                 =
|speedlimitnotes            =
|ntscj                      =
|ntscjnotes                 =
|panichandlers              =
|panichandlersnotes         =
|skipbios                   =
|skipbiosnotes              =
|cpuengine                  =
|cpuenginenotes             =
|cpuclock                   =
|cpuclocknotes              =

<!-- Graphics -->
|gfxbackend                 =
|gfxbackendnotes            =
|fullres                    =
|fullresnotes               =
|aspectratio                =
|aspectrationotes           =
|vsync                      =
|vsyncnotes                 =
|startfull                  =
|startfullnotes             =
|rendertomain               =
|rendertomainnotes          =
|shadercomp                 =
|shadercompnotes            =
|compilefirst               =
|compilefirstnotes          =
|internalres                =
|internalresnotes           =
|antialiasing               =
|antialiasingnotes          =
|efbscaledcopy              =
|efbscaledcopynotes         =
|pixellighting              =
|pixellightingnotes         =
|forcetexturefiltering      =
|forcetexturefilteringnotes =
|widescreenhack             =
|widescreenhacknotes        =
|disablefog                 =
|disablefognotes            =
|force24bit                 =
|force24bitnotes            =
|arbmipmap                  =
|arbmipmapnotes             =
|skipcpuefbaccess           =
|skipcpuefbaccessnotes      =
|formatchanges              =
|formatchangesnotes         =
|efb2texonly                =
|efb2texonlynotes           =
|deferefb                   =
|deferefbnotes              =
|accuratetexturecache       =
|accuratetexturecachenotes  =
|gputexdecode               =
|gputexdecodenotes          =
|xfb2texonly                =
|xfb2texonlynotes           =
|xfbimmediate               =
|xfbimmediatenotes          =
|fastdepth                  =
|fastdepthnotes             =
|boundingbox                =
|boundingboxnotes           =
|vertexrounding             =
|vertexroundingnotes        =
|crop                       =
|cropnotes                  =
|progressivescan            =
|progressivescannotes       =
|manualtexturesampling      =
|manualtexturesamplingnotes =

<!-- Audio -->
|dspengine                  =
|dspenginenotes             =
|audiobackend               =
|audiobackendnotes          =

<!-- Wii -->
|pal60                      =
|pal60notes                 =
|screensaver                =
|screensavernotes           =
|sdcard                     =
|sdcardnotes                =
|usbkeyboard                =
|usbkeyboardnotes           =
|systemlang                 =
|systemlangnotes            =

<!-- Wiimote -->
|enablespeakerdata          =
|enablespeakerdatanotes     =
|wiimotemotor               =
|wiimotemotornotes          =

<!-- Game Properties -->
|mmu                        =
|mmunotes                   =
|fprf                       =
|fprfnotes                  =
|syncgputhread              =
|syncgputhreadnotes         =
|fastdisc                   =
|fastdiscnotes              =
|patches                    =
|patchesnotes               =
}}
Retrieved from "https://wiki.dolphin-emu.org/index.php?title=Template:Config&oldid=169892"