Template:Config/sandbox: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 8: Line 8:
     {{{cpuengine|}}}
     {{{cpuengine|}}}
     {{{cpuclock|}}}
     {{{cpuclock|}}}
     <!-- GRAPHICS -->
     <!-- GRAPHICS GENERAL -->
     {{{gfxbackend|}}}
     {{{gfxbackend|}}}
     {{{fullres|}}}
     {{{fullres|}}}
Line 17: Line 17:
     {{{shadercomp|}}}
     {{{shadercomp|}}}
     {{{compilefirst|}}}
     {{{compilefirst|}}}
    <!-- GRAPHICS ENHANCEMENTS -->
     {{{internalres|}}}
     {{{internalres|}}}
     {{{antialiasing|}}}
     {{{antialiasing|}}}
Line 27: Line 28:
     {{{force24bit|}}}
     {{{force24bit|}}}
     {{{arbmipmap|}}}
     {{{arbmipmap|}}}
    <!-- GRAPHICS HACKS -->
     {{{skipcpuefbaccess|}}}
     {{{skipcpuefbaccess|}}}
     {{{formatchanges|}}}
     {{{formatchanges|}}}
Line 38: Line 40:
     {{{boundingbox|}}}
     {{{boundingbox|}}}
     {{{vertexrounding|}}}
     {{{vertexrounding|}}}
    <!-- GRAPHICS ADVANCED -->
     {{{crop|}}}
     {{{crop|}}}
     {{{progressivescan|}}}
     {{{progressivescan|}}}
