Progress Continues
We've already had 21455 updates since Dolphin 5.0. Keep up with Dolphin's continuing progress through the Dolphin Blog: August, September, and October 2023 Progress Report.
User-info.png The Dolphin Emulator Wiki needs your help!
Dolphin can play thousands of games, and changes are happening all the time. Help us keep up! Join in and help us make this the best resource for Dolphin.

Template:Config/sandbox: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 63: Line 63:
     {{{patches|}}}|
     {{{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:
    {{{ntscj|}}}
    {{{panichandlers|}}}
    {{{skipbios|}}}{{#if:
     {{{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"
     !Configuration!!Setting!![[GameINI]] <span style="font-weight:normal;">[Core]</span>!!Notes
     !Configuration!!Setting!![[GameINI]] <span style="font-weight:normal;">{{#var:iniheader}}</span>!!Notes
     {{!}}-
     {{!}}-
     {{#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:{{{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|}}}}}
Line 90: Line 90:
     {{!}}-
     {{!}}-
     {{!}}}
     {{!}}}
}}<!-- GRAPHICS -->{{#if:{{#if:
}}<!-- GRAPHICS -->{{#vardefine:iniheader|}}{{#if:
    <!-- ini n/a -->
    {{{fullres|}}}
    {{{startfull|}}}
    {{{rendertomain|}}}
    {{{crop|}}}{{#if:
     <!-- Core -->
     <!-- Core -->
    {{{crop|}}}
     {{{progressivescan|}}}|{{#vardefineecho:iniheader|[Core]}}}}{{#if:
     {{{progressivescan|}}}|{{#vardefineecho:iniheader|[Core]}}}}{{#if:
     <!-- Video_Settings -->
     <!-- Video_Settings -->
     {{{gfxbackend|}}}
     {{{gfxbackend|}}}
    {{{fullres|}}}
     {{{aspectratio|}}}
     {{{aspectratio|}}}
    {{{startfull|}}}
    {{{rendertomain|}}}
     {{{shadercomp|}}}
     {{{shadercomp|}}}
     {{{compilefirst|}}}|{{#vardefineecho:iniheader|{{#if:{{#var:iniheader}}|headings|[Video_Settings]}}}}}}{{#if:
     {{{compilefirst|}}}|{{#vardefineecho:iniheader|{{#if:{{#var:iniheader}}|headings|[Video_Settings]}}}}}}{{#if:
Line 130: Line 131:
     <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"
     !Configuration!!Setting!!{{#ifeq:{{#var:iniheader}}|headings|<span style="font-weight:normal;">See</span> [[GameINI]] <span style="font-weight:normal;">for headings</span>|[[GameINI]] <span style="font-weight:normal;">{{#var:iniheader}}</span>}}!!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|}}}|{{!}}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:{{{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|}}}}}
Line 172: Line 173:
     {{#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:{{{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|}}}|{{!}}Graphics > Hacks > {{Config required|Store EFB Copies to Texture Only||boolean|Stores EFB Copies exclusively on the GPU, bypassing system memory|{{{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|}}}|{{!}}Graphics > Hacks > {{Config required|Defer EFB Copies to RAM||boolean|Wait to store EFB Copies providing performance improvements|{{{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|}}}|{{!}}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:{{{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|}}}}}
Line 180: Line 181:
     {{#if:{{{gputexdecode|}}}|{{!}}Graphics > Hacks > {{Config required|GPU Texture Decoding|EnableGPUTextureDecoding|boolean|Enables texture decoding using the GPU instead of the CPU|{{{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|}}}|{{!}}Graphics > Hacks > {{Config required|Store XFB Copies to Texture Only||boolean|Stores XFB Copies exclusively on the GPU, bypassing system memory|{{{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|}}}|{{!}}Graphics > Hacks > {{Config required|Immediately Present XFB||boolean|Displays the XFB Copies as soon as they are created, without waiting for scanout|{{{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|}}}|{{!}}Graphics > Hacks > {{Config required|Fast Depth Calculation|FastDepthCalc|boolean|Uses a less accurate method of depth calculation for a speedup|{{{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|}}}}}
Line 197: Line 198:
     {{!}}-
     {{!}}-
     {{!}}}
     {{!}}}
}}<!-- AUDIO -->{{#if:
}}<!-- AUDIO -->{{#vardefine:iniheader|}}{{#if:
     {{{dspengine|}}}
     {{{dspengine|}}}
     {{{audiobackend|}}}|
     {{{audiobackend|}}}|
Line 209: Line 210:
     {{!}}-
     {{!}}-
     {{!}}}
     {{!}}}
}}<!-- WII -->{{#if:
}}<!-- WII -->{{#vardefine:iniheader|}}{{#if:
    <!-- ini n/a -->
     {{{pal60|}}}
     {{{pal60|}}}
     {{{screensaver|}}}
     {{{screensaver|}}}
     {{{sdcard|}}}
     {{{sdcard|}}}
     {{{usbkeyboard|}}}
     {{{usbkeyboard|}}}{{#if:
     {{{systemlang|}}}|
    <!-- Wii -->
     {{{systemlang|}}}|{{#vardefineecho:iniheader|[Wii]}}}}|
     <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"
     !Configuration!!Setting!![[GameINI]] <span style="font-weight:normal;">[Wii]</span>!!Notes
     !Configuration!!Setting!![[GameINI]] <span style="font-weight:normal;">{{#var:iniheader}}</span>!!Notes
     {{!}}-
     {{!}}-
     {{#if:{{{pal60|}}}|{{!}}Settings > Wii > {{Config required|Use PAL60 Mode (EuRGB60)||boolean||{{{pal60|}}}}}{{{pal60notes|}}}}}
     {{#if:{{{pal60|}}}|{{!}}Settings > Wii > {{Config required|Use PAL60 Mode (EuRGB60)||boolean||{{{pal60|}}}}}{{{pal60notes|}}}}}
Line 230: Line 233:
     {{!}}-
     {{!}}-
     {{!}}}
     {{!}}}
}}<!-- 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"
     !Configuration!!Setting!![[GameINI]] <span style="font-weight:normal;">[Controls]</span>!!Notes
     !Configuration!!Setting!![[GameINI]] <span style="font-weight:normal;">{{#var:iniheader}}</span>!!Notes
     {{!}}-
     {{!}}-
     {{#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:{{{enablespeakerdata|}}}|{{!}}Controllers > {{Config required|Enable Speaker Data||boolean|Controls if sounds come from the Wii Remote speaker of Real Wii Remotes|{{{enablespeakerdata|}}}}}{{{enablespeakerdatanotes|}}}}}
Line 243: Line 247:
     {{!}}}
     {{!}}}
}}<!-- GAME PROPERTIES -->{{#if:
}}<!-- GAME PROPERTIES -->{{#if:
    <!-- ini n/a -->
    {{{patches|}}}{{#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"
     !Configuration!!Setting!![[GameINI]] <span style="font-weight:normal;">[Core]</span>!!Notes
     !Configuration!!Setting!![[GameINI]] <span style="font-weight:normal;">{{#var:iniheader}}</span>!!Notes
     {{!}}-
     {{!}}-
     {{#if:{{{mmu|}}}|{{!}}Properties > General > {{Config required|Enable MMU|MMU|boolean|Enable Memory Management Unit|{{{mmu|}}}}}{{{mmunotes|}}}}}
     {{#if:{{{mmu|}}}|{{!}}Properties > General > {{Config required|Enable MMU|MMU|boolean|Enable Memory Management Unit|{{{mmu|}}}}}{{{mmunotes|}}}}}

Revision as of 11:07, 10 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 > General > 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 GameINI [Wii] Notes
Settings > Wii > Use PAL60 Mode (EuRGB60) On Boolean
Settings > Wii > Enable Screen Saver On Boolean
Settings > Wii > Insert SD Card On 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
Retrieved from "https://wiki.dolphin-emu.org/index.php?title=Template:Config/sandbox&oldid=180810"