Template:Config: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
(adjust error category)
(Updated to be as is in r7612 (latest))
Line 1: Line 1:
<includeonly>{{#if:{{{dualcore|}}}{{{idleskipping|}}}{{{framelimit|}}}{{{fpsforlimit|}}}{{{skipbios|}}}{{{cpuengine|}}}{{{lockthreadstocore|}}}{{{dsplleonthread|}}}{{{gfxbackend|}}}{{{fullres|}}}{{{winsize|}}}{{{startfull|}}}{{{rendertomain|}}}{{{progressivescan|}}}{{{ntscj|}}}{{{panichandler|}}}{{{aspectratio|}}}{{{widescreenhack|}}}{{{vsync|}}}{{{anisotropic|}}}{{{antialiasing|}}}{{{nativemipmaps|}}}{{{efbscaledcopy|}}}{{{pixellighting|}}}{{{pixeldepth|}}}{{{forcefilter|}}}{{{3dvision|}}}{{{internalres|}}}{{{cpuefbaccess|}}}{{{formatchanges|}}}{{{efbcopy|}}}{{{accuratetexturecache|}}}{{{disablelighting|}}}{{{disablefog|}}}{{{disablealpha|}}}{{{xfb|}}}{{{realxfb|}}}{{{opencl|}}}{{{dlistcaching|}}}{{{openmp|}}}{{{dspplugin|}}}{{{dspengine|}}}{{{dtkmusic|}}}{{{audiothrottle|}}}{{{samplerate|}}}{{{audiobackend|}}}{{{screensaver|}}}{{{pal60|}}}{{{sdcard|}}}{{{usbkeyboard|}}}{{{hacks|}}}{{{patches|}}}{{{mmu|}}}{{{bat|}}}{{{mmuhack|}}}{{{rfi|}}}{{{fastdisc|}}}{{{blockmerging|}}}{{{dsphle|}}}{{{ztphack|}}}{{{projectionhack|}}}|Only configuration options for the best compatibility are listed. Please see the [[performance guide]], for an overview of performance related settings.
<includeonly>{{#if:{{{dualcore|}}}{{{idleskipping|}}}{{{framelimit|}}}{{{limitbyfps|}}}{{{cpuengine|}}}{{{lockthreadstocore|}}}{{{ntscj|}}}{{{panichandlers|}}}{{{skipbios|}}}{{{gfxbackend|}}}{{{fullres|}}}{{{aspectratio|}}}{{{vsync|}}}{{{startfull|}}}{{{rendertomain|}}}{{{internalres|}}}{{{antialiasing|}}}{{{anisotropic|}}}{{{efbscaledcopy|}}}{{{forcefilter|}}}{{{pixellighting|}}}{{{3dvision|}}}{{{cpuefbaccess|}}}{{{formatchanges|}}}{{{efbcopy|}}}{{{accuratetexturecache|}}}{{{xfb|}}}{{{fastmipmaps|}}}{{{disablelighting|}}}{{{pixeldepth|}}}{{{opencl|}}}{{{dlistcaching|}}}{{{disablefog|}}}{{{disablealpha|}}}{{{openmp|}}}{{{{widescreenhack|}}}{{{progressivescan|}}}{{{dspengine|}}}{{{dtkmusic|}}}{{{dsplleonthread|}}}{{{audiothrottle|}}}{{{audiobackend|}}}{{{samplerate|}}}{{{screensaver|}}}{{{pal60|}}}{{{sdcard|}}}{{{usbkeyboard|}}}{{{hacks|}}}{{{patches|}}}{{{mmu|}}}{{{bat|}}}{{{mmuhack|}}}{{{rfi|}}}{{{fastdisc|}}}{{{blockmerging|}}}{{{dsphle|}}}{{{ztphack|}}}{{{projectionhack|}}}|Only configuration options for the best compatibility are listed. Please see the [[performance guide]], for an overview of performance related settings.
{{#if:{{{dualcore|}}}{{{idleskipping|}}}{{{framelimit|}}}{{{fpsforlimit|}}}{{{hletheipl|}}}{{{skipbios|}}}{{{cpuengine|}}}{{{lockthreadstocore|}}}{{{dsplleonthread|}}}|
{{#if:{{{dualcore|}}}{{{idleskipping|}}}{{{framelimit|}}}{{{limitbyfps|}}}{{{cpuengine|}}}{{{lockthreadstocore|}}}{{{ntscj|}}}{{{panichandlers|}}}{{{skipbios|}}}|
===General===
===General===
{{{!}}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"
Line 11: Line 11:
{{#if:{{{framelimit|}}}|{{!}}'''Framelimit'''{{!!}}{{{framelimit|}}}{{!!}}{{{framelimitnotes|}}}}}
{{#if:{{{framelimit|}}}|{{!}}'''Framelimit'''{{!!}}{{{framelimit|}}}{{!!}}{{{framelimitnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{fpsforlimit|}}}|{{!}}'''Use FPS for Limiting'''{{!!}}{{{fpsforlimit|}}}{{!!}}{{{fpsforlimitnotes|}}}}}
{{#if:{{{fpsforlimit|}}}|{{!}}'''Limit by FPS'''{{!!}}{{{limitbyfps|}}}{{!!}}{{{limitbyfpsnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{skipbios|}}}|{{!}}'''Skip GC BIOS'''{{!!}}{{{skipbios|}}}{{!!}}{{{skipbiosnotes|}}}}}
{{#if:{{{cpuengine|}}}|{{!}}'''CPU Emulator Engine'''{{!!}}{{{cpuengine|}}}{{!!}}{{{cpuenginenotes|}}}}}
{{!}}-
{{#if:{{{lockthreadstocore|}}}|{{!}}'''Lock Threads to Cores'''{{!!}}{{{lockthreadstocore|}}}{{!!}}{{{lockthreadstocorenotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{cpuengine|}}}|{{!}}'''CPU Emulator Engine'''{{!!}}{{{cpuengine|}}}{{!!}}{{{cpuenginenotes|}}}}}
{{#if:{{{ntscj|}}}|{{!}}'''Force Console as NTSC-J'''{{!!}}{{{ntscj|}}}{{!!}}{{{ntscjnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{lockthreadstocore|}}}|{{!}}'''Lock threads to cores'''{{!!}}{{{lockthreadstocore|}}}{{!!}}{{{lockthreadstocorenotes|}}}}}
{{#if:{{{panichandlers|}}}|{{!}}'''Use Panic Handlers'''{{!!}}{{{panichandlers|}}}{{!!}}{{{panichandlersnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{dsplleonthread|}}}|{{!}}'''DSPLLE on thread'''{{!!}}{{{dsplleonthread|}}}{{!!}}{{{dsplleonthreadnotes|}}}}}
{{#if:{{{skipbios|}}}|{{!}}'''Skip GC BIOS'''{{!!}}{{{skipbios|}}}{{!!}}{{{skipbiosnotes|}}}}}
{{!}}-
{{!}}-
{{!}}}
{{!}}}
}}
}}
{{#if:{{{graphicsplugin|}}}{{{gfxbackend|}}}{{{fullres|}}}{{{winsize|}}}{{{startfull|}}}{{{rendertomain|}}}{{{progressivescan|}}}{{{ntscj|}}}{{{panichandler|}}}|
 
===Display===
{{#if:{{{gfxbackend|}}}{{{fullres|}}}{{{aspectratio|}}}{{{vsync|}}}{{{startfull|}}}{{{rendertomain|}}}{{{internalres|}}}{{{antialiasing|}}}{{{anisotropic|}}}{{{efbscaledcopy|}}}{{{forcefilter|}}}{{{pixellighting|}}}{{{3dvision|}}}{{{cpuefbaccess|}}}{{{formatchanges|}}}{{{efbcopy|}}}{{{accuratetexturecache|}}}{{{xfb|}}}{{{fastmipmaps|}}}{{{disablelighting|}}}{{{pixeldepth|}}}{{{opencl|}}}{{{dlistcaching|}}}{{{disablefog|}}}{{{disablealpha|}}}{{{openmp|}}}{{{{widescreenhack|}}}{{{progressivescan|}}}|
===Graphics===
{{{!}}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
Line 30: Line 33:
{{#if:{{{gfxbackend|}}}|{{!}}'''Video Backend'''{{!!}}{{{gfxbackend|}}}{{!!}}{{{gfxbackendnotes|}}}}}
{{#if:{{{gfxbackend|}}}|{{!}}'''Video Backend'''{{!!}}{{{gfxbackend|}}}{{!!}}{{{gfxbackendnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{fullres|}}}|{{!}}'''Fullscreen Display Resolution'''{{!!}}{{{fullres|}}}{{!!}}{{{fullresnotes|}}}}}
{{#if:{{{fullres|}}}|{{!}}'''Fullscreen Resolution'''{{!!}}{{{fullres|}}}{{!!}}{{{fullresnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{winsize|}}}|{{!}}'''Window Size'''{{!!}}{{{winsize|}}}{{!!}}{{{winsizenotes|}}}}}
{{#if:{{{aspectratio|}}}|{{!}}'''Aspect Ratio'''{{!!}}{{{aspectratio|}}}{{!!}}{{{aspectrationotes|}}}}}
        {{!}}-
{{#if:{{{vsync|}}}|{{!}}'''V-Sync'''{{!!}}{{{vsync|}}}{{!!}}{{{vsyncnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{startfull|}}}|{{!}}'''Start Renderer in Fullscreen'''{{!!}}{{{startfull|}}}{{!!}}{{{startfullnotes|}}}}}
{{#if:{{{startfull|}}}|{{!}}'''Use Fullscreen'''{{!!}}{{{startfull|}}}{{!!}}{{{startfullnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{rendertomain|}}}|{{!}}'''Render to Main Window'''{{!!}}{{{rendertomain|}}}{{!!}}{{{rendertomainnotes|}}}}}
{{#if:{{{rendertomain|}}}|{{!}}'''Render to Main Window'''{{!!}}{{{rendertomain|}}}{{!!}}{{{rendertomainnotes|}}}}}
{{!}}-
{{#if:{{{progressivescan|}}}|{{!}}'''Enable Progressive Scan'''{{!!}}{{{progressivescan|}}}{{!!}}{{{progressivescannotes|}}}}}
{{!}}-
{{#if:{{{ntscj|}}}|{{!}}'''Set console as NTSC-J'''{{!!}}{{{ntscj|}}}{{!!}}{{{ntscjnotes|}}}}}
{{!}}-
{{#if:{{{panichandler|}}}|{{!}}'''Use Panic Handlers'''{{!!}}{{{panichandler|}}}{{!!}}{{{panichandlernotes|}}}}}
{{!}}-
        {{!}}}
}}
{{#if:{{{aspectratio|}}}{{{widescreenhack|}}}{{{vsync|}}}{{{anisotropic|}}}{{{antialiasing|}}}{{{nativemipmaps|}}}{{{efbscaledcopy|}}}{{{pixellighting|}}}{{{pixeldepth|}}}{{{forcefilter|}}}{{{3dvision|}}}{{{internalres|}}}{{{cpuefbaccess|}}}{{{formatchanges|}}}{{{efbcopy|}}}{{{safetexturecache|}}}{{{accuratetexturecache|}}}{{{disablelighting|}}}{{{disablefog|}}}{{{disablealpha|}}}{{{xfb|}}}{{{opencl|}}}{{{dlistcaching|}}}{{{openmp|}}}|
===Graphics===
{{{!}}class="wikitable" style="font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
!Config!!Setting!!Notes
{{!}}-
{{#if:{{{aspectratio|}}}|{{!}}'''Aspect Ratio'''{{!!}}{{{aspectratio|}}}{{!!}}{{{aspectrationotes|}}}}}
        {{!}}-
{{#if:{{{widescreenhack|}}}|{{!}}'''Widescreen Hack'''{{!!}}{{{widescreenhack|}}}{{!!}}{{{widescreenhacknotes|}}}}}
        {{!}}-
{{#if:{{{vsync|}}}|{{!}}'''V-Sync'''{{!!}}{{{vsync|}}}{{!!}}{{{vsyncnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{internalres|}}}|{{!}}'''Internal Resolution'''{{!!}}{{{internalres|}}}{{!!}}{{{internalresnotes|}}}}}
{{#if:{{{internalres|}}}|{{!}}'''Internal Resolution'''{{!!}}{{{internalres|}}}{{!!}}{{{internalresnotes|}}}}}
Line 81: Line 67:
{{#if:{{{xfb|}}}|{{!}}'''External Frame Buffer'''{{!!}}{{{xfb|}}}{{!!}}{{{xfbnotes|}}}}}
{{#if:{{{xfb|}}}|{{!}}'''External Frame Buffer'''{{!!}}{{{xfb|}}}{{!!}}{{{xfbnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{realxfb|}}}|{{!}}'''External Frame Buffer'''{{!!}}Real{{!!}}{{{realxfbnotes|}}}}}
{{#if:{{{fastmipmaps|}}}|{{!}}'''Fast Mipmaps'''{{!!}}{{{fastmipmaps|}}}{{!!}}{{{fastmipmapsnotes|}}}}}
{{!}}-
{{#if:{{{nativemipmaps|}}}|{{!}}'''Fast Mipmaps'''{{!!}}{{{nativemipmaps|}}}{{!!}}{{{nativemipmapsnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{disablelighting|}}}|{{!}}'''Disable Lighting'''{{!!}}{{{disablelighting|}}}{{!!}}{{{disablelightingnotes|}}}}}
{{#if:{{{disablelighting|}}}|{{!}}'''Disable Lighting'''{{!!}}{{{disablelighting|}}}{{!!}}{{{disablelightingnotes|}}}}}
Line 98: Line 82:
{{!}}-
{{!}}-
{{#if:{{{openmp|}}}|{{!}}'''OpenMP Texture Decoder'''{{!!}}{{{openmp|}}}{{!!}}{{{openmpnotes|}}}}}
{{#if:{{{openmp|}}}|{{!}}'''OpenMP Texture Decoder'''{{!!}}{{{openmp|}}}{{!!}}{{{openmpnotes|}}}}}
{{!}}-
{{#if:{{{widescreenhack|}}}|{{!}}'''Widescreen Hack'''{{!!}}{{{widescreenhack|}}}{{!!}}{{{widescreenhacknotes|}}}}}
        {{!}}-
{{#if:{{{progressivescan|}}}|{{!}}'''Enable Progressive Scan'''{{!!}}{{{progressivescan|}}}{{!!}}{{{progressivescannotes|}}}}}
{{!}}-
{{!}}-
{{!}}}
{{!}}}
}}
}}
{{#if:{{{dspplugin|}}}{{{dspengine|}}}{{{dtkmusic|}}}{{{audiothrottle|}}}{{{samplerate|}}}{{{audiobackend|}}}|
 
{{#if:{{{dspengine|}}}{{{dtkmusic|}}}{{{dsplleonthread|}}}{{{audiothrottle|}}}{{{audiobackend|}}}{{{samplerate|}}}|
===Audio===
===Audio===
{{{!}}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:{{{dspplugin|}}}|{{!}}'''DSP Emulator Engine'''{{!!}}{{{dspplugin|}}}{{!!}}{{{dsppluginnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{dspengine|}}}|{{!}}'''DSP Emulator Engine'''{{!!}}{{{dspengine|}}}{{!!}}{{{dspenginenotes|}}}}}
{{#if:{{{dspengine|}}}|{{!}}'''DSP Emulator Engine'''{{!!}}{{{dspengine|}}}{{!!}}{{{dspenginenotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{dtkmusic|}}}|{{!}}'''Enable DTK Music'''{{!!}}{{{dtkmusic|}}}{{!!}}{{{dtkmusicnotes|}}}}}
{{#if:{{{dtkmusic|}}}|{{!}}'''Enable DTK Music'''{{!!}}{{{dtkmusic|}}}{{!!}}{{{dtkmusicnotes|}}}}}
{{!}}-
{{#if:{{{dsplleonthread|}}}|{{!}}'''DSP LLE on thread'''{{!!}}{{{dsplleonthread|}}}{{!!}}{{{dsplleonthreadnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{audiothrottle|}}}|{{!}}'''Enable Audio Throttle'''{{!!}}{{{audiothrottle|}}}{{!!}}{{{audiothrottlenotes|}}}}}
{{#if:{{{audiothrottle|}}}|{{!}}'''Enable Audio Throttle'''{{!!}}{{{audiothrottle|}}}{{!!}}{{{audiothrottlenotes|}}}}}
Line 120: Line 109:
{{!}}}
{{!}}}
}}
}}
{{#if:{{{screensaver|}}}{{{pal60|}}}{{{sdcard|}}}{{{usbkeyboard|}}}|
{{#if:{{{screensaver|}}}{{{pal60|}}}{{{sdcard|}}}{{{usbkeyboard|}}}|
===Wii===
===Wii===
Line 163: Line 153:
{{!}}-
{{!}}-
{{!}}}
{{!}}}
}}|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]].}}{{#if:{{{graphicsplugin|}}}{{{graphicspluginnotes|}}}{{{hletheipl|}}}{{{hletheiplnotes|}}}{{{mmuhack|}}}{{{mmuhacknotes|}}}{{{realxfb|}}}{{{realxfbnotes|}}}{{{recompiler|}}}{{{recompilernotes|}}}{{{safetexturecache|}}}{{{safetexturecachenotes|}}}|[[Category:Pages with deprecated config template parameters]]}}</includeonly><noinclude>
}}|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]].}}{{#if:{{{graphicsplugin|}}}{{{graphicspluginnotes|}}}{{{hletheipl|}}}{{{hletheiplnotes|}}}{{{realxfb|}}}{{{realxfbnotes|}}}{{{recompiler|}}}{{{recompilernotes|}}}{{{safetexturecache|}}}{{{safetexturecachenotes|}}}{{{winsize|}}}{{{winsizenotes|}}}{{{dspplugin|}}}{{{dsppluginnotes|}}}{{{panichandler|}}}{{{panichandlernotes|}}}|[[Category:Pages with deprecated config template parameters]]}}</includeonly><noinclude>
{{documentation}}
{{documentation}}
</noinclude>
</noinclude>

Revision as of 20:12, 20 June 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.

General

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

Graphics

Config Setting Notes

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