franklinblanco/yuzu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
0373000143
yuzu/src/yuzu_cmd/default_ini.h

513 lines
17 KiB
C++
Raw Normal View History

chore: make yuzu REUSE compliant [REUSE] is a specification that aims at making file copyright information consistent, so that it can be both human and machine readable. It basically requires that all files have a header containing copyright and licensing information. When this isn't possible, like when dealing with binary assets, generated files or embedded third-party dependencies, it is permitted to insert copyright information in the `.reuse/dep5` file. Oh, and it also requires that all the licenses used in the project are present in the `LICENSES` folder, that's why the diff is so huge. This can be done automatically with `reuse download --all`. The `reuse` tool also contains a handy subcommand that analyzes the project and tells whether or not the project is (still) compliant, `reuse lint`. Following REUSE has a few advantages over the current approach: - Copyright information is easy to access for users / downstream - Files like `dist/license.md` do not need to exist anymore, as `.reuse/dep5` is used instead - `reuse lint` makes it easy to ensure that copyright information of files like binary assets / images is always accurate and up to date To add copyright information of files that didn't have it I looked up who committed what and when, for each file. As yuzu contributors do not have to sign a CLA or similar I couldn't assume that copyright ownership was of the "yuzu Emulator Project", so I used the name and/or email of the commit author instead. [REUSE]: https://reuse.software Follow-up to 01cf05bc75b1e47beb08937439f3ed9339e7b254
2022-05-15 00:06:02 +00:00
// SPDX-FileCopyrightText: 2014 Citra Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
Added configuration file system. Uses QSettings on citra-qt, and inih on citra-cli.
2014-09-13 00:06:13 +00:00
#pragma once
namespace DefaultINI {
default_ini: Split and concatenate the config string literal We are dangerously close to MSVC's 16384 character limit for string literals. Breaking this string up and concatenating will allow for more settings to be added in the future.
2023-01-25 19:04:01 +00:00
const char* sdl2_config_file =
R"(
yuzu-cmd: Update configuration file description
2022-11-27 01:41:50 +00:00
[ControlsP0]
default_ini.h: Update from citra to yuzu
2018-04-04 21:05:51 +00:00
# The input devices and parameters for each Switch native input
yuzu-cmd: Update configuration file description
2022-11-27 01:41:50 +00:00
# The config section determines the player number where the config will be applied on. For example "ControlsP0", "ControlsP1", ...
citra: update default ini with new input system
2017-01-28 13:30:42 +00:00
# It should be in the format of "engine:[engine_name],[param1]:[value1],[param2]:[value2]..."
# Escape characters $0 (for ':'), $1 (for ',') and $2 (for '$') can be used in values
implement circle pad modifier
2016-05-13 15:32:43 +00:00
yuzu-cmd: Update configuration file description
2022-11-27 01:41:50 +00:00
# Indicates if this player should be connected at boot
yuzu_cmd: Fix mismatching controller input
2023-02-04 16:59:14 +00:00
# 0 (default): Disabled, 1: Enabled
yuzu-cmd: Update configuration file description
2022-11-27 01:41:50 +00:00
connected=
Fix some spelling mistakes
2017-08-11 07:51:16 +00:00
# for button input, the following devices are available:
citra: update default ini with new input system
2017-01-28 13:30:42 +00:00
# - "keyboard" (default) for keyboard input. Required parameters:
# - "code": the code of the key to bind
# - "sdl" for joystick input using SDL. Required parameters:
yuzu-cmd: Update configuration file description
2022-11-27 01:41:50 +00:00
# - "guid": SDL identification GUID of the joystick
# - "port": the index of the joystick to bind
citra: update default ini with new input system
2017-01-28 13:30:42 +00:00
# - "button"(optional): the index of the button to bind
# - "hat"(optional): the index of the hat to bind as direction buttons
input_common/sdl: add support for binding button to axis
2017-04-17 08:49:04 +00:00
# - "axis"(optional): the index of the axis to bind
citra: update default ini with new input system
2017-01-28 13:30:42 +00:00
# - "direction"(only used for hat): the direction name of the hat to bind. Can be "up", "down", "left" or "right"
Fix some spelling mistakes
2017-08-11 07:51:16 +00:00
# - "threshold"(only used for axis): a float value in (-1.0, 1.0) which the button is
input_common/sdl: add support for binding button to axis
2017-04-17 08:49:04 +00:00
# triggered if the axis value crosses
# - "direction"(only used for axis): "+" means the button is triggered when the axis value
# is greater than the threshold; "-" means the button is triggered when the axis value
# is smaller than the threshold
citra: update default ini with new input system
2017-01-28 13:30:42 +00:00
button_a=
button_b=
button_x=
button_y=
yuzu_cmd: fix default ini
2018-01-15 07:31:59 +00:00
button_lstick=
button_rstick=
citra: update default ini with new input system
2017-01-28 13:30:42 +00:00
button_l=
button_r=
button_zl=
button_zr=
yuzu_cmd: fix default ini
2018-01-15 07:31:59 +00:00
button_plus=
button_minus=
button_dleft=
button_dup=
button_dright=
button_ddown=
button_lstick_left=
button_lstick_up=
button_lstick_right=
button_lstick_down=
button_sl=
button_sr=
yuzu_cmd: Fix default ini, add screenshot button
2018-01-15 09:27:30 +00:00
button_home=
button_screenshot=
citra: update default ini with new input system
2017-01-28 13:30:42 +00:00
Fix some spelling mistakes
2017-08-11 07:51:16 +00:00
# for analog input, the following devices are available:
move MotionEmu from core/frontend to input_common as a InputDevice
2017-08-06 21:04:06 +00:00
# - "analog_from_button" (default) for emulating analog input from direction buttons. Required parameters:
citra: update default ini with new input system
2017-01-28 13:30:42 +00:00
# - "up", "down", "left", "right": sub-devices for each direction.
# Should be in the format as a button input devices using escape characters, for example, "engine$0keyboard$1code$00"
# - "modifier": sub-devices as a modifier.
# - "modifier_scale": a float number representing the applied modifier scale to the analog input.
# Must be in range of 0.0-1.0. Defaults to 0.5
# - "sdl" for joystick input using SDL. Required parameters:
yuzu-cmd: Update configuration file description
2022-11-27 01:41:50 +00:00
# - "guid": SDL identification GUID of the joystick
# - "port": the index of the joystick to bind
citra: update default ini with new input system
2017-01-28 13:30:42 +00:00
# - "axis_x": the index of the axis to bind as x-axis (default to 0)
# - "axis_y": the index of the axis to bind as y-axis (default to 1)
yuzu_cmd: fix default ini
2018-01-15 07:31:59 +00:00
lstick=
rstick=
Use config files to store whether SDMC is enabled or not Before, it used to use whether the directory actually existed. As a result, .citra-emu/sdmc was never auto-created (something quite confusing to me until I read through the logs).
2014-10-10 02:43:40 +00:00
yuzu-cmd: Update configuration file description
2022-11-27 01:41:50 +00:00
# for motion input, the following devices are available:
# - "keyboard" (default) for emulating random motion input from buttons. Required parameters:
# - "code": the code of the key to bind
# - "sdl" for motion input using SDL. Required parameters:
# - "guid": SDL identification GUID of the joystick
# - "port": the index of the joystick to bind
# - "motion": the index of the motion sensor to bind
# - "cemuhookudp" for motion input using Cemu Hook protocol. Required parameters:
# - "guid": the IP address of the cemu hook server encoded to a hex string. for example 192.168.0.1 = "c0a80001"
# - "port": the port of the cemu hook server
# - "pad": the index of the joystick
# - "motion": the index of the motion sensor of the joystick to bind
motionleft=
motionright=
[ControlsGeneral]
yuzu_cmd: Add missing or update current settings Many settings in common/settings.h are missing from yuzu-cmd, either they were added to default_ini.h but not read in, or vice versa, or the setting was altogether omitted from yuzu-cmd. Some defaults were reported wrong, so those were fixed where noticed.
2021-07-16 00:48:16 +00:00
# To use the debug_pad, prepend `debug_pad_` before each button setting above.
# i.e. debug_pad_button_a=
# Enable debug pad inputs to the guest
# 0 (default): Disabled, 1: Enabled
debug_pad_enabled =
yuzu_cmd: Fix mismatching controller input
2023-02-04 16:59:14 +00:00
# Enable sdl raw input. Allows to configure up to 8 xinput controllers.
# 0 (default): Disabled, 1: Enabled
enable_raw_input =
# Enable yuzu joycon driver instead of SDL drive.
# 0: Disabled, 1 (default): Enabled
enable_joycon_driver =
# Emulates an analog input from buttons. Allowing to dial any angle.
# 0 (default): Disabled, 1: Enabled
emulate_analog_keyboard =
configure_input: Hook up the vibration percentage spinbox This allows setting the vibration strength percentage anywhere from 1% to 100%. Also hooks up the remaining motion button and checkbox in the Controller Applet.
2020-10-09 03:43:07 +00:00
# Whether to enable or disable vibration
# 0: Disabled, 1 (default): Enabled
vibration_enabled=
configure_input: Add per-player vibration Allows for enabling and modifying vibration and vibration strength per player. Also adds a toggle for enabling/disabling accurate vibrations. Co-authored-by: Its-Rei <kupfel@gmail.com>
2020-10-17 13:38:12 +00:00
# Whether to enable or disable accurate vibrations
# 0 (default): Disabled, 1: Enabled
enable_accurate_vibrations=
yuzu_cmd: Add missing or update current settings Many settings in common/settings.h are missing from yuzu-cmd, either they were added to default_ini.h but not read in, or vice versa, or the setting was altogether omitted from yuzu-cmd. Some defaults were reported wrong, so those were fixed where noticed.
2021-07-16 00:48:16 +00:00
# Enables controller motion inputs
# 0: Disabled, 1 (default): Enabled
motion_enabled =
config: Cleanup and documentation
2021-11-04 04:35:45 +00:00
# Defines the udp device's touch screen coordinate system for cemuhookudp devices
# - "min_x", "min_y", "max_x", "max_y"
EmuWindow: refactor touch input into a TouchDevice
2017-08-08 23:57:42 +00:00
touch_device=
yuzu-cmd: Add touch_from_button in config file
2021-06-03 22:58:35 +00:00
# for mapping buttons to touch inputs.
#touch_from_button_map=1
#touch_from_button_maps_0_name=default
#touch_from_button_maps_0_count=2
#touch_from_button_maps_0_bind_0=foo
#touch_from_button_maps_0_bind_1=bar
# etc.
yuzu_cmd: Add missing or update current settings Many settings in common/settings.h are missing from yuzu-cmd, either they were added to default_ini.h but not read in, or vice versa, or the setting was altogether omitted from yuzu-cmd. Some defaults were reported wrong, so those were fixed where noticed.
2021-07-16 00:48:16 +00:00
# List of Cemuhook UDP servers, delimited by ','.
# Default: 127.0.0.1:26760
# Example: 127.0.0.1:26760,123.4.5.67:26761
udp_input_servers =
# Enable controlling an axis via a mouse input.
# 0 (default): Off, 1: On
mouse_panning =
# Set mouse sensitivity.
# Default: 1.0
mouse_panning_sensitivity =
# Emulate an analog control stick from keyboard inputs.
# 0 (default): Disabled, 1: Enabled
emulate_analog_keyboard =
# Enable mouse inputs to the guest
# 0 (default): Disabled, 1: Enabled
mouse_enabled =
# Enable keyboard inputs to the guest
# 0 (default): Disabled, 1: Enabled
keyboard_enabled =
default_ini: Split and concatenate the config string literal We are dangerously close to MSVC's 16384 character limit for string literals. Breaking this string up and concatenating will allow for more settings to be added in the future.
2023-01-25 19:04:01 +00:00
)"
R"(
Use configuration files to enable or disable the new dyncom interpreter.
2014-10-25 19:54:44 +00:00
[Core]
core: Add a configuration setting for use_multi_core.
2018-05-03 04:34:54 +00:00
# Whether to use multi-core for CPU emulation
yuzu: settings: Enable multicore, asynch GPU, and assembly shaders by default. - In general, this is now the preferred settings for most games. # Conflicts: # src/yuzu/configuration/config.cpp
2020-10-27 06:13:05 +00:00
# 0: Disabled, 1 (default): Enabled
default_ini: List use_extended_memory_layout in default config file
2022-03-15 07:10:44 +00:00
use_multi_core =
# Enable extended guest system memory layout (6GB DRAM)
# 0 (default): Disabled, 1: Enabled
use_extended_memory_layout =
core: Add a configuration setting for use_multi_core.
2018-05-03 04:34:54 +00:00
configuration: Add settings to enable/disable specific CPU optimizations
2020-07-11 13:26:36 +00:00
[Cpu]
yuzu_cmd: Add missing or update current settings Many settings in common/settings.h are missing from yuzu-cmd, either they were added to default_ini.h but not read in, or vice versa, or the setting was altogether omitted from yuzu-cmd. Some defaults were reported wrong, so those were fixed where noticed.
2021-07-16 00:48:16 +00:00
# Adjusts various optimizations.
# Auto-select mode enables choice unsafe optimizations.
# Accurate enables only safe optimizations.
# Unsafe allows any unsafe optimizations.
# 0 (default): Auto-select, 1: Accurate, 2: Enable unsafe optimizations
cpu_accuracy =
# Allow disabling safe optimizations.
# 0 (default): Disabled, 1: Enabled
cpu_debug_mode =
configuration: Add settings to enable/disable specific CPU optimizations
2020-07-11 13:26:36 +00:00
# Enable inline page tables optimization (faster guest memory access)
# 0: Disabled, 1 (default): Enabled
cpuopt_page_tables =
# Enable block linking CPU optimization (reduce block dispatcher use during predictable jumps)
# 0: Disabled, 1 (default): Enabled
cpuopt_block_linking =
# Enable return stack buffer CPU optimization (reduce block dispatcher use during predictable returns)
# 0: Disabled, 1 (default): Enabled
cpuopt_return_stack_buffer =
# Enable fast dispatcher CPU optimization (use a two-tiered dispatcher architecture)
# 0: Disabled, 1 (default): Enabled
cpuopt_fast_dispatcher =
# Enable context elimination CPU Optimization (reduce host memory use for guest context)
# 0: Disabled, 1 (default): Enabled
cpuopt_context_elimination =
# Enable constant propagation CPU optimization (basic IR optimization)
# 0: Disabled, 1 (default): Enabled
cpuopt_const_prop =
# Enable miscellaneous CPU optimizations (basic IR optimization)
# 0: Disabled, 1 (default): Enabled
cpuopt_misc_ir =
# Enable reduction of memory misalignment checks (reduce memory fallbacks for misaligned access)
# 0: Disabled, 1 (default): Enabled
cpuopt_reduce_misalign_checks =
General: Add settings for fastmem and disabling adress space check.
2021-06-06 07:57:24 +00:00
# Enable Host MMU Emulation (faster guest memory access)
# 0: Disabled, 1 (default): Enabled
cpuopt_fastmem =
dynarmic: Inline exclusive memory accesses Inlines implementation of exclusive instructions into JITted code, improving performance of applications relying heavily on these instructions. We also fastmem these instructions for additional speed, with support for appropriate recompilation on fastmem failure. An unsafe optimization to disable the intercore global_monitor is also provided, should one wish to rely solely on cmpxchg semantics for safety. See also: merryhime/dynarmic#664
2022-02-27 19:40:05 +00:00
# Enable Host MMU Emulation for exclusive memory instructions (faster guest memory access)
# 0: Disabled, 1 (default): Enabled
cpuopt_fastmem_exclusives =
# Enable fallback on failure of fastmem of exclusive memory instructions (faster guest memory access)
# 0: Disabled, 1 (default): Enabled
cpuopt_recompile_exclusives =
core: add option to break on unmapped access
2022-12-02 03:48:43 +00:00
# Enable optimization to ignore invalid memory accesses (faster guest memory access)
# 0: Disabled, 1 (default): Enabled
cpuopt_ignore_memory_aborts =
yuzu_cmd: Add missing or update current settings Many settings in common/settings.h are missing from yuzu-cmd, either they were added to default_ini.h but not read in, or vice versa, or the setting was altogether omitted from yuzu-cmd. Some defaults were reported wrong, so those were fixed where noticed.
2021-07-16 00:48:16 +00:00
# Enable unfuse FMA (improve performance on CPUs without FMA)
# Only enabled if cpu_accuracy is set to Unsafe. Automatically chosen with cpu_accuracy = Auto-select.
# 0: Disabled, 1 (default): Enabled
cpuopt_unsafe_unfuse_fma =
# Enable faster FRSQRTE and FRECPE
# Only enabled if cpu_accuracy is set to Unsafe.
# 0: Disabled, 1 (default): Enabled
cpuopt_unsafe_reduce_fp_error =
# Enable faster ASIMD instructions (32 bits only)
# Only enabled if cpu_accuracy is set to Unsafe. Automatically chosen with cpu_accuracy = Auto-select.
# 0: Disabled, 1 (default): Enabled
cpuopt_unsafe_ignore_standard_fpcr =
# Enable inaccurate NaN handling
# Only enabled if cpu_accuracy is set to Unsafe. Automatically chosen with cpu_accuracy = Auto-select.
# 0: Disabled, 1 (default): Enabled
cpuopt_unsafe_inaccurate_nan =
# Disable address space checks (64 bits only)
# Only enabled if cpu_accuracy is set to Unsafe. Automatically chosen with cpu_accuracy = Auto-select.
# 0: Disabled, 1 (default): Enabled
cpuopt_unsafe_fastmem_check =
dynarmic: Inline exclusive memory accesses Inlines implementation of exclusive instructions into JITted code, improving performance of applications relying heavily on these instructions. We also fastmem these instructions for additional speed, with support for appropriate recompilation on fastmem failure. An unsafe optimization to disable the intercore global_monitor is also provided, should one wish to rely solely on cmpxchg semantics for safety. See also: merryhime/dynarmic#664
2022-02-27 19:40:05 +00:00
# Enable faster exclusive instructions
# Only enabled if cpu_accuracy is set to Unsafe. Automatically chosen with cpu_accuracy = Auto-select.
# 0: Disabled, 1 (default): Enabled
cpuopt_unsafe_ignore_global_monitor =
default_ini: Split and concatenate the config string literal We are dangerously close to MSVC's 16384 character limit for string literals. Breaking this string up and concatenating will allow for more settings to be added in the future.
2023-01-25 19:04:01 +00:00
)"
R"(
Allow the user to set the background clear color during emulation The background color can be seen at the sides of the bottom screen or when the window is wider than normal.
2015-04-03 22:35:51 +00:00
[Renderer]
settings: Add settings for graphics backend
2020-01-21 19:37:41 +00:00
# Which backend API to use.
default_ini: Reflect new renderer backend default setting
2022-05-28 06:32:57 +00:00
# 0: OpenGL, 1 (default): Vulkan
settings: Add settings for graphics backend
2020-01-21 19:37:41 +00:00
backend =
# Enable graphics API debugging mode.
# 0 (default): Disabled, 1: Enabled
debug =
renderer_vulkan: Add setting to log pipeline statistics Use VK_KHR_pipeline_executable_properties when enabled and available to log statistics about the pipeline cache in a game. For example, this is on Turing GPUs when generating a pipeline cache from Super Smash Bros. Ultimate: Average pipeline statistics ========================================== Code size: 6433.167 Register count: 32.939 More advanced results could be presented, at the moment it's just an average of all 3D and compute pipelines.
2021-07-27 22:15:32 +00:00
# Enable shader feedback.
# 0 (default): Disabled, 1: Enabled
renderer_shader_feedback =
shader: Add shader loop safety check settings Also add a setting for enable Nsight Aftermath.
2021-07-08 21:22:31 +00:00
# Enable Nsight Aftermath crash dumps
# 0 (default): Disabled, 1: Enabled
nsight_aftermath =
# Disable shader loop safety checks, executing the shader without loop logic changes
# 0 (default): Disabled, 1: Enabled
disable_shader_loop_safety_checks =
settings: Add settings for graphics backend
2020-01-21 19:37:41 +00:00
# Which Vulkan physical device to use (defaults to 0)
vulkan_device =
yuzu_cmd: Read resolution_setup and scaling_filter from config Also adds descriptions and the settings to the default config.
2021-10-09 00:48:10 +00:00
# 0: 0.5x (360p/540p) [EXPERIMENTAL]
# 1: 0.75x (540p/810p) [EXPERIMENTAL]
# 2 (default): 1x (720p/1080p)
# 3: 2x (1440p/2160p)
# 4: 3x (2160p/3240p)
# 5: 4x (2880p/4320p)
# 6: 5x (3600p/5400p)
# 7: 6x (4320p/6480p)
resolution_setup =
# Pixel filter to use when up- or down-sampling rendered frames.
# 0: Nearest Neighbor
# 1 (default): Bilinear
# 2: Bicubic
# 3: Gaussian
# 4: ScaleForce
# 5: AMD FidelityFX™️ Super Resolution [Vulkan Only]
scaling_filter =
# Anti-Aliasing (AA)
# 0 (default): None, 1: FXAA
anti_aliasing =
yuzu_cmd: Make use of fullscreen_mode setting Reverts 48259de0c1a6a1aca77eec31cb8aca5ca2b680dd to the previous hierarchy and fixes the resolution issue with this fullscreen mode. yuzu-cmd will now read the fullscreen_mode setting and use it appropriately.
2021-07-21 23:48:03 +00:00
# Whether to use fullscreen or borderless window mode
# 0 (Windows default): Borderless window, 1 (All other default): Exclusive fullscreen
fullscreen_mode =
Add following aspect ratios: 16:9, 21:9, Stretch to Window Available as a drop down within the configure graphics tab.
2020-02-14 03:17:28 +00:00
# Aspect ratio
Add 4:3 aspect ratio and address feedback
2020-02-14 19:39:04 +00:00
# 0: Default (16:9), 1: Force 4:3, 2: Force 21:9, 3: Stretch to Window
Add following aspect ratios: 16:9, 21:9, Stretch to Window Available as a drop down within the configure graphics tab.
2020-02-14 03:17:28 +00:00
aspect_ratio =
Create an "Advanced" tab in the graphics configuration tab and add anisotropic filtering levels.
2020-02-24 00:01:17 +00:00
# Anisotropic filtering
# 0: Default, 1: 2x, 2: 4x, 3: 8x, 4: 16x
max_anisotropy =
config: Add a setting for graphics V-Sync.
2016-08-25 22:20:47 +00:00
# Whether to enable V-Sync (caps the framerate at 60FPS) or not.
# 0 (default): Off, 1: On
use_vsync =
general: Add setting shader_backend GLASM is getting good enough that we can move it out of advanced graphics settings. This removes the setting `use_assembly_shaders`, opting for a enum class `shader_backend`. This comes with the benefits that it is extensible for additional shader backends besides GLSL and GLASM, and this will work better with a QComboBox. Qt removes the related assembly shader setting from the Advanced Graphics section and places it as a new QComboBox in the API Settings group. This will replace the Vulkan device selector when OpenGL is selected. Additionally, mark all of the custom anisotropic filtering settings as "WILL BREAK THINGS", as that is the case with a select few games.
2021-07-08 21:28:48 +00:00
# Selects the OpenGL shader backend. NV_gpu_program5 is required for GLASM. If NV_gpu_program5 is
# not available and GLASM is selected, GLSL will be used.
# 0: GLSL, 1 (default): GLASM, 2: SPIR-V
shader_backend =
yuzu: Add frontend settings for assembly shaders Add settings for assembly shaders. Currently hidden to avoid users from accidentally enabled them.
2020-05-18 00:06:32 +00:00
Rebase for per game settings
2020-07-10 04:00:02 +00:00
# Whether to allow asynchronous shader building.
# 0 (default): Off, 1: On
use_asynchronous_shaders =
configure_graphics: Add GPU nvdec decoding as an option Some system configurations may see visual regressions or lower performance using GPU decoding compared to CPU decoding. This setting provides the option for users to specify their decoding preference. Co-Authored-By: yzct12345 <87620833+yzct12345@users.noreply.github.com>
2021-08-08 20:56:40 +00:00
# NVDEC emulation.
# 0: Disabled, 1: CPU Decoding, 2 (default): GPU Decoding
nvdec_emulation =
yuzu_cmd/config: Add Accelerate ASTC and missing NVDEC emulation settings
2021-06-13 19:40:21 +00:00
# Accelerate ASTC texture decoding.
# 0: Off, 1 (default): On
accelerate_astc =
general: Rename "Frame Limit" references to "Speed Limit" This setting is best referred to as a speed limit, as it involves the limits of all timing based aspects of the emulator, not only framerate. This allows us to differentiate it from the fps unlocker setting.
2021-07-22 23:56:21 +00:00
# Turns on the speed limiter, which will limit the emulation speed to the desired speed limit value
Port #3353 from Citra
2018-08-20 23:14:06 +00:00
# 0: Off, 1: On (default)
general: Rename "Frame Limit" references to "Speed Limit" This setting is best referred to as a speed limit, as it involves the limits of all timing based aspects of the emulator, not only framerate. This allows us to differentiate it from the fps unlocker setting.
2021-07-22 23:56:21 +00:00
use_speed_limit =
Port #3353 from Citra
2018-08-20 23:14:06 +00:00
# Limits the speed of the game to run no faster than this value as a percentage of target speed
# 1 - 9999: Speed limit as a percentage of target game speed. 100 (default)
general: Rename "Frame Limit" references to "Speed Limit" This setting is best referred to as a speed limit, as it involves the limits of all timing based aspects of the emulator, not only framerate. This allows us to differentiate it from the fps unlocker setting.
2021-07-22 23:56:21 +00:00
speed_limit =
Port #3353 from Citra
2018-08-20 23:14:06 +00:00
settings: Hide shader cache behind a setting
2019-01-14 05:14:27 +00:00
# Whether to use disk based shader cache
yuzu_cmd: Add missing or update current settings Many settings in common/settings.h are missing from yuzu-cmd, either they were added to default_ini.h but not read in, or vice versa, or the setting was altogether omitted from yuzu-cmd. Some defaults were reported wrong, so those were fixed where noticed.
2021-07-16 00:48:16 +00:00
# 0: Off, 1 (default): On
settings: Hide shader cache behind a setting
2019-01-14 05:14:27 +00:00
use_disk_shader_cache =
UI: Replasce accurate GPU option for GPU Accuracy Level
2020-02-18 20:51:42 +00:00
# Which gpu accuracy level to use
yuzu_cmd: Add missing or update current settings Many settings in common/settings.h are missing from yuzu-cmd, either they were added to default_ini.h but not read in, or vice versa, or the setting was altogether omitted from yuzu-cmd. Some defaults were reported wrong, so those were fixed where noticed.
2021-07-16 00:48:16 +00:00
# 0: Normal, 1 (default): High, 2: Extreme (Very slow)
UI: Replasce accurate GPU option for GPU Accuracy Level
2020-02-18 20:51:42 +00:00
gpu_accuracy =
settings: Add a configuration for use_accurate_framebuffers.
2018-06-26 18:36:26 +00:00
settings: Add new graphics setting for use_asynchronous_gpu_emulation.
2019-01-08 02:46:33 +00:00
# Whether to use asynchronous GPU emulation
# 0 : Off (slow), 1 (default): On (fast)
use_asynchronous_gpu_emulation =
yuzu_cmd: Add missing or update current settings Many settings in common/settings.h are missing from yuzu-cmd, either they were added to default_ini.h but not read in, or vice versa, or the setting was altogether omitted from yuzu-cmd. Some defaults were reported wrong, so those were fixed where noticed.
2021-07-16 00:48:16 +00:00
# Inform the guest that GPU operations completed more quickly than they did.
# 0: Off, 1 (default): On
use_fast_gpu_time =
video_core: add option for pessimistic flushing
2022-08-25 16:32:14 +00:00
# Force unmodified buffers to be flushed, which can cost performance.
# 0: Off (default), 1: On
use_pessimistic_flushes =
Reaper: Change memory restrictions on TC depending on host memory on VK.
2021-06-16 22:29:48 +00:00
# Whether to use garbage collection or not for GPU caches.
Reaper: Setup settings and final tuning.
2021-06-14 09:58:36 +00:00
# 0 (default): Off, 1: On
use_caches_gc =
config: SDL: Move background color setting to correct section.
2016-12-30 05:35:38 +00:00
# The clear color for the renderer. What shows up on the sides of the bottom screen.
configure_graphics: Use u8 for bg_color values
2021-07-09 01:45:01 +00:00
# Must be in range of 0-255. Defaults to 0 for all.
config: SDL: Move background color setting to correct section.
2016-12-30 05:35:38 +00:00
bg_red =
bg_blue =
bg_green =
default_ini: Split and concatenate the config string literal We are dangerously close to MSVC's 16384 character limit for string literals. Breaking this string up and concatenating will allow for more settings to be added in the future.
2023-01-25 19:04:01 +00:00
)"
R"(
Audio: Add sink selection to configuration files
2016-04-27 12:53:23 +00:00
[Audio]
# Which audio output engine to use.
Various suggestions by v1993 and lioncash
2021-06-07 10:51:59 +00:00
# auto (default): Auto-select
# cubeb: Cubeb audio engine (if available)
Add sdl2 audio description in the yuzu-cmd config file
2021-06-06 09:22:22 +00:00
# sdl2: SDL2 audio engine (if available)
Various suggestions by v1993 and lioncash
2021-06-07 10:51:59 +00:00
# null: No audio output
Audio: Add sink selection to configuration files
2016-04-27 12:53:23 +00:00
output_engine =
SDL: Select audio device (#2403) * Initial Commit Added Device logic to Sinks Started on UI for selecting devices Removed redundant import * Audio Core: Complete Device Switching Complete the device switching implementation by allowing the output device to be loaded, changed and saved through the configurations menu. Worked with the Sink abstraction and tuned the "Device Selection" configuration so that the Device List is automatically populated when the Sink is changed. This hopefully addresses the concerns and recommendations mentioned in the comments of the PR. * Clean original implementation. * Refactor GetSinkDetails
2017-01-26 03:33:26 +00:00
# Which audio device to use.
# auto (default): Auto-select
output_device =
audio_core: Add configuration settings.
2018-07-31 03:57:53 +00:00
# Output volume.
configure_audio: Use u8 for volume value
2021-07-09 00:58:38 +00:00
# 100 (default): 100%, 0; mute
audio_core: Add configuration settings.
2018-07-31 03:57:53 +00:00
volume =
Use config files to store whether SDMC is enabled or not Before, it used to use whether the directory actually existed. As a result, .citra-emu/sdmc was never auto-created (something quite confusing to me until I read through the logs).
2014-10-10 02:43:40 +00:00
[Data Storage]
default_ini.h: Put comments on their own lines Apparently inline comments is not necessarily standard in the INI format, and our parser was erroneously parsing the comments as values.
2015-01-06 02:25:57 +00:00
# Whether to create a virtual SD card.
# 1 (default): Yes, 0: No
Use config files to store whether SDMC is enabled or not Before, it used to use whether the directory actually existed. As a result, .citra-emu/sdmc was never auto-created (something quite confusing to me until I read through the logs).
2014-10-10 02:43:40 +00:00
use_virtual_sd =
Add support for disabling log from settings
2014-10-27 21:18:28 +00:00
settings: Add options for managing gamecard emulation
2019-04-23 12:35:12 +00:00
# Whether or not to enable gamecard emulation
# 1: Yes, 0 (default): No
filesystem: Add const qualification to various accessors
2019-04-23 18:38:18 +00:00
gamecard_inserted =
settings: Add options for managing gamecard emulation
2019-04-23 12:35:12 +00:00
# Whether or not the gamecard should be emulated as the current game
# If 'gamecard_inserted' is 0 this setting is irrelevant
# 1: Yes, 0 (default): No
filesystem: Add const qualification to various accessors
2019-04-23 18:38:18 +00:00
gamecard_current_game =
settings: Add options for managing gamecard emulation
2019-04-23 12:35:12 +00:00
# Path to an XCI file to use as the gamecard
# If 'gamecard_inserted' is 0 this setting is irrelevant
# If 'gamecard_current_game' is 1 this setting is irrelevant
filesystem: Add const qualification to various accessors
2019-04-23 18:38:18 +00:00
gamecard_path =
settings: Add options for managing gamecard emulation
2019-04-23 12:35:12 +00:00
SDL2: Add forgotten default config changes from 7129611e65096ba2cbe8266f6cb068a9b18981d8.
2016-06-11 01:19:51 +00:00
[System]
config: Add setting for whether the system is docked or not.
2018-03-27 02:24:31 +00:00
# Whether the system is docked
config: Enable docked mode by default
2021-01-10 14:37:38 +00:00
# 1 (default): Yes, 0: No
config: Rename is_docked to use_docked_mode to be consistent with other config bools.
2018-03-27 02:59:18 +00:00
use_docked_mode =
config: Add setting for whether the system is docked or not.
2018-03-27 02:24:31 +00:00
settings: Add config option to set RNG seed
2018-11-12 03:34:23 +00:00
# Sets the seed for the RNG generator built into the switch
# rng_seed will be ignored and randomly generated if rng_seed_enabled is false
rng_seed_enabled =
rng_seed =
settings: Add custom RTC settings Stored as signed seconds since epoch.
2018-12-28 23:35:55 +00:00
# Sets the current time (in seconds since 12:00 AM Jan 1, 1970) that will be used by the time service
# This will auto-increment, with the time set being the time the game is started
# This override will only occur if custom_rtc_enabled is true, otherwise the current time is used
time: Use custom RTC settings if applicable for game
2018-12-29 00:09:57 +00:00
custom_rtc_enabled =
custom_rtc =
settings: Add custom RTC settings Stored as signed seconds since epoch.
2018-12-28 23:35:55 +00:00
Added ability to change username & language code in the settings ui. Added IProfile::Get and SET::GetLanguageCode for libnx tests (#851)
2018-08-03 15:02:55 +00:00
# Sets the systems language index
# 0: Japanese, 1: English (default), 2: French, 3: German, 4: Italian, 5: Spanish, 6: Chinese,
# 7: Korean, 8: Dutch, 9: Portuguese, 10: Russian, 11: Taiwanese, 12: British English, 13: Canadian French,
configure_system: Add Brazilian Portuguese to the list of languages
2021-07-27 13:33:03 +00:00
# 14: Latin American Spanish, 15: Simplified Chinese, 16: Traditional Chinese, 17: Brazilian Portuguese
Added ability to change username & language code in the settings ui. Added IProfile::Get and SET::GetLanguageCode for libnx tests (#851)
2018-08-03 15:02:55 +00:00
language_index =
Remove some references to Citra
2018-07-06 13:47:06 +00:00
# The system region that yuzu will use during emulation
Config: auto-select region and language
2016-11-30 09:32:09 +00:00
# -1: Auto-select (default), 0: Japan, 1: USA, 2: Europe, 3: Australia, 4: China, 5: Korea, 6: Taiwan
yuzu_cmd: Add missing or update current settings Many settings in common/settings.h are missing from yuzu-cmd, either they were added to default_ini.h but not read in, or vice versa, or the setting was altogether omitted from yuzu-cmd. Some defaults were reported wrong, so those were fixed where noticed.
2021-07-16 00:48:16 +00:00
region_index =
Services: Stub some functions
2015-01-31 23:11:51 +00:00
core: settings: Add a setting for time zone.
2020-05-11 21:50:07 +00:00
# The system time zone that yuzu will use during emulation
# 0: Auto-select (default), 1: Default (system archive value), Others: Index for specified time zone
time_zone_index =
yuzu_cmd: Add missing or update current settings Many settings in common/settings.h are missing from yuzu-cmd, either they were added to default_ini.h but not read in, or vice versa, or the setting was altogether omitted from yuzu-cmd. Some defaults were reported wrong, so those were fixed where noticed.
2021-07-16 00:48:16 +00:00
# Sets the sound output mode.
# 0: Mono, 1 (default): Stereo, 2: Surround
sound_index =
Add support for disabling log from settings
2014-10-27 21:18:28 +00:00
[Miscellaneous]
default_ini.h: Put comments on their own lines Apparently inline comments is not necessarily standard in the INI format, and our parser was erroneously parsing the comments as values.
2015-01-06 02:25:57 +00:00
# A filter which removes logs below a certain logging level.
# Examples: *:Debug Kernel.SVC:Trace Service.*:Critical
config: Default log filter to trace.
2018-01-13 21:23:12 +00:00
log_filter = *:Trace
Implement gdbstub
2015-09-02 12:56:38 +00:00
yuzu_cmd: Add missing or update current settings Many settings in common/settings.h are missing from yuzu-cmd, either they were added to default_ini.h but not read in, or vice versa, or the setting was altogether omitted from yuzu-cmd. Some defaults were reported wrong, so those were fixed where noticed.
2021-07-16 00:48:16 +00:00
# Use developer keys
# 0 (default): Disabled, 1: Enabled
use_dev_keys =
Implement gdbstub
2015-09-02 12:56:38 +00:00
[Debugging]
Add frametime logging for tracking performance over time Co-Authored-By: jroweboy <jroweboy@gmail.com>
2019-08-26 15:29:08 +00:00
# Record frame time data, can be found in the log directory. Boolean value
record_frame_times =
settings: Add option to dump ExeFS of games upon launch When enabled, all exefs(es) will be copied to yuzu/dump/<title_id>/exefs.
2018-11-20 22:49:09 +00:00
# Determines whether or not yuzu will dump the ExeFS of all games it attempts to load while loading them
dump_exefs=false
settings: Add setting to control NSO dumping Also adds UI option in Debug > Dump section, with the idea later things to be dumped (i.e. other game data or textures, etc) will use the same group box.
2018-10-29 20:09:08 +00:00
# Determines whether or not yuzu will dump all NSOs it attempts to load while loading them
dump_nso=false
fsp_srv: Fix filesystem access logging This introduces a new setting Enable FS Access Log which saves the filesystem access log to sdmc:/FsAccessLog.txt If this setting is not enabled, this will indicate to FS to not call OutputAccessLogToSdCard. Fixes softlocks during loading in Xenoblade Chronicles 2 when certain DLC is enabled.
2021-06-13 08:30:54 +00:00
# Determines whether or not yuzu will save the filesystem access log.
enable_fs_access_log=false
yuzu_cmd: Add missing or update current settings Many settings in common/settings.h are missing from yuzu-cmd, either they were added to default_ini.h but not read in, or vice versa, or the setting was altogether omitted from yuzu-cmd. Some defaults were reported wrong, so those were fixed where noticed.
2021-07-16 00:48:16 +00:00
# Enables verbose reporting services
reporting_services =
settings: Add config option for kiosk (quest) mode
2019-06-28 22:37:33 +00:00
# Determines whether or not yuzu will report to the game that the emulated console is in Kiosk Mode
# false: Retail/Normal Mode (default), true: Kiosk Mode
quest_flag =
core: settings: Add setting for debug assertions and disable by default. - This is a developer-only setting and no longer needs to be enabled by default. - Also adds "use_auto_stub" setting to SDL frontend while we are here. - Supersedes #1340.
2021-04-14 01:38:10 +00:00
# Determines whether debug asserts should be enabled, which will throw an exception on asserts.
# false: Disabled (default), true: Enabled
use_debug_asserts =
# Determines whether unimplemented HLE service calls should be automatically stubbed.
# false: Disabled (default), true: Enabled
use_auto_stub =
Implement macro JIT
2020-05-29 04:53:27 +00:00
# Enables/Disables the macro JIT compiler
disable_macro_jit=false
core/debugger: support operation in yuzu-cmd
2022-06-10 13:11:02 +00:00
# Determines whether to enable the GDB stub and wait for the debugger to attach before running.
# false: Disabled (default), true: Enabled
use_gdbstub=false
# The port to use for the GDB server, if it is enabled.
gdbstub_port=6543
settings: Add telemetry endpoint URL.
2017-06-28 02:46:52 +00:00
[WebService]
settings: Add enable_telemetry, citra_username, and citra_token.
2017-08-23 02:37:03 +00:00
# Whether or not to enable telemetry
# 0: No, 1 (default): Yes
enable_telemetry =
Port web_service from Citra
2018-09-16 18:05:51 +00:00
# URL for Web API
web_api_url = https://api.yuzu-emu.org
Change Telemetry Names to yuzu
2018-03-24 08:18:48 +00:00
# Username and token for yuzu Web Service
Review comments - part 3
2018-09-19 18:04:45 +00:00
# See https://profile.yuzu-emu.org/ for more info
Change Telemetry Names to yuzu
2018-03-24 08:18:48 +00:00
yuzu_username =
yuzu_token =
config: Store and load disabled add-ons list
2018-11-28 19:00:01 +00:00
config: Read network_interface Let's yuzu_cmd use a network interface. Also adds it to the default ini.
2021-10-15 16:14:09 +00:00
[Network]
# Name of the network interface device to use with yuzu LAN play.
# e.g. On *nix: 'enp7s0', 'wlp6s0u1u3u3', 'lo'
# e.g. On Windows: 'Ethernet', 'Wi-Fi'
network_interface =
config: Store and load disabled add-ons list
2018-11-28 19:00:01 +00:00
[AddOns]
# Used to disable add-ons
# List of title IDs of games that will have add-ons disabled (separated by '|'):
qt: Add Properties menu to game list right-click
2018-12-04 18:34:46 +00:00
title_ids =
config: Store and load disabled add-ons list
2018-11-28 19:00:01 +00:00
# For each title ID, have a key/value pair called `disabled_<title_id>` equal to the names of the add-ons to disable (sep. by '|')
# e.x. disabled_0100000000010000 = Update|DLC <- disables Updates and DLC on Super Mario Odyssey
Added configuration file system. Uses QSettings on citra-qt, and inih on citra-cli.
2014-09-13 00:06:13 +00:00
)";
default_ini: Remove deprecated settings These settings are not being read in config.cpp AND they do not exist in common/settings.h. Remove their references.
2021-07-15 20:24:08 +00:00
} // namespace DefaultINI
Reference in New Issue Copy Permalink