Progress Continues
We've already had 21453 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.

GameINI: Difference between revisions

Jump to navigation Jump to search

GameINI (view source)

Revision as of 23:33, 20 November 2017

289 bytes added ,  20 November 2017
→‎Audio Backend: Add cubeb backend
No edit summary
(→‎Audio Backend: Add cubeb backend)
(24 intermediate revisions by 3 users not shown)
Line 2: Line 2:


== Properties Window ==
== Properties Window ==
These are settings you can also find in the ISO properties.
These are settings you can update GameINI directly from the game properties window.
* Enable Dual Core - controls [[#CPUThread]]
* Enable Dual Core - controls [[#Dual Core]]
* Enable MMU - controls [[#MMU]]
* Enable MMU - controls [[#Memory Management Unit (MMU)]]
* Skip DCBZ clearing - controls [[#DCBZ]]
* Skip DCBZ clearing - controls [[#DCBZ]]
* Enable FPRF - controls [[#]]
* Enable FPRF - controls [[#Floating-point Result Flag]]
* Synchronize GPU thread - controls [[#SyncGPU]]
* Synchronize GPU thread - controls [[#Synchronize GPU Thread]]
* Speed up Disc Transfer Rate - controls [[#FastDiscSpeed]]
* Speed up Disc Transfer Rate - controls [[#Speed Up Disc Transfer Rate]]
* DSP HLE emulation (fast) - controls [[#DSPHLE]]
* DSP HLE emulation (fast) - controls [[#DSP HLE]]
* Stereoscopy Depth Percentage - controls StereoDepthPercentage in [[#Stereoscopic 3D Settings]]
* Deterministic dual core - controls [[#Dualcore Determinism]]
* Convergence - controls StereoConvergence in [[#Stereoscopic 3D Settings]]
* Stereoscopy Depth Percentage - controls StereoDepthPercentage in [[#Stereoscopic 3D Offset Settings]]
* Monoscopic Shadows - controls StereoEFBMonoDepth in [[#Stereoscopic 3D Settings]]
* Convergence - controls StereoConvergence in [[#Stereoscopic 3D Offset Settings]]
* [[#BlockMerging]]
* Monoscopic Shadows - controls StereoEFBMonoDepth in [[#Stereoscopic 3D Offset Settings]]
* [[#TLBHack]]
* [[#VBeam]]


== [Core] ==
== [Core] ==
Line 24: Line 22:


=== Graphics Backend ===
=== Graphics Backend ===
*<code>GFXBackend = DX9</code> to set the video backend to Direct3D 9. Removed (will do nothing) in {{revision|4.0-155}} and later.
*<code>GFXBackend = D3D</code> to set the video backend to Direct3D 11.
*<code>GFXBackend = D3D</code> to set the video backend to Direct3D 11. Use <code>DX11</code> in Dolphin build earlier than {{revision|4.0-155}}.
*<code>GFXBackend = D3D12</code> to set the video backend to Direct3D 12. Removed (will do nothing) in {{revision|5.0-3774}} and later.
*<code>GFXBackend = D3D12</code> to set the video backend to Direct3D 12. Removed (will do nothing) in {{revision|5.0-3774}} and later.
*<code>GFXBackend = OGL</code> to set the video backend to OpenGL.
*<code>GFXBackend = OGL</code> to set the video backend to OpenGL.
*<code>GFXBackend = Vulkan</code> to set the video backend to Vulkan.
*<code>GFXBackend = Vulkan</code> to set the video backend to Vulkan.


=== CPU Engine ===
=== CPU Emulator Engine ===
*<code>CPUCore = 0</code> to set the CPU engine to "Interpreter".
*<code>CPUCore = 0</code> to set the CPU emulator engine to "Interpreter".
*<code>CPUCore = 1</code> to set the CPU engine to "JIT".
*<code>CPUCore = 1</code> to set the CPU emulator engine to "JIT".
*<code>CPUCore = 2</code> to set the CPU engine to "JITIL". Removed (will do nothing) in {{revision|5.0-3792}} and later.
*<code>CPUCore = 2</code> to set the CPU emulator engine to "JITIL". Removed (will do nothing) in {{revision|5.0-3792}} and later.
*<code>CPUCore = 5</code> to set the CPU engine to "Cached Interpreter".
*<code>CPUCore = 5</code> to set the CPU emulator engine to "Cached Interpreter".


Uses numbers starting with 0 to represent the tick-mark order used in the Dolphin GUI for the option.
=== Floating-point Result Flag ===
*<code>FPRF = True</code> or <code>False</code> to enable and disable "Floating-point Result Flag" calculation respectively.


=== DSP HLE ===
=== DSP HLE ===
*<code>DSPHLE = True</code> or <code>False</code> to force enable and disable "DSP HLE" for the game respectively.
*<code>DSPHLE = True</code> or <code>False</code> to enable and disable "DSP HLE" respectively.


If DSP HLE is disabled, DSL LLE will be used, it will use either DSP LLE recompiler or DSP LLE interpreter based on your general Dolphin settings. More information at [[Audio Emulation]].
If DSP HLE is disabled, DSL LLE will be used, it will use either DSP LLE recompiler or DSP LLE interpreter based on your general Dolphin settings, or see [[#DSP Emulator Engine]]. More information at [[Audio Emulation]].


=== DSP LLE on Dedicated Thread ===
=== DSP LLE on Dedicated Thread ===
Line 47: Line 45:


=== Emulation Speed (formerly Framelimit) ===
=== Emulation Speed (formerly Framelimit) ===
*<code>EmulationSpeed = 0.000000000</code> will set it to "unlimited". Equivalent to <code>FrameLimit = 0x00000000</code> "Off" in {{revision|4.0-XXXX}} and before.
*<code>EmulationSpeed = 0.000000000</code> will set it to "unlimited".
*<code>EmulationSpeed = 0.100000001</code> will set it to "10%".
*<code>EmulationSpeed = 0.100000001</code> will set it to "10%".
*<code>EmulationSpeed = 0.200000003</code> will set it to "20%".
*<code>EmulationSpeed = 0.200000003</code> will set it to "20%".
Line 57: Line 55:
*<code>EmulationSpeed = 0.800000012</code> will set it to "80%".
*<code>EmulationSpeed = 0.800000012</code> will set it to "80%".
*<code>EmulationSpeed = 0.900000036</code> will set it to "90%".
*<code>EmulationSpeed = 0.900000036</code> will set it to "90%".
*<code>EmulationSpeed = 1.00000000</code> will set it to "100%", as in normal emulation speed. Equivalent to <code>FrameLimit = 0x00000001</code> "Auto" in {{revision|4.0-XXXX}} and before.
*<code>EmulationSpeed = 1.00000000</code> will set it to "100%", as in normal emulation speed.
*<code>EmulationSpeed = 1.10000002</code> will set it to "110%".
*<code>EmulationSpeed = 1.10000002</code> will set it to "110%".
*<code>EmulationSpeed = 1.20000005</code> will set it to "120%".
*<code>EmulationSpeed = 1.20000005</code> will set it to "120%".
Line 67: Line 65:
*<code>EmulationSpeed = 1.80000007</code> will set it to "180%".
*<code>EmulationSpeed = 1.80000007</code> will set it to "180%".
*<code>EmulationSpeed = 1.89999998</code> will set it to "190%".
*<code>EmulationSpeed = 1.89999998</code> will set it to "190%".
*<code>EmulationSpeed = 2.00000000</code> will set it to "200%". Equivalent to <code>FrameLimit = 0x00000019</code> "120" in {{revision|4.0-XXXX}} and before.
*<code>EmulationSpeed = 2.00000000</code> will set it to "200%".


=== UseFPS ===
=== CPU Overclock ===
Implemented in {{revision|4.0-265}} and later.
Implemented in {{revision|5.0-2302}} and later.
*<code>UseFPS = True</code> to set the FrameLimiter to be based on FPS instead of the VPS.  
*<code>OverclockEnable = True</code> or <code>False</code> to enable and disable "CPU Overclock" respectively.
*<code>UseFPS = False</code> to set the FrameLimiter to be based on VPS instead of the FPS. This is the normal behavior for the emulator.
*<code>Overclock = 1.0</code> translates to "100%" CPU clock, greater in value is considered overclocking and smaller in value is considered underclocking.


=== VBeam Speed Hack ===
=== Synchronize GPU Thread ===
*<code>VBeam = True</code> or <code>False</code> to enable and disable the "VBeam Speed Hack" respectively.
 
=== Synchronize GPU ===
SyncGPU is a speed hack for dual core mode to allow games to get around dual core glitches without having to use single core. Usually not much faster than single core mode.
SyncGPU is a speed hack for dual core mode to allow games to get around dual core glitches without having to use single core. Usually not much faster than single core mode.
*<code>SyncGPU = True</code> or <code>False</code> to enable and disable the "Synchronize GPU" respectively.
*<code>SyncGPU = True</code> or <code>False</code> to enable and disable the "Synchronize GPU thread" respectively.


=== FastDiscSpeed ===
=== Speed Up Disc Transfer Rate ===
Accelerates the emulated disc speed, removing any loading emulation.
Accelerates the emulated disc speed, removing any loading emulation.
*<code>FastDiscSpeed = True</code> or <code>False</code> to enable and disable the "Speed up Disc Transfer Rate" respectively.
*<code>FastDiscSpeed = True</code> or <code>False</code> to enable and disable the "Speed up Disc Transfer Rate" respectively.


=== BlockMerging ===
=== Dualcore Determinism ===
*<code>BlockMerging = True</code> or <code>False</code> to enable and disable the "???" respectively.
*<code>GPUDeterminismMode = fake-completion</code> or <code>none</code> to enable and disable "Deterministic dual core" respectively.


=== Memory Management Unit (MMU) ===
=== Memory Management Unit (MMU) ===
*<code>MMU = True</code> <code>False</code> to enable and disable the "Memory Management Unit" respectively.
*<code>MMU = True</code> or <code>False</code> to enable and disable the "Memory Management Unit" respectively.
 
=== TLBHack ===
Controls the "MMU Speed Hack" setting, a hacked version of the MMU that isn't as demanding.
*<code>TLBHack = True</code> or <code>False</code> to enable or disable the "MMU Speed Hack" respectively.


=== DCBZ ===
=== DCBZ ===
*<code>DCBZ = True</code> or <code>False</code> to enable and disable "Skip DCBZ Clearing" respectively.
*<code>DCBZ = True</code> or <code>False</code> to enable and disable "Skip DCBZ Clearing" respectively.
=== Progressive Scan ===
*<code>ProgressiveScan = True</code> or <code>False</code> to enable and disable "Progressive Scan" respectively.
=== GameCube Language ===
Implemented in {{revision|5.0-2023}} and later.
*<code>GameCubeLanguage = 0</code> for English or Japanese, depending on the region of the console/game.
Choose a number for the language you want from the list below:
0 = English/Japanese
1 = German
2 = French
3 = Spanish
4 = Italian
5 = Dutch


== [Video_Settings] ==
== [Video_Settings] ==
The following entries go under [Video_Settings] section of the GameINI.
=== Internal Resolution ===
=== Internal Resolution ===
Sets the internal resolution. Values starting from 0 represent the drop down order in the list that dolphin uses.
Values starting from 0 represent the drop down order in the list that dolphin uses.
*<code>EFBScale = 0</code> to set the Internal Resolution to "Auto (Multiple of 640x528)"
*<code>InternalResolution = 0</code>
*<code>EFBScale = 1</code> to set the Internal Resolution to "Auto (Window Size)"
*<code>EFBScale = 2</code> to set the Internal Resolution to 1x Native
*<code>EFBScale = 3</code> to set the Internal Resolution to 1.5x Native
*<code>EFBScale = 4</code> to set the Internal Resolution to 2x Native
*<code>EFBScale = 5</code> to set the Internal Resolution to 2.5x Native
*<code>EFBScale = 6</code> to set the Internal Resolution to 3x Native
*<code>EFBScale = 7</code> to set the Internal Resolution to 4x Native
*<code>EFBScale = -1</code> "-1" is a special case that does not exist in the GUI. It is used to set an Internal Resolution that is the nearest whole number multiplier of the value set in Dolphin's general settings, rounded down. For example, if 2.5x Native is set in the GUI (general settings), than 2x Native will be used.


=== Texture Cache Accuracy ===
=== Texture Cache Accuracy ===
Line 118: Line 118:


=== Aspect Ratio ===
=== Aspect Ratio ===
Values represent the drop down list in the Dolphin GUI, starting with 0.
Values starting from 0 represent the drop down order in the list that dolphin uses.
*<code>AspectRatio = 0</code> is auto, assigned based on what the emulated console indicates.
*<code>AspectRatio = 0</code> is auto, assigned based on what the emulated console indicates.
*<code>AspectRatio = 1</code> to force the aspect ratio to 16:9.
*<code>AspectRatio = 1</code> to force the aspect ratio to 16:9.
Line 126: Line 126:
=== Widescreen Hack ===
=== Widescreen Hack ===
Separates the aspect ratio rendered by the game from the one displayed in the game window. Use [[#Aspect Ratio]] options in addition to this setting.
Separates the aspect ratio rendered by the game from the one displayed in the game window. Use [[#Aspect Ratio]] options in addition to this setting.
*<code>wideScreenHack = True</code> or <code>False</code> to enable and disable the ''Widescreen Hack'' respectively.
*<code>wideScreenHack = True</code> or <code>False</code> to enable and disable the "Widescreen Hack" respectively.


=== MSAA ===
=== Anti-Aliasing ===
Values starting from 0 represent the drop down order in the list that dolphin uses. Each backend has it's own list of Anti-Aliasing options so it is suggested to enforce a certain video backend along with this option.
*<code>MSAA = 0</code> will set it to the top of the list value which is "None". "2x", "4x", "8x" samples would need <code>2</code>, <code>4</code>, <code>8</code> to be used respectively.
*<code>MSAA = 0</code> will set it to the top of the list value which is 'Off' for all backends, for values starting from 1 the result will vary depending on the backend used, check the drop list in the GUI and start counting from 0 to find which Anti-Aliasing option will be used for values higher than zero.
*<code>SSAA = True</code> or <code>False</code> will toggle between "SSAA" and "MSAA" respectively. The amount of samples used for SSAA will depend on the MSAA value above.


=== External Frame Buffer ===
=== External Frame Buffer ===
Line 141: Line 141:
=== Per-Pixel Lighting ===
=== Per-Pixel Lighting ===
*<code>EnablePixelLighting = True</code> or <code>False</code> to enable and disable "Per-Pixel Lighting" respectively.
*<code>EnablePixelLighting = True</code> or <code>False</code> to enable and disable "Per-Pixel Lighting" respectively.
=== OpenMP Texture Decoder ===
*<code>OMPDecoder = True</code> or <code>False</code> to enable and disable "OpenMP Texture Decoder" respectively.
=== OpenCL Texture Decoder ===
*<code>EnableOpenCL = True</code> or <code>False</code> to enable and disable "OpenCL Texture Decoder" respectively.


=== Disable Fog ===
=== Disable Fog ===
*<code>DisableFog = True</code> or <code>False</code> to enable and disable "Disable Fog" respectively.
*<code>DisableFog = True</code> or <code>False</code> to enable and disable "Disable Fog" respectively.


=== Disable Destination Alpha ===
=== Load Custom Textures ===
*<code>DstAlphaPass = True</code> or <code>False</code> to enable and disable "Disable Destination Alpha" respectively.
*<code>HiresTextures = True</code> or <code>False</code> to enable and disable "Load Custom Textures" respectively.


== [Video_Enhancements] ==
== [Video_Enhancements] ==
The following entries go under [Video_Enhancements] section of the GameINI.
=== Anisotropic Filtering ===
=== Anisotropic Filtering ===
Values starting from 0 represent the drop down order in the list that dolphin uses.
Values starting from 0 represent the drop down order in the list that dolphin uses.
Line 163: Line 159:


=== Post-processing Effects ===
=== Post-processing Effects ===
This option will only work with the opengl backend. Use the names listed in the drop down menu of the option, below we use sepia as an example.
This option will only work with the OpenGL and Vulkan backend. Use the names listed in the drop down menu of the option, below we use sepia as an example.
*<code>PostProcessingShader = sepia</code>, also you can put the name of your preferred shader here.
*<code>PostProcessingShader = sepia</code>, also you can put the name of your preferred shader here.


== [Video_Hacks] ==
== [Video_Hacks] ==
=== Cache Display Lists ===
The following entries go under [Video_Hacks] section of the GameINI.
*<code>DlistCachingEnable = True</code> or <code>False</code> to enable and disable "Cache Display Lists" respectively.


=== EFB Copies ===
=== EFB Copies ===
*<code>EFBToTextureEnable = True</code> or <code>False</code> to enable "EFB to Texture" and "EFB to Ram" respectively.
*<code>EFBToTextureEnable = True</code> or <code>False</code> to enable "EFB to Texture" and "EFB to Ram" respectively.
*<code>EFBCopyEnable = True</code> or <code>False</code> to enable and disable "EFB copies" respectively.
*<code>EFBCopyCacheEnable = True</code> or <code>False</code> to enable and disable "EFB to RAM Cache" respectively.


=== Scaled EFB Copy ===
=== Scaled EFB Copy ===
Line 184: Line 177:
*<code>EFBEmulateFormatChanges = True</code> or <code>False</code> to disable and enable "Ignore Format Changes" respectively. Beware that it has the opposite behavior of the GUI option!
*<code>EFBEmulateFormatChanges = True</code> or <code>False</code> to disable and enable "Ignore Format Changes" respectively. Beware that it has the opposite behavior of the GUI option!


== [Video] ==
=== Bounding Box ===
*<code>UseBBox = True</code> or <code>False</code> to enable and disable "Bounding Box Calculation" respectively.
*<code>BBoxEnable = True</code> or <code>False</code> to enable and disable "Bounding Box" calculation respectively.
*<code>ZTPSpeedupHack = True</code> or <code>False</code> to enable and disable "ZTP Hack" respectively.
 
*<code>ProjectionHack = 1</code> or <code>0</code> to enable and disable "Custom Projection Hack" respectively.
=== Vertex Rounding ===
*<code>VertexRounding = True</code> or <code>False</code> to enable and disable "Vertex Rounding" respectively.
 
===XFB copies ===
*<code>XFBToTextureEnable = True</code> or <code>False</code> to enable "XFB to Texture" and "XFB to Ram" respectively.
 
===Immediate XFB ===
*<code>ImmediateXFBenable = True</code> or <code>False</code> to enable and disable "Immediate XFB" respectively.


== [Video_Hardware] ==
== [Video_Hardware] ==
=== VSync ===
The following entries go under [Video_Hardware] section of the GameINI.
*<code>VSync = True</code> or <code>False</code> to enable and disable "VSync" respectively.
 
=== V-Sync ===
*<code>VSync = True</code> or <code>False</code> to enable and disable "V-Sync" respectively.


== [Video_Stereoscopy] ==
== [Video_Stereoscopy] ==
The following entries go under [Video_Stereoscopy] section of the GameINI.
=== Stereoscopic 3D Offset Settings ===
*<code>StereoDepthPercentage = 100</code> Percentage to multiply with the depth value of StereoDepth in [[#Stereoscopic 3D Settings]].
*<code>StereoConvergence = 0</code> Base convergence value to be multiplied with the percentage value of StereoConvergencePercentage in [[#Stereoscopic 3D Settings]].
*<code>StereoEFBMonoDepth = True</code> or <code>False</code> to enable and disable "Monoscopic Shadows" respectively.
=== Stereoscopic 3D Mode ===
Values starting from 0 represent the drop down order in the list that dolphin uses.
*<code>StereoMode = 0</code>
=== Stereoscopic 3D Settings ===
=== Stereoscopic 3D Settings ===
*<code>StereoDepthPercentage = 100</code> Percentage of depth value set in the video configuration applied in-game.
*<code>StereoDepth = 20</code> Separation distance between the virtual cameras.
*<code>StereoConvergenceMinimum = 0</code> Base convergence value that's added to the value set in the video configuration.
*<code>StereoConvergencePercentage = 100</code> Distance of the convergence plane.
*<code>StereoEFBMonoDepth = False</code> or <code>True</code> to enable "Monoscopic Shadows" respectively.
*<code>StereoSwapEyes = True</code> or <code>False</code> to enable and disable "Swap Eyes" respectively.


== [DSP] ==
== [DSP] ==
=== Backend ===
The following entries go under [DSP] section of the GameINI.
Implemented in {{revision|4.0-101}} and later.
 
=== Audio Backend ===
*<code>Backend = OpenAL</code>
*<code>Backend = OpenAL</code>
*<code>Backend = DSound</code>
*<code>Backend = XAudio2</code>
*<code>Backend = XAudio2</code>
*<code>Backend = Cubeb</code>
*<code>Backend = No audio output</code>


=== EnableJIT ===
=== DSP Emulator Engine ===
*<code>EnableJIT = True</code> => for LLE recompiler
*<code>EnableJIT = True</code> or <code>False</code> for "LLE recompiler" and "LLE interpreter" respectively. This is when [[#DSP HLE]] is disabled.
*<code>EnableJIT = False</code> => for LLE interpreter


=== Volume ===
=== Volume ===
Implemented in {{revision|4.0-265}} and later.
*<code>Volume = 100</code>, values starting from 0 up to 100 max are valid.
*<code>Volume = 100</code>, values starting from 0 up to 100 max are valid.


== [Controls] ==
== [Controls] ==
=== PadProfile# ===
The following entries go under [Controls] section of the GameINI.
 
=== GameCube Controller Port ===
<pre>
PadType0 = 0
PadType1 = 0
PadType2 = 0
PadType3 = 0
</pre>
 
=== GameCube Controller Profile ===
The GameCube controller profile to be used for player 1 to 4.
The GameCube controller profile to be used for player 1 to 4.
<pre>
<pre>
Line 226: Line 249:
Change ''Name of Profile'' to the name of an existing control profile. It requires that you have created and saved a new control profile beforehand for the emulated GameCube controller.
Change ''Name of Profile'' to the name of an existing control profile. It requires that you have created and saved a new control profile beforehand for the emulated GameCube controller.


=== WiimoteProfile# ===
=== Wii Remote ===
Values starting from 0 represent the drop down order in the list that dolphin uses.
<pre>
WiimoteSource0 = 0
WiimoteSource1 = 0
WiimoteSource2 = 0
WiimoteSource3 = 0
</pre>
 
=== Balance Board ===
<code>WiimoteSourceBB = 0</code> or <code>2</code> to disable and enable the "Real Balance Board" respectively.
 
=== Wii Remote Profile ===
The Wii Remote profile to be used for player 1 to 4.
The Wii Remote profile to be used for player 1 to 4.
<pre>
<pre>
Line 236: Line 271:


Change ''Name of Profile'' to the name of an existing control profile. It requires that you have created and saved a new control profile beforehand for the emulated Wii Remote.
Change ''Name of Profile'' to the name of an existing control profile. It requires that you have created and saved a new control profile beforehand for the emulated Wii Remote.
== [Wii] ==
=== Wii System Language ===
Implemented in {{revision|5.0-2023}} and later.
*<code>Language = 1</code> for English
Choose a number for the language you want from the list below:
0 = Japanese
1 = English
2 = German
3 = French
4 = Spanish
5 = Italian
6 = Dutch
7 = Simplified Chinese
8 = Traditional Chinese
9 = Korean


[[Category:Tutorials]]
[[Category:Tutorials]]
Nickps
208

edits

Retrieved from "https://wiki.dolphin-emu.org/index.php?title=Special:MobileDiff/146156...151692"

Navigation menu