Template:Config/sandbox: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
(Created page with "<includeonly>{{#if: <!-- GENERAL --> {{{dualcore|}}} {{{speedlimit|}}} {{{ntscj|}}} {{{panichandlers|}}} {{{skipbios|}}} {{{cpuengine|}}} {{{cp...")
 
mNo edit summary
 
(30 intermediate revisions by the same user not shown)
Line 3: Line 3:
     {{{dualcore|}}}
     {{{dualcore|}}}
     {{{speedlimit|}}}
     {{{speedlimit|}}}
    {{{ntscj|}}}
     {{{panichandlers|}}}
     {{{panichandlers|}}}
     {{{skipbios|}}}
     {{{skipbios|}}}
     {{{cpuengine|}}}
     {{{cpuengine|}}}
     {{{cpuclock|}}}
     {{{cpuclock|}}}
     <!-- GRAPHICS -->
     <!-- GRAPHICS > GENERAL -->
     {{{gfxbackend|}}}
     {{{gfxbackend|}}}
    {{{fullres|}}}
     {{{aspectratio|}}}
     {{{aspectratio|}}}
     {{{vsync|}}}
     {{{vsync|}}}
Line 17: Line 15:
     {{{shadercomp|}}}
     {{{shadercomp|}}}
     {{{compilefirst|}}}
     {{{compilefirst|}}}
    <!-- GRAPHICS > ENHANCEMENTS -->
     {{{internalres|}}}
     {{{internalres|}}}
     {{{antialiasing|}}}
     {{{antialiasing|}}}
Line 25: Line 24:
     {{{widescreenhack|}}}
     {{{widescreenhack|}}}
     {{{disablefog|}}}
     {{{disablefog|}}}
    {{{force24bit|}}}
     {{{arbmipmap|}}}
     {{{arbmipmap|}}}
    <!-- GRAPHICS > HACKS -->
     {{{skipcpuefbaccess|}}}
     {{{skipcpuefbaccess|}}}
     {{{formatchanges|}}}
     {{{formatchanges|}}}
Line 37: Line 38:
     {{{boundingbox|}}}
     {{{boundingbox|}}}
     {{{vertexrounding|}}}
     {{{vertexrounding|}}}
    <!-- GRAPHICS > ADVANCED -->
     {{{crop|}}}
     {{{crop|}}}
     {{{progressivescan|}}}
     {{{progressivescan|}}}
Line 56: Line 58:
     {{{fprf|}}}
     {{{fprf|}}}
     {{{syncgputhread|}}}
     {{{syncgputhread|}}}
     {{{fastdisc|}}}
     {{{fastdisc|}}}|
    {{{patches|}}}|
     Only configuration options for the best compatibility where they deviate from defaults are listed.
     Only configuration options for the best compatibility where they deviate from defaults are listed.
