Settings

Settings are stored inside settings.json. This file is located in the config folder of HexPatch. The config folder is located in the following locations:

• Windows: %APPDATA%\HexPatch
• Linux: $HOME/.config/HexPatch or $XDG_CONFIG_HOME/HexPatch
• macOS: $HOME/Library/Application Support/HexPatch

You can specify a different configuration file to use with the --config flag.

If the file or directory doesn't exist, it will be created with the default settings.

To improve forward compatibility, the app will not create a file with the default settings if the --config flag is not used. This is to avoid creating a config file that will override new default settings in future versions of the app.

Settings are stored in JSON format and have the following structure:

{
    "color": {
        //color settings, used to define the style of the UI
    },
    "key": {
        //key settings, used to define the keybindings
    },
    "app": {
        //app settings, used to define the behavior of the app
    },
    "custom": {
        //custom settings, used to define plugin related settings in a Key-Value format
    }
}

If a setting is not present in the file, the default value will be used. For color settings, the default value changes based on the theme specified in the app settings, if the theme is not specified, the default theme is "auto" and if the detection fails, the "dark" theme is used.

You can find the default settings here. You can also generate the same file by running hexpatch --config <CONFIG_PATH> passing in a path that doesn't exist yet, the file will be created there.

Color

Style

Every setting in this categroy is a style object, a style object has the following fields:

Style.Modifier

The following modifiers are available:

• BOLD
• DIM
• ITALIC
• UNDERLINED
• SLOW_BLINK
• RAPID_BLINK
• REVERSED
• HIDDEN
• CROSSED_OUT

Color fields

The following styles can be customized in the color settings:

Key

KeyEvent

Every setting in this category is a key event object, a key event object has the following fields:

KeyEvent.Code

Key codes can be in one of the following formats:

• Named key: a string containing the name of one of the following keys:

  • "Backspace"
  • "Enter"
  • "Left"
  • "Right"
  • "Up"
  • "Down"
  • "Home"
  • "End"
  • "PageUp"
  • "PageDown"
  • "Tab"
  • "BackTab"
  • "Delete"
  • "Insert"
  • "Esc"
  • "CapsLock"
  • "ScrollLock"
  • "NumLock"
  • "PrintScreen"
  • "Pause"
  • "Menu"
  • "KeypadBegin"

• Function key: a json object containing the field "F" with the number of the function key i.e.

  {"F": 1}
  

  Numbers from 1 to 24 are valid.

• Character key: a json object containing the field "Char" with the character of the key i.e.

  {"Char": "a"}
  

  Both uppercase and lowercase characters are valid, as well as numbers and symbols. Uppercase characters should be used with the SHIFT modifier.

• Media key: a json object containing the field "Media" with the name of the media key i.e.

  {"Media": "Play"}
  

  Available media keys are:

  • "Play"
  • "Pause"
  • "PlayPause"
  • "Reverse"
  • "Stop"
  • "FastForward"
  • "Rewind"
  • "TrackNext"
  • "TrackPrevious"
  • "Record"
  • "LowerVolume"
  • "RaiseVolume"
  • "MuteVolume"

• Modifier key: a json object containing the field "Modifier" with the name of the modifier key i.e.

  {"Modifier": "LeftShift"}
  

  Available modifier keys are:

  • "LeftShift"
  • "LeftControl"
  • "LeftAlt"
  • "LeftSuper"
  • "LeftHyper"
  • "LeftMeta"
  • "RightShift"
  • "RightControl"
  • "RightAlt"
  • "RightSuper"
  • "RightHyper"
  • "RightMeta"
  • "IsoLevel3Shift"
  • "IsoLevel5Shift"

KeyEvent.Modifier

The available modifiers are:

• SHIFT
• CONTROL
• ALT
• SUPER
• HYPER
• META

KeyEvent.State

The available states are:

• KEYPAD (this means that the event originated from the keypad)
• CAPS_LOCK
• NUM_LOCK

Key fields

The following key bindings can be customized in the key settings:

App

App fields

The following app settings can be customized in the app settings:

Custom

Custom fields are used to store and configure plugin related settings in a Key-Value format.

CustomValue

Every setting in this category is a custom value object, a custom value object can be any JSON value apart from an object or an array. It can also be a Style object or a KeyEvent object.

Example:

{
    "custom_string": "This is a string",
    "custom_integer": 42,
    "custom_bool": true,
    "custom_float": 3.14,
    "custom_style": {
        "fg": "#000000",
        "bg": "#FFFFFF",
        "underline_color": "#FFFFFF",
        "add_modifier": "BOLD",
        "sub_modifier": ""
    },
    "custom_key": {
        "code": {"Char": "a"},
        "modifiers": "CONTROL",
        "kind": "Press",
        "state": ""
    }
}