Template:Config: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
m (move cpu engine option to match dolphin's ordering)
No edit summary
 
(6 intermediate revisions by 4 users not shown)
Line 19: Line 19:
     {{{internalres|}}}
     {{{internalres|}}}
     {{{antialiasing|}}}
     {{{antialiasing|}}}
    {{{anisotropic|}}}
     {{{efbscaledcopy|}}}
     {{{efbscaledcopy|}}}
     {{{pixellighting|}}}
     {{{pixellighting|}}}
     {{{forcefilter|}}}
     {{{forcetexturefiltering|}}}
     {{{widescreenhack|}}}
     {{{widescreenhack|}}}
     {{{disablefog|}}}
     {{{disablefog|}}}
    {{{force24bit|}}}
     {{{arbmipmap|}}}
     {{{arbmipmap|}}}
     {{{skipcpuefbaccess|}}}
     {{{skipcpuefbaccess|}}}
Line 39: Line 39:
     {{{crop|}}}
     {{{crop|}}}
     {{{progressivescan|}}}
     {{{progressivescan|}}}
    {{{manualtexturesampling|}}}
     <!-- AUDIO -->
     <!-- AUDIO -->
     {{{dspengine|}}}
     {{{dspengine|}}}
Line 96: Line 97:
     {{{internalres|}}}
     {{{internalres|}}}
     {{{antialiasing|}}}
     {{{antialiasing|}}}
    {{{anisotropic|}}}
     {{{efbscaledcopy|}}}
     {{{efbscaledcopy|}}}
     {{{pixellighting|}}}
     {{{pixellighting|}}}
     {{{forcefilter|}}}
     {{{forcetexturefiltering|}}}
     {{{widescreenhack|}}}
     {{{widescreenhack|}}}
     {{{disablefog|}}}
     {{{disablefog|}}}
    {{{force24bit|}}}
     {{{arbmipmap|}}}
     {{{arbmipmap|}}}
     {{{skipcpuefbaccess|}}}
     {{{skipcpuefbaccess|}}}
Line 115: Line 116:
     {{{vertexrounding|}}}
     {{{vertexrounding|}}}
     {{{crop|}}}
     {{{crop|}}}
     {{{progressivescan|}}}|
     {{{progressivescan|}}}
    {{{manualtexturesampling|}}}|
     <h3> Graphics </h3>
     <h3> Graphics </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:{{{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|}}}}}
     {{#if:{{{gfxbackend|}}}|{{!}}[[Category:Video Backend (Config Required)]]{{Hover|Selects which graphical API interface should be used for display rendering (OpenGL, Direct3D 11, Direct3D 12, Vulkan, Metal, Software)|'''Video Backend'''}}{{!!}}{{{gfxbackend|}}}{{!!}}{{{gfxbackendnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{fullres|}}}|{{!}}[[Category:Fullscreen Resolution (Config Required)]]{{Hover|Selects what the monitor resolution should be set to for fullscreen mode.|'''Fullscreen Resolution'''}}{{!!}}{{{fullres|}}}{{!!}}{{{fullresnotes|}}}}}
     {{#if:{{{fullres|}}}|{{!}}[[Category:Fullscreen Resolution (Config Required)]]{{Hover|Selects what the monitor resolution should be set to for fullscreen mode.|'''Fullscreen Resolution'''}}{{!!}}{{{fullres|}}}{{!!}}{{{fullresnotes|}}}}}
Line 138: Line 140:
     {{#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|}}}|{{!}}[[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:{{{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|}}}|{{!}}[[Category:Anti-Aliasing (Config Required)]]{{Hover|Corrects aliasing along lines and edges (Many choices depending on Video Backend)|'''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:{{{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:{{{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|}}}}}
Line 146: Line 146:
     {{#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:{{{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|}}}|{{!}}[[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:{{{forcetexturefiltering|}}}|{{!}}[[Category:Texture Filtering (Config Required)]]{{Hover|Forces specific texture filtering method even if the game intentionally disables it (Default, Anisotropic, Force Nearest, Force Linear)|'''Texture Filtering'''|}}{{!!}}{{{forcetexturefiltering|}}}{{!!}}{{{forcetexturefilteringnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{widescreenhack|}}}|{{!}}[[Category:Widescreen Hack (Config Required)]]{{Hover|Force GameCube games to output graphics for widescreen resolutions (On, Off)|'''Widescreen Hack'''}}{{!!}}{{{widescreenhack|}}}{{!!}}{{{widescreenhacknotes|}}}}}
     {{#if:{{{widescreenhack|}}}|{{!}}[[Category:Widescreen Hack (Config Required)]]{{Hover|Force GameCube games to output graphics for widescreen resolutions (On, Off)|'''Widescreen Hack'''}}{{!!}}{{{widescreenhack|}}}{{!!}}{{{widescreenhacknotes|}}}}}
     {{!}}-
     {{!}}-
     {{#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:{{{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:{{{force24bit|}}}|{{!}}[[Category:Force 24-Bit Color (Config Required)]]{{Hover|Force the game to render the RGB color channels in 24-bit, thereby increasing quality by reducing color banding. (On, Off)|'''Force 24-Bit Color'''}}{{!!}}{{{force24bit|}}}{{!!}}{{{force24bitnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#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:{{{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|}}}}}
Line 174: Line 176:
     {{#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:{{{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:{{{vertexrounding|}}}|{{!}}[[Category:Vertex Rounding Hack (Config Required)]]{{Hover|Round 2d vertices to whole pixels (On, Off)|'''Vertex Rounding Hack'''}}{{!!}}{{{vertexrounding|}}}{{!!}}{{{vertexroundingnotes|}}}}}
     {{#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|}}}}}
     {{#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|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{progressivescan|}}}|{{!}}[[Category:Enable Progressive Scan (Config Required)]]{{Hover|Enables progressive scan if your game supports it (On, Off)|'''Enable Progressive Scan'''}}{{!!}}{{{progressivescan|}}}{{!!}}{{{progressivescannotes|}}}}}
     {{#if:{{{progressivescan|}}}|{{!}}[[Category:Enable Progressive Scan (Config Required)]]{{Hover|Enables progressive scan if your game supports it (On, Off)|'''Enable Progressive Scan'''}}{{!!}}{{{progressivescan|}}}{{!!}}{{{progressivescannotes|}}}}}
    {{!}}-
    {{#if:{{{manualtexturesampling|}}}|{{!}}[[Category:Manual Texture Sampling (Config Required)]]{{Hover|Use a manual implementation of texture sampling instead of the graphics backend's built-in functionality (On, Off)|'''Manual Texture Sampling'''}}{{!!}}{{{manualtexturesampling|}}}{{!!}}{{{manualtexturesamplingnotes|}}}}}
     {{!}}-
     {{!}}-
     {{!}}}
     {{!}}}
Line 190: Line 194:
     {{#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:{{{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:{{{audiobackend|}}}|{{!}}[[Category:Audio Back End (Config Required)]]{{Hover|Select the audio back-end API library (No Audio Output, Cubeb, XAudio2, OpenAL)|'''Audio Back End'''}}{{!!}}{{{audiobackend|}}}{{!!}}{{{audiobackendnotes|}}}}}
     {{#if:{{{audiobackend|}}}|{{!}}[[Category:Audio Backend (Config Required)]]{{Hover|Select the audio backend API library (ALSA, Cubeb, Pulse, WASAPI)|'''Audio Backend'''}}{{!!}}{{{audiobackend|}}}{{!!}}{{{audiobackendnotes|}}}}}
     {{!}}-
     {{!}}-
     {{!}}}
     {{!}}}
Line 350: Line 354:
     {{{ubershaders|}}}
     {{{ubershaders|}}}
     {{{ubershadersnotes|}}}
     {{{ubershadersnotes|}}}
    <!-- Since 5.0-4525 -->
    {{#regex:{{{audiobackend}}}|/OpenAL/}}
    <!-- Since 5.0-4901 -->
    {{#regex:{{{audiobackend}}}|/CoreAudio/}}
     <!-- Since 5.0-5874 -->
     <!-- Since 5.0-5874 -->
     {{{xfb|}}}
     {{{xfb|}}}
     {{{xfbnotes|}}}
     {{{xfbnotes|}}}
    <!-- Since 5.0-10950 -->
    {{#regex:{{{audiobackend}}}|/XAudio2/}}
    <!-- Since 5.0-18025 -->
    {{{anisotropic|}}}
    {{{anisotropicnotes|}}}
    {{{forcefilter|}}}
    {{{forcefilternotes|}}}
     |[[Category:Pages with deprecated config template parameters]]}}</includeonly><noinclude>{{documentation}}</noinclude>
     |[[Category:Pages with deprecated config template parameters]]}}</includeonly><noinclude>{{documentation}}</noinclude>

Latest revision as of 22:16, 29 January 2023

[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=183161"