aboutsummaryrefslogtreecommitdiff
path: root/CONFIG.md
diff options
context:
space:
mode:
authorjduncanator <1518948+jduncanator@users.noreply.github.com>2019-02-11 23:00:32 +1100
committergdkchan <gab.dark.100@gmail.com>2019-02-11 09:00:32 -0300
commitd306115750df9df170cfef4d49c6b0b7af498962 (patch)
tree13e51d71ad264c8815106dc6a3190af02d193777 /CONFIG.md
parenta694420d11ef74e4f0bf473be2b6f64635bc89c7 (diff)
Logger and Configuration Refactoring (#573)
* Logging: Refactor log targets into Ryujinx.Common * Logger: Implement JSON Log Target * Logger: Optimize Console/File logging targets Implement a simple ObjectPool to pool up StringBuilders to avoid causing excessive GCing of gen1/2 items when large amounts of log entries are being generated. We can also pre-determine the async overflow action at initialization time, allowing for an easy optimization in the message enqueue function, avoiding a number of comparisons. * Logger: Implement LogFormatters * Config: Refactor configuration file and loading * Config: Rename to .jsonc to avoid highlighting issues in VSC and GitHub * Resolve style nits * Config: Resolve incorrect default key binding * Config: Also update key binding default in schema * Tidy up namespace imports * Config: Update CONFIG.md to reflect new Config file
Diffstat (limited to 'CONFIG.md')
-rw-r--r--CONFIG.md208
1 files changed, 105 insertions, 103 deletions
diff --git a/CONFIG.md b/CONFIG.md
index eef7b68d..b63f5e83 100644
--- a/CONFIG.md
+++ b/CONFIG.md
@@ -1,123 +1,124 @@
## Config File
-`Ryujinx.conf` should be present in executable folder (It's an *.ini file) following this format:
+`Config.jsonc` should be present in executable folder. The available settings follow:
-- `Logging_Enable_Info` *(bool)*
+- `graphics_shaders_dump_path` *(string)*
- Enable the Informations Logging.
-
-- `Logging_Enable_Trace` *(bool)*
+ Dump shaders in local directory (e.g. `C:\ShaderDumps`)
- Enable the Trace Logging (Enabled in Debug recommended).
-
-- `Logging_Enable_Debug` *(bool)*
+- `logging_enable_debug` *(bool)*
- Enable the Debug Logging (Enabled in Debug recommended).
+ Enable the Debug Logging.
-- `Logging_Enable_Warn` *(bool)*
+- `logging_enable_stub` *(bool)*
- Enable the Warning Logging (Enabled in Debug recommended).
+ Enable the Trace Logging.
-- `Logging_Enable_Error` *(bool)*
+- `logging_enable_info` *(bool)*
- Enable the Error Logging (Enabled in Debug recommended).
+ Enable the Informations Logging.
-- `Logging_Enable_Fatal` *(bool)*
+- `logging_enable_warn` *(bool)*
- Enable the Fatal Logging (Enabled in Debug recommended).
+ Enable the Warning Logging.
-- `Logging_Enable_Ipc` *(bool)*
+- `logging_enable_error` *(bool)*
- Enable the Ipc Message Logging.
+ Enable the Error Logging.
-- `Logging_Enable_LogFile` *(bool)*
+- `enable_file_log` *(bool)*
Enable writing the logging inside a Ryujinx.log file.
-
-- `GamePad_Index` *(int)*
- The index of the Controller Device.
-
-- `GamePad_Deadzone` *(float)*
-
- The deadzone of both analog sticks on the Controller.
-
-- `GamePad_Enable` *(bool)*
-
- Whether or not to enable Controller Support.
+- `system_language` *(string)*
+
+ Change System Language, [System Language list](https://gist.github.com/HorrorTroll/b6e4a88d774c3c9b3bdf54d79a7ca43b)
+
+- `docked_mode` *(bool)*
+
+ Enable or Disable Docked Mode
+
+- `enable_vsync` *(bool)*
+
+ Enable or Disable Game Vsync
+
+- `enable_multicore_scheduling` *(bool)*
+
+ Enable or Disable Multi-core scheduling of threads
+
+- `enable_fs_integrity_checks` *(bool)*
+
+ Enable integrity checks on Switch content files
+
+- `controller_type` *(string)*
+
+ The primary controller's type.
+ Supported Values: `Handheld`, `ProController`, `NpadPair`, `NpadLeft`, `NpadRight`
+
+- `keyboard_controls` *(object)* :
+ - `left_joycon` *(object)* :
+ Left JoyCon Keyboard Bindings
+ - `stick_up` *(string)*
+ - `stick_down` *(string)*
+ - `stick_left` *(string)*
+ - `stick_right` *(string)*
+ - `stick_button` *(string)*
+ - `dpad_up` *(string)*
+ - `dpad_down` *(string)*
+ - `dpad_left` *(string)*
+ - `dpad_right` *(string)*
+ - `button_minus` *(string)*
+ - `button_l` *(string)*
+ - `button_zl` *(string)*
+ - `right_joycon` *(object)* :
+ Right JoyCon Keyboard Bindings
+ - `stick_up` *(string)*
+ - `stick_down` *(string)*
+ - `stick_left` *(string)*
+ - `stick_right` *(string)*
+ - `stick_button` *(string)*
+ - `button_a` *(string)*
+ - `button_b` *(string)*
+ - `button_x` *(string)*
+ - `button_y` *(string)*
+ - `button_plus` *(string)*
+ - `button_r` *(string)*
+ - `button_zr` *(string)*
+
+- `gamepad_controls` *(object)* :
+ - `enabled` *(bool)*
+ Whether or not to enable Controller Support.
+ - `index` *(int)*
+ The index of the Controller Device.
+ - `deadzone` *(number)*
+ The deadzone of both analog sticks on the Controller.
+ - `trigger_threshold` *(number)*
+ The value of how pressed down each trigger has to be in order to register a button press
+ - `left_joycon` *(object)* :
+ Left JoyCon Controller Bindings
+ - `stick` *(string)*
+ - `stick_button` *(string)*
+ - `dpad_up` *(string)*
+ - `dpad_down` *(string)*
+ - `dpad_left` *(string)*
+ - `dpad_right` *(string)*
+ - `button_minus` *(string)*
+ - `button_l` *(string)*
+ - `button_zl` *(string)*
+ - `right_joycon` *(object)* :
+ Right JoyCon Controller Bindings
+ - `stick` *(string)*
+ - `stick_button` *(string)*
+ - `button_a` *(string)*
+ - `button_b` *(string)*
+ - `button_x` *(string)*
+ - `button_y` *(string)*
+ - `button_plus` *(string)*
+ - `button_r` *(string)*
+ - `button_zr` *(string)*
-- `Controls_Left_JoyConKeyboard_XX` *(int)*
- ```
- Controls_Left_JoyConKeyboard_Stick_Up (int)
- Controls_Left_JoyConKeyboard_Stick_Down (int)
- Controls_Left_JoyConKeyboard_Stick_Left (int)
- Controls_Left_JoyConKeyboard_Stick_Right (int)
- Controls_Left_JoyConKeyboard_Stick_Button (int)
- Controls_Left_JoyConKeyboard_DPad_Up (int)
- Controls_Left_JoyConKeyboard_DPad_Down (int)
- Controls_Left_JoyConKeyboard_DPad_Left (int)
- Controls_Left_JoyConKeyboard_DPad_Right (int)
- Controls_Left_JoyConKeyboard_Button_Minus (int)
- Controls_Left_JoyConKeyboard_Button_L (int)
- Controls_Left_JoyConKeyboard_Button_ZL (int)
- ```
-
- Keys of the Left Emulated Joycon, the values depend of the [OpenTK Enum Keys](https://github.com/opentk/opentk/blob/develop/src/OpenTK/Input/Key.cs).
-
- OpenTK use a QWERTY layout, so pay attention if you use another Keyboard Layout.
-
- Ex: `Controls_Left_JoyConKeyboard_Button_Minus = 52` > Tab key (All Layout).
-
-- `Controls_Right_JoyConKeyboard_XX` *(int)*
- ```
- Controls_Right_JoyConKeyboard_Stick_Up (int)
- Controls_Right_JoyConKeyboard_Stick_Down (int)
- Controls_Right_JoyConKeyboard_Stick_Left (int)
- Controls_Right_JoyConKeyboard_Stick_Right (int)
- Controls_Right_JoyConKeyboard_Stick_Button (int)
- Controls_Right_JoyConKeyboard_Button_A (int)
- Controls_Right_JoyConKeyboard_Button_B (int)
- Controls_Right_JoyConKeyboard_Button_X (int)
- Controls_Right_JoyConKeyboard_Button_Y (int)
- Controls_Right_JoyConKeyboard_Button_Plus (int)
- Controls_Right_JoyConKeyboard_Button_R (int)
- Controls_Right_JoyConKeyboard_Button_ZR (int)
- ```
-
- Keys of the right Emulated Joycon, the values depend of the [OpenTK Enum Keys](https://github.com/opentk/opentk/blob/develop/src/OpenTK/Input/Key.cs).
-
- OpenTK use a QWERTY layout, so pay attention if you use another Keyboard Layout.
-
- Ex: `Controls_Right_JoyConKeyboard_Button_A = 83` > A key (QWERTY Layout) / Q key (AZERTY Layout).
-
-- `Controls_Left_JoyConController_XX` *(String)*
- ```
- Controls_Left_JoyConController_Stick (String)
- Controls_Left_JoyConController_Stick_Button (String)
- Controls_Left_JoyConController_DPad_Up (String)
- Controls_Left_JoyConController_DPad_Down (String)
- Controls_Left_JoyConController_DPad_Left (String)
- Controls_Left_JoyConController_DPad_Right (String)
- Controls_Left_JoyConController_Button_Minus (String)
- Controls_Left_JoyConController_Button_L (String)
- Controls_Left_JoyConController_Button_ZL (String)
- ```
-
-- `Controls_Right_JoyConController_XX` *(String)*
- ```
- Controls_Right_JoyConController_Stick (String)
- Controls_Right_JoyConController_Stick_Button (String)
- Controls_Right_JoyConController_Button_A (String)
- Controls_Right_JoyConController_Button_B (String)
- Controls_Right_JoyConController_Button_X (String)
- Controls_Right_JoyConController_Button_Y (String)
- Controls_Right_JoyConController_Button_Plus (String)
- Controls_Right_JoyConController_Button_R (String)
- Controls_Right_JoyConController_Button_ZR (String)
- ```
-
-- Default Mapping
- - Controller
+### Default Mapping
+ #### Controller
- Left Joycon:
- Analog Stick = Left Analog Stick
- DPad Up = DPad Up
@@ -137,7 +138,8 @@
- Plus = Start / Options
- R = Right Shoulder Button
- ZR = Right Trigger
- - Keyboard
+
+ #### Keyboard
- Left Joycon:
- Stick Up = W
- Stick Down = S
@@ -166,7 +168,7 @@
- R = U
- ZR = O
-- Valid Button Mappings
+### Valid Button Mappings
- A = The A / Cross Button
- B = The B / Circle Button
- X = The X / Square Button