<!-- GENERAL -->{{#if:
<!-- GENERAL -->{{#vardefine:iniheader|}}{{#if:
    <!-- ini n/a -->
    {{{panichandlers|}}}
    {{{skipbios|}}}{{#if:
    <!-- Core -->
     {{{dualcore|}}}
     {{{dualcore|}}}
     {{{speedlimit|}}}
     {{{speedlimit|}}}
    {{{ntscj|}}}
    {{{panichandlers|}}}
    {{{skipbios|}}}
     {{{cpuengine|}}}
     {{{cpuengine|}}}
     {{{cpuclock|}}}|
     {{{cpuclock|}}}|{{#vardefineecho:iniheader|[Core]}}}}|
     <h3> General </h3>
     <h3> General </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
     !Configuration!!Setting!![[GameINI]] <span style="font-weight:normal;">{{#var:iniheader}}</span>!!Notes
     {{!}}-
     {{!}}-
     {{#if:{{{dualcore|}}}|{{Config required|Enable Dual Core|Creates two threads, one for graphics and one for CPU, allowing better use of more than one processor core (On, Off)|{{{dualcore|}}}}}{{{dualcorenotes|}}}}}
     {{#if:{{{dualcore|}}}|{{!}}Settings > General > {{Config required|Enable Dual Core|CPUThread|boolean|Creates two threads, one for graphics and one for CPU, allowing better use of more than one processor core|{{{dualcore|}}}}}{{{dualcorenotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{speedlimit|}}}|{{Config required|Speed Limit|Limits the speed of emulation (10-200% or Unlimited)|{{{speedlimit|}}}}}{{{speedlimitnotes|}}}}}
     {{#if:{{{speedlimit|}}}|{{!}}Settings > General > {{Config required|Speed Limit|EmulationSpeed|decimal|Limits the speed of emulation|{{{speedlimit|}}}|10-200% or Unlimited}}{{{speedlimitnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{ntscj|}}}|{{Config required|Force Console as NTSC-J|(On, Off)|{{{ntscj|}}}}}{{{ntscjnotes|}}}}}
     {{#if:{{{panichandlers|}}}|{{!}}Settings > Interface > {{Config required|Use Panic Handlers||boolean|Shows a pop-up when an error or a panic condition is encountered|{{{panichandlers|}}}}}{{{panichandlersnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{panichandlers|}}}|{{Config required|Use Panic Handlers|Shows a pop-up when an error or a panic condition is encountered (On, Off)|{{{panichandlers|}}}}}{{{panichandlersnotes|}}}}}
     {{#if:{{{skipbios|}}}|{{!}}Settings > GameCube > {{Config required|Skip GC BIOS||boolean|Skip loading of GameCube BIOS before booting the game when the IPL dumps are present on User\GC\|{{{skipbios|}}}}}{{{skipbiosnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{skipbios|}}}|{{Config required|Skip GC BIOS|Skip loading of GameCube BIOS before booting the game when the IPL dumps are present on User\GC (On, Off)|{{{skipbios|}}}}}{{{skipbiosnotes|}}}}}
     {{#if:{{{cpuengine|}}}|{{!}}Settings > Advanced > {{Config required|CPU Emulator Engine|CPUCore|string|Sets which CPU Emulator Engine should be used|{{{cpuengine|}}}|{{#vardefineecho:=|Interpreter=0, JIT x64=1, JIT ARM64=4, Cached Interpreter=5}}}}{{{cpuenginenotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{cpuengine|}}}|{{Config required|CPU Emulator Engine|Sets which CPU Emulator Engine should be used (Interpreter, Cached Interpreter, JIT)|{{{cpuengine|}}}}}{{{cpuenginenotes|}}}}}
     {{#if:{{{cpuclock|}}}|{{!}}Settings > Advanced > {{Config required|CPU Clock Override|Overclock|decimal|Sets the CPU clock speed|{{{cpuclock|}}}|6-400%}}{{{cpuclocknotes|}}}}}
    {{!}}-
    {{#if:{{{cpuclock|}}}|{{Config required|CPU Clock Override|Sets the CPU clock speed (6-400%)|{{{cpuclock|}}}}}{{{cpuclocknotes|}}}}}
     {{!}}-
     {{!}}-
     {{!}}}
     {{!}}}
}}<!-- GRAPHICS -->{{#if:
}}<!-- GRAPHICS -->{{#vardefine:iniheader|}}{{#if:
    <!-- ini n/a -->
    {{{startfull|}}}
    {{{rendertomain|}}}
    {{{crop|}}}{{#if:
    <!-- Core -->
    {{{progressivescan|}}}|{{#vardefineecho:iniheader|[Core]}}}}{{#if:
    <!-- Video_Settings -->
     {{{gfxbackend|}}}
     {{{gfxbackend|}}}
    {{{fullres|}}}
     {{{aspectratio|}}}
     {{{aspectratio|}}}
    {{{vsync|}}}
    {{{startfull|}}}
    {{{rendertomain|}}}
     {{{shadercomp|}}}
     {{{shadercomp|}}}
     {{{compilefirst|}}}
     {{{compilefirst|}}}|{{#vardefineecho:iniheader|{{#if:{{#var:iniheader}}|headings|[Video_Settings]}}}}}}{{#if:
    <!-- Video_Enhancements -->
     {{{internalres|}}}
     {{{internalres|}}}
     {{{antialiasing|}}}
     {{{antialiasing|}}}
Line 103: Line 107:
     {{{widescreenhack|}}}
     {{{widescreenhack|}}}
     {{{disablefog|}}}
     {{{disablefog|}}}
     {{{arbmipmap|}}}
    {{{force24bit|}}}
     {{{arbmipmap|}}}|{{#vardefineecho:iniheader|{{#if:{{#var:iniheader}}|headings|[Video_Enhancements]}}}}}}{{#if:
    <!-- Video_Hacks -->
     {{{skipcpuefbaccess|}}}
     {{{skipcpuefbaccess|}}}
     {{{formatchanges|}}}
     {{{formatchanges|}}}
Line 115: Line 121:
     {{{boundingbox|}}}
     {{{boundingbox|}}}
     {{{vertexrounding|}}}
     {{{vertexrounding|}}}
     {{{crop|}}}
     {{{manualtexturesampling|}}}|{{#vardefineecho:iniheader|{{#if:{{#var:iniheader}}|headings|[Video_Hacks]}}}}}}{{#if:
     {{{progressivescan|}}}
    <!-- Video_Hardware -->
    {{{manualtexturesampling|}}}|
     {{{vsync|}}}|{{#vardefineecho:iniheader|{{#if:{{#var:iniheader}}|headings|[Video_Hardware]}}}}}}|
     <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
     !Configuration!!Setting!!{{#ifeq:{{#var:iniheader}}|headings|<span style="font-weight:normal;">See '''[[GameINI]]''' for headings</span>|[[GameINI]] <span style="font-weight:normal;">{{#var:iniheader}}</span>}}!!Notes
     {{!}}-
     {{!}}-
     {{#if:{{{gfxbackend|}}}|{{Config required|Video Back End|Selects which graphical API interface should be used for display rendering (OpenGL, Direct3D11, Direct3D12, Vulkan, Software)|{{{gfxbackend|}}}}}{{{gfxbackendnotes|}}}}}
     {{#if:{{{gfxbackend|}}}|{{!}}Graphics > General > {{Config required|Video Back End|GFXBackend|string|Selects which graphical API interface should be used for display rendering|{{{gfxbackend|}}}|{{#vardefineecho:=|OpenGL=OGL, Direct3D11=D3D, Direct3D12=D3D12, Vulkan=Vulkan, Software=Software Renderer}}}}{{{gfxbackendnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{fullres|}}}|{{Config required|Fullscreen Resolution|Selects what the monitor resolution should be set to for fullscreen mode.|{{{fullres|}}}}}{{{fullresnotes|}}}}}
     {{#if:{{{aspectratio|}}}|{{!}}Graphics > General > {{Config required|Aspect Ratio|AspectRatio|string|Selects what aspect ratio the monitor should display the game in|{{{aspectratio|}}}|{{#vardefineecho:=|Auto=0, Force 16:9=1, Force 4:3=2, Stretch to Window=3}}}}{{{aspectrationotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{aspectratio|}}}|{{Config required|Aspect Ratio|Selects what aspect ratio the monitor should display the game in (Auto, Force 16:9, Force 4:3)|{{{aspectratio|}}}}}{{{aspectrationotes|}}}}}
     {{#if:{{{vsync|}}}|{{!}}Graphics > General > {{Config required|V-Sync|VSync|boolean|Synchronizes Dolphin's framerate with your monitor's refresh rate|{{{vsync|}}}}}{{{vsyncnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{vsync|}}}|{{Config required|V-Sync|Synchronizes Dolphin's framerate with your monitor's refresh rate (On, Off)|{{{vsync|}}}}}{{{vsyncnotes|}}}}}
     {{#if:{{{startfull|}}}|{{!}}Graphics > General > {{Config required|Use Fullscreen||boolean|Goes to fullscreen by default when a game is started|{{{startfull|}}}}}{{{startfullnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{startfull|}}}|{{Config required|Use Fullscreen|Goes to fullscreen by default when a game is started (On, Off)|{{{startfull|}}}}}{{{startfullnotes|}}}}}
     {{#if:{{{rendertomain|}}}|{{!}}Graphics > General > {{Config required|Render to Main Window||boolean|Displays games in the main window instead of a separate one|{{{rendertomain|}}}}}{{{rendertomainnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{rendertomain|}}}|{{Config required|Render to Main Window|Displays games in the main window instead of a separate one (On, Off)|{{{rendertomain|}}}}}{{{rendertomainnotes|}}}}}
     {{#if:{{{shadercomp|}}}|{{!}}Graphics > General > {{Config required|Shader Compilation|ShaderCompilationMode|string|Sets whether specialized shaders or ubershaders are used|{{{shadercomp|}}}|{{#vardefineecho:=|Synchronous=0, Synchronous (Ubershaders)=1, Asynchronous (Ubershaders)=2, Asynchronous (Skip Drawing)=3}}}}{{{shadercompnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{shadercomp|}}}|{{Config required|Shader Compilation|Sets whether specialized shaders or ubershaders are used (Synchronous, Synchronous (Ubershaders), Asynchronous (Ubershaders), Asynchronous (Skip Drawing))|{{{shadercomp|}}}}}{{{shadercompnotes|}}}}}
     {{#if:{{{compilefirst|}}}|{{!}}Graphics > General > {{Config required|Compile Shaders Before Starting|WaitForShadersBeforeStarting|boolean|Waits for all shaders to finish compiling before starting a game|{{{compilefirst|}}}}}{{{compilefirstnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{compilefirst|}}}|{{Config required|Compile Shaders Before Starting|Waits for all shaders to finish compiling before starting a game (On, Off)|{{{compilefirst|}}}}}{{{compilefirstnotes|}}}}}
     {{#if:{{{internalres|}}}|{{!}}Graphics > Enhancements > {{Config required|Internal Resolution|InternalResolution|string|Sets the resolution the game will be rendered at behind-the-scenes (Multiple of 640x528)|{{{internalres|}}}|{{#vardefineecho:=|1x=0, 1.5x=0, 2x=1, 2.5x=1, 3x=2, 4x=3}}}}{{{internalresnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{internalres|}}}|{{Config required|Internal Resolution|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)|{{{internalres|}}}}}{{{internalresnotes|}}}}}
     {{#if:{{{antialiasing|}}}|{{!}}Graphics > Enhancements > {{Config required|Anti-Aliasing|MSAA|string|Corrects aliasing along lines and edges (Many choices depending on Video Back End)|{{{antialiasing|}}}|{{#vardefineecho:=|None=0, Non-SSAA=0</code> or <code>SSAA = False, 2x MSAA=2</code><br><code>SSAA = False, 4x MSAA=4</code><br><code>SSAA = False, 8x MSAA=8</code><br><code>SSAA = False, 2x SSAA=2</code><br><code>SSAA = True, 4x SSAA=4</code><br><code>SSAA = True, 8x SSAA=8</code><br><code>SSAA = True}}}}{{{antialiasingnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{antialiasing|}}}|{{Config required|Anti-Aliasing|Corrects aliasing along lines and edges (Many choices depending on Video Back End)|{{{antialiasing|}}}}}{{{antialiasingnotes|}}}}}
     {{#if:{{{anisotropic|}}}|{{!}}Graphics > Enhancements > {{Config required|Anisotropic Filtering|MaxAnisotropy|string|Reduces distortion when viewing textures at an angle|{{{anisotropic|}}}|{{#vardefineecho:=|1x=0, 2x=1, 4x=2, 8x=3, 16x=4}}}}{{{anisotropicnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{anisotropic|}}}|{{Config required|Anisotropic Filtering|Reduces distortion when viewing textures at an angle (1x, 2x, 4x, 8x, 16x)|{{{anisotropic|}}}}}{{{anisotropicnotes|}}}}}
     {{#if:{{{efbscaledcopy|}}}|{{!}}Graphics > Enhancements > {{Config required|Scaled EFB Copy|EFBScaledCopy|boolean|Greatly increase the quality of textures generated using render-to-texture effects|{{{efbscaledcopy|}}}}}{{{efbscaledcopynotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{efbscaledcopy|}}}|{{Config required|Scaled EFB Copy|Greatly increase the quality of textures generated using render-to-texture effects (On, Off)|{{{efbscaledcopy|}}}}}{{{efbscaledcopynotes|}}}}}
     {{#if:{{{pixellighting|}}}|{{!}}Graphics > Enhancements > {{Config required|Per-Pixel Lighting|EnablePixelLighting|boolean|Calculate lighting of 3D graphics per-pixel rather than per-vertex|{{{pixellighting|}}}}}{{{pixellightingnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{pixellighting|}}}|{{Config required|Per-Pixel Lighting|Calculate lighting of 3D graphics per-pixel rather than per-vertex (On, Off)|{{{pixellighting|}}}}}{{{pixellightingnotes|}}}}}
     {{#if:{{{forcefilter|}}}|{{!}}Graphics > Enhancements > {{Config required|Force Texture Filtering|ForceFiltering|boolean|Forces texture filtering even if the game specifically disables it|{{{forcefilter|}}}}}{{{forcefilternotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{forcefilter|}}}|{{Config required|Force Texture Filtering|Forces texture filtering even if the game specifically disables it (On, Off)|{{{forcefilter|}}}}}{{{forcefilternotes|}}}}}
     {{#if:{{{widescreenhack|}}}|{{!}}Graphics > Enhancements > {{Config required|Widescreen Hack|wideScreenHack|boolean|Force GameCube games to output graphics for widescreen resolutions|{{{widescreenhack|}}}}}{{{widescreenhacknotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{widescreenhack|}}}|{{Config required|Widescreen Hack|Force GameCube games to output graphics for widescreen resolutions (On, Off)|{{{widescreenhack|}}}}}{{{widescreenhacknotes|}}}}}
     {{#if:{{{disablefog|}}}|{{!}}Graphics > Enhancements > {{Config required|Disable Fog|DisableFog|boolean|Disables the fog used in some games to hide far-away objects|{{{disablefog|}}}}}{{{disablefognotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{disablefog|}}}|{{Config required|Disable Fog|Disables the fog used in some games to hide far-away objects (On, Off)|{{{disablefog|}}}}}{{{disablefognotes|}}}}}
     {{#if:{{{force24bit|}}}|{{!}}Graphics > Enhancements > {{Config required|Force 24-Bit Color|ForceTrueColor|boolean|Force the game to render the RGB color channels in 24-bit, thereby increasing quality by reducing color banding.|{{{force24bit|}}}}}{{{force24bitnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{arbmipmap|}}}|{{Config required|Arbitrary Mipmap Detection|Enables detection of arbitrary mipmaps, which some games use for special distance-based effects (On, Off)|{{{arbmipmap|}}}}}{{{arbmipmapnotes|}}}}}
     {{#if:{{{arbmipmap|}}}|{{!}}Graphics > Enhancements > {{Config required|Arbitrary Mipmap Detection|ArbitraryMipmapDetection|boolean|Enables detection of arbitrary mipmaps, which some games use for special distance-based effects|{{{arbmipmap|}}}}}{{{arbmipmapnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{skipcpuefbaccess|}}}|{{Config required|Skip EFB Access from CPU|Prevents the CPU from accessing the External Frame Buffer (On, Off)|{{{skipcpuefbaccess|}}}}}{{{skipcpuefbaccessnotes|}}}}}
     {{#if:{{{skipcpuefbaccess|}}}|{{!}}Graphics > Hacks > {{Config required|Skip EFB Access from CPU|EFBAccessEnable|string|Prevents the CPU from accessing the External Frame Buffer|{{{skipcpuefbaccess|}}}|{{#vardefineecho:=|On=False, Off=True}}}}{{{skipcpuefbaccessnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{formatchanges|}}}|{{Config required|Ignore Format Changes|Ignore any changes to the External Frame Buffer format (On, Off)|{{{formatchanges|}}}}}{{{formatchangesnotes|}}}}}
     {{#if:{{{formatchanges|}}}|{{!}}Graphics > Hacks > {{Config required|Ignore Format Changes|EFBEmulateFormatChanges|string|Ignore any changes to the External Frame Buffer format|{{{formatchanges|}}}|{{#vardefineecho:=|On=False, Off=True}}}}{{{formatchangesnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{efb2texonly|}}}|{{Config required|Store EFB Copies to Texture Only|Stores EFB Copies exclusively on the GPU, bypassing system memory (On, Off)|{{{efb2texonly|}}}}}{{{efb2texonlynotes|}}}}}
     {{#if:{{{efb2texonly|}}}|{{!}}Graphics > Hacks > {{Config required|Store EFB Copies to Texture Only|EFBToTextureEnable|boolean|Stores EFB Copies exclusively on the GPU, bypassing system memory|{{{efb2texonly|}}}}}{{{efb2texonlynotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{deferefb|}}}|{{Config required|Defer EFB Copies to RAM|Wait to store EFB Copies providing performance improvements (On, Off)|{{{deferefb|}}}}}{{{deferefbnotes|}}}}}
     {{#if:{{{deferefb|}}}|{{!}}Graphics > Hacks > {{Config required|Defer EFB Copies to RAM|DeferEFBCopies|boolean|Wait to store EFB Copies providing performance improvements|{{{deferefb|}}}}}{{{deferefbnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{accuratetexturecache|}}}|{{Config required|Texture Cache Accuracy|(Position 1 (Safe), Position 2 (Medium), Position 3 (Fast))|{{{accuratetexturecache|}}}}}{{{accuratetexturecachenotes|}}}}}
     {{#if:{{{accuratetexturecache|}}}|{{!}}Graphics > Hacks > {{Config required|Texture Cache Accuracy|SafeTextureCacheColorSamples|string||{{{accuratetexturecache|}}}|{{#vardefineecho:=|Position 1 (Safe)=0, Position 2 (Medium)=512, Position 3 (Fast)=128}}}}{{{accuratetexturecachenotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{gputexdecode|}}}|{{Config required|GPU Texture Decoding|Enables texture decoding using the GPU instead of the CPU (On, Off)|{{{gputexdecode|}}}}}{{{gputexdecodenotes|}}}}}
     {{#if:{{{gputexdecode|}}}|{{!}}Graphics > Hacks > {{Config required|GPU Texture Decoding|EnableGPUTextureDecoding|boolean|Enables texture decoding using the GPU instead of the CPU|{{{gputexdecode|}}}}}{{{gputexdecodenotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{xfb2texonly|}}}|{{Config required|Store XFB Copies to Texture Only|Stores XFB Copies exclusively on the GPU, bypassing system memory (On, Off)|{{{xfb2texonly|}}}}}{{{xfb2texonlynotes|}}}}}
     {{#if:{{{xfb2texonly|}}}|{{!}}Graphics > Hacks > {{Config required|Store XFB Copies to Texture Only|XFBToTextureEnable|boolean|Stores XFB Copies exclusively on the GPU, bypassing system memory|{{{xfb2texonly|}}}}}{{{xfb2texonlynotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{xfbimmediate|}}}|{{Config required|Immediately Present XFB|Displays the XFB Copies as soon as they are created, without waiting for scanout (On, Off)|{{{xfbimmediate|}}}}}{{{xfbimmediatenotes|}}}}}
     {{#if:{{{xfbimmediate|}}}|{{!}}Graphics > Hacks > {{Config required|Immediately Present XFB|ImmediateXFBenable|boolean|Displays the XFB Copies as soon as they are created, without waiting for scanout|{{{xfbimmediate|}}}}}{{{xfbimmediatenotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{fastdepth|}}}|{{Config required|Fast Depth Calculation|Uses a less accurate method of depth calculation for a speedup (On, Off)|{{{fastdepth|}}}}}{{{fastdepthnotes|}}}}}
     {{#if:{{{fastdepth|}}}|{{!}}Graphics > Hacks > {{Config required|Fast Depth Calculation|FastDepthCalc|boolean|Uses a less accurate method of depth calculation for a speedup|{{{fastdepth|}}}}}{{{fastdepthnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{boundingbox|}}}|{{Config required|Disable Bounding Box|Disables a niche GC/Wii GPU feature for a speedup. A very small number of games will break with this. (On/Off)|{{{boundingbox|}}}}}{{{boundingboxnotes|}}}}}
     {{#if:{{{boundingbox|}}}|{{!}}Graphics > Hacks > {{Config required|Disable Bounding Box|BBoxEnable|boolean|Disables a niche GC/Wii GPU feature for a speedup. A very small number of games will break with this.|{{{boundingbox|}}}}}{{{boundingboxnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{vertexrounding|}}}|{{Config required|Vertex Rounding Hack|Round 2D vertices to whole pixels (On, Off)|{{{vertexrounding|}}}}}{{{vertexroundingnotes|}}}}}
     {{#if:{{{vertexrounding|}}}|{{!}}Graphics > Hacks > {{Config required|Vertex Rounding Hack|VertexRounding|boolean|Round 2D vertices to whole pixels|{{{vertexrounding|}}}}}{{{vertexroundingnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{crop|}}}|{{Config required|Crop|Crop the picture from it's native aspect ratio to 4:3 or 16:9. (On, Off)|{{{crop|}}}}}{{{cropnotes|}}}}}
     {{#if:{{{crop|}}}|{{!}}Graphics > Advanced > {{Config required|Crop||boolean|Crop the picture from it's native aspect ratio to 4:3 or 16:9.|{{{crop|}}}}}{{{cropnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{progressivescan|}}}|{{Config required|Enable Progressive Scan|Enables progressive scan if your game supports it (On, Off)|{{{progressivescan|}}}}}{{{progressivescannotes|}}}}}
     {{#if:{{{progressivescan|}}}|{{!}}Graphics > Advanced > {{Config required|Enable Progressive Scan|ProgressiveScan|boolean|Enables progressive scan if your game supports it|{{{progressivescan|}}}}}{{{progressivescannotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{manualtexturesampling|}}}|{{Config required|Manual Texture Sampling|Use a manual implementation of texture sampling instead of the graphics backend's built-in functionality (On, Off)|{{{manualtexturesampling|}}}}}{{{manualtexturesamplingnotes|}}}}}
     {{#if:{{{manualtexturesampling|}}}|{{!}}Graphics > Advanced > {{Config required|Manual Texture Sampling|FastTextureSampling|string|Use a manual implementation of texture sampling instead of the graphics backend's built-in functionality|{{{manualtexturesampling|}}}|{{#vardefineecho:=|On=False, Off=True}}}}{{{manualtexturesamplingnotes|}}}}}
     {{!}}-
     {{!}}-
     {{!}}}
     {{!}}}
}}<!-- AUDIO -->{{#if:
}}<!-- AUDIO -->{{#vardefine:iniheader|}}{{#if:
     {{{dspengine|}}}
     {{{dspengine|}}}
     {{{audiobackend|}}}|
     {{{audiobackend|}}}|
     <h3> Audio </h3>
     <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
     !Configuration!!Setting!![[GameINI]] <span style="font-weight:normal;">[DSP]</span>!!Notes
     {{!}}-
     {{!}}-
     {{#if:{{{dspengine|}}}|{{Config required|DSP Emulator Engine|Use High-Level audio Emulation (HLE) or Low-Level audio Emulation (LLE); LLE audio emulation is more accurate, but uses more CPU power|{{{dspengine|}}}}}{{{dspenginenotes|}}}}}
     {{#if:{{{dspengine|}}}|{{!}}Settings > Audio > {{Config required|DSP Emulator Engine|EnableJIT|string|Use High-Level audio Emulation or Low-Level audio Emulation; LLE audio emulation is more accurate, but uses more CPU power|{{{dspengine|}}}|{{#vardefineecho:=|HLE=True, LLE=False}}}}{{{dspenginenotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{audiobackend|}}}|{{Config required|Audio Back End|Select the audio back-end API library (No Audio Output, Cubeb, OpenAL)|{{{audiobackend|}}}}}{{{audiobackendnotes|}}}}}
     {{#if:{{{audiobackend|}}}|{{!}}Settings > Audio > {{Config required|Audio Back End|Backend|string|Select the audio back-end API library|{{{audiobackend|}}}|{{#vardefineecho:=|No Audio Output=No audio output, Cubeb=Cubeb, OpenAL=OpenAL}}}}{{{audiobackendnotes|}}}}}
     {{!}}-
     {{!}}-
     {{!}}}
     {{!}}}
}}<!-- WII -->{{#if:
}}<!-- WII -->{{#vardefine:iniheader|}}{{#if:
    <!-- ini n/a -->
    {{{screensaver|}}}
    {{{usbkeyboard|}}}{{#if:
    <!-- Core -->
     {{{pal60|}}}
     {{{pal60|}}}
     {{{screensaver|}}}
     {{{sdcard|}}}|{{#vardefineecho:iniheader|[Core]}}}}{{#if:
    {{{sdcard|}}}
    <!-- Wii -->
     {{{usbkeyboard|}}}
     {{{systemlang|}}}|{{#vardefineecho:iniheader|{{#if:{{#var:iniheader}}|headings|[Wii]}}}}}}|
    {{{systemlang|}}}|
     <h3> Wii </h3>
     <h3> Wii </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
     !Configuration!!Setting!!{{#ifeq:{{#var:iniheader}}|headings|<span style="font-weight:normal;">See '''[[GameINI]]''' for headings</span>|[[GameINI]] <span style="font-weight:normal;">{{#var:iniheader}}</span>}}!!Notes
     {{!}}-
     {{!}}-
     {{#if:{{{pal60|}}}|{{Config required|Use PAL60 Mode (EuRGB60)|(On, Off)|{{{pal60|}}}}}{{{pal60notes|}}}}}
     {{#if:{{{pal60|}}}|{{!}}Settings > Wii > {{Config required|Use PAL60 Mode (EuRGB60)|PAL60|boolean||{{{pal60|}}}}}{{{pal60notes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{screensaver|}}}|{{Config required|Enable Screen Saver|(On, Off)|{{{screensaver|}}}}}{{{screensavernotes|}}}}}
     {{#if:{{{screensaver|}}}|{{!}}Settings > Wii > {{Config required|Enable Screen Saver||boolean||{{{screensaver|}}}}}{{{screensavernotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{sdcard|}}}|{{Config required|Insert SD Card|(On, Off)|{{{sdcard|}}}}}{{{sdcardnotes|}}}}}
     {{#if:{{{sdcard|}}}|{{!}}Settings > Wii > {{Config required|Insert SD Card|WiiSDCard|boolean||{{{sdcard|}}}}}{{{sdcardnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{usbkeyboard|}}}|{{Config required|Connect USB Keyboard|(On, Off)|{{{usbkeyboard|}}}}}{{{usbkeyboardnotes|}}}}}
     {{#if:{{{usbkeyboard|}}}|{{!}}Settings > Wii > {{Config required|Connect USB Keyboard||boolean||{{{usbkeyboard|}}}}}{{{usbkeyboardnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{systemlang|}}}|{{Config required|System Language|(Japanese, English, German, French, Spanish, Italian, Dutch, Simplified Chinese, Traditional Chinese, Korean)|{{{systemlang|}}}}}{{{systemlangnotes|}}}}}
     {{#if:{{{systemlang|}}}|{{!}}Settings > Wii > {{Config required|System Language|Language|string||{{{systemlang|}}}|{{#vardefineecho:=|Japanese=0, English=1, German=2, French=3, Spanish=4, Italian=5, Dutch=6, Simplified Chinese=7, Traditional Chinese=8, Korean=9}}}}{{{systemlangnotes|}}}}}
     {{!}}-
     {{!}}-
     {{!}}}
     {{!}}}
}}<!-- WII REMOTE -->{{#if:
}}<!-- WII REMOTE -->{{#vardefine:iniheader|}}{{#if:
    <!-- ini n/a -->
     {{{enablespeakerdata|}}}
     {{{enablespeakerdata|}}}
     {{{wiimotemotor|}}}|
     {{{wiimotemotor|}}}|
     <h3> Wii Remote </h3>
     <h3> Wii Remote </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
     !Configuration!!Setting!![[GameINI]] <span style="font-weight:normal;">{{#var:iniheader}}</span>!!Notes
     {{!}}-
     {{!}}-
     {{#if:{{{enablespeakerdata|}}}|{{Config required|Enable Speaker Data|Controls if sounds come from the Wii Remote speaker of Real Wii Remotes (On, Off)|{{{enablespeakerdata|}}}}}{{{enablespeakerdatanotes|}}}}}
     {{#if:{{{enablespeakerdata|}}}|{{!}}Controllers > {{Config required|Enable Speaker Data||boolean|Controls if sounds come from the Wii Remote speaker of Real Wii Remotes|{{{enablespeakerdata|}}}}}{{{enablespeakerdatanotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{wiimotemotor|}}}|{{Config required|Wii Remote Motor|(On, Off)|{{{wiimotemotor|}}}}}{{{wiimotemotornotes|}}}}}
     {{#if:{{{wiimotemotor|}}}|{{!}}Controllers > {{Config required|Wii Remote Motor||boolean||{{{wiimotemotor|}}}}}{{{wiimotemotornotes|}}}}}
     {{!}}-
     {{!}}-
     {{!}}}
     {{!}}}
}}<!-- GAME PROPERTIES -->{{#if:
}}<!-- GAME PROPERTIES -->{{#if:{{#if:
    <!-- Core -->
     {{{mmu|}}}
     {{{mmu|}}}
     {{{fprf|}}}
     {{{fprf|}}}
     {{{syncgputhread|}}}
     {{{syncgputhread|}}}
     {{{fastdisc|}}}
     {{{fastdisc|}}}|{{#vardefineecho:iniheader|[Core]}}}}|
    {{{patches|}}}|
     <h3> Game Properties </h3>
     <h3> Game Properties </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
     !Configuration!!Setting!![[GameINI]] <span style="font-weight:normal;">{{#var:iniheader}}</span>!!Notes
     {{!}}-
     {{!}}-
     {{#if:{{{mmu|}}}|{{Config required|Enable MMU|Enable Memory Management Unit (On, Off)|{{{mmu|}}}}}{{{mmunotes|}}}}}
     {{#if:{{{mmu|}}}|{{!}}Properties > General > {{Config required|Enable MMU|MMU|boolean|Enable Memory Management Unit|{{{mmu|}}}}}{{{mmunotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{fprf|}}}|{{Config required|Enable FPRF|Floating Point Result Flag support (On, Off)|{{{fprf|}}}}}{{{fprfnotes|}}}}}
     {{#if:{{{fprf|}}}|{{!}}Properties > General > {{Config required|Enable FPRF|FPRF|boolean|Floating Point Result Flag support|{{{fprf|}}}}}{{{fprfnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{syncgputhread|}}}|{{Config required|Synchronize GPU Thread|Synchronizes CPU and GPU threads, allowing dual core to work in games where it has problems otherwise (On, Off)|{{{syncgputhread|}}}}}{{{syncgputhreadnotes|}}}}}
     {{#if:{{{syncgputhread|}}}|{{!}}Properties > General > {{Config required|Synchronize GPU Thread|SyncGPU|boolean|Synchronizes CPU and GPU threads, allowing dual core to work in games where it has problems otherwise|{{{syncgputhread|}}}}}{{{syncgputhreadnotes|}}}}}
     {{!}}-
     {{!}}-
     {{#if:{{{fastdisc|}}}|{{Config required|Speed up Disc Transfer Rate|Enables fast disc access (On, Off)|{{{fastdisc|}}}}}{{{fastdiscnotes|}}}}}
     {{#if:{{{fastdisc|}}}|{{!}}Properties > General > {{Config required|Speed up Disc Transfer Rate|FastDiscSpeed|boolean|Enables fast disc access|{{{fastdisc|}}}}}{{{fastdiscnotes|}}}}}
    {{!}}-
    {{#if:{{{patches|}}}|{{Config required|Patches|Patching required|{{{patches|}}}}}{{{patchesnotes|}}}}}
     {{!}}-
     {{!}}-
     {{!}}}
     {{!}}}
Line 352: Line 360:
     {{{framelimitnotes|}}}
     {{{framelimitnotes|}}}
     {{#regex:{{{cpuengine}}}|/.*[iI][lL].*/}}
     {{#regex:{{{cpuengine}}}|/.*[iI][lL].*/}}
    {{{ntscj|}}}
     {{{ubershaders|}}}
     {{{ubershaders|}}}
     {{{ubershadersnotes|}}}
     {{{ubershadersnotes|}}}

Latest revision as of 05:03, 14 February 2022

[edit] [purge] Template documentation

This template outputs a standardized set of configuration information.

Features

New features in this sandbox version:

Issues

  • Requires {{#vardefineecho:=|setting=gameini}} for all string-based settings for using equal signs.
  • String-based settings need empty equation when ini isn't available.
  • Those using decimal will accept "Unlimited" as input.

Example

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

Produces

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

General

Configuration Setting GameINI [Core] Notes
Settings > General > Enable Dual Core Off CPUThread = False Show File Select menus properly

Full preview

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

General

Configuration Setting GameINI [Core] Notes
Settings > General > Enable Dual Core On CPUThread = True Boolean
Settings > General > Speed Limit 100% EmulationSpeed = 1 Decimal
Settings > Interface > Use Panic Handlers On Boolean
Settings > GameCube > Skip GC BIOS On Boolean
Settings > Advanced > CPU Emulator Engine JIT x64 CPUCore = 1 String
Settings > Advanced > CPU Clock Override 100% Overclock = 1 Decimal

Graphics

Configuration Setting See GameINI for headings Notes
Graphics > General > Video Back End OpenGL GFXBackend = OGL String
Graphics > General > Aspect Ratio Auto AspectRatio = 0 String
Graphics > General > V-Sync On VSync = True Boolean
Graphics > General > Use Fullscreen On Boolean
Graphics > General > Render to Main Window On Boolean
Graphics > General > Shader Compilation Synchronous ShaderCompilationMode = 0 String
Graphics > General > Compile Shaders Before Starting On WaitForShadersBeforeStarting = True Boolean
Graphics > Enhancements > Internal Resolution 1x InternalResolution = 0 String
Graphics > Enhancements > Anti-Aliasing 4x SSAA MSAA = 4
SSAA = True
String
Graphics > Enhancements > Anisotropic Filtering 1x MaxAnisotropy = 0 String
Graphics > Enhancements > Scaled EFB Copy On EFBScaledCopy = True Boolean
Graphics > Enhancements > Per-Pixel Lighting On EnablePixelLighting = True Boolean
Graphics > Enhancements > Force Texture Filtering On ForceFiltering = True Boolean
Graphics > Enhancements > Widescreen Hack On wideScreenHack = True Boolean
Graphics > Enhancements > Disable Fog On DisableFog = True Boolean
Graphics > Enhancements > Force 24-Bit Color On ForceTrueColor = True Boolean
Graphics > Enhancements > Arbitrary Mipmap Detection On ArbitraryMipmapDetection = True Boolean
Graphics > Hacks > Skip EFB Access from CPU On EFBAccessEnable = False String
Graphics > Hacks > Ignore Format Changes On EFBEmulateFormatChanges = False String
Graphics > Hacks > Store EFB Copies to Texture Only On EFBToTextureEnable = True Boolean
Graphics > Hacks > Defer EFB Copies to RAM On DeferEFBCopies = True Boolean
Graphics > Hacks > Texture Cache Accuracy Position 3 (Fast) SafeTextureCacheColorSamples = 128 String
Graphics > Hacks > GPU Texture Decoding On EnableGPUTextureDecoding = True Boolean
Graphics > Hacks > Store XFB Copies to Texture Only On XFBToTextureEnable = True Boolean
Graphics > Hacks > Immediately Present XFB On ImmediateXFBenable = True Boolean
Graphics > Hacks > Fast Depth Calculation On FastDepthCalc = True Boolean
Graphics > Hacks > Disable Bounding Box On BBoxEnable = True Boolean
Graphics > Hacks > Vertex Rounding Hack On VertexRounding = True Boolean
Graphics > Advanced > Crop On Boolean
Graphics > Advanced > Enable Progressive Scan On ProgressiveScan = True Boolean
Graphics > Advanced > Manual Texture Sampling On FastTextureSampling = False String

Audio

Configuration Setting GameINI [DSP] Notes
Settings > Audio > DSP Emulator Engine HLE EnableJIT = True String
Settings > Audio > Audio Back End Cubeb Backend = Cubeb String

Wii

Configuration Setting See GameINI for headings Notes
Settings > Wii > Use PAL60 Mode (EuRGB60) On PAL60 = True Boolean
Settings > Wii > Enable Screen Saver On Boolean
Settings > Wii > Insert SD Card On WiiSDCard = True Boolean
Settings > Wii > Connect USB Keyboard On Boolean
Settings > Wii > System Language English Language = 1 String

Wii Remote

Configuration Setting GameINI Notes
Controllers > Enable Speaker Data On Boolean
Controllers > Wii Remote Motor On Boolean

Game Properties

Configuration Setting GameINI [Core] Notes
Properties > General > Enable MMU On MMU = True Boolean
Properties > General > Enable FPRF On FPRF = True Boolean
Properties > General > Synchronize GPU Thread On SyncGPU = True Boolean
Properties > General > Speed up Disc Transfer Rate On FastDiscSpeed = True Boolean