Template:Config: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
mNo edit summary
(Moved 3.0 variables to their own table, deprecated a few variables, added hover text to (almost) all terms. Mega <high-fives> to Kolano for the teamwork.)
Line 1: Line 1:
<includeonly>{{#if:{{{dualcore|}}}
<includeonly>{{#if:{{{dualcore|}}}
<!-- GENERAL -->
{{{idleskipping|}}}
{{{idleskipping|}}}
{{{framelimit|}}}
{{{framelimit|}}}
Line 8: Line 9:
{{{panichandlers|}}}
{{{panichandlers|}}}
{{{skipbios|}}}
{{{skipbios|}}}
<!-- GRAPHICS -->
{{{gfxbackend|}}}
{{{gfxbackend|}}}
{{{fullres|}}}
{{{fullres|}}}
Line 20: Line 22:
{{{forcefilter|}}}
{{{forcefilter|}}}
{{{3dvision|}}}
{{{3dvision|}}}
{{{cpuefbaccess|}}}
{{{skipcpuefbaccess|}}}
{{{formatchanges|}}}
{{{formatchanges|}}}
{{{efbcopy|}}}
{{{efbcopy|}}}
Line 33: Line 35:
{{{widescreenhack|}}}
{{{widescreenhack|}}}
{{{progressivescan|}}}
{{{progressivescan|}}}
<!-- AUDIO -->
{{{dspengine|}}}
{{{dspengine|}}}
{{{dtkmusic|}}}
{{{dtkmusic|}}}
Line 39: Line 42:
{{{audiobackend|}}}
{{{audiobackend|}}}
{{{samplerate|}}}
{{{samplerate|}}}
<!-- WII -->
{{{screensaver|}}}
{{{screensaver|}}}
{{{pal60|}}}
{{{pal60|}}}
{{{sdcard|}}}
{{{sdcard|}}}
{{{usbkeyboard|}}}
{{{usbkeyboard|}}}
{{{hacks|}}}
<!-- GAME PROPERTIES -->
{{{patches|}}}
{{{patches|}}}
{{{mmu|}}}
{{{mmu|}}}
Line 51: Line 55:
{{{fastdisc|}}}
{{{fastdisc|}}}
{{{blockmerging|}}}
{{{blockmerging|}}}
{{{dsphle|}}}
{{{ztphack|}}}
{{{ztphack|}}}
{{{projectionhack|}}}|
{{{projectionhack|}}}
Only configuration options for the best compatibility are listed. Please see the [[performance guide]] for an overview of performance related settings.
<!-- 3.0-ONLY CONFIG -->
{{{efbscaledcopy|}}}
{{{efbscaledcopynotes|}}}
{{{accuratetexturecache|}}}
{{{accuratetexturecachenotes|}}}
{{{fastmipmaps|}}}
{{{fastmipmapsnotes|}}}|
Only configuration options for the best compatibility are listed. Please see the [[performance guide]] for an overview of performance related settings. A full list of options is available at [[Template:Config/doc]]
<!-- GENERAL -->
<!-- GENERAL -->
{{#if: {{{dualcore|}}}
{{#if: {{{dualcore|}}}
Line 69: Line 79:
!Config!!Setting!!Notes
!Config!!Setting!!Notes
{{!}}-
{{!}}-
{{#if:{{{dualcore|}}}|{{!}}'''Enable Dual Core'''{{!!}}{{{dualcore|}}}{{!!}}{{{dualcorenotes|}}}}}
{{#if:{{{dualcore|}}}|{{!}}{{Hover|Creates two threads, one for graphics and one for CPU, allowing better use of more than one processor core (On or Off)|'''Enable Dual Core'''}}{{!!}}{{{dualcore|}}}{{!!}}{{{dualcorenotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{idleskipping|}}}|{{!}}'''Enable Idle Skipping'''{{!!}}{{{idleskipping|}}}{{!!}}{{{idleskippingnotes|}}}}}
{{#if:{{{idleskipping|}}}|{{!}}{{Hover|(On, Off)|'''Enable Idle Skipping'''}}{{!!}}{{{idleskipping|}}}{{!!}}{{{idleskippingnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{framelimit|}}}|{{!}}'''Framelimit'''{{!!}}{{{framelimit|}}}{{!!}}{{{framelimitnotes|}}}}}
{{#if:{{{framelimit|}}}|{{!}}{{Hover|Limits the number of frames per second displayed by Dolphin (Off, Auto, or 10-120 fps)|'''Framelimit'''}}{{!!}}{{{framelimit|}}}{{!!}}{{{framelimitnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{limitbyfps|}}}|{{!}}'''Limit by FPS'''{{!!}}{{{limitbyfps|}}}{{!!}}{{{limitbyfpsnotes|}}}}}
{{#if:{{{limitbyfps|}}}|{{!}}{{Hover|Limit by FPS instead of by VPS (On, Off)|'''Limit by FPS'''}}{{!!}}{{{limitbyfps|}}}{{!!}}{{{limitbyfpsnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{cpuengine|}}}|{{!}}'''CPU Emulator Engine'''{{!!}}{{{cpuengine|}}}{{!!}}{{{cpuenginenotes|}}}}}
{{#if:{{{cpuengine|}}}|{{!}}{{Hover|Sets which CPU Emulator Engine should be used (Interpreter, JIT, JITIL)|'''CPU Emulator Engine'''}}{{!!}}{{{cpuengine|}}}{{!!}}{{{cpuenginenotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{lockthreadstocore|}}}|{{!}}'''Lock Threads to Cores'''{{!!}}{{{lockthreadstocore|}}}{{!!}}{{{lockthreadstocorenotes|}}}}}
{{#if:{{{lockthreadstocore|}}}|{{!}}{{Hover|Forces Dolphin threads to stay on their individual cores (On, Off)|'''Lock Threads to Cores'''}}{{!!}}{{{lockthreadstocore|}}}{{!!}}{{{lockthreadstocorenotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{ntscj|}}}|{{!}}'''Force Console as NTSC-J'''{{!!}}{{{ntscj|}}}{{!!}}{{{ntscjnotes|}}}}}
{{#if:{{{ntscj|}}}|{{!}}{{Hover|(On, Off)|'''Force Console as NTSC-J'''}}{{!!}}{{{ntscj|}}}{{!!}}{{{ntscjnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{panichandlers|}}}|{{!}}'''Use Panic Handlers'''{{!!}}{{{panichandlers|}}}{{!!}}{{{panichandlersnotes|}}}}}
{{#if:{{{panichandlers|}}}|{{!}}{{Hover|Shows a pop-up when a panic condition is encountered (On, Off)|'''Use Panic Handlers'''}}{{!!}}{{{panichandlers|}}}{{!!}}{{{panichandlersnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{skipbios|}}}|{{!}}'''Skip GC BIOS'''{{!!}}{{{skipbios|}}}{{!!}}{{{skipbiosnotes|}}}}}
{{#if:{{{skipbios|}}}|{{!}}{{Hover|(On, Off)|'''Skip GC BIOS'''}}{{!!}}{{{skipbios|}}}{{!!}}{{{skipbiosnotes|}}}}}
{{!}}-
{{!}}-
{{!}}}
{{!}}}
Line 102: Line 112:
{{{forcefilter|}}}
{{{forcefilter|}}}
{{{3dvision|}}}
{{{3dvision|}}}
{{{cpuefbaccess|}}}
{{{skipcpuefbaccess|}}}
{{{formatchanges|}}}
{{{formatchanges|}}}
{{{efbcopy|}}}
{{{efbcopy|}}}
Line 119: Line 129:
!Config!!Setting!!Notes
!Config!!Setting!!Notes
{{!}}-
{{!}}-
{{#if:{{{gfxbackend|}}}|{{!}}'''Video Backend'''{{!!}}{{{gfxbackend|}}}{{!!}}{{{gfxbackendnotes|}}}}}
{{#if:{{{gfxbackend|}}}|{{!}}{{Hover|Selects which graphics technology should be used for display rendering (DirectX9, DirectX11, OpenGL, Software)|'''Video Backend'''}}{{!!}}{{{gfxbackend|}}}{{!!}}{{{gfxbackendnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{fullres|}}}|{{!}}'''Fullscreen Resolution'''{{!!}}{{{fullres|}}}{{!!}}{{{fullresnotes|}}}}}
{{#if:{{{fullres|}}}|{{!}}{{Hover|Selects what the monitor resolution should be set to for fullscreen mode.|'''Fullscreen Resolution'''}}{{!!}}{{{fullres|}}}{{!!}}{{{fullresnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{aspectratio|}}}|{{!}}'''Aspect Ratio'''{{!!}}{{{aspectratio|}}}{{!!}}{{{aspectrationotes|}}}}}
{{#if:{{{aspectratio|}}}|{{!}}{{Hover|Selects what aspect ratio the monitor should display the game in (Auto, Force 16:9, Force 4:3)|'''Aspect Ratio'''}}{{!!}}{{{aspectratio|}}}{{!!}}{{{aspectrationotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{vsync|}}}|{{!}}'''V-Sync'''{{!!}}{{{vsync|}}}{{!!}}{{{vsyncnotes|}}}}}
{{#if:{{{vsync|}}}|{{!}}{{Hover|Synchronizes Dolphin's framerate with your monitor's refresh rate (On, Off)|'''V-Sync'''}}{{!!}}{{{vsync|}}}{{!!}}{{{vsyncnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{startfull|}}}|{{!}}'''Use Fullscreen'''{{!!}}{{{startfull|}}}{{!!}}{{{startfullnotes|}}}}}
{{#if:{{{startfull|}}}|{{!}}{{Hover|Goes to fullscreen by default when a game is started (On, Off)|'''Use Fullscreen'''}}{{!!}}{{{startfull|}}}{{!!}}{{{startfullnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{rendertomain|}}}|{{!}}'''Render to Main Window'''{{!!}}{{{rendertomain|}}}{{!!}}{{{rendertomainnotes|}}}}}
{{#if:{{{rendertomain|}}}|{{!}}{{Hover|Displays games in the main window instead of a separate one (On, Off)|'''Render to Main Window'''}}{{!!}}{{{rendertomain|}}}{{!!}}{{{rendertomainnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{internalres|}}}|{{!}}'''Internal Resolution'''{{!!}}{{{internalres|}}}{{!!}}{{{internalresnotes|}}}}}
{{#if:{{{internalres|}}}|{{!}}{{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:{{{antialiasing|}}}|{{!}}'''Anti-Aliasing'''{{!!}}{{{antialiasing|}}}{{!!}}{{{antialiasingnotes|}}}}}
{{#if:{{{antialiasing|}}}|{{!}}{{Hover|Corrects aliasing along lines and edges (Many choices depending on Video Backend)|'''Anti-Aliasing'''}}{{!!}}{{{antialiasing|}}}{{!!}}{{{antialiasingnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{anisotropic|}}}|{{!}}'''Anisotropic Filtering'''{{!!}}{{{anisotropic|}}}{{!!}}{{{anisotropicnotes|}}}}}
{{#if:{{{anisotropic|}}}|{{!}}{{Hover|Reduces distortion when viewing textures at an angle (1x, 2x, 4x, 8x, 16x)|'''Anisotropic Filtering'''}}{{!!}}{{{anisotropic|}}}{{!!}}{{{anisotropicnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{pixellighting|}}}|{{!}}'''Per-Pixel Lighting'''{{!!}}{{{pixellighting|}}}{{!!}}{{{pixellightingnotes|}}}}}
{{#if:{{{pixellighting|}}}|{{!}}{{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|}}}|{{!}}{{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:{{{3dvision|}}}|{{!}}{{Hover|Enables the 3D effect in game, requires special glasses (On, Off)|'''3D Vision'''}}{{!!}}{{{3dvision|}}}{{!!}}{{{3dvisionnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{cpuefbaccess|}}}|{{!}}'''Skip EFB Access from CPU'''{{!!}}{{{cpuefbaccess|}}}{{!!}}{{{cpuefbaccessnotes|}}}}}
{{#if:{{{skipcpuefbaccess|}}}|{{!}}{{Hover|Prevents the CPU from accessing the External Frame Buffer (On, Off)|'''Skip EFB Access from CPU'''}}{{!!}}{{{skipcpuefbaccess|}}}{{!!}}{{{skipcpuefbaccessnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{formatchanges|}}}|{{!}}'''Ignore Format Changes'''{{!!}}{{{formatchanges|}}}{{!!}}{{{formatchangesnotes|}}}}}
{{#if:{{{formatchanges|}}}|{{!}}'''Ignore Format Changes'''{{!!}}{{{formatchanges|}}}{{!!}}{{{formatchangesnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{efbcopy|}}}|{{!}}'''EFB Copies'''{{!!}}{{{efbcopy|}}}{{!!}}{{{efbcopynotes|}}}}}
{{#if:{{{efbcopy|}}}|{{!}}{{Hover|Controls emulation of External Frame Buffer copies for post-processing or render-to-texture effects (Disable, Enable, Virtual, RAM)|'''EFB Copies'''}}{{!!}}{{{efbcopy|}}}{{!!}}{{{efbcopynotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{xfb|}}}|{{!}}'''External Frame Buffer'''{{!!}}{{{xfb|}}}{{!!}}{{{xfbnotes|}}}}}
{{#if:{{{xfb|}}}|{{!}}{{Hover|Controls emulation of the External Frame Buffer (Disable, Virtual, Real)|'''External Frame Buffer'''}}{{!!}}{{{xfb|}}}{{!!}}{{{xfbnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{dlistcaching|}}}|{{!}}'''Cache Display Lists'''{{!!}}{{{dlistcaching|}}}{{!!}}{{{dlistcachingnotes|}}}}}
{{#if:{{{dlistcaching|}}}|{{!}}{{Hover|Caches display lists, experimental (On, Off)|'''Cache Display Lists'''}}{{!!}}{{{dlistcaching|}}}{{!!}}{{{dlistcachingnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{disablelighting|}}}|{{!}}'''Disable Lighting'''{{!!}}{{{disablelighting|}}}{{!!}}{{{disablelightingnotes|}}}}}
{{#if:{{{disablelighting|}}}|{{!}}{{Hover|Disables dynamic lighting in some games (On, Off)|'''Disable Lighting'''}}{{!!}}{{{disablelighting|}}}{{!!}}{{{disablelightingnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{disablefog|}}}|{{!}}'''Disable Fog'''{{!!}}{{{disablefog|}}}{{!!}}{{{disablefognotes|}}}}}
{{#if:{{{disablefog|}}}|{{!}}{{Hover|Disables the fog used in some games to hide far-away objects (On, Off)|'''Disable Fog'''}}{{!!}}{{{disablefog|}}}{{!!}}{{{disablefognotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{pixeldepth|}}}|{{!}}'''Disable Per-Pixel Depth'''{{!!}}{{{pixeldepth|}}}{{!!}}{{{pixeldepthnotes|}}}}}
{{#if:{{{pixeldepth|}}}|{{!}}{{Hover|Calculate depth values of 3D graphics per-pixel rather than per-vertex (On, Off)|'''Disable Per-Pixel Depth'''}}{{!!}}{{{pixeldepth|}}}{{!!}}{{{pixeldepthnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{disablealpha|}}}|{{!}}'''Skip Dest. Alpha Pass'''{{!!}}{{{disablealpha|}}}{{!!}}{{{disablealphanotes|}}}}}
{{#if:{{{disablealpha|}}}|{{!}}{{Hover|Skip the alpha pass used in many games for graphical effects (On, Off)|'''Skip Dest. Alpha Pass'''}}{{!!}}{{{disablealpha|}}}{{!!}}{{{disablealphanotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{opencl|}}}|{{!}}'''OpenCL Texture Decoder'''{{!!}}{{{opencl|}}}{{!!}}{{{openclnotes|}}}}}
{{#if:{{{opencl|}}}|{{!}}{{Hover|Offloads texture decoding to the GPU using OpenCL, experimental (On, Off)|'''OpenCL Texture Decoder'''}}{{!!}}{{{opencl|}}}{{!!}}{{{openclnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{openmp|}}}|{{!}}'''OpenMP Texture Decoder'''{{!!}}{{{openmp|}}}{{!!}}{{{openmpnotes|}}}}}
{{#if:{{{openmp|}}}|{{!}}{{Hover|Uses multiple threads to decode textures (On, Off)|'''OpenMP Texture Decoder'''}}{{!!}}{{{openmp|}}}{{!!}}{{{openmpnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{widescreenhack|}}}|{{!}}'''Widescreen Hack'''{{!!}}{{{widescreenhack|}}}{{!!}}{{{widescreenhacknotes|}}}}}
{{#if:{{{widescreenhack|}}}|{{!}}{{Hover|Force the game to output graphics for widescreen resolutions (On, Off)|'''Widescreen Hack'''}}{{!!}}{{{widescreenhack|}}}{{!!}}{{{widescreenhacknotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{progressivescan|}}}|{{!}}'''Enable Progressive Scan'''{{!!}}{{{progressivescan|}}}{{!!}}{{{progressivescannotes|}}}}}
{{#if:{{{progressivescan|}}}|{{!}}{{Hover|Enables progressive scan if your game supports it (On, Off)|'''Enable Progressive Scan'''}}{{!!}}{{{progressivescan|}}}{{!!}}{{{progressivescannotes|}}}}}
{{!}}-
{{!}}-
{{!}}}
{{!}}}
Line 182: Line 192:
!Config!!Setting!!Notes
!Config!!Setting!!Notes
{{!}}-
{{!}}-
{{#if:{{{dspengine|}}}|{{!}}'''DSP Emulator Engine'''{{!!}}{{{dspengine|}}}{{!!}}{{{dspenginenotes|}}}}}
{{#if:{{{dspengine|}}}|{{!}}{{Hover|Use High-level (HL) or Low-level (LL) audio emulation; LL emulation is more accurate (HLE, LLE, LLE Interpreter)|'''DSP Emulator Engine'''}}{{!!}}{{{dspengine|}}}{{!!}}{{{dspenginenotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{dtkmusic|}}}|{{!}}'''Enable DTK Music'''{{!!}}{{{dtkmusic|}}}{{!!}}{{{dtkmusicnotes|}}}}}
{{#if:{{{dtkmusic|}}}|{{!}}{{Hover|Used to play background music (On, Off)|'''Enable DTK Music'''}}{{!!}}{{{dtkmusic|}}}{{!!}}{{{dtkmusicnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{dsplleonthread|}}}|{{!}}'''DSP LLE on thread'''{{!!}}{{{dsplleonthread|}}}{{!!}}{{{dsplleonthreadnotes|}}}}}
{{#if:{{{dsplleonthread|}}}|{{!}}{{Hover|Run the DSP on a dedicated thread (On, Off)|'''DSP LLE on thread'''}}{{!!}}{{{dsplleonthread|}}}{{!!}}{{{dsplleonthreadnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{audiothrottle|}}}|{{!}}'''Enable Audio Throttle'''{{!!}}{{{audiothrottle|}}}{{!!}}{{{audiothrottlenotes|}}}}}
{{#if:{{{audiothrottle|}}}|{{!}}{{Hover|Control game speed with audio throttle (On, Off)|'''Enable Audio Throttle'''}}{{!!}}{{{audiothrottle|}}}{{!!}}{{{audiothrottlenotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{audiobackend|}}}|{{!}}'''Audio Backend'''{{!!}}{{{audiobackend|}}}{{!!}}{{{audiobackendnotes|}}}}}
{{#if:{{{audiobackend|}}}|{{!}}{{Hover|Select the audio back-end API library (No Audio Output, DSound, XAudio2)|'''Audio Backend'''}}{{!!}}{{{audiobackend|}}}{{!!}}{{{audiobackendnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{samplerate|}}}|{{!}}'''Sample Rate'''{{!!}}{{{samplerate|}}}{{!!}}{{{samplerate notes|}}}}}
{{#if:{{{samplerate|}}}|{{!}}{{Hover|(32000 Hz, 48000 Hz)|'''Sample Rate'''}}{{!!}}{{{samplerate|}}}{{!!}}{{{samplerate notes|}}}}}
{{!}}-
{{!}}-
{{!}}}
{{!}}}
Line 205: Line 215:
!Config!!Setting!!Notes
!Config!!Setting!!Notes
{{!}}-
{{!}}-
{{#if:{{{screensaver|}}}|{{!}}'''Enable Screen Saver (burn-in reduction)'''{{!!}}{{{screensaver|}}}{{!!}}{{{screensavernotes|}}}}}
{{#if:{{{screensaver|}}}|{{!}}{{Hover|(On, Off)|'''Enable Screen Saver'''}}{{!!}}{{{screensaver|}}}{{!!}}{{{screensavernotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{pal60|}}}|{{!}}'''Use EuRGB60 Mode (PAL60)'''{{!!}}{{{pal60|}}}{{!!}}{{{pal60notes|}}}}}
{{#if:{{{pal60|}}}|{{!}}{{Hover|(On, Off)|'''Use EuRGB60 Mode (PAL60)'''}}{{!!}}{{{pal60|}}}{{!!}}{{{pal60notes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{sdcard|}}}|{{!}}'''Insert SD Card'''{{!!}}{{{sdcard|}}}{{!!}}{{{sdcardnotes|}}}}}
{{#if:{{{sdcard|}}}|{{!}}{{Hover|(On, Off)|'''Insert SD Card'''}}{{!!}}{{{sdcard|}}}{{!!}}{{{sdcardnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{usbkeyboard|}}}|{{!}}'''Connect USB Keyboard'''{{!!}}{{{usbkeyboard|}}}{{!!}}{{{usbkeyboardnotes|}}}}}
{{#if:{{{usbkeyboard|}}}|{{!}}{{Hover|(On, Off)|'''Connect USB Keyboard'''}}{{!!}}{{{usbkeyboard|}}}{{!!}}{{{usbkeyboardnotes|}}}}}
{{!}}-
{{!}}-
{{!}}}
{{!}}}
}}
}}
<!-- GAME PROPERTIES -->
<!-- GAME PROPERTIES -->
{{#if: {{{hacks|}}}
{{#if: {{{patches|}}}
{{{patches|}}}
{{{mmu|}}}
{{{mmu|}}}
{{{bat|}}}
{{{bat|}}}
Line 224: Line 233:
{{{fastdisc|}}}
{{{fastdisc|}}}
{{{blockmerging|}}}
{{{blockmerging|}}}
{{{dsphle|}}}
{{{ztphack|}}}
{{{ztphack|}}}
{{{projectionhack|}}}|
{{{projectionhack|}}}|
Line 231: Line 239:
!Config!!Setting!!Notes
!Config!!Setting!!Notes
{{!}}-
{{!}}-
{{#if:{{{hacks|}}}|{{!}}'''Hacks'''{{!!}}{{{hacks|}}}{{!!}}{{{hacksnotes|}}}}}
{{#if:{{{patches|}}}|{{!}}'''Patches'''{{!!}}{{{patches|}}}{{!!}}{{{patchesnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{patches|}}}|{{!}}'''Patches'''{{!!}}{{{patches|}}}{{!!}}{{{patchesnotes|}}}}}
{{#if:{{{mmu|}}}|{{!}}{{Hover|Enable Memory Management Unit (On, Off)|'''Enable MMU'''}}{{!!}}{{{mmu|}}}{{!!}}{{{mmunotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{mmu|}}}|{{!}}'''Enable MMU'''{{!!}}{{{mmu|}}}{{!!}}{{{mmunotes|}}}}}
{{#if:{{{bat|}}}|{{!}}{{Hover|Enables Block Address Translation, a function of the Memory Management Unit (MMU), accurate to the hardware but slow to emulate (On, Off)|'''Enable BAT'''}}{{!!}}{{{bat|}}}{{!!}}{{{batnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{bat|}}}|{{!}}'''Enable BAT'''{{!!}}{{{bat|}}}{{!!}}{{{batnotes|}}}}}
{{#if:{{{mmuhack|}}}|{{!}}{{Hover|Fast version of the Memory Management Unit (On, Off)|'''MMU Speed Hack'''}}{{!!}}{{{mmuhack|}}}{{!!}}{{{mmuhacknotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{mmuhack|}}}|{{!}}'''MMU Speed Hack'''{{!!}}{{{mmuhack|}}}{{!!}}{{{mmuhacknotes|}}}}}
{{#if:{{{vbeamhack|}}}|{{!}}{{Hover|If the FPS is erratic the option may be helpful (On, Off)|'''Accurate VBeam emulation'''}}{{!!}}{{{vbeamhack|}}}{{!!}}{{{vbeamhacknotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{vbeamhack|}}}|{{!}}'''Accurate VBeam emulation'''{{!!}}{{{vbeamhack|}}}{{!!}}{{{vbeamhacknotes|}}}}}
{{#if:{{{fastdisc|}}}|{{!}}{{Hover|Enables fast disc access (On, Off)|'''Speed up Disc Transfer Rate'''}}{{!!}}{{{fastdisc|}}}{{!!}}{{{fastdiscnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{fastdisc|}}}|{{!}}'''Speed up Disc Transfer Rate'''{{!!}}{{{fastdisc|}}}{{!!}}{{{fastdiscnotes|}}}}}
{{#if:{{{blockmerging|}}}|{{!}}{{Hover|(On, Off)|'''Enable Block Merging'''}}{{!!}}{{{blockmerging|}}}{{!!}}{{{blockmergingnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{blockmerging|}}}|{{!}}'''Enable Block Merging'''{{!!}}{{{blockmerging|}}}{{!!}}{{{blockmergingnotes|}}}}}
{{#if:{{{ztphack|}}}|{{!}}{{Hover|Enable this to speed up Zelda:The Twilight Princess (On, Off)|'''ZTP hack'''}}{{!!}}{{{ztphack|}}}{{!!}}{{{ztphacknotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{dsphle|}}}|{{!}}'''DSP HLE emulation'''{{!!}}{{{dsphle|}}}{{!!}}{{{dsphlenotes|}}}}}
{{#if:{{{projectionhack|}}}|{{!}}{{Hover|Enable custom projection hacks (Various /w options)|'''Custom Projection Hack'''}}{{!!}}{{{projectionhack|}}}{{!!}}{{{projectionhacknotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{ztphack|}}}|{{!}}'''ZTP hack'''{{!!}}{{{ztphack|}}}{{!!}}{{{ztphacknotes|}}}}}
{{!}}}
}}
<!-- 3.0-ONLY CONFIG -->
{{#if: {{{efbscaledcopy|}}}
{{{accuratetexturecache|}}}
{{{fastmipmaps|}}}|
===Release 3.0 Settings===
''The following settings have been removed from the latest revisions of Dolphin, but may still be useful for Dolphin Release 3.0''
{{{!}}class="wikitable" style="font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
!Config!!Setting!!Notes
{{!}}-
{{!}}-
{{#if:{{{projectionhack|}}}|{{!}}'''Custom Projection Hack'''{{!!}}{{{projectionhack|}}}{{!!}}{{{projectionhacknotes|}}}}}
{{#if:{{{efbscaledcopy|}}}|{{!}}{{Hover|(On, Off)|'''Scaled EFB Copy'''}}{{!!}}{{{efbscaledcopy|}}}{{!!}}{{{efbscaledcopynotes|}}}}}
{{!}}-
{{#if:{{{accuratetexturecache|}}}|{{!}}{{Hover|(Off, Safe, Fast)|'''Texture Cache Accuracy'''}}{{!!}}{{{accuratetexturecache|}}}{{!!}}{{{accuratetexturecachenotes|}}}}}
{{!}}-
{{#if:{{{fastmipmaps|}}}|{{!}}{{Hover|(On, Off)|'''Fast Mipmaps'''}}{{!!}}{{{fastmipmaps|}}}{{!!}}{{{fastmipmapsnotes|}}}}}
{{!}}-
{{!}}-
{{!}}}
{{!}}}
}}|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]].}}
}}
 
|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]]. A full list of config options is available at [[Template:Config/doc]]}}
A full list of options is available at [[Template:Config/doc]].
{{#if: {{{graphicsplugin|}}}
{{#if: {{{graphicsplugin|}}}
{{{graphicspluginnotes|}}}
{{{graphicspluginnotes|}}}
Line 277: Line 297:
{{{fpsforlimit|}}}
{{{fpsforlimit|}}}
{{{fpsforlimitnotes|}}}
{{{fpsforlimitnotes|}}}
{{{efbscaledcopy|}}}
{{{cpuefbaccess|}}}
{{{hacks|}}}
{{{dsphle|}}}
|[[Category:Pages with deprecated config template parameters]]}}
{{#if: {{{efbscaledcopy|}}}
{{{efbscaledcopynotes|}}}
{{{efbscaledcopynotes|}}}
{{{accuratetexturecache|}}}
{{{accuratetexturecache|}}}
Line 283: Line 307:
{{{fastmipmaps|}}}
{{{fastmipmaps|}}}
{{{fastmipmapsnotes|}}}
{{{fastmipmapsnotes|}}}
|[[Category:Pages with deprecated config template parameters]]
|[[Category:Pages with 3.0-only config template parameters]]}}
}}</includeonly>
</includeonly>
<noinclude>
<noinclude>
{{documentation}}
{{documentation}}
</noinclude>
</noinclude>

Revision as of 06:22, 17 August 2011


[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 are listed. Please see the performance guide for an overview of performance related settings. A full list of options is available at Template:Config/doc

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               =
}}