Line 87: Line 90:
     {{!}}-
     {{!}}-
     {{!}}}
     {{!}}}
}}<!-- GRAPHICS -->{{#if:
}}<!-- GRAPHICS -->{{#if:{{#if:
    <!-- GRAPHICS GENERAL -->
     {{{gfxbackend|}}}
     {{{gfxbackend|}}}
     {{{fullres|}}}
     {{{fullres|}}}
Line 95: Line 99:
     {{{rendertomain|}}}
     {{{rendertomain|}}}
     {{{shadercomp|}}}
     {{{shadercomp|}}}
     {{{compilefirst|}}}|
     {{{compilefirst|}}}|{{#vardefineecho:iniheader|[Video_Settings]}}}}{{#if:
    <!-- GRAPHICS ENHANCEMENTS -->
    {{{internalres|}}}
    {{{antialiasing|}}}
    {{{anisotropic|}}}
    {{{efbscaledcopy|}}}
    {{{pixellighting|}}}
    {{{forcefilter|}}}
    {{{widescreenhack|}}}
    {{{disablefog|}}}
    {{{force24bit|}}}
    {{{arbmipmap|}}}|{{#vardefineecho:iniheader|{{#if:{{#var:iniheader}}||[Video_Enhancements]}}}}}}{{#if:
    <!-- GRAPHICS HACKS -->
    {{{skipcpuefbaccess|}}}
    {{{formatchanges|}}}
    {{{efb2texonly|}}}
    {{{deferefb|}}}
    {{{accuratetexturecache|}}}
    {{{gputexdecode|}}}
    {{{xfb2texonly|}}}
    {{{xfbimmediate|}}}
    {{{fastdepth|}}}
    {{{boundingbox|}}}
    {{{vertexrounding|}}}|{{#vardefineecho:iniheader|{{#if:{{#var:iniheader}}||[Video_Hacks]}}}}}}{{#if:
    <!-- GRAPHICS ADVANCED -->
    {{{crop|}}}
    {{{progressivescan|}}}
    {{{manualtexturesampling|}}}|{{#vardefineecho:iniheader|{{#if:{{#var:iniheader}}||[Core]}}}}}}|
     <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!![[GameINI]] <span style="font-weight:normal;">[Video_Settings]</span>!!Notes
     !Configuration!!Setting!![[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 115: Line 146:
     {{!}}-
     {{!}}-
     {{#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|}}}|{{!}}Graphics > General > {{Config required|Compile Shaders Before Starting|WaitForShadersBeforeStarting|boolean|Waits for all shaders to finish compiling before starting a game|{{{compilefirst|}}}}}{{{compilefirstnotes|}}}}}
    {{!}}-
    {{!}}}
}}<!-- GRAPHICS ENHANCEMENTS -->{{#if:
    {{{internalres|}}}
    {{{antialiasing|}}}
    {{{anisotropic|}}}
    {{{efbscaledcopy|}}}
    {{{pixellighting|}}}
    {{{forcefilter|}}}
    {{{widescreenhack|}}}
    {{{disablefog|}}}
    {{{force24bit|}}}
    {{{arbmipmap|}}}|
    <h3> Graphics Enhancements</h3>
    {{{!}}class="wikitable" style="font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
    !Configuration!!Setting!![[GameINI]] <span style="font-weight:normal;">[Video_Enhancements]</span>!!Notes
     {{!}}-
     {{!}}-
     {{#if:{{{internalres|}}}|{{!}}Graphics > Enhancements > {{Config required|Internal Resolution|InternalResolution|string|Sets the resolution the game will be rendered at behind-the-scenes|{{{internalres|}}}|{{#vardefineecho:=|Window Size, Multiple of 640x528, 1x=0, 1.5x=0, 2x=1, 2.5x=1, 3x=2, 4x=3}}}}{{{internalresnotes|}}}}}
     {{#if:{{{internalres|}}}|{{!}}Graphics > Enhancements > {{Config required|Internal Resolution|InternalResolution|string|Sets the resolution the game will be rendered at behind-the-scenes|{{{internalres|}}}|{{#vardefineecho:=|Window Size, Multiple of 640x528, 1x=0, 1.5x=0, 2x=1, 2.5x=1, 3x=2, 4x=3}}}}{{{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, 2x MSAA=2, 4x MSAA=4, 8x MSAA=8, 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|}}}|{{!}}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, 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:{{{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|}}}|{{!}}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|}}}}}
Line 151: Line 166:
     {{!}}-
     {{!}}-
     {{#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:{{{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|}}}}}
    {{!}}-
    {{!}}}
}}<!-- GRAPHICS HACKS -->{{#if:
    {{{skipcpuefbaccess|}}}
    {{{formatchanges|}}}
    {{{efb2texonly|}}}
    {{{deferefb|}}}
    {{{accuratetexturecache|}}}
    {{{gputexdecode|}}}
    {{{xfb2texonly|}}}
    {{{xfbimmediate|}}}
    {{{fastdepth|}}}
    {{{boundingbox|}}}
    {{{vertexrounding|}}}|
    <h3> Graphics Hacks </h3>
    {{{!}}class="wikitable" style="font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
    !Configuration!!Setting!![[GameINI]] <span style="font-weight:normal;">[Video_Hacks]</span>!!Notes
     {{!}}-
     {{!}}-
     {{#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:{{{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|}}}}}
Line 190: Line 188:
     {{!}}-
     {{!}}-
     {{#if:{{{vertexrounding|}}}|{{!}}Graphics > Hacks > {{Config required|Vertex Rounding Hack|VertexRounding|boolean|Round 2D vertices to whole pixels|{{{vertexrounding|}}}}}{{{vertexroundingnotes|}}}}}
     {{#if:{{{vertexrounding|}}}|{{!}}Graphics > Hacks > {{Config required|Vertex Rounding Hack|VertexRounding|boolean|Round 2D vertices to whole pixels|{{{vertexrounding|}}}}}{{{vertexroundingnotes|}}}}}
    {{!}}-
    {{!}}}
}}<!-- GRAPHICS ADVANCED -->{{#if:
    {{{crop|}}}
    {{{progressivescan|}}}
    {{{manualtexturesampling|}}}|
    <h3> Graphics </h3>
    {{{!}}class="wikitable" style="font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
    !Configuration!!Setting!![[GameINI]] <span style="font-weight:normal;">[Core]</span>!!Notes
     {{!}}-
     {{!}}-
     {{#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:{{{crop|}}}|{{!}}Graphics > Advanced > {{Config required|Crop||boolean|Crop the picture from it's native aspect ratio to 4:3 or 16:9.|{{{crop|}}}}}{{{cropnotes|}}}}}

Revision as of 05:12, 9 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 GameINI 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 Boolean
Graphics > Hacks > Defer EFB Copies to RAM On 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 Boolean
Graphics > Hacks > Immediately Present XFB On 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 [Controls] 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