Template:Config/sandbox: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
Line 83: | Line 83: | ||
{{#if:{{{skipbios|}}}|{{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||boolean|Skip loading of GameCube BIOS before booting the game when the IPL dumps are present on User\GC\|{{{skipbios|}}}}}{{{skipbiosnotes|}}}}} | ||
{{!}}- | {{!}}- | ||
{{#if:{{{cpuengine|}}}|{{Config required|CPU Emulator Engine|CPUCore|string|Sets which CPU Emulator Engine should be used|{{{cpuengine|}}}|Interpreter=0, JIT x64=1, JIT ARM64=4, Cached Interpreter=5}}{{{cpuenginenotes|}}}}} | {{#if:{{{cpuengine|}}}|{{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:{{{cpuclock|}}}|{{Config required|CPU Clock Override|Overclock|decimal|Sets the CPU clock speed|{{{cpuclock|}}}|6-400%}}{{{cpuclocknotes|}}}}} | {{#if:{{{cpuclock|}}}|{{Config required|CPU Clock Override|Overclock|decimal|Sets the CPU clock speed|{{{cpuclock|}}}|6-400%}}{{{cpuclocknotes|}}}}} | ||
Line 124: | Line 124: | ||
!Configuration!!Setting!![[GameINI]]!!Notes | !Configuration!!Setting!![[GameINI]]!!Notes | ||
{{!}}- | {{!}}- | ||
{{#if:{{{gfxbackend|}}}|{{Config required|Video Back End|GFXBackend|string|Selects which graphical API interface should be used for display rendering|{{{gfxbackend|}}}|OpenGL=OGL, Direct3D11=D3D, Direct3D12=D3D12, Vulkan=Vulkan, Software=Software Renderer}}{{{gfxbackendnotes|}}}}} | {{#if:{{{gfxbackend|}}}|{{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||boolean|Selects what the monitor resolution should be set to for fullscreen mode.|{{{fullres|}}}}}{{{fullresnotes|}}}}} | {{#if:{{{fullres|}}}|{{Config required|Fullscreen Resolution||boolean|Selects what the monitor resolution should be set to for fullscreen mode.|{{{fullres|}}}}}{{{fullresnotes|}}}}} | ||
{{!}}- | {{!}}- | ||
{{#if:{{{aspectratio|}}}|{{Config required|Aspect Ratio|AspectRatio|string|Selects what aspect ratio the monitor should display the game in|{{{aspectratio|}}}|Auto=0, Force 16:9=1, Force 4:3=2, Stretch to Window=3}}{{{aspectrationotes|}}}}} | {{#if:{{{aspectratio|}}}|{{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:{{{vsync|}}}|{{Config required|V-Sync|VSync|boolean|Synchronizes Dolphin's framerate with your monitor's refresh rate|{{{vsync|}}}}}{{{vsyncnotes|}}}}} | {{#if:{{{vsync|}}}|{{Config required|V-Sync|VSync|boolean|Synchronizes Dolphin's framerate with your monitor's refresh rate|{{{vsync|}}}}}{{{vsyncnotes|}}}}} | ||
Line 136: | Line 136: | ||
{{#if:{{{rendertomain|}}}|{{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||boolean|Displays games in the main window instead of a separate one|{{{rendertomain|}}}}}{{{rendertomainnotes|}}}}} | ||
{{!}}- | {{!}}- | ||
{{#if:{{{shadercomp|}}}|{{Config required|Shader Compilation|ShaderCompilationMode|string|Sets whether specialized shaders or ubershaders are used|{{{shadercomp|}}}|Synchronous=0, Synchronous (Ubershaders)=1, Asynchronous (Ubershaders)=2, Asynchronous (Skip Drawing)=3}}{{{shadercompnotes|}}}}} | {{#if:{{{shadercomp|}}}|{{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:{{{compilefirst|}}}|{{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|WaitForShadersBeforeStarting|boolean|Waits for all shaders to finish compiling before starting a game|{{{compilefirst|}}}}}{{{compilefirstnotes|}}}}} | ||
{{!}}- | {{!}}- | ||
{{#if:{{{internalres|}}}|{{Config required|Internal Resolution|InternalResolution|string|Sets the resolution the game will be rendered at behind-the-scenes|{{{internalres|}}}|Window Size, Multiple of 640x528, 1x=0, 1.5x=0, 2x=1, 2.5x=1, 3x=2, 4x=3}}{{{internalresnotes|}}}}} | {{#if:{{{internalres|}}}|{{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|}}}|{{Config required|Anti-Aliasing|MSAA|string|Corrects aliasing along lines and edges (Many choices depending on Video Back End)|{{{antialiasing|}}}|None=0, 2x MSAA=2, 4x MSAA=4, 8x MSAA=8, 2x SSAA=2, 4x SSAA=4, 8x SSAA=8}}{{{antialiasingnotes|}}}}} | {{#if:{{{antialiasing|}}}|{{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, 4x SSAA=4, 8x SSAA=8}}}}{{{antialiasingnotes|}}}}} | ||
{{!}}- | {{!}}- | ||
{{#if:{{{anisotropic|}}}|{{Config required|Anisotropic Filtering|MaxAnisotropy|string|Reduces distortion when viewing textures at an angle|{{{anisotropic|}}}|1x=0, 2x=1, 4x=2, 8x=3, 16x=4}}{{{anisotropicnotes|}}}}} | {{#if:{{{anisotropic|}}}|{{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:{{{efbscaledcopy|}}}|{{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|EFBScaledCopy|boolean|Greatly increase the quality of textures generated using render-to-texture effects|{{{efbscaledcopy|}}}}}{{{efbscaledcopynotes|}}}}} | ||
Line 158: | Line 158: | ||
{{#if:{{{arbmipmap|}}}|{{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|}}}|{{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|EFBAccessEnable|string|Prevents the CPU from accessing the External Frame Buffer|{{{skipcpuefbaccess|}}}|On=False, Off=True}}{{{skipcpuefbaccessnotes|}}}}} | {{#if:{{{skipcpuefbaccess|}}}|{{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|EFBEmulateFormatChanges|string|Ignore any changes to the External Frame Buffer format|{{{formatchanges|}}}}}{{{formatchangesnotes|}}} | {{#if:{{{formatchanges|}}}|{{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||boolean|Stores EFB Copies exclusively on the GPU, bypassing system memory|{{{efb2texonly|}}}}}{{{efb2texonlynotes|}}}}} | {{#if:{{{efb2texonly|}}}|{{Config required|Store EFB Copies to Texture Only||boolean|Stores EFB Copies exclusively on the GPU, bypassing system memory|{{{efb2texonly|}}}}}{{{efb2texonlynotes|}}}}} | ||
Line 166: | Line 166: | ||
{{#if:{{{deferefb|}}}|{{Config required|Defer EFB Copies to RAM||boolean|Wait to store EFB Copies providing performance improvements|{{{deferefb|}}}}}{{{deferefbnotes|}}}}} | {{#if:{{{deferefb|}}}|{{Config required|Defer EFB Copies to RAM||boolean|Wait to store EFB Copies providing performance improvements|{{{deferefb|}}}}}{{{deferefbnotes|}}}}} | ||
{{!}}- | {{!}}- | ||
{{#if:{{{accuratetexturecache|}}}|{{Config required|Texture Cache Accuracy|SafeTextureCacheColorSamples|string||{{{accuratetexturecache|}}}|Position 1 (Safe)=0, Position 2 (Medium)=512, Position 3 (Fast)=128}}{{{accuratetexturecachenotes|}}}}} | {{#if:{{{accuratetexturecache|}}}|{{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|EnableGPUTextureDecoding|boolean|Enables texture decoding using the GPU instead of the CPU|{{{gputexdecode|}}}}}{{{gputexdecodenotes|}}}}} | {{#if:{{{gputexdecode|}}}|{{Config required|GPU Texture Decoding|EnableGPUTextureDecoding|boolean|Enables texture decoding using the GPU instead of the CPU|{{{gputexdecode|}}}}}{{{gputexdecodenotes|}}}}} | ||
Line 184: | Line 184: | ||
{{#if:{{{progressivescan|}}}|{{Config required|Enable Progressive Scan|ProgressiveScan|boolean|Enables progressive scan if your game supports it|{{{progressivescan|}}}}}{{{progressivescannotes|}}}}} | {{#if:{{{progressivescan|}}}|{{Config required|Enable Progressive Scan|ProgressiveScan|boolean|Enables progressive scan if your game supports it|{{{progressivescan|}}}}}{{{progressivescannotes|}}}}} | ||
{{!}}- | {{!}}- | ||
{{#if:{{{manualtexturesampling|}}}|{{Config required|Manual Texture Sampling|FastTextureSampling|string|Use a manual implementation of texture sampling instead of the graphics backend's built-in functionality|{{{manualtexturesampling|}}}|On=False, Off=True}}{{{manualtexturesamplingnotes|}}}}} | {{#if:{{{manualtexturesampling|}}}|{{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|}}}}} | ||
{{!}}- | {{!}}- | ||
{{#if:{{{force24bit|}}}|{{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:{{{force24bit|}}}|{{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|}}}}} | ||
Line 196: | Line 196: | ||
!Configuration!!Setting!![[GameINI]]!!Notes | !Configuration!!Setting!![[GameINI]]!!Notes | ||
{{!}}- | {{!}}- | ||
{{#if:{{{dspengine|}}}|{{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|}}}|HLE=True, LLE=False}}{{{dspenginenotes|}}}}} | {{#if:{{{dspengine|}}}|{{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|Backend|string|Select the audio back-end API library|{{{audiobackend|}}}|No Audio Output=No audio output, Cubeb=Cubeb, OpenAL=OpenAL}}{{{audiobackendnotes|}}}}} | {{#if:{{{audiobackend|}}}|{{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|}}}}} | ||
{{!}}- | {{!}}- | ||
{{!}}} | {{!}}} | ||
Line 219: | Line 219: | ||
{{#if:{{{usbkeyboard|}}}|{{Config required|Connect USB Keyboard||boolean||{{{usbkeyboard|}}}}}{{{usbkeyboardnotes|}}}}} | {{#if:{{{usbkeyboard|}}}|{{Config required|Connect USB Keyboard||boolean||{{{usbkeyboard|}}}}}{{{usbkeyboardnotes|}}}}} | ||
{{!}}- | {{!}}- | ||
{{#if:{{{systemlang|}}}|{{Config required|System Language|Language|string||{{{systemlang|}}}|Japanese=0, English=1, German=2, French=3, Spanish=4, Italian=5, Dutch=6, Simplified Chinese=7, Traditional Chinese=8, Korean=9}}{{{systemlangnotes|}}}}} | {{#if:{{{systemlang|}}}|{{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|}}}}} | ||
{{!}}- | {{!}}- | ||
{{!}}} | {{!}}} | ||
Line 252: | Line 252: | ||
{{#if:{{{fastdisc|}}}|{{Config required|Speed up Disc Transfer Rate|FastDiscSpeed|boolean|Enables fast disc access|{{{fastdisc|}}}}}{{{fastdiscnotes|}}}}} | {{#if:{{{fastdisc|}}}|{{Config required|Speed up Disc Transfer Rate|FastDiscSpeed|boolean|Enables fast disc access|{{{fastdisc|}}}}}{{{fastdiscnotes|}}}}} | ||
{{!}}- | {{!}}- | ||
{{#if:{{{patches|}}}|{{Config required|Patches||string|Patching required|{{{patches|}}}|_}}{{{patchesnotes|}}}}} | {{#if:{{{patches|}}}|{{Config required|Patches||string|Patching required|{{{patches|}}}|{{#vardefineecho:=|_=_}}}}{{{patchesnotes|}}}}} | ||
{{!}}- | {{!}}- | ||
{{!}}} | {{!}}} |
Revision as of 03:13, 8 February 2022
[edit] [ ] Template documentation
This template outputs a standardized set of configuration information.
Features
New features in this sandbox version:
- Path to setting
- GameINI counterparts
- Using Template:Config required
- Handing off table tags for improved editing performance
- Produces Category:Config template misformatted settings
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
Enable Dual CoreConfiguration | Setting | GameINI | Notes |
---|---|---|---|
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
Enable Dual CoreSpeed LimitUse Panic HandlersSkip GC BIOSCPU Emulator EngineCPU Clock OverrideConfiguration | Setting | GameINI | Notes |
---|---|---|---|
On | CPUThread = True |
Boolean | |
100% | EmulationSpeed = 1 |
Decimal | |
On | Boolean | ||
On | Boolean | ||
JIT x64 | CPUCore = 1 |
String | |
100% | Overclock = 1 |
Decimal |
Graphics
Video Back EndAspect RatioV-SyncUse FullscreenRender to Main WindowShader CompilationCompile Shaders Before StartingInternal ResolutionAnti-AliasingAnisotropic FilteringScaled EFB CopyPer-Pixel LightingForce Texture FilteringWidescreen HackDisable FogArbitrary Mipmap DetectionSkip EFB Access from CPUIgnore Format ChangesStore EFB Copies to Texture OnlyDefer EFB Copies to RAMTexture Cache AccuracyGPU Texture DecodingStore XFB Copies to Texture OnlyImmediately Present XFBFast Depth CalculationDisable Bounding BoxVertex Rounding HackCropEnable Progressive ScanManual Texture SamplingForce 24-Bit ColorConfiguration | Setting | GameINI | Notes |
---|---|---|---|
OpenGL | GFXBackend = OGL |
String | |
Auto | AspectRatio = 0 |
String | |
On | VSync = True |
Boolean | |
On | Boolean | ||
On | Boolean | ||
Synchronous | ShaderCompilationMode = 0 |
String | |
On | WaitForShadersBeforeStarting = True |
Boolean | |
1x | InternalResolution = 0 |
String | |
4x SSAA | MSAA = 4 |
String | |
1x | MaxAnisotropy = 0 |
String | |
On | EFBScaledCopy = True |
Boolean | |
On | EnablePixelLighting = True |
Boolean | |
On | ForceFiltering = True |
Boolean | |
On | wideScreenHack = True |
Boolean | |
On | DisableFog = True |
Boolean | |
On | ArbitraryMipmapDetection = True |
Boolean | |
On | EFBAccessEnable = False |
String | |
On | EFBEmulateFormatChanges = False |
String | |
On | Boolean | ||
On | Boolean | ||
Position 3 (Fast) | SafeTextureCacheColorSamples = 128 |
String | |
On | EnableGPUTextureDecoding = True |
Boolean | |
On | Boolean | ||
On | Boolean | ||
On | FastDepthCalc = True |
Boolean | |
On | BBoxEnable = True |
Boolean | |
On | VertexRounding = True |
Boolean | |
On | Boolean | ||
On | ProgressiveScan = True |
Boolean | |
On | FastTextureSampling = False |
String | |
On | ForceTrueColor = True |
Boolean |
Audio
DSP Emulator EngineAudio Back EndConfiguration | Setting | GameINI | Notes |
---|---|---|---|
HLE | EnableJIT = True |
String | |
Cubeb | Backend = Cubeb |
String |
Wii
Use PAL60 Mode (EuRGB60)Enable Screen SaverInsert SD CardConnect USB KeyboardSystem LanguageConfiguration | Setting | GameINI | Notes |
---|---|---|---|
On | Boolean | ||
On | Boolean | ||
On | Boolean | ||
On | Boolean | ||
English | Language = 1 |
String |
Wii Remote
Enable Speaker DataWii Remote MotorConfiguration | Setting | GameINI | Notes |
---|---|---|---|
On | Boolean | ||
On | Boolean |
Game Properties
Enable MMUEnable FPRFSynchronize GPU ThreadSpeed up Disc Transfer RateConfiguration | Setting | GameINI | Notes |
---|---|---|---|
On | MMU = True |
Boolean | |
On | FPRF = True |
Boolean | |
On | SyncGPU = True |
Boolean | |
On | FastDiscSpeed = True |
Boolean |
The above documentation is transcluded from Template:Config/sandbox/doc. (edit | history) Editors can experiment in this template's sandbox (edit) and testcases (edit) pages. Subpages of this template. |