Template:Config: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
(Let's see what is happening, the MaJoR's code should work without issues...)
(So, I think I got what went wrong. Also, removed some white space that was causing some issues when only some parameters are present. Deprecated dtkmusic and samplerate. Added Latency...)
Line 8: Line 8:
{{{panichandlers|}}}
{{{panichandlers|}}}
{{{skipbios|}}}
{{{skipbios|}}}
<!-- GRAPHICS -->
<!-- GRAPHICS -->
{{{gfxbackend|}}}
{{{gfxbackend|}}}
Line 37: Line 38:
{{{progressivescan|}}}
{{{progressivescan|}}}
{{{hackedbuffer|}}}
{{{hackedbuffer|}}}
<!-- AUDIO -->
<!-- AUDIO -->
{{{dspengine|}}}
{{{dspengine|}}}
{{{dsponthread|}}}
{{{dsponthread|}}}
{{{dsplleonthread|}}}
{{{audiobackend|}}}
{{{audiobackend|}}}
{{{samplerate|}}}
{{{latency|}}}
 
<!-- WII -->
<!-- WII -->
{{{screensaver|}}}
{{{screensaver|}}}
Line 48: Line 52:
{{{sdcard|}}}
{{{sdcard|}}}
{{{usbkeyboard|}}}
{{{usbkeyboard|}}}
<!-- WIIMOTE -->
<!-- WIIMOTE -->
{{{enablespeakerdata|}}}
{{{enablespeakerdata|}}}
{{{wiimotemotor|}}}
{{{wiimotemotor|}}}
<!-- GAME PROPERTIES -->
<!-- GAME PROPERTIES -->
{{{patches|}}}
{{{patches|}}}
Line 62: Line 68:
         {{{bbox|}}}
         {{{bbox|}}}
{{{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.  A full list of options is available at [[Template:Config/doc]]<!--   
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|}}}
{{{idleskipping|}}}
{{{idleskipping|}}}
{{{framelimit|}}}
{{{framelimit|}}}
{{{limitbyfps|}}}
{{{limitbyfps|}}}
{{{cpuengine|}}}
{{{cpuengine|}}}
{{{lockthreadstocore|}}}
{{{ntscj|}}}
{{{ntscj|}}}
{{{panichandlers|}}}
{{{panichandlers|}}}
{{{skipbios|}}}|
{{{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"
!Config!!Setting!!Notes
!Config!!Setting!!Notes
Line 87: Line 90:
{{!}}-
{{!}}-
{{#if:{{{cpuengine|}}}|{{!}}{{Hover|Sets which CPU Emulator Engine should be used (Interpreter, JIT, JITIL)|'''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|}}}|{{!}}{{Hover|Forces Dolphin threads to stay on their individual cores (On, Off)|'''Lock Threads to Cores'''}}{{!!}}{{{lockthreadstocore|}}}{{!!}}{{{lockthreadstocorenotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{ntscj|}}}|{{!}}{{Hover|(On, Off)|'''Force Console as NTSC-J'''}}{{!!}}{{{ntscj|}}}{{!!}}{{{ntscjnotes|}}}}}
{{#if:{{{ntscj|}}}|{{!}}{{Hover|(On, Off)|'''Force Console as NTSC-J'''}}{{!!}}{{{ntscj|}}}{{!!}}{{{ntscjnotes|}}}}}
Line 96: Line 97:
{{#if:{{{skipbios|}}}|{{!}}{{Hover|Skip loading of GameCube BIOS before booting the {{#if:{{{type|}}}|{{{type|}}}|game}} when the IPL dumps are present on User\GC (On, Off)|'''Skip GC BIOS'''}}{{!!}}{{{skipbios|}}}{{!!}}{{{skipbiosnotes|}}}}}
{{#if:{{{skipbios|}}}|{{!}}{{Hover|Skip loading of GameCube BIOS before booting the {{#if:{{{type|}}}|{{{type|}}}|game}} when the IPL dumps are present on User\GC (On, Off)|'''Skip GC BIOS'''}}{{!!}}{{{skipbios|}}}{{!!}}{{{skipbiosnotes|}}}}}
{{!}}-
{{!}}-
{{!}}}
{{!}}}}}<!--
}}<!-- GRAPHICS -->
        -- GRAPHICS --
{{#if: {{{gfxbackend|}}}
-->{{#if:{{{gfxbackend|}}}
{{{fullres|}}}
{{{fullres|}}}
{{{aspectratio|}}}
{{{aspectratio|}}}
Line 123: Line 124:
{{{openmp|}}}
{{{openmp|}}}
{{{widescreenhack|}}}
{{{widescreenhack|}}}
{{{progressivescan|}}}|
{{{progressivescan|}}}
{{{hackedbuffer|}}}
{{{hackedbuffer|}}}|===Graphics===
===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 185: Line 185:
{{#if:{{{hackedbuffer|}}}|{{!}}{{Hover|OpenGL only. Enables hacked buffer upload for a speedup in OpenGL (On, Off)|'''Hacked Buffer Upload'''}}{{!!}}{{{hackedbuffer|}}}{{!!}}{{{hackedbuffer|}}}}}
{{#if:{{{hackedbuffer|}}}|{{!}}{{Hover|OpenGL only. Enables hacked buffer upload for a speedup in OpenGL (On, Off)|'''Hacked Buffer Upload'''}}{{!!}}{{{hackedbuffer|}}}{{!!}}{{{hackedbuffer|}}}}}
{{!}}-
{{!}}-
{{!}}}
{{!}}}}}<!--
}}<!-- AUDIO -->
        -- AUDIO --
{{#if: {{{dspengine|}}}
-->{{#if:{{{dspengine|}}}
{{{dtkmusic|}}}
{{{dsplleonthread|}}}
{{{dsplleonthread|}}}
{{{dsponthread|}}}
{{{dsponthread|}}}
{{{audiobackend|}}}
{{{audiobackend|}}}
{{{samplerate|}}}|
{{{latency|}}}|===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
Line 199: Line 197:
{{#if:{{{dspengine|}}}|{{!}}{{Hover|Use High-level (HL) or Low-level (LL) audio emulation; LL emulation is more accurate, but require a dump of GameCube or Wii DSP ROMs at User\GC (HLE, LLE, LLE Interpreter)|'''DSP Emulator Engine'''}}{{!!}}{{{dspengine|}}}{{!!}}{{{dspenginenotes|}}}}}
{{#if:{{{dspengine|}}}|{{!}}{{Hover|Use High-level (HL) or Low-level (LL) audio emulation; LL emulation is more accurate, but require a dump of GameCube or Wii DSP ROMs at User\GC (HLE, LLE, LLE Interpreter)|'''DSP Emulator Engine'''}}{{!!}}{{{dspengine|}}}{{!!}}{{{dspenginenotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{dtkmusic|}}}|{{!}}{{Hover|Used to play background music (On, Off)|'''Enable DTK Music'''}}{{!!}}{{{dtkmusic|}}}{{!!}}{{{dtkmusicnotes|}}}}}
{{#if:{{{dsplleonthread|}}}|{{!}}{{Hover|Run the DSP on a dedicated thread (On, Off)|'''DSP on Dedicated Thread'''}}{{!!}}{{{dsplleonthread|}}}{{!!}}{{{dsplleonthreadnotes|}}}}}
{{!}}-
{{#if:{{{dsplleonthread|}}}|{{!}}{{Hover|Run the DSP on a dedicated thread (On, Off)|'''DSP LLE on thread'''}}{{!!}}{{{dsplleonthread|}}}{{!!}}{{{dsplleonthreadnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{dsponthread|}}}|{{!}}{{Hover|Run the DSP on a dedicated thread (On, Off)|'''DSP on Dedicated Thread'''}}{{!!}}{{{dsponthread|}}}{{!!}}{{{dsponthreadnotes|}}}}}
{{#if:{{{dsponthread|}}}|{{!}}{{Hover|Run the DSP on a dedicated thread (On, Off)|'''DSP on Dedicated Thread'''}}{{!!}}{{{dsponthread|}}}{{!!}}{{{dsponthreadnotes|}}}}}
Line 207: Line 203:
{{#if:{{{audiobackend|}}}|{{!}}{{Hover|Select the audio back-end API library (No Audio Output, DSound, XAudio2, OpenAL)|'''Audio Back End'''}}{{!!}}{{{audiobackend|}}}{{!!}}{{{audiobackendnotes|}}}}}
{{#if:{{{audiobackend|}}}|{{!}}{{Hover|Select the audio back-end API library (No Audio Output, DSound, XAudio2, OpenAL)|'''Audio Back End'''}}{{!!}}{{{audiobackend|}}}{{!!}}{{{audiobackendnotes|}}}}}
{{!}}-
{{!}}-
{{#if:{{{samplerate|}}}|{{!}}{{Hover|(32000 Hz, 48000 Hz)|'''Sample Rate'''}}{{!!}}{{{samplerate|}}}{{!!}}{{{samplerate notes|}}}}}
{{#if:{{{latency|}}}|{{!}}{{Hover|Adjust the latency (in ms). Higher values may reduce audio crackling. OpenAL backend only (0 to 30)|'''Latency'''}}{{!!}}{{{latency|}}}{{!!}}{{{latencynotes|}}}}}
{{!}}-
{{!}}-
{{!}}}
{{!}}}}}<!--
}}<!-- WII -->
        -- WII --
{{#if: {{{screensaver|}}}
-->{{#if:{{{screensaver|}}}
{{{pal60|}}}
{{{pal60|}}}
{{{systemlang|}}}
{{{systemlang|}}}
{{{sdcard|}}}
{{{sdcard|}}}
{{{usbkeyboard|}}}|
{{{usbkeyboard|}}}|===Wii===
===Wii===
{{{!}}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 230: Line 225:
{{#if:{{{usbkeyboard|}}}|{{!}}{{Hover|(On, Off)|'''Connect USB Keyboard'''}}{{!!}}{{{usbkeyboard|}}}{{!!}}{{{usbkeyboardnotes|}}}}}
{{#if:{{{usbkeyboard|}}}|{{!}}{{Hover|(On, Off)|'''Connect USB Keyboard'''}}{{!!}}{{{usbkeyboard|}}}{{!!}}{{{usbkeyboardnotes|}}}}}
{{!}}-
{{!}}-
{{!}}}
{{!}}}}}<!--
}}<!-- WIIMOTE -->
        -- WIIMOTE --
{{#if: {{{enablespeakerdata|}}}
-->{{#if:{{{enablespeakerdata|}}}
{{{wiimotemotor|}}}
{{{wiimotemotor|}}}|===Wiimote===
===Wiimote===
{{{!}}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:{{{enablespeakerdata|}}}|{{!}}{{Hover|Controls if sounds come from the Wii Remote speaker of Real Wiimotes (On, Off)|'''Enable Speaker Data'''}}{{!!}}{{{enablespeakerdata|}}}{{!!}}{{{enablespeakerdata|}}}}}
{{#if:{{{enablespeakerdata|}}}|{{!}}{{Hover|Controls if sounds come from the Wii Remote Speaker of Real Wiimotes (On, Off)|'''Enable Speaker Data'''}}{{!!}}{{{enablespeakerdata|}}}{{!!}}{{{enablespeakerdata|}}}}}
{{!}}-
{{!}}-
{{#if:{{{wiimotemotor|}}}|{{!}}{{Hover|(On, Off)|'''Wiimote Motor'''}}{{!!}}{{{wiimotemotor|}}}{{!!}}{{{wiimotemotor|}}}}}
{{#if:{{{wiimotemotor|}}}|{{!}}{{Hover|(On, Off)|'''Wiimote Motor'''}}{{!!}}{{{wiimotemotor|}}}{{!!}}{{{wiimotemotor|}}}}}
}}<!-- GAME PROPERTIES -->
{{!}}-
{{#if: {{{patches|}}}
{{!}}}}}<!--
        -- GAME PROPERTIES --
-->{{#if:{{{patches|}}}
{{{mmu|}}}
{{{mmu|}}}
{{{bat|}}}
{{{bat|}}}
Line 254: Line 250:
{{{syncgputhread|}}}
{{{syncgputhread|}}}
{{{altwiimotetiming|}}}
{{{altwiimotetiming|}}}
{{{boundingbox|}}}|
{{{boundingbox|}}}|===Game Properties===
===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
Line 306: Line 301:
{{{fpsforlimit|}}}
{{{fpsforlimit|}}}
{{{fpsforlimitnotes|}}}
{{{fpsforlimitnotes|}}}
{{{samplerate|}}}
{{{sampleratenotes|}}}
{{{cpuefbaccess|}}}
{{{cpuefbaccess|}}}
{{{hacks|}}}
{{{hacks|}}}

Revision as of 21:34, 11 April 2013